Create readme for the 3.0 version of the OAS #1274

usarid · 2017-07-14T15:44:33Z

No description provided.

fehguy

I think this looks great. As noted, we will have to clean up some of the docs we're linking to, but this PR is 👍 from my POV.

fehguy · 2017-07-14T16:05:17Z

README.md


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


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

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

usarid · 2017-07-14T16:30:30Z

README.md

-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 [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.


Needs to get updated with TDC language

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.

Updated in the gdoc

DavidBiesack · 2017-07-14T16:14:37Z

README.md

+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.


Suggest: "The OpenAPI Specification defines ..."

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

Thanks, incorporated into the gdoc

DavidBiesack · 2017-07-14T16:17:36Z

README.md

+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.

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


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

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

Thanks, incorporated into the gdoc

DavidBiesack · 2017-07-14T16:23:59Z

README.md

+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.

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


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

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.

DavidBiesack · 2017-07-14T16:25:41Z

README.md

+
+## Current Version - 3.0
+
+The current version of the OpenAPI specification is 3.0 - and you can find it [here](versions/3.0.md).


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

Thanks, incorporated into the gdoc.

DavidBiesack · 2017-07-14T16:26:15Z

README.md

+
+The current version of the OpenAPI specification is 3.0 - and you can find it [here](versions/3.0.md).
+
+### [Previous Versions](versions/2.0.md)


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

Thanks, incorporated into the gdoc.

DavidBiesack · 2017-07-14T16:26:43Z

README.md

+
+### [Previous Versions](versions/2.0.md)
+
+This repository also contains the OpenAPI Specification 2.0, which is identical to the Swagger 2.0 specification, 


[OpenAPI Specification 2.0](versions/2.0)

Thanks, incorporated into the gdoc.

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

DavidBiesack · 2017-07-14T16:32:21Z

README.md

-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 [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.


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

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

olensmar · 2017-07-18T07:29:54Z

@usarid i'd be happy to help make the suggested changes - but your branch doesn't seem to be available...

usarid · 2017-07-19T20:36:07Z

Thanks @olensmar I've been too slammed to look into what happened here, but looking at it now.

usarid · 2017-07-24T17:11:20Z

This was eventually implemented in #1281 so let's close this one.

Create readme for the 3.0 version of the OAS

0e29662

fehguy approved these changes Jul 14, 2017

View reviewed changes

usarid commented Jul 14, 2017

View reviewed changes

DavidBiesack suggested changes Jul 14, 2017

View reviewed changes

darrelmiller approved these changes Jul 18, 2017

View reviewed changes

usarid closed this Jul 24, 2017


		## Current Version - 3.0

		The current version of the OpenAPI specification is 3.0 - and you can find it [here](versions/3.0.md).


		The current version of the OpenAPI specification is 3.0 - and you can find it [here](versions/3.0.md).

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


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

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

Create readme for the 3.0 version of the OAS #1274

Create readme for the 3.0 version of the OAS #1274

Uh oh!

Conversation

usarid commented Jul 14, 2017

Uh oh!

fehguy left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

olensmar commented Jul 18, 2017

Uh oh!

usarid commented Jul 19, 2017

Uh oh!

usarid commented Jul 24, 2017

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants