You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
The `Link` header is now addressed in another PR.
Make the first example a real header instead of an `X-`.
Also provide a link to the Header Object for special cases
that will be documented there in other PRs.
Copy file name to clipboardExpand all lines: src/oas.md
+6-40Lines changed: 6 additions & 40 deletions
Original file line number
Diff line number
Diff line change
@@ -1038,6 +1038,8 @@ For cookies, neither the `?` nor `&` delimiter is correct (see [Appendix D: Seri
1038
1038
1039
1039
Note that RFC6570 form expansion implementations will include either a leading `?` or `&` delimiter, depending on which type of form expansion is used, so in some scenarios it is necessary to strip off or change the leading delimiter.
1040
1040
1041
+
See the [Header Object](#header-object) for special rules for showing examples of the `Set-Cookie` response header, which violates the normal rules for multiple header values.
1042
+
1041
1043
The following section illustrates these rules.
1042
1044
1043
1045
##### Style Examples
@@ -2506,8 +2508,10 @@ Using `content` with a `text/plain` media type is RECOMMENDED for headers where
2506
2508
A simple header of type `integer`:
2507
2509
2508
2510
```yaml
2509
-
X-Rate-Limit-Limit:
2510
-
description: The number of allowed requests in the current period
2511
+
Retry-After:
2512
+
description: |
2513
+
The number of seconds to wait before retrying the operation.
2514
+
This Header Object does not allow the HTTP date format syntax.
2511
2515
schema:
2512
2516
type: integer
2513
2517
examples:
@@ -2528,44 +2532,6 @@ ETag:
2528
2532
pattern: ^"
2529
2533
```
2530
2534
2531
-
A `Link` header that, if present, must include links with the standard relation types `self`, `first`, `prev`, `next`, and `last`, as might be used on a paginated collection:
2532
-
2533
-
```yaml
2534
-
Link:
2535
-
schema:
2536
-
type: array
2537
-
items:
2538
-
type: string
2539
-
allOf:
2540
-
- contains:
2541
-
pattern: rel="?first"?
2542
-
- contains:
2543
-
pattern: rel="?prev"?
2544
-
- contains:
2545
-
pattern: rel="?self"?
2546
-
- contains:
2547
-
pattern: rel="?next"?
2548
-
- contains:
2549
-
pattern: rel="?last"?
2550
-
style: simple
2551
-
# The ";" character and the URI delimiters are reserved
2552
-
# but needs to be allowed as headers do not expect these
0 commit comments