Skip to content

3.1.1: Improved request-response example #3998

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Aug 8, 2024
Merged

3.1.1: Improved request-response example #3998

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
2389c8c
Improved request-response example
ralfhandl Aug 5, 2024
1a32433
Inconsistent monospace
ralfhandl Aug 5, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 9 additions & 5 deletions versions/3.1.1.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -294,7 +294,7 @@ Relative references in CommonMark hyperlinks are resolved in their rendered cont

This section describes the structure of the OpenAPI Description format.
This text is the only normative description of the format.
A JSON Schema is hosted on [`spec.openapis.org`](https://spec.openapis.org) for informational purposes.
A JSON Schema is hosted on [spec.openapis.org](https://spec.openapis.org) for informational purposes.
If the JSON Schema differs from this section, then this section MUST be considered authoritative.

In the following description, if a field is not explicitly **REQUIRED** or described with a MUST or SHALL, it can be considered OPTIONAL.
Expand Down Expand Up @@ -2100,17 +2100,21 @@ For example, given the following HTTP request:
POST /subscribe/myevent?queryUrl=https://clientdomain.com/stillrunning HTTP/1.1
Host: example.org
Content-Type: application/json
Content-Length: 187
Content-Length: 188

{
"failedUrl" : "https://clientdomain.com/failed",
"successUrls" : [
"failedUrl": "https://clientdomain.com/failed",
"successUrls": [
"https://clientdomain.com/fast",
"https://clientdomain.com/medium",
"https://clientdomain.com/slow"
]
}
```

resulting in:

```http
201 Created
Location: https://example.org/subscription/1
```
Expand Down Expand Up @@ -3149,7 +3153,7 @@ components:
$id: fully_generic_array
type: array
items:
$dynamicRef: "#generic-array"
$dynamicRef: '#generic-array'
$defs:
allowAll:
$dynamicAnchor: generic-array
Expand Down