Mirrors/api-guidelines
1
0
Fork 0
mirror of https://github.com/adidas/api-guidelines.git synced 2025-10-25 15:19:19 +00:00
Code Issues Packages Projects Releases Wiki Activity

Updates core-principles/openapi-specification.md

Browse Source 
Auto commit by GitBook Editor
This commit is contained in:
apidesigner
2017-01-30 11:54:56 +00:00
parent c07fc4057d
commit 0069b7b81f
4 changed files with 8 additions and 7 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
core-principles/apiary.md
View File

@@ -1,4 +1,4 @@
# Apiary
Every API description MUST to be stored in [Apiary](https://apiary.io/) under the ADIDAS GROUP team. Apiary MUST be the single source of truth to learn about existing APIs within the organization.
Every API description MUST to be stored in [Apiary](https://apiary.io/) under the ADIDAS GROUP team. Apiary MUST be the **single source of truth** to learn about existing APIs within the organization.
(TODO: see Apiary Appendix)

4
core-principles/design-maturity.md
View File

@@ -1,7 +1,7 @@
# Design Maturity
Every API design MUST be resource-centric ([Web API Design Maturity Model Level 2](http://amundsen.com/talks/2016-11-apistrat-wadm/2016-11-apistrat-wadm.pdf)). That is an API design MUST revolve around Web-styled resources, relations between the resources and the actions the resources might afford.
Every API design MUST be **resource-centric** ([Web API Design Maturity Model Level 2](http://amundsen.com/talks/2016-11-apistrat-wadm/2016-11-apistrat-wadm.pdf)). That is an API design MUST revolve around Web-styled **resources**, **relations** between the resources and the **actions** the resources might afford.
An API design MAY be affordance-centric ([Web API Design Maturity Model Level 3](http://amundsen.com/talks/2016-11-apistrat-wadm/2016-11-apistrat-wadm.pdf)).
An API design MAY be **affordance-centric** ([Web API Design Maturity Model Level 3](http://amundsen.com/talks/2016-11-apistrat-wadm/2016-11-apistrat-wadm.pdf)).
(TODO: see API Design Process Appendix)

3
core-principles/implementation-maturity.md
View File

@@ -1,4 +1,5 @@
# Implementation Maturity
Every API design using the HTTP(S) protocol MUST implement any action afforded by a resource using the appropriate HTTP Request Method semantics.
Every API design using the HTTP(S) protocol MUST implement any action afforded by a resource using the appropriate **HTTP Request Method semantics** ([Richardson Maturity Model Level 2](https://martinfowler.com/articles/richardsonMaturityModel.html#level2)).
(TODO: see HTTP Verbs Appendix)

6
core-principles/openapi-specification.md
View File

@@ -1,7 +1,7 @@
# OpenAPI Specification
Every API MUST be described using 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).
## Language
The API description MUST be written in U.S. English.
(TODO: see OpenAPI Appendix)
(TODO: see OpenAPI Appendix)
## Language
The API description MUST be written in **American English**.