api: OpenAPI scaffolding for TM backend API specification and documentation #4608
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
mikolajpp
changed the title
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR lays the foundation of TM API documentation. We use OpenAPI to define the specification of existing backend endpoints. Subsequently, the documentation can be generated with Redocly.
The API coverage so far is minimal and includes only a handful of endpoints of the %groups agent. This was enough to establish a general structure. The specification can now be expanded in the areas we consider most useful.
I have made an attempt at generating the spec using static code analysis of our Hoon codebase, but for this approach to be practical the code analyser would have to be made more powerful – other things take priority for now.