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
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:
4
4
- clarity and expanded explanations including several new appendices with supplementary details
5
-
- examples and additional documentation moved tohttps://learn.openapis.org
6
-
-the HTML rendering of the specification at https://spec.openapis.orgis 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 athttps://learn.openapis.org
6
+
-Declares that the HTML specifications at https://spec.openapis.orgare now the authoritative versions (formerly it was the Markdown source on GitHub)
7
7
8
8
OpenAPI description writers should mark their OpenAPI descriptions with the version of OpenAPI specification they used to write their specification, updating where possible.
9
9
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.
11
11
12
12
## Clearer Definitions
13
13
14
14
Introduce consistent language around OpenAPI Document/Description/Definition:
15
15
- 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.
18
18
19
19
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.
20
20
@@ -23,7 +23,9 @@ Improved language regarding schemas, explaining the difference between the OpenA
23
23
## References
24
24
25
25
Additional guidance for resolving references and parsing documents was added.
26
+
26
27
Resolving component names, tags, and operationIds are clarified.
28
+
27
29
[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.
28
30
29
31
[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
32
34
## Data Types
33
35
34
36
Extensive clarifications on data types and encoding.
37
+
35
38
Added a section on handling binary data.
36
39
37
40
## Security
38
41
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
+
40
44
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.
42
45
46
+
Added a "Security Concerns" section containing advice for implementers and users of OpenAPI.
43
47
## Request Data
44
48
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
+
47
52
Headers have their own section with examples and specific information.
48
53
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.
50
55
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.
0 commit comments