Skip to content

Create readme for the 3.0 version of the OAS #1274

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 1 commit into from
Closed

Create readme for the 3.0 version of the OAS #1274

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
51 changes: 41 additions & 10 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,31 +1,62 @@
# 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 goal of the OpenAPI Specification is to define 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, 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.
Copy link

@DavidBiesack DavidBiesack Jul 14, 2017

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggest: "The OpenAPI Specification defines ..."

Copy link

@DavidBiesack DavidBiesack Jul 14, 2017

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggest: "without access to source code, additional documentation," (the OpenAPI definition is documentation)

Copy link
Contributor Author

@usarid usarid Jul 19, 2017

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks, incorporated into the gdoc


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, as well as automated test cases. OpenAPI descriptions describe APIs via YAML or JSON documents that adhere to the OpenAPI Specification documented in this repository. These documents can either be produced and served statically, or be generated dynamically from your application.
Copy link

@DavidBiesack DavidBiesack Jul 14, 2017

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggest: "Use cases for machine-readable API interfaces include interactive documentation; code generation for documentation, client, and server; automated test cases."

Copy link

@DavidBiesack DavidBiesack Jul 14, 2017

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Remove "in this repository" - that is, the document is the spec (the fact that it is in a GigHub repository is unimportant)

Copy link
Contributor Author

@usarid usarid Jul 19, 2017

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks, incorporated into the gdoc


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).
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.
Copy link

@DavidBiesack DavidBiesack Jul 14, 2017

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggestion: replace the first sentence with "The OpenAPI Specification design was informed by lessons learned from CORBA, WSDL, WADL, and other historical efforts in defining web services. These other specifications ..."

(I'm not sure one can claim CORBA or WSDL did not gain traction - they did, but were not easy to use. Also, this para seems more related to REST vs other web service architecture, so feels misplaced.)

Copy link
Contributor Author

@usarid usarid Jul 19, 2017

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm going to omit the paragraph entirely. I don't believe it belongs in the readme of the spec, maybe more in commentary somewhere else.


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 3.0 - and you can find it [here](versions/3.0.md).
Copy link

@DavidBiesack DavidBiesack Jul 14, 2017

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggest: The current version of the OpenAPI specification is [OpenAPI Specification 3.0](versions/3.0.md).

Copy link
Contributor Author

@usarid usarid Jul 19, 2017

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks, incorporated into the gdoc.


### [Previous Versions](versions/2.0.md)
Copy link

@DavidBiesack DavidBiesack Jul 14, 2017

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

defer to the link to 2.0 to the paragraph, not the header.

Copy link
Contributor Author

@usarid usarid Jul 19, 2017

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks, incorporated into the gdoc.


This repository also contains the OpenAPI Specification 2.0, which is identical to the Swagger 2.0 specification,
Copy link

@DavidBiesack DavidBiesack Jul 14, 2017

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

[OpenAPI Specification 2.0](versions/2.0)

Copy link
Contributor Author

@usarid usarid Jul 19, 2017

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks, incorporated into the gdoc.

Copy link

@DavidBiesack DavidBiesack Jul 19, 2017

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Oops, sorry.... that should be [OpenAPI Specification 2.0](versions/2.0.md) (i.e. the .md extension is required)

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).
Copy link
Contributor

@fehguy fehguy Jul 14, 2017

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It's good to leave this, but we will need to update this doc

Copy link
Contributor Author

@usarid usarid Jul 19, 2017

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

That should be a different PR - who can take that?

Development of the next version of the OpenAPI Specification is guided by the [OAI Technical Contributors Board](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.
Copy link
Contributor Author

@usarid usarid Jul 14, 2017

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Needs to get updated with TDC language

Copy link

@olensmar olensmar Jul 14, 2017

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I suggest replacing "OAI Technical Contributors Board" with simply "TDC Contributors" - it's important to note that the OAI or its official members have no direct influence or mandate on the work/direction of the TDC - the suggested wording could be interpreted differently.

Copy link
Contributor Author

@usarid usarid Jul 19, 2017

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Updated in the gdoc

Copy link

@DavidBiesack DavidBiesack Jul 14, 2017

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

[Technical Developer Community](https://www.openapis.org/participate/how-to-contribute/governance#TDC), not OAI Technical Contributors Board

Copy link
Contributor Author

@usarid usarid Jul 19, 2017

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks, incorporated a slight modification of this in the gdoc.


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.

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
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.
Expand Down