Skip to content

Commit 8da2c2a

Browse files
authored
3.1.0-rc1 Release prep (#2369)
* Update 3.1.0.md * Merge branch 'master' into v3.1.0-dev
1 parent 0e91fe8 commit 8da2c2a

File tree

2 files changed

+12
-10
lines changed

2 files changed

+12
-10
lines changed

README.md

+10-9
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,10 @@
11
# The OpenAPI Specification
22

3-
[![Build Status](https://travis-ci.org/OAI/OpenAPI-Specification.svg?branch=master)](https://travis-ci.org/OAI/OpenAPI-Specification)
3+
![Build Status](https://github.com/OAI/OpenAPI-Specification/workflows/validate-markdown/badge.svg)
44

55
![](https://avatars3.githubusercontent.com/u/16343502?v=3&s=200)
66

77

8-
**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-
118
The OpenAPI Specification is a community-driven open specification within the [OpenAPI Initiative](https://www.openapis.org/), a Linux Foundation Collaborative Project.
129

1310
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
1815

1916
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.
2017

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
2223

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).
2425

2526
### Previous Versions
2627

@@ -45,11 +46,11 @@ Development of the next version of the OpenAPI Specification is guided by the [T
4546

4647
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).
4748

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:
4950

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.
5152
* 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.
5354
* Create an issue to describe a new concern. If possible, propose a solution.
5455

5556
Not all feedback can be accommodated and there may be solid arguments for or against a change being appropriate for the specification.

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-rc0
3+
#### Version 3.1.0-rc1
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

@@ -3422,6 +3422,7 @@ Two examples of this:
34223422

34233423
Version | Date | Notes
34243424
--- | --- | ---
3425+
3.1.0-rc0 | 2020-10-07 | rc1 of the 3.1 specification
34253426
3.1.0-rc0 | 2020-06-18 | rc0 of the 3.1 specification
34263427
3.0.3 | 2020-02-20 | Patch release of the OpenAPI Specification 3.0.3
34273428
3.0.2 | 2018-10-08 | Patch release of the OpenAPI Specification 3.0.2

0 commit comments

Comments
 (0)