Skip to content

Commit a1e8818

Browse files
lornajaneralfhandl
andauthored
Apply suggestions from code review
Co-authored-by: Ralf Handl <[email protected]>
1 parent ca5f9f2 commit a1e8818

File tree

2 files changed

+10
-10
lines changed

2 files changed

+10
-10
lines changed

draft-release-notes.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -162,7 +162,7 @@ There is also a new Media Types Registry, to provide further resources for worki
162162
- Additional parameter location `querystring`, to allow parsing the entire query string as a single field similar to the way a request body is handled, using the `content` field. Useful for complex or unconventional query data. Mutually exclusive with the `query` field.
163163
- Parameters can therefore be `in` the `querystring` as an alternative to the existing `header`, `cookie`, `query` and `path` values.
164164
- `allowReserved` field is now permitted on headers and on parameters with any value of `in`, and applies where the combination of `in` and `style` automatically percent-encode the value.
165-
- Remove incorrect mention of Reference Object in the header `schema` field. The JSONSchema ref would be the correct thing to use in this context.
165+
- Remove incorrect mention of Reference Object in the header `schema` field. The JSON Schema `$ref` would be the correct thing to use in this context.
166166
- The `examples` (and older `example`) field is now supported with `content`.
167167

168168
#### Specific `style` option for cookies
@@ -343,7 +343,7 @@ Particularly if you are building OpenAPI tooling, these sections give much bette
343343

344344
Version 3.1.2 has no material changes but does contain editorial fixes, additional examples, and clarifications.
345345

346-
- Clarify that `$ref` in a Schema Object is a JSONSchema `$ref` keyword.
346+
- Clarify that `$ref` in a Schema Object is a JSON Schema `$ref` keyword.
347347
- Detailed explanation of percent-encoding and -decoding, updated examples and references to match, including the Style Examples table.
348348
- Better explanation and examples for using Encoding and Serialization, and a note not to apply percent-encoding to headers.
349349
- Clarify that Request Body Objects need to specify at least one media type to be meaningful.

summary-release-notes.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ What's coming up? Look at `src/oas.md` on the relevant development branch for fu
2929
- Streaming support: sequential media types including SSE
3030

3131
- Support for sequential media types such as `text/event-stream` for server-sent events (SSE) and `multipart/mixed`, `application/jsonl`, `application/json-seq` and others for sequential data.
32-
- Responses can be a repeating data structure, and are treated as if they are an array of schema objects.
32+
- Responses can be a repeating data structure, and are treated as if they are an array of Schema Objects.
3333
- Use `itemSchema` in a mediatype entry to describe each item.
3434
- A media types registry is published to give more context for each of the media types.
3535

@@ -57,9 +57,9 @@ What's coming up? Look at `src/oas.md` on the relevant development branch for fu
5757
- The `xml` keyword can be used in any Schema Object.
5858
- XML namespaces can be IRIs (rather than URIs).
5959
- Explanation and examples for many use cases including handling `null`, handling arrays, replacing the name, and handling ordered elements.
60-
- Clarify that the root schema of an XML object should use the component name.
60+
- Clarify that the root schema of an XML Object should use the component name.
6161

62-
- Examples as either structured or serialised values
62+
- Examples as either structured or serialized values
6363

6464
- The Example Object (used in `examples` fields) gets two new fields: `dataValue` and `serializedValue`.
6565
- `dataValue` describes the example in structured format.
@@ -75,7 +75,7 @@ What's coming up? Look at `src/oas.md` on the relevant development branch for fu
7575
- Additional `deprecated` field for security schemes (indicating that the scheme may still be supported, but that it should not be used).
7676
- Ability to reference a security scheme by URI rather than declaring it in components.
7777

78-
- Improvements to the Servers object
78+
- Improvements to the Server Object
7979

8080
- Clarify that server URLs should not include fragment or query.
8181
- Support new `name` field alongside `description`, `url` and `variables`.
@@ -88,11 +88,11 @@ What's coming up? Look at `src/oas.md` on the relevant development branch for fu
8888

8989
- Templates with formal syntax
9090

91-
- The specification now includes **ABNF** (Augmented Backus–Naur Form) for path templating, server variables, and runtime expressions in the Links object.
91+
- The specification now includes **ABNF** (Augmented Backus–Naur Form) for path templating, server variables, and runtime expressions in the Link Object.
9292

93-
- Flexible metadata fields in the Response object
93+
- Flexible metadata fields in the Response Object
9494

95-
- `description` field for responses are now optional.
95+
- `description` field for responses is now optional.
9696
- Additional `summary` field for responses.
9797

9898
- Additional updates
@@ -122,7 +122,7 @@ What's coming up? Look at `src/oas.md` on the relevant development branch for fu
122122

123123
Version 3.1.2 has no material changes but does contain editorial fixes, additional examples, and clarifications.
124124

125-
- Clarify that `$ref` in a Schema Object is a JSONSchema `$ref` keyword.
125+
- Clarify that `$ref` in a Schema Object is a JSON Schema `$ref` keyword.
126126
- Detailed explanation of percent-encoding and -decoding, updated examples and references to match, including the Style Examples table.
127127
- Better explanation and examples for using Encoding and Serialization, and a note not to apply percent-encoding to headers.
128128
- Clarify that Request Body Objects need to specify at least one media type to be meaningful.

0 commit comments

Comments
 (0)