docs: Auto-generated OpenAPI spec for miner HTTP endpoints (Fixes #23)#52
Open
shadow6427 wants to merge 2 commits into
Open
docs: Auto-generated OpenAPI spec for miner HTTP endpoints (Fixes #23)#52shadow6427 wants to merge 2 commits into
shadow6427 wants to merge 2 commits into
Conversation
|
@shadow6427 is attempting to deploy a commit to the praise's projects Team on Vercel. A member of the Team first needs to authorize it. |
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.
This PR generates an OpenAPI 3 specification from the miner's route definitions.
Features:
docs/openapi.yamlauto-generated containing schemas mapped fromengram.protocol(IngestSynapse, QuerySynapse, ChallengeSynapse, KeyShareSynapse, KeyShareRetrieve).hotkey,nonce, andsignatureJSON payload verification schema.scripts/generate_openapi.pyto auto-generate the YAML using Pydanticmodel_json_schema()and dynamic AST parsing ofneurons/miner.py..github/workflows/openapi.ymlCI check that asserts the spec stays perfectly in sync with the codebase.This addresses the bounty requirements for Issue #23.