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

Correct non-standard headers description and add key words

Browse Source
This commit is contained in:
Jarzyna, Andrzej
2019-07-31 12:26:56 +02:00
parent 74a3c91454
commit 139093fd5c
1 changed files with 16 additions and 16 deletions
Download Patch File Download Diff File Expand all files Collapse all files

32
ruleset.md
View File

@@ -1,23 +1,23 @@
# Adidas API Guidelines Ruleset
- all JSON fields follow `camelCase`
- field names are ASCII alphanumeric characters or `_` or `$`
- collection/array fields have names in plural
- all JSON fields MUST follow `camelCase`
- field names MUST be ASCII alphanumeric characters or `_` or `$`
- collection/array fields MUST have names in plural
- all requests go through `https` protocol
- every API operation needs to have at least on `2xx` response
- `GET` request cannot accept a `body` parameter
- all responses are of media type `application/hal+json`
- all error responses are of media type `application/problem+json`
- every request should support `application/json` media type
- every API operation MUST have at least one `2xx` response
- `GET` request MUST NOT accept a `body` parameter
- all success responses MUST be of media type `application/hal+json`
- all error responses MUST be of media type `application/problem+json`
- every request SHOULD support `application/json` media type
- `application/hal+json` follows https://supermodel.io/adidas/api/HAL `JSON-Schema`
- `application/problem+json` messages must include `title` and `detail` fields
- `application/problem+json` messages should include `type` field
- date and time follow `ISO 8601` standard: https://www.iso.org/iso-8601-date-and-time-format.html
- language codes follow `ISO 639` standard: https://www.iso.org/iso-639-language-codes.html
- country codes follow `ISO 3166 alpha-2` standard: https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2
- currency codes follow `ISO 4217` standard: https://en.wikipedia.org/wiki/ISO_4217
- `application/problem+json` messages MUST include `title` and `detail` fields
- `application/problem+json` messages SHOULD include `type` field
- date and time MUST follow `ISO 8601` standard: https://www.iso.org/iso-8601-date-and-time-format.html
- language codes MUST follow `ISO 639` standard: https://www.iso.org/iso-639-language-codes.html
- country codes MUST follow `ISO 3166 alpha-2` standard: https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2
- currency codes MUST follow `ISO 4217` standard: https://en.wikipedia.org/wiki/ISO_4217
- `202` response code is used after creating an asynchronous process request
- a successful and finished async api request returns `303` response code and sends the target resource location in the `Link` header
- `URI` cannot contain a `-` character
- `HTTP` headers use `Hyphenated-Pascal-Case` notation
- `HTTP` headers cannot include `X-` headers (https://tools.ietf.org/html/rfc6648). All non-standard headers are named without the `X-` prefix.
- `HTTP` headers MUST use `Hyphenated-Pascal-Case` notation
- `HTTP` headers SHOULD NOT include `X-` headers (https://tools.ietf.org/html/rfc6648). All non-standard headers are named without the `X-` prefix.