[docs] OpenAPI 3 spec for miner HTTP endpoints (#23)#50
Open
5AIBountyHunter wants to merge 2 commits into
Open
[docs] OpenAPI 3 spec for miner HTTP endpoints (#23)#505AIBountyHunter wants to merge 2 commits into
5AIBountyHunter wants to merge 2 commits into
Conversation
|
@5AIBountyHunter is attempting to deploy a commit to the praise's projects Team on Vercel. A member of the Team first needs to authorize it. |
Author
|
Hi @Dipraise1, this PR adds the OpenAPI spec requested in #23. I also have PR #37 open for the TypeScript SDK. Both are related — the OpenAPI spec is useful for auto-generating the TS client. Please review when you have a chance. Happy to adjust! |
4 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
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 an OpenAPI 3.0.3 specification covering all 24 registered miner HTTP endpoints, including auth scheme documentation and a CI validation workflow.
Changes
New files:
docs/openapi.yaml— Complete OpenAPI 3 spec covering:.github/workflows/openapi-check.yml— CI workflow to validate spec stays in syncDetails
neurons/miner.pyroute registrationsCloses #23