The REST API documentation covers:
- Authentication method (tbd)
- HTTP call type definitions
- GET, POST, PUT, PATCH, DELETE
- Endpoint definitions
- what an endpoint does and how it is related to the rest of them. Create a map of endpoints.
- URI Structures, methods, and parameters
- structure and methods for each URI
- Method descriptions
- Human-readable description of the API
- Code snippets
- Example request and responses
- requests and responses with examples
- Error descriptions