Skip to content

Commit 31bae9b

Browse files
Apply suggestions from code review
Co-authored-by: Marsh Gardiner <[email protected]>
1 parent 7c3faf6 commit 31bae9b

File tree

1 file changed

+17
-12
lines changed

1 file changed

+17
-12
lines changed

release-notes-3.1.1.md

Lines changed: 17 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,20 @@
11
# Release Notes
22

3-
This release makes no changes to the OpenAPI standard, however the formal specification document had multiple improvements, including:
3+
While the 3.1.1 release makes no mechanical changes to the OpenAPI 3.1.0 specification, it does introduce a number of notable improvements, including:
44
- clarity and expanded explanations including several new appendices with supplementary details
5-
- examples and additional documentation moved to https://learn.openapis.org
6-
- the HTML rendering of the specification at https://spec.openapis.org is now considered the authoritative version (formerly it was the Markdown source on GitHub)
5+
- Focuses on technical specifics by moving examples and additional documentation now published at https://learn.openapis.org
6+
- Declares that the HTML specifications at https://spec.openapis.org are now the authoritative versions (formerly it was the Markdown source on GitHub)
77

88
OpenAPI description writers should mark their OpenAPI descriptions with the version of OpenAPI specification they used to write their specification, updating where possible.
99

10-
Tool creators should also not expect changes, but it is recommended to check the list of changes below.
10+
Tooling maintainers should expect minimal work to support 3.1.1/3.0.4; however, we recommend checking the list of changes below.
1111

1212
## Clearer Definitions
1313

1414
Introduce consistent language around OpenAPI Document/Description/Definition:
1515
- OpenAPI Description means the OpenAPI description of an API, whether it is in one or many files.
16-
- a document means a single file.
17-
- an "entry document" is where the OpenAPI description for an API starts; it may reference other documents.
16+
- A document means a single file.
17+
- An "entry document" is where the OpenAPI description for an API starts; it may reference other documents.
1818

1919
Improved language regarding schemas, explaining the difference between the OpenAPI schema, the schemas used within the OpenAPI schema, and the use of a non-authoritative JSON Schema to supplement the written spec.
2020

@@ -23,7 +23,9 @@ Improved language regarding schemas, explaining the difference between the OpenA
2323
## References
2424

2525
Additional guidance for resolving references and parsing documents was added.
26+
2627
Resolving component names, tags, and operationIds are clarified.
28+
2729
[3.1.1]The adoption of JSON Schema in 3.1.x changed the parsing and referencing, and a new section was added to cover the changes in more depth than in 3.1.0.
2830

2931
[3.1.1]Improved explanation of URLs and URIs, and made clear which to use for each URL/URI field.
@@ -32,22 +34,25 @@ Clarified that Markdown links are resolved in relation to their rendered context
3234
## Data Types
3335

3436
Extensive clarifications on data types and encoding.
37+
3538
Added a section on handling binary data.
3639

3740
## Security
3841

39-
Added a note that the `security` array that is empty or missing values does not indicate that no security arrangements exist for this API.
42+
Added a note that a `security` array that is empty or missing does not indicate that no security arrangements exist for this API.
43+
4044
Updated references to other standards where newer versions are available, and added more explanation for OpenIDConnect.
41-
Added a "Security Concerns" section containing advice for implementers and users of OpenAPI.
4245

46+
Added a "Security Concerns" section containing advice for implementers and users of OpenAPI.
4347
## Request Data
4448

45-
The parameters section was extensively refactored.
46-
Examples were updated, improved and explanations added.
49+
Extensive refactoring of the parameters section
50+
Examples were updated, improved, and explanations added.
51+
4752
Headers have their own section with examples and specific information.
4853

49-
Explanation of OpenAPI `example` and `examples` was expanded and the "Working with Examples" section added with clearer description and examples included.
54+
Improves and expands on OpenAPI `example` and `examples` and adds a "Working with Examples" section with a clearer description and examples.
5055

51-
Information regarding file uploads, form-urlencoded request bodies and multipart content were expanded and moved to the refactored Encoding Object section to provide better coverage of edge cases and more examples.
56+
Clarifies and expands on file uploads, form-urlencoded request bodies, and multipart content, and moves them to a refactored `Encoding Object` section to provide better coverage of edge cases and more examples.
5257

5358

0 commit comments

Comments
 (0)