[WIP] [DevOps] Interactive Swagger/OpenAPI V3 API Documentation#189
Open
gaiabio12-design wants to merge 1 commit into
Open
[WIP] [DevOps] Interactive Swagger/OpenAPI V3 API Documentation#189gaiabio12-design wants to merge 1 commit into
gaiabio12-design wants to merge 1 commit into
Conversation
2 tasks
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
1 participant
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.
Closes #172
Acceptance Criteria
Description: Implement a fully interactive API documentation site using the OpenAPI 3.0 specification, hosted dynamically on the API server itself (e.g., at
/api-docs).Context / Motivation: External developers integrating TradeFlow into their dApps or wallets need a clear, executable reference for our REST endpoints. A self-updating Swagger UI is the industry standard for developer onboarding.
Acceptance Criteria: - [ ] Write the
openapi.yaml(or JSON/TS equivalent) detailing all public routes, request bodies, and response schemas.swagger-ui-express(or simiImplementation in progress — will remove
[WIP]once code is ready.