docs: add comprehensive API reference documentation#5289
Closed
Agolid wants to merge 48 commits intoMintplex-Labs:masterfrom
Closed
docs: add comprehensive API reference documentation#5289Agolid wants to merge 48 commits intoMintplex-Labs:masterfrom
Agolid wants to merge 48 commits intoMintplex-Labs:masterfrom
Conversation
Member
|
Closing simply because auto-updating this is going to be a super large chore to maintain and being able to just read or use the Swagger docs is exactly what this is for - mainting the MD files is just another chore that will grow stale |
Author
Totally fair point! Keeping a separate set of MD docs in sync with the API is indeed a losing battle — the Swagger UI is the right single source of truth here. Appreciate you taking the time to explain the reasoning rather than just silently closing it. Makes total sense. 🤝 |
This file contains hidden or 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
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.
Summary
Adds auto-generated API reference documentation from the existing OpenAPI spec (
server/swagger/openapi.json).Closes #5288
Changes
server/API_REFERENCE/with 12 markdown filesGenerated with
api-doc-sync from
server/swagger/openapi.json(OpenAPI 3.0)Note
The documentation is placed in
server/API_REFERENCE/to keep it close to the source spec. If you prefer a different location (e.g.docs/), I am happy to move it.