DOCS Spaces
Originally
ADR-0074-DOCS-SPACES (v4) · Source on Confluence ↗UTM Docs and Spaces
Invalid Image Path
Context
UTM API service provides endpoints which primarily serve airspace to clients via REST and gRPC. This service also hosts documentation. Separating the docs into its own service decouples the viewing of docs from all of the other API functions.
In addition, development has started on a new UTM front-end application (Spaces) which will provide the ability to view and update airspace.
Decision Drivers
- separation of concerns
- scalability
- reliability
Decision
A separate service will be created for the new Spaces application, and the documentation functionality previously in the API will be extracted and moved to a new Docs service.
New Services
Docs
Docs is a platform for hosting technical documentation in an intuitive web interface. Supported formats include OpenAPI Specification (OAS) and markdown. Documentation is served from files stored in the git repository.
Spaces
Spaces is a platform designed for the governance, administration, and visualization of DroneUp’s UTM APIs, serving as a single source of truth for operating environments with flexible, role-based access control.