Skip to content

Commit

Permalink
Apply suggestions from code review
Browse files Browse the repository at this point in the history
  • Loading branch information
ralfhandl authored Sep 19, 2024
1 parent 5a57fb0 commit 501362d
Show file tree
Hide file tree
Showing 2 changed files with 10 additions and 8 deletions.
12 changes: 7 additions & 5 deletions blog-post.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
The OpenAPI Initiative is pleased to announce a patch release of the 3.0 and 3.1 OpenAPI specifications.
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.
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.
Think of this release as the "Words Mean Things" edition.

## Released versions

3.1.1 is the newest and recommended version of OpenAPI.
3.1.1 is the newest and recommended version of the OpenAPI Specification.
If you are starting a new project today, or have the option to upgrade, this is your target version.
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.

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

## Summary of changes

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.
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.
The highlights include a lot of new content to expand on existing content and reduce ambiguity.
The sections regarding parameters, encoding and schemas have had significant updates and expansion to cover more cases.
You will also find some security clarifications and a whole new "Security Considerations" section has been added.

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

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

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

## Beyond the specification
Expand All @@ -38,6 +38,8 @@ In addition to the main specifications that you can always find at https://spec.
This representation should not require changes between 3.1.0 and 3.1.1 since patch releases don't change the structure.
- 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.

All of these resources are now linked from the relevant parts of the OpenAPI Specification.

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.
Which doesn't affect the specification but does make it a nicer place to be and hopefully makes the next release easier too.

Expand Down
6 changes: 3 additions & 3 deletions release-notes-3.1.1.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
# Release Notes

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:
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:
- Expands and clarifies a number of explanations, including several new appendices with supplementary details
- Focuses on technical specifics by moving examples and additional documentation now published at https://learn.openapis.org
- Declares that the HTML specifications at https://spec.openapis.org are now the authoritative versions (formerly it was the Markdown source on GitHub)

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

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

Expand All @@ -14,7 +14,7 @@ Tooling maintainers should expect minimal work to support 3.1.1/3.0.4; however,
Introduce consistent language around OpenAPI Document/Description/Definition:
- OpenAPI Description means the OpenAPI description of an API, whether it is in one or many files.
- A document means a single file.
- An "entry document" is where the OpenAPI description for an API starts; it may reference other documents.
- An "entry document" is where the OpenAPI Description for an API starts; it may reference other documents.

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.

Expand Down

0 comments on commit 501362d

Please sign in to comment.