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

Merge pull request #27 from adidas/naming-fixes

Browse Source 
Fix naming of rules in the documentation
This commit is contained in:
Z
2019-12-05 15:05:47 +01:00
committed by GitHub
parent 1b525e3002 3d0bbd92eb
commit 740980ea43
1 changed files with 18 additions and 18 deletions
Download Patch File Download Diff File Expand all files Collapse all files

36
general-guidelines/validating-api-descriptions.md
View File

@@ -79,27 +79,27 @@ Adidas specific rules are listed below:
### Adidas general rules
* `paths-camelCase` - All YAML/JSON paths MUST follow camelCase.
* `definitions-camelCase-alphanumeric` - All YAML/JSON definitions MUST follow fields-camelCase and be ASCII alphanumeric characters or `_` or `$`.
* `properties-camelCase-alphanumeric` - All JSON Schema properties MUST follow fields-camelCase and be ASCII alphanumeric characters or `_` or `$`.
* `request-GET-no-body` - A 'GET' request MUST NOT accept a 'body` parameter.
* `uri-template-cannot-dash` - The 'URI' template (RFC 6570 - https://tools.ietf.org/html/rfc6570) cannot contain a '-' character.
* `headers-no-x-headers` - All 'HTTP' headers SHOULD NOT include 'X-' headers (https://tools.ietf.org/html/rfc6648).
* `headers-hyphenated-pascal-case` - All `HTTP` headers MUST use `Hyphenated-Pascal-Case` notation.
* `adidas-paths-camelCase` - All YAML/JSON paths MUST follow camelCase.
* `adidas-definitions-camelCase-alphanumeric` - All YAML/JSON definitions MUST follow fields-camelCase and be ASCII alphanumeric characters or `_` or `$`.
* `adidas-properties-camelCase-alphanumeric` - All JSON Schema properties MUST follow fields-camelCase and be ASCII alphanumeric characters or `_` or `$`.
* `adidas-request-GET-no-body` - A 'GET' request MUST NOT accept a 'body` parameter.
* `adidas-uri-template-cannot-dash` - The 'URI' template (RFC 6570 - https://tools.ietf.org/html/rfc6570) cannot contain a '-' character.
* `adidas-headers-no-x-headers` - All 'HTTP' headers SHOULD NOT include 'X-' headers (https://tools.ietf.org/html/rfc6648).
* `adidas-headers-hyphenated-pascal-case` - All `HTTP` headers MUST use `Hyphenated-Pascal-Case` notation.
### Adidas OAS2/Swagger rules
* `protocol-https-only` - ALL requests MUST go through `https` protocol only.
* `request-support-json` - Every request SHOULD support `application/json` media type.
* `example-exists-in-parameters` - All models MUST have a valid example.
* `response-success-hal` - All success responses MUST be of media type `application/hal+json`.
* `response-error-problem` - All error responses MUST be of media type `application/problem+json`.
* `adidas-oas2-protocol-https-only` - ALL requests MUST go through `https` protocol only.
* `adidas-oas2-request-support-json` - Every request SHOULD support `application/json` media type.
* `adidas-oas2-example-exists-in-parameters` - All models MUST have a valid example.
* `adidas-oas2-response-success-hal` - All success responses MUST be of media type `application/hal+json`.
* `adidas-oas2-response-error-problem` - All error responses MUST be of media type `application/problem+json`.
### Adidas OAS3 rules
* `request-support-json-oas3` - Every request MUST support `application/json` media type.
* `valid-example-in-parameters` - Examples must be valid against their defined schema.
* `valid-example-in-definitions` - Examples must be valid against their defined schema.
* `protocol-https-only-oas3` - ALL requests MUST go through `https` protocol only.
* `response-success-hal-oas3` - All success responses MUST be of media type `application/hal+json`.
* `response-success-hal-body-oas3` - All success responses MUST follow `application/hal+json` schema.
* `adidas-oas3-request-support-json` - Every request MUST support `application/json` media type.
* `adidas-oas3-valid-example-in-parameters` - Examples must be valid against their defined schema.
* `adidas-oas3-valid-example-in-definitions` - Examples must be valid against their defined schema.
* `adidas-oas3-protocol-https-only` - ALL requests MUST go through `https` protocol only.
* `adidas-oas3-response-success-hal` - All success responses MUST be of media type `application/hal+json`.
* `adidas-oas3-response-success-hal-body` - All success responses MUST follow `application/hal+json` schema.