API

1. Endpoint

1.1. Name

1.2. Description

1.3. Preconditions

1.4. URI

1.4.1. Pattern

1.4.2. Parameters

1.4.2.1. Path

1.4.2.1.1. Name

1.4.2.1.2. Description

1.4.2.1.3. Type

1.4.2.1.4. Constrains

1.4.2.2. Query

1.4.2.2.1. Name

1.4.2.2.2. Description

1.4.2.2.3. Type

1.4.2.2.4. Constrains

1.4.2.2.5. Optional

1.4.2.2.6. Default

1.5. Request

1.5.1. HTTP Method

1.5.2. HTTP Headers

1.5.2.1. Content-Type

1.5.2.2. Accept

1.5.2.3. Authorization

1.5.3. Body

1.5.3.1. Object

1.5.3.2. Schema

1.5.3.3. Sample

1.6. Responses

1.6.1. Success

1.6.1.1. HTTP Status Code

1.6.1.2. Body

1.6.1.2.1. Object

1.6.1.2.2. Schema

1.6.1.2.3. Sample

1.6.2. Failure

1.6.2.1. Description

1.6.2.2. HTTP Status Code

1.6.2.3. Body

1.6.2.3.1. Object

1.6.2.3.2. Schema

1.6.2.3.3. Sample

1.7. Notes

1.8. Try Me!