-
Notifications
You must be signed in to change notification settings - Fork 151
OpenAPI3 migration
Roman Krivtsov edited this page May 13, 2019
·
1 revision
This document provides a roadmap for migration and adoption the library to OpenAPI3
Despite changes will be released with major version 2.0, the goal is to achieve migration keeping backward compatibility with Swagger 2.0.
The migration is splitted to the following steps:
- Paths section
- Object definitions sections
- New mets info
Good visual representation of changes between schemas is here: https://blog.readme.io/an-example-filled-guide-to-swagger-3-2/ Schemas:
- 2.0 https://raw.githubusercontent.com/OAI/OpenAPI-Specification/master/schemas/v2.0/schema.json
- 3.0 https://raw.githubusercontent.com/OAI/OpenAPI-Specification/master/schemas/v3.0/schema.json
Petstore examples:
- 2.0 https://github.com/OAI/OpenAPI-Specification/blob/master/examples/v2.0/yaml/petstore-expanded.yaml
- 3.0 https://github.com/OAI/OpenAPI-Specification/blob/master/examples/v3.0/petstore-expanded.yaml
Migration related issues are marked with label openapi3 https://github.com/yarax/swagger-to-graphql/labels/openapi3
There is a branch openapi3, which is aimed to be a release branch for the whole feature. So feature related pull requests should be merged to that branch.