mirror of
https://github.com/adidas/api-guidelines.git
synced 2025-10-25 15:19:19 +00:00
Creates rest/core-principles/quality.md
Auto commit by GitBook Editor
This commit is contained in:
7
rest/core-principles/openapi-specification.md
Normal file
7
rest/core-principles/openapi-specification.md
Normal file
@@ -0,0 +1,7 @@
|
||||
# OpenAPI Specification
|
||||
Every API **MUST** be described using an API description format. The API description format used MUST be the [OpenAPI Specification (formerly known as Swagger Specification) version 2.0](https://github.com/OAI/OpenAPI-Specification/blob/master/versions/2.0.md).
|
||||
|
||||
Every API description **MUST** be published in adidas [API design platform](./apiary.md) and it **SHOULD** be stored in version control system (Bitbucket, GitHub) in the same repository as the API implementation.
|
||||
|
||||
## Language
|
||||
The API description MUST be written in **American English**.
|
||||
Reference in New Issue
Block a user