Skip to content

Commit db581fe

Browse files
author
Ron
authored
Merge pull request OAI#1281 from usarid/Update-readme-for-v3
Update readme for v3
2 parents cdd1eed + 92b66a6 commit db581fe

File tree

1 file changed

+40
-18
lines changed

1 file changed

+40
-18
lines changed

README.md

Lines changed: 40 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -1,38 +1,60 @@
11
# The OpenAPI Specification
22

3-
### Draft implementations of tooling supporting the 3.0.0 specification can be found here!
3+
[![Build Status](https://travis-ci.org/OAI/OpenAPI-Specification.svg?branch=master)](https://travis-ci.org/OAI/OpenAPI-Specification)
44

5-
[3.0.0 Implementations](https://github.com/OAI/OpenAPI-Specification/blob/OpenAPI.next/IMPLEMENTATIONS.md)
5+
![](https://avatars3.githubusercontent.com/u/16343502?v=3&s=200)
66

7-
This is the working branch for the next version of the OpenAPI Specification. You can read more about the Open API Initiative (OAI) at [https://openapis.org](https://openapis.org).
7+
The OpenAPI Specification is a community driven, open specification within the [Open API Initiative](https://www.openapis.org/), a Linux Foundation Collaborative Project.
88

9-
The current, released version of the OpenAPI Specification is 2.0, through donation of the Swagger Specification to the OAI by SmartBear Software. If you are interested in the release specification, see the [master branch](https://github.com/OAI/OpenAPI-Specification/blob/master/README.md) of this project.
9+
The OpenAPI Specification (OAS) defines a standard, programming language-agnostic interface description for REST 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.
1010

11-
Development of the next version of the OpenAPI Specification is guided by the [OAI Technical Contributors Board](https://github.com/OAI/OpenAPI-Specification/blob/OpenAPI.next/CONTRIBUTORS.md). This group of committers bring their API expertise, incorporate feedback from the community, and expand the group of committers as appropriate. All development activity on the future specification will be performed as features and merged into this branch. Upon release of the OpenAPI Specification, this branch will be merged to master.
11+
Use cases for machine-readable API definition documents include, but are not limited to, interactive documentation; code generation for documentation, clients, and servers; and automation of test cases. OpenAPI documents describe an API's services and are represented in either YAML or JSON formats. These documents may either be produced and served statically or be generated dynamically from an application.
1212

13-
The current process for development of the OpenAPI Specification is described in [Development Guidelines](https://github.com/OAI/OpenAPI-Specification/blob/OpenAPI.next/DEVELOPMENT.md).
13+
The OpenAPI Specification does not require rewriting existing APIs. It does not require binding any software to a service—the service being described may not even be owned by the creator of its description. It does, however, require the capabilities of the service be described in the structure of the OpenAPI Specification. Not all services can be described by OpenAPI—this specification is not intended to cover every possible style of REST APIs. The OpenAPI Specification does not mandate a specific development process such as design-first or code-first. It does facilitate either technique by establishing clear interactions with a REST API.
14+
15+
This GitHub project is the starting point for OpenAPI.
16+
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.
17+
18+
## Current Version - 3.0
19+
20+
The current version of the OpenAPI specification is [OpenAPI Specification 3.0](versions/3.0.md).
21+
22+
### Previous Versions
23+
24+
This repository also contains the [OpenAPI Specification 2.0](versions/2.0), which is identical to the Swagger 2.0 specification before it was renamed to “OpenAPI Specification”,
25+
as well as the Swagger 1.2 and Swagger 2.0 specifications.
26+
27+
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.
28+
29+
## See It in Action
30+
31+
If you just want to see it work, check out the [list of current examples](examples/v3.0).
32+
33+
## Tools and Libraries
34+
35+
Looking to see how you can create your own OpenAPI definition, present it, or otherwise use it? Check out the growing
36+
[list of 3.0 Implementations](IMPLEMENTATIONS.md).
1437

1538
## Participation
1639

17-
The OpenAPI Specification is a community driven, open project hosted by the Linux Foundation. The OAI encourages participation from individuals and companies alike. If you want to participate in the evolution of the OpenAPI Specification, consider taking the following actions:
40+
The current process for development of the OpenAPI Specification is described in
41+
[Development Guidelines](DEVELOPMENT.md).
42+
Development of the next version of the OpenAPI Specification is guided by the [Technical Developer Community](https://www.openapis.org/participate/how-to-contribute/governance#TDC). This group of committers bring their API expertise, incorporate feedback from the community, and expand the group of committers as appropriate. All development activity on the future specification will be performed as features and merged into this branch. Upon release of the future specification, this branch will be merged to master.
43+
44+
The Open API Initiative encourages participation from individuals and companies alike.
45+
If you want to participate in the evolution of the OpenAPI Specification, consider taking the following actions:
1846

19-
* Review the [current specification](https://github.com/OAI/OpenAPI-Specification/blob/OpenAPI.next/versions/3.0.md). The human-readable markdown file _is the source of truth_ for the specification.
20-
* Review the [development](https://github.com/OAI/OpenAPI-Specification/blob/OpenAPI.next/DEVELOPMENT.md) process so you understand how the spec is evolving.
47+
* Review the [current specification](versions/3.0.md). The human-readable markdown file _is the source of truth_ for the specification.
48+
* Review the [development](DEVELOPMENT.md) process so you understand how the spec is evolving.
2149
* 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.
2250
* Create an issue to describe a new concern. If possible, propose a solution.
2351

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

2654
## License
2755

28-
Copyright 2016 The Linux Foundation
2956

30-
Licensed under the Apache License, Version 2.0 (the "License");
31-
you may not use this file except in compliance with the License.
32-
You may obtain a copy of the License at [apache.org/licenses/LICENSE-2.0](http://www.apache.org/licenses/LICENSE-2.0)
57+
See: [License (MIT)](https://github.com/OAI/OpenAPI-Specification/blob/master/LICENSE)
58+
3359

34-
Unless required by applicable law or agreed to in writing, software
35-
distributed under the License is distributed on an "AS IS" BASIS,
36-
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
37-
See the License for the specific language governing permissions and
38-
limitations under the License.
60+
![Analytics](https://ga-beacon.appspot.com/UA-831873-42/readme.md?pixel)

0 commit comments

Comments
 (0)