From 3fd491d0a3a7764b917d7df1a9b0a2aacf29dde8 Mon Sep 17 00:00:00 2001 From: Uri Sarid Date: Wed, 19 Jul 2017 17:29:16 -0700 Subject: [PATCH 1/4] First draft of readme for v3 Incorporated first batch of suggestions from TDC, before any changes from the gdoc. --- README.md | 49 +++++++++++++++++++++++++++++++++++++++---------- 1 file changed, 39 insertions(+), 10 deletions(-) diff --git a/README.md b/README.md index aa21756748..554a7ab1ee 100644 --- a/README.md +++ b/README.md @@ -1,23 +1,52 @@ # The OpenAPI Specification -### Draft implementations of tooling supporting the 3.0.0 specification can be found here! +[![Build Status](https://travis-ci.org/OAI/OpenAPI-Specification.svg?branch=master)](https://travis-ci.org/OAI/OpenAPI-Specification) -[3.0.0 Implementations](https://github.com/OAI/OpenAPI-Specification/blob/OpenAPI.next/IMPLEMENTATIONS.md) +![](https://avatars3.githubusercontent.com/u/16343502?v=3&s=200) -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). +The OpenAPI Specification is a community driven, open specification within the [Open API Initiative](https://www.openapis.org/), a Linux Foundation Collaborative Project. -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. +The OpenAPI Specification defines a standard, language-agnostic interface description for REST APIs which allows both humans and computers to discover and understand the capabilities of the service without access to source code, additional documentation, or through network traffic inspection. 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 the guesswork in calling the service. -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. +Use cases for machine-readable API interfaces include interactive documentation; code generation for documentation, client, and server; and automated test cases. OpenAPI descriptions describe APIs via YAML or JSON documents that adhere to the OpenAPI Specification. These documents can either be produced and served statically, or be generated dynamically from your application. -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). +The OpenAPI Specification does not require you to rewrite your existing API. It does not require binding any software to a service--the service being described may not even be yours. 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 use-case of a REST API. The OpenAPI Specification does not define a specific development process such as design-first or code-first. It does facilitate either technique by establishing clear interactions with a REST API. + +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. + +## Current Version - 3.0 + +The current version of the OpenAPI specification is [OpenAPI Specification 3.0](versions/3.0.md). + +### Previous Versions + +This repository also contains the [OpenAPI Specification 2.0](versions/2.0), which is identical to the Swagger 2.0 specification, +as well as the Swagger 1.2 and Swagger 2.0 specifications. + +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. + +## See it in Action + +If you just want to see it work, check out the [list of current examples](examples/v3.0). + +## Tools and Libraries + +Looking to see how you can create your own OpenAPI definition, present it or otherwise use it? Check out the growing +[list of 3.0 Implementations](IMPLEMENTATIONS.md). ## Participation -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: +The current process for development of the OpenAPI Specification is described in +[Development Guidelines](DEVELOPMENT.md). +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) and governed by the [TDC Contributors](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 future specification, this branch will be merged to master. + +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: -* 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. -* Review the [development](https://github.com/OAI/OpenAPI-Specification/blob/OpenAPI.next/DEVELOPMENT.md) process so you understand how the spec is evolving. +* Review the [current specification](versions/3.0.md). The human-readable markdown file _is the source of truth_ for the specification. +* Review the [development](DEVELOPMENT.md) process so you understand how the spec is evolving. * 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. * Create an issue to describe a new concern. If possible, propose a solution. @@ -25,7 +54,7 @@ Not all feedback can be accommodated and there may be solid arguments for or aga ## License -Copyright 2016 The Linux Foundation +Copyright 2016, 2017 The Linux Foundation Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. From 04215293cb5e746854421d6e04e393513515f308 Mon Sep 17 00:00:00 2001 From: Uri Sarid Date: Fri, 21 Jul 2017 07:42:31 -0700 Subject: [PATCH 2/4] Update per the Google doc Work by people in the TDC and marketing committee --- README.md | 27 ++++++++++----------------- 1 file changed, 10 insertions(+), 17 deletions(-) diff --git a/README.md b/README.md index 554a7ab1ee..20b86e969b 100644 --- a/README.md +++ b/README.md @@ -6,15 +6,14 @@ The OpenAPI Specification is a community driven, open specification within the [Open API Initiative](https://www.openapis.org/), a Linux Foundation Collaborative Project. -The OpenAPI Specification defines a standard, language-agnostic interface description for REST APIs which allows both humans and computers to discover and understand the capabilities of the service without access to source code, additional documentation, or through network traffic inspection. 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 the guesswork in calling the service. +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. -Use cases for machine-readable API interfaces include interactive documentation; code generation for documentation, client, and server; and automated test cases. OpenAPI descriptions describe APIs via YAML or JSON documents that adhere to the OpenAPI Specification. These documents can either be produced and served statically, or be generated dynamically from your application. +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. -The OpenAPI Specification does not require you to rewrite your existing API. It does not require binding any software to a service--the service being described may not even be yours. 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 use-case of a REST API. The OpenAPI Specification does not define a specific development process such as design-first or code-first. It does facilitate either technique by establishing clear interactions with a REST API. +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. 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. +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. ## Current Version - 3.0 @@ -22,12 +21,12 @@ The current version of the OpenAPI specification is [OpenAPI Specification 3.0]( ### Previous Versions -This repository also contains the [OpenAPI Specification 2.0](versions/2.0), which is identical to the Swagger 2.0 specification, +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”, as well as the Swagger 1.2 and Swagger 2.0 specifications. 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. -## See it in Action +## See It in Action If you just want to see it work, check out the [list of current examples](examples/v3.0). @@ -40,7 +39,7 @@ Looking to see how you can create your own OpenAPI definition, present it or oth The current process for development of the OpenAPI Specification is described in [Development Guidelines](DEVELOPMENT.md). -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) and governed by the [TDC Contributors](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 future specification, this branch will be merged to master. +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) and governed by the [TDC Contributors](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 future specification, this branch will be merged to master. 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: @@ -54,14 +53,8 @@ Not all feedback can be accommodated and there may be solid arguments for or aga ## License -Copyright 2016, 2017 The Linux Foundation -Licensed under the Apache License, Version 2.0 (the "License"); -you may not use this file except in compliance with the License. -You may obtain a copy of the License at [apache.org/licenses/LICENSE-2.0](http://www.apache.org/licenses/LICENSE-2.0) +See: [License (MIT)](https://github.com/OAI/OpenAPI-Specification/blob/master/LICENSE) -Unless required by applicable law or agreed to in writing, software -distributed under the License is distributed on an "AS IS" BASIS, -WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -See the License for the specific language governing permissions and -limitations under the License. + +![Analytics](https://ga-beacon.appspot.com/UA-831873-42/readme.md?pixel) From 7f26f7d29f9d92a380f4bc711cbc12137dc7214b Mon Sep 17 00:00:00 2001 From: Uri Sarid Date: Fri, 21 Jul 2017 10:12:52 -0700 Subject: [PATCH 3/4] Remove reference to contributors (for now) --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 20b86e969b..fcd073ad0a 100644 --- a/README.md +++ b/README.md @@ -39,7 +39,7 @@ Looking to see how you can create your own OpenAPI definition, present it or oth The current process for development of the OpenAPI Specification is described in [Development Guidelines](DEVELOPMENT.md). -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) and governed by the [TDC Contributors](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 future specification, this branch will be merged to master. +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. 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: From 92b66a638981588da25110583858a8a806c4f3f6 Mon Sep 17 00:00:00 2001 From: Uri Sarid Date: Fri, 21 Jul 2017 10:13:54 -0700 Subject: [PATCH 4/4] Add missing comma --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index fcd073ad0a..88bddecabc 100644 --- a/README.md +++ b/README.md @@ -32,7 +32,7 @@ If you just want to see it work, check out the [list of current examples](exampl ## Tools and Libraries -Looking to see how you can create your own OpenAPI definition, present it or otherwise use it? Check out the growing +Looking to see how you can create your own OpenAPI definition, present it, or otherwise use it? Check out the growing [list of 3.0 Implementations](IMPLEMENTATIONS.md). ## Participation