eclipse / microprofile-open-api

Microprofile open api
Apache License 2.0
132 stars 82 forks source link

Investigate new OAS 3.1.0 version and define a strategy. #431

Closed jmini closed 4 years ago

jmini commented 4 years ago

The first 3.1.0 version (3.1.0-rc0) has been released.

We need to decide for a strategy regarding the adoption of this spec update for Microprofile-OpenAPI. If I remember well, we decided a long time ago that Microprofile-OpenAPI does not want to support multiple OpenAPI versions. We could say that our version 2.0 will provide support for OpenAPI 3.1.0 (when it is out).

I suggest to create issues for required changes (we can tag them with the OAS 3.1.0 label)

I would like to start working on this, as the release candidate phase of OpenAPI release might be a good timing to provide feedback to the spec team.

We can also decide to store all changes required by OpenAPI 3.1.0 on a specific branch.

jmini commented 4 years ago

Released (3.1.0-rc0) specification documentation: https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.1.0.md

Changes related to the upcoming 3.1.0 release should be submitted at the development branch.

So the "SNAPSHOT" version of the 3.1.0 specification documentation is on this branch: https://github.com/OAI/OpenAPI-Specification/blob/v3.1.0-dev/versions/3.1.0.md

jmini commented 4 years ago

If we decide to use the master branch for OpenAPI version 3.1.0, maybe we can create a released version 2.0-MR2 release prior to the integration of the new OpenAPI features.

jmini commented 4 years ago

This issue is a duplicate of #333. Closing this.