Skip to content

Commit 501362d

Browse files
authored
Apply suggestions from code review
1 parent 5a57fb0 commit 501362d

File tree

2 files changed

+10
-8
lines changed

2 files changed

+10
-8
lines changed

blog-post.md

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
The OpenAPI Initiative is pleased to announce a patch release of the 3.0 and 3.1 OpenAPI specifications.
2-
In patch releases, no changes are made to the way that APIs are described, but the specification wording itself contains many updates, expansions, and clarifications where previous the points may have been unclear or not covered.
2+
In patch releases, no changes are made to the way that APIs are described, but the specification wording itself contains many updates, expansions, and clarifications where previously the points may have been unclear or not covered.
33
Think of this release as the "Words Mean Things" edition.
44

55
## Released versions
66

7-
3.1.1 is the newest and recommended version of OpenAPI.
7+
3.1.1 is the newest and recommended version of the OpenAPI Specification.
88
If you are starting a new project today, or have the option to upgrade, this is your target version.
99
Tooling that supports 3.1.0 is expected to work without problems on 3.1.1 since the patch releases don't contain structure changes.
1010

@@ -13,19 +13,19 @@ It is expected that 3.0.4 will be the final release in the 3.0.x line.
1313

1414
## Summary of changes
1515

16-
The releases include as many explanations, clarifications and expanded sections as we could manage, driven mostly by the questions and comments we get from the users and tools creators of OpenAPI.
16+
The releases include as many explanations, clarifications and expanded sections as we could manage, driven mostly by the questions and comments we get from the users and tools creators of the OpenAPI Specification.
1717
The highlights include a lot of new content to expand on existing content and reduce ambiguity.
1818
The sections regarding parameters, encoding and schemas have had significant updates and expansion to cover more cases.
1919
You will also find some security clarifications and a whole new "Security Considerations" section has been added.
2020

2121
Look out for additional appendices with some great explanations that support the additions to the main body of the specification.
2222
We added a great collection of new content sections and appendix entries about handling data including data types, serialization and encoding.
23-
In 3.1, there is more information about parsing documents and resolving references since the adoption of JSON Schema.
23+
In 3.1, there is more information about parsing documents and resolving references since the adoption of full JSON Schema compatibility.
2424

2525
The updates also strayed into distinctly "meta" areas, so we've also got:
2626

2727
- examples of using the `example(s)` fields
28-
- reference to a schema to represent the OpenAPI schema
28+
- reference to a JSON Schema to represent the OpenAPI Specification schema
2929
- we have clearly defined when something was undefined or implementation dependent
3030

3131
## Beyond the specification
@@ -38,6 +38,8 @@ In addition to the main specifications that you can always find at https://spec.
3838
This representation should not require changes between 3.1.0 and 3.1.1 since patch releases don't change the structure.
3939
- The [formats registry](https://spec.openapis.org/registry/format/index.html) and the [extensions registry](https://spec.openapis.org/registry/extension/index.html) list some common patterns in specification use.
4040

41+
All of these resources are now linked from the relevant parts of the OpenAPI Specification.
42+
4143
We also updated the tooling that publishes the specification, changed the GitHub repository structure, cleaned up and reformatted all the Markdown content, and improved our workflow automation.
4244
Which doesn't affect the specification but does make it a nicer place to be and hopefully makes the next release easier too.
4345

release-notes-3.1.1.md

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

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:
3+
While the 3.1.1 release makes no changes to requirements of the OpenAPI 3.1.0 specification, it does introduce a number of notable improvements, including:
44
- Expands and clarifies a number of explanations, including several new appendices with supplementary details
55
- Focuses on technical specifics by moving examples and additional documentation now published at https://learn.openapis.org
66
- Declares that the HTML specifications at https://spec.openapis.org are now the authoritative versions (formerly it was the Markdown source on GitHub)
77

8-
OpenAPI description writers should mark their OpenAPI descriptions with the version of the OpenAPI specification they used to write their specification, updating where possible.
8+
OpenAPI Description writers should mark their OpenAPI Descriptions with the version of the OpenAPI specification they used to write their specification, updating where possible.
99

1010
Tooling maintainers should expect minimal work to support 3.1.1/3.0.4; however, we recommend checking the list of changes below.
1111

@@ -14,7 +14,7 @@ Tooling maintainers should expect minimal work to support 3.1.1/3.0.4; however,
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.
1616
- A document means a single file.
17-
- An "entry document" is where the OpenAPI description for an API starts; it may reference other documents.
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

0 commit comments

Comments
 (0)