OS Hub API - V1 Design Spec

This GitHub repository houses both the OpenAPI specifications and RESTful API design best practices used for making changes and implementing new features for the Target API. This ensures consistency and quality in API modifications and enhancements.

Before you begin

This project uses the latest version of the OpenAPI Specification and JSON Schema. We recommend familiarizing yourself with it if you are not already.

Getting started

This repository uses Docker for local development, so:

1. Make sure you have Docker and Docker Compose installed.

2. Then run the following command in your terminal:

docker compose up -d

3. After running the command, you'll be able to access the rendered specification on http://localhost:8090/.

4. Edit the /docs/openapi.yaml file to add new API endpoints and see them immediately reflected in the browser interface.

5. All of the schemas are located inside the /docs/schemas directory and referenced inside the /docs/openapi.yaml file.