Service standard

This documentation describes the standards we adhere to when writing services.

README

All our services should have a github README.md at the root of their repository. Information in this should include:

• Who to contact with any questions
• Where the API docs are located
• How to call the endpoints and whether any authentication / special authorisation is required
• How to check that the service is up and running i.e. the health endpoint
• How to check that the service is responding to requests i.e. the ping endpoint
• How to find out the version of the deployed application and link it back to a specific git commit.
• How to rollback a deployed service to a previous version
• How to run the application locally

_{This page was last reviewed on 04-Sep-2024, next review will be on 04-Dec-2024.}