feat(api-reference): remote OpenAPI spec + interactive API docs#2
Draft
gilbertsahumada wants to merge 5 commits intoChaosChain:mainfrom
Draft
feat(api-reference): remote OpenAPI spec + interactive API docs#2gilbertsahumada wants to merge 5 commits intoChaosChain:mainfrom
gilbertsahumada wants to merge 5 commits intoChaosChain:mainfrom
Conversation
…l yarn.lock file - Introduced openapi.yaml defining the API structure, endpoints, and security schemes for the ChaosChain Gateway. - Added .yarn-integrity file to track Yarn dependencies. - Created yarn.lock file for dependency management.
…update API reference to reflect current endpoints.
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
ChaosChain/chaoschain(no local copy) — Mintlify fetches it on every build, so docs stay in sync automaticallyPUBLIC_API_SPEC.mdfromgateway/public-api.mdxsince the interactive API Reference now serves that purpose (can be restored if preferred)Note
The
openapiURL indocs.jsoncurrently points to my fork (gilbertsahumada/chaoschain/feat/openapi-spec) so the docs can be tested before PR #40 is merged. Once #40 is merged and there are no further observations, I'll update the URL to point toChaosChain/chaoschain/develop.Depends on
develop)Before merging
developopenapiURL indocs.jsonfromgilbertsahumada/chaoschain/feat/openapi-spec->ChaosChain/chaoschain/developHow it works
docs.jsonreferences the OpenAPI spec via raw GitHub URL -> no localopenapi.yamlneeded