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 is the WIP branch for the next minor version of the spec - 3.1.0. Non-breaking changes should be submitted against this branch, specifically against [3.1.0.md](https://github.com/OAI/OpenAPI-Specification/blob/v3.1.0-dev/versions/3.1.0.md).**
9
-
10
-
11
8
The OpenAPI Specification is a community-driven open specification within the [OpenAPI Initiative](https://www.openapis.org/), a Linux Foundation Collaborative Project.
12
9
13
10
The OpenAPI Specification (OAS) defines a standard, programming language-agnostic interface description for HTTP APIs, which allows both humans and computers to discover and understand the capabilities of a service without requiring access to source code, additional documentation, or inspection of network traffic. When properly defined via OpenAPI, a consumer can understand and interact with the remote service with a minimal amount of implementation logic. Similar to what interface descriptions have done for lower-level programming, the OpenAPI Specification removes guesswork in calling a service.
@@ -18,9 +15,13 @@ The OpenAPI Specification does not require rewriting existing APIs. It does not
18
15
19
16
This GitHub project is the starting point for OpenAPI. Here you will find the information you need about the OpenAPI Specification, simple examples of what it looks like, and some general information regarding the project.
20
17
21
-
## Current Version - 3.0.2
18
+
## Current Version - 3.0.3
19
+
20
+
The current version of the OpenAPI specification is [OpenAPI Specification 3.0.3](versions/3.0.3.md).
21
+
22
+
## Current Release Candidate Version - 3.1.0-RC1
22
23
23
-
The current version of the OpenAPI specification is [OpenAPI Specification 3.0.2](versions/3.0.2.md).
24
+
We invite the community to review and provide feedback for the current release candidate ([OpenAPI Specification 3.1.0-RC1](versions/3.1.0.md). Changes related to the upcoming 3.1.0 release should be submitted at [the development branch](https://github.com/OAI/OpenAPI-Specification/tree/v3.1.0-dev).
24
25
25
26
### Previous Versions
26
27
@@ -45,11 +46,11 @@ Development of the next version of the OpenAPI Specification is guided by the [T
45
46
46
47
The TSC holds weekly web conferences to review open pull requests and discuss open issues related to the evolving OpenAPI Specification. Participation in weekly calls and scheduled working sessions is open to the community. You can view the [TSC calendar online](https://openapi.groups.io/g/tsc/calendar), and import it to your calendar using the [iCal link](https://openapi.groups.io/g/tsc/ics/1105671/1995679554/feed.ics).
47
48
48
-
The Open API Initiative encourages participation from individuals and companies alike. If you want to participate in the evolution of the OpenAPI Specification, consider taking the following actions:
49
+
The OpenAPI Initiative encourages participation from individuals and companies alike. If you want to participate in the evolution of the OpenAPI Specification, consider taking the following actions:
49
50
50
-
* Review the [current specification](versions/3.0.1.md). The human-readable markdown file _is the source of truth_ for the specification.
51
+
* Review the [current specification](versions/3.0.3.md). The human-readable markdown file _is the source of truth_ for the specification.
51
52
* Review the [development](DEVELOPMENT.md) process so you understand how the spec is evolving.
52
-
* Check the [issues](https://github.com/OAI/OpenAPI-Specification/issues) and [pull requests](https://github.com/OAI/OpenAPI-Specification/pulls) to see if someone has already documented your idea or feedback on the specification. You can follow an existing conversation by adding a comment to the existing issue or PR.
53
+
* Check the [issues](https://github.com/OAI/OpenAPI-Specification/issues) and [pull requests](https://github.com/OAI/OpenAPI-Specification/pulls) to see if someone has already documented your idea or feedback on the specification. You can follow an existing conversation by subscribing to the existing issue or PR.
53
54
* Create an issue to describe a new concern. If possible, propose a solution.
54
55
55
56
Not all feedback can be accommodated and there may be solid arguments for or against a change being appropriate for the specification.
Copy file name to clipboardExpand all lines: versions/3.1.0.md
+2-1
Original file line number
Diff line number
Diff line change
@@ -1,6 +1,6 @@
1
1
# OpenAPI Specification
2
2
3
-
#### Version 3.1.0-rc0
3
+
#### Version 3.1.0-rc1
4
4
5
5
The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", "SHOULD", "SHOULD NOT", "RECOMMENDED", "NOT RECOMMENDED", "MAY", and "OPTIONAL" in this document are to be interpreted as described in [BCP 14](https://tools.ietf.org/html/bcp14)[RFC2119](https://tools.ietf.org/html/rfc2119)[RFC8174](https://tools.ietf.org/html/rfc8174) when, and only when, they appear in all capitals, as shown here.
6
6
@@ -3422,6 +3422,7 @@ Two examples of this:
3422
3422
3423
3423
Version | Date | Notes
3424
3424
--- | --- | ---
3425
+
3.1.0-rc0 | 2020-10-07 | rc1 of the 3.1 specification
3425
3426
3.1.0-rc0 | 2020-06-18 | rc0 of the 3.1 specification
3426
3427
3.0.3 | 2020-02-20 | Patch release of the OpenAPI Specification 3.0.3
3427
3428
3.0.2 | 2018-10-08 | Patch release of the OpenAPI Specification 3.0.2
0 commit comments