Merge pull request #1283 from OAI/OpenAPI.next

Publish OAS 3.0.0

Author: Ron

.travis.yml

@@ -1,8 +1,18 @@
 sudo: false
-language: scala
-scala:
-   - 2.10.4
 script:
   - npm install
-  - npm test
-  - sbt ++$TRAVIS_SCALA_VERSION test
+env:
+  - VALIDATORS=tv4
+  - VALIDATORS=zschema
+matrix:
+  allow_failures:
+    - env: VALIDATORS=tv4
+install:
+  - rm -rf ~/.nvm
+  - curl -L https://raw.githubusercontent.com/creationix/nvm/master/install.sh | sh
+  - source ~/.nvm/nvm.sh
+  - nvm install 6.1
+  - nvm use 6.1
+script:
+  - npm install
+  - node node_modules/mdv/mdv versions/3.*.md

CONTRIBUTORS.md

@@ -0,0 +1,9 @@
+* Darrel Miller [@darrelmiller](https://github.com/darrelmiller)
+* Jason Harmon [@jharmn](https://github.com/jharmn)
+* Jeremy Whitlock [@whitlockjc](https://github.com/whitlockjc)
+* Kris Hahn [@KrisHahn](https://github.com/krishahn)
+* Marsh Gardiner [@earth2marsh](https://github.com/earth2marsh)
+* Mike Ralphson [@MikeRalphson](https://github.com/mikeralphson)
+* Rob Dolin [@RobDolinMS](https://github.com/robdolinms)
+* Ron Ratovsky [@webron](https://github.com/webron)
+* Tony Tam [@fehguy](https://github.com/fehguy)

DEVELOPMENT.md

@@ -0,0 +1,51 @@
+## Development Guidelines
+
+This document intends to establish guidelines which build a transparent, open mechanism for deciding how to evolve the OpenAPI Specification. The Open API Technical Contributor Board will initially follow these processes when merging changes from external contributors or from the TCB itself. This guideline document will be adjusted as practicality dictates.
+
+## OAI Specification Driving factors
+
+The OpenAPI Specification should be use-case driven.  We can specify support for hypothetical use cases as we see fit, but specifications should be backed by realistic scenarios.
+
+## Specification Change Criteria
+
+The specification _will change_ from the original 2.0 version.  We should typically make changes when any of the following criteria are met:
+
+ - Clarity.  The current "way" something is done doesn't make sense, is complicated, or not clear.
+ - Consistency.  A portion of the specification is not consistent with the rest, or with the industry standard terminology.
+ - Necessary functionality.  We are missing functionality because of a certain design of the specification.
+ - Forward-looking designs.  As usage of APIs evolves to new protocols, formats, and patterns, we should always consider what the next important functionality should be.
+ - Impact.  A change will provide impact on a large number of use cases.  We should not be forced to accommodate every use case.  We should strive to make the _common_ and _important_ use cases both well supported and common in the definition of the OAI Spec.  We cannot be edge-case driven.
+
+
+## Tracking Process
+
+ - Use GitHub for all spec designs, use cases, and so on.
+ - As with 2.0, the **human readable** document is the source of truth.  If using a JSON Schema again to document the spec, it is secondary to the human documentation.  The documentation should live in a *.md file, in parallel to the 2.0 document (versions/3.0.0.md for example).
+ - The `master` branch shall remain the current, released OpenAPI Specification (i.e., 2.0).  We will work in an OpenAPI.next branch, which shall be described and linked to on the **default** README.md on master.
+ - Examples of how something is described _currently_ vs. the proposed solution should accompany any change proposal.
+ - New features should be done in feature branches which, upon approval, are merged into the OpenAPI.next branch.
+ - Use labels for the workflow of specification changes.  Examples of labels are `proposed`, `needs migration review`, `needs tooling review`, `needs documentation`, `rejected`, and `needs approval`.  These labels must be assigned by project committers.
+ - An issue will be opened for each feature change.  Embedded in the issue, or ideally linked in a file via pull-request (PR), a document about use cases should be supplied with the change.
+ - A PR will be used to describe the _proposed_ solution, and linked to the original issue.
+ - Not all committers will contribute to every single proposed change.  There may be many open proposals at once, and multiple efforts may happen in parallel.
+ - When the OpenApi.next spec is complete and approved for release, the branch will be merged to master.
+
+## Approving Changes
+
+For each change in the specification we should _always_ consider the following:
+
+ - Migration.  Is this a construct that has a path from the existing 2.0 specification?  If so, how complicated is it to migrate to the proposed change?
+ - Tooling.  Strive to support code generation, software interfaces, and spec generation techniques.  Some features may be impossible to support in different frameworks/languages.  These should be documented and considered during the change approval process.
+ - Visualization.  Can the specification change be graphically visualized somehow in a UI or other interface?
+
+Spec changes should be approved by a majority of the committers.  Approval can be given by commenting on the issue itself, for example, "Approved by @fehguy".  After voting criteria is met, any committer can merge the PR. (**TODO**: we will want to formalize what voting criteria actually is).
+
+No change should be approved until there is documentation for it, supplied in an accompanying PR.
+
+## Transparency
+
+We should always be as transparent as possible.  Sometimes there will be discussions that use customer names, sensitive use cases, and so on.  These must be anonymized, discussed in a private repository, or conducted offline.
+
+ - Asynchronous discussions should live in the GitHub issues for this project.
+ - Realtime discussions should be in a public chat such as IRC or Slack.
+

IMPLEMENTATIONS.md

@@ -0,0 +1,47 @@
+### Implementations
+
+Below is a list of known tooling that implements the 3.0.0 specification. Because
+the 3.0.0 specification has not yet been released, refer to the details of projects listed below for any notes about stability and roadmap.  The process 
+to create the best possible 3.0.0 specification includes feedback from end-users
+and tooling creators. We strongly encourage draft tooling be
+made available for early users of the OAS.
+
+These tools are not necessarily endorsed by the OAI.
+
+#### Low-Level tooling
+
+| Title          | Project Link | Language |Description                          |
+|----------------|--------------|----------|---------------------|
+| swagger-parser | [GitHub/swagger-api](https://github.com/swagger-api/swagger-parser/tree/feature/3.0.0-rc0) | Java | Swagger 1.0, 1.1, 1.2, 2.0 to Open API Specification converter |
+| swagger-models | [GitHub/swagger-api](https://github.com/swagger-api/swagger-core/tree/feature/3.0.0-rc0/modules/swagger-models) | Java | Open API 3.0 Java Pojos |
+| KaiZen OpenAPI Parser | [GitHub/RepreZen/KaiZen-OpenAPI-Parser](https://github.com/RepreZen/KaiZen-OpenAPI-Parser) | Java | High-performance Parser, Validator, and Java Object Model for OpenAPI 3.x |
+| openapi3-ts | [GitHub/metadevpro/openapi3-ts](https://github.com/metadevpro/openapi3-ts) | TypeScript | TS Model & utils for OpenAPI 3.0.x contracts |
+| swagger2openapi | [GitHub/mermade/swagger2openapi](https://github.com/mermade/swagger2openapi) | Node.js | An OpenAPI / Swagger 2.0 to OpenAPI 3.0.x converter and validator |
+| Tavis.OpenApi | [GitHub/tavis-sofware/Tavis.OpenApi](https://github.com/tavis-software/Tavis.OpenApi/) | dotnet | C# based parser with definition validation and migration support from V2 |
+
+
+#### Editors
+
+| Title          | Project Link | Language |Description                          |
+|----------------|--------------|----------|---------------------|
+| KaiZen OpenAPI Editor | [GitHub/RepreZen/KaiZen-OpenAPI-Editor](https://github.com/RepreZen/KaiZen-OpenAPI-Editor) | Java | Eclipse Editor for OpenAPI 2.0 and 3.0 |
+| RepreZen API Studio | [RepreZen.com/OpenAPI](https://www.reprezen.com/OpenAPI) | Java | Commercial desktop IDE for API design, documentation & development |
+| OpenApi-gui | [GitHub/Mermade/openapi-gui](https://github.com/Mermade/openapi-gui) | Node.js | GUI / visual editor for creating and editing OpenApi / Swagger definitions |
+
+
+#### User Interfaces
+
+| Title          | Project Link | Language |Description                          |
+|----------------|--------------|----------|---------------------|
+| openapi-viewer | [GitHub/koumoul/openapi-viewer](https://github.com/koumoul-dev/openapi-viewer) | Vue.js | Browse and test a REST API described with the OpenAPI 3.0 Specification. |
+
+
+#### Server Implementations
+
+
+#### Code Generators
+
+| Title          | Project Link | Language |Description                          |
+|----------------|--------------|----------|---------------------|
+| baucis-openapi3 | [Github/metadevpro/baucis-openapi3](https://github.com/metadevpro/baucis-openapi3) | Node.js | [Baucis.js](https://github.com/wprl/baucis) plugin for generating OpenAPI 3.0 compliant API contracts. |
+| Google Gnostic | [GitHub/googleapis/gnostic](https://github.com/googleapis/gnostic) | Go | Compile OpenAPI descriptions into equivalent Protocol Buffer representations. |

LICENSE

@@ -1,4 +1,4 @@
-Copyright 2016 The Linux Foundation
+Copyright 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.

README.md

@@ -1,69 +1,60 @@
-# The OpenAPI Specification (fka The Swagger Specification)
+# The OpenAPI Specification
 
 [![Build Status](https://travis-ci.org/OAI/OpenAPI-Specification.svg?branch=master)](https://travis-ci.org/OAI/OpenAPI-Specification)
 
-## Looking for the upcoming 3.0 version?  See here:
-[The pre-release OAS 3.0.0 Specification Branch](https://github.com/OAI/OpenAPI-Specification/blob/OpenAPI.next/README.md)
-
 ![](https://avatars3.githubusercontent.com/u/16343502?v=3&s=200)
 
-The goal of The OpenAPI Specification is to define a standard, language-agnostic interface to REST APIs which allows both humans and computers to discover and understand the capabilities of the service without access to source code, 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 interfaces have done for lower-level programming, OpenAPI removes the guesswork in calling the service.
+The OpenAPI Specification is a community driven, open specification within the [Open API Initiative](https://www.openapis.org/), a Linux Foundation Collaborative Project.
 
-Use cases for machine-readable API interfaces include interactive documentation, code generation for documentation, client, and server, as well as automated test cases.  OpenAPI-enabled APIs expose JSON files that correctly adhere to the OpenAPI Specification, documented in this repository.  These files can either be produced and served statically, or be generated dynamically from your application.
+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.
 
-Without going into a long history of interfaces to Web Services, this is not the first attempt to do so.  We can learn from CORBA, WSDL and WADL.  These specifications had good intentions but were limited by proprietary vendor-specific implementations, being bound to a specific programming language, and goals which were too open-ended.  In the end, they failed to gain traction.
+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.
 
-OpenAPI 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-ful API.  OpenAPI 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, a simple static sample of what it looks like,
-and some general information regarding the project.
-
-
-## Current Version - 2.0
+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.
 
-The current version of the OpenAPI specification is 2.0 - and you can find it [here](versions/2.0.md).
+## Current Version - 3.0
 
-### [OpenAPI 2.0 Specification](versions/2.0.md)
+The current version of the OpenAPI specification is [OpenAPI Specification 3.0](versions/3.0.0.md).
 
-This repository contains the existing Swagger 1.2, 2.0 specifications as well as proposals for the next version of the specification, which will be called the OpenAPI Specification 3.0.  The proposals live in the [OpenAPI.next](https://github.com/OAI/OpenAPI-Specification/tree/OpenAPI.next) branch.
+### Previous Versions
 
-## Structure
+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 section should contain v1.2 and v2.0 folders to avoid confusion between the versions.
+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.
 
-Please keep in mind that the other projects under OpenAPI use an independent version system.
-As such, don't confuse the version of the OpenAPI Specification they support and the version of that given library.
+## See It in Action
 
-## The Wiki
+If you just want to see it work, check out the [list of current examples](examples/v3.0).
 
-Check out the [wiki](https://github.com/OAI/OpenAPI-Specification/wiki) for additional and relevant information about the project.
+## Tools and Libraries
 
-This includes:
-- Static sample tutorial.
-- List of known deployments.
-- Revision history.
+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).
 
-## See it in Action
+## Participation
 
-If you just want to see it work, check out the [pet store sample](http://petstore.swagger.io/).
+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). 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.
 
-## Tools and Libraries
+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:
 
-Looking to see how you can create your own OpenAPI definition, present it or otherwise use it? Check out our [list of tools](http://swagger.io/open-source-integrations/) over at [http://swagger.io](http://swagger.io/open-source-integrations/).
+* Review the [current specification](versions/3.0.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.
 
-(Yes, there used to be a really long list here, we just moved it to the main website)
+Not all feedback can be accommodated and there may be solid arguments for or against a change being appropriate for the specification.
 
 ## License
 
-Copyright 2016 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 (Apache-2.0)](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)