SEGAS-00016 - Documenting an API

More information about SEGAS-00016

More information can be found on the engineering website about SEGAS-00016

Does this codebase pass the following requirement: You MUST include your API on the relevant registers if your API is public?

More information about You MUST include your API on the relevant registers if your API is public

More information can be found on the engineering website about You MUST include your API on the relevant registers if your API is public

Does this codebase pass the following requirement: You MUST have documentation on requests and responses of all endpoints?

More information about You MUST have documentation on requests and responses of all endpoints

More information can be found on the engineering website about You MUST have documentation on requests and responses of all endpoints

Does this codebase pass the following requirement: You MUST provide specific feedback in error responses?

More information about You MUST provide specific feedback in error responses

More information can be found on the engineering website about You MUST provide specific feedback in error responses

Does this codebase pass the following requirement: You MUST document how to connect to your API?

More information about You MUST document how to connect to your API

More information can be found on the engineering website about You MUST document how to connect to your API

Does this codebase pass the following requirement: You MUST document how to raise an issue with your API if your API has external consumers?

More information about You MUST document how to raise an issue with your API if your API has external consumers

More information can be found on the engineering website about You MUST document how to raise an issue with your API if your API has external consumers

Does this codebase pass the following requirement: You MUST document information on rate limits?

More information about You MUST document information on rate limits

More information can be found on the engineering website about You MUST document information on rate limits

Does this codebase pass the following requirement: You MUST document different versions of your API?

More information about You MUST document different versions of your API

More information can be found on the engineering website about You MUST document different versions of your API