mirror of
https://github.com/adidas/api-guidelines.git
synced 2025-10-25 15:19:19 +00:00
14 lines
783 B
Markdown
14 lines
783 B
Markdown
# 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)
|
|
* stored in version control system (Bitbucket, GitHub) in the same repository as the API implementation.
|
|
* accessible via endpoint through GET operation. _To be discussed_
|
|
|
|
> NOTE: Synchronization between the version control system and adidas [API Description platform](./apiary.md)
|
|
should be automated using CI/CD framework.
|
|
|
|
|
|
## Language
|
|
The API description MUST be written in **American English**.
|