Skip to content

Commit d6443c1

Browse files
authored
3.1.0 release prep (#2461)
* 3.1.0 release prep * Update README.md
1 parent 7ee1ca2 commit d6443c1

File tree

2 files changed

+8
-11
lines changed

2 files changed

+8
-11
lines changed

README.md

+6-10
Original file line numberDiff line numberDiff line change
@@ -15,28 +15,24 @@ The OpenAPI Specification does not require rewriting existing APIs. It does not
1515

1616
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.
1717

18-
## Current Version - 3.0.3
18+
## Current Version - 3.1.0
1919

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
23-
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).
20+
The current version of the OpenAPI specification is [OpenAPI Specification 3.1.0](versions/3.1.0.md).
2521

2622
### Previous Versions
2723

28-
This repository also contains the [OpenAPI Specification 2.0](versions/2.0.md), which is identical to the Swagger 2.0 specification before it was renamed to "OpenAPI Specification", as well as the Swagger 1.2 and Swagger 2.0 specifications.
24+
This repository also contains all [previous versions](versions).
2925

3026
Each folder in this repository, such as [examples](examples) and [schemas](schemas), should contain folders pertaining to the current and previous versions of the specification.
3127

3228
## See It in Action
3329

34-
If you just want to see it work, check out the [list of current examples](examples/v3.0).
30+
If you just want to see it work, check out the [list of current examples](examples).
3531

3632
## Tools and Libraries
3733

3834
Looking to see how you can create your own OpenAPI definition, present it, or otherwise use it? Check out the growing
39-
[list of 3.0 implementations](IMPLEMENTATIONS.md).
35+
[list of implementations](IMPLEMENTATIONS.md).
4036

4137
## Participation
4238

@@ -48,7 +44,7 @@ The TSC holds weekly web conferences to review open pull requests and discuss op
4844

4945
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:
5046

51-
* Review the [current specification](versions/3.0.3.md). The human-readable markdown file _is the source of truth_ for the specification.
47+
* Review the [current specification](versions/3.1.0.md). The human-readable markdown file _is the source of truth_ for the specification.
5248
* Review the [development](DEVELOPMENT.md) process so you understand how the spec is evolving.
5349
* 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.
5450
* Create an issue to describe a new concern. If possible, propose a solution.

versions/3.1.0.md

+2-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# OpenAPI Specification
22

3-
#### Version 3.1.0-rc1
3+
#### Version 3.1.0
44

55
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.
66

@@ -3451,6 +3451,7 @@ Two examples of this:
34513451

34523452
Version | Date | Notes
34533453
--- | --- | ---
3454+
3.1.0 | 2021-02-15 | Release of the OpenAPI Specification 3.1.0
34543455
3.1.0-rc1 | 2020-10-08 | rc1 of the 3.1 specification
34553456
3.1.0-rc0 | 2020-06-18 | rc0 of the 3.1 specification
34563457
3.0.3 | 2020-02-20 | Patch release of the OpenAPI Specification 3.0.3

0 commit comments

Comments
 (0)