feat: add OpenAPI 3.0 spec for miner HTTP endpoints#35
Open
pvbang wants to merge 1 commit into
Open
Conversation
- Add comprehensive OpenAPI 3.0.3 spec covering all 24 miner HTTP routes - Include auth scheme docs (sr25519 signed-challenge headers) - Add Redoc page under docs/ for rendered API documentation - Add CI sync check script (scripts/check_openapi_sync.py) Covers: IngestSynapse, QuerySynapse, ChallengeSynapse, RepairSynapse, KeyShareSynapse, KeyShareRetrieve, namespace management, attestation, chat history, conversations, memory CRUD, wallet stats, metagraph, metrics, commitment, and prove-memory endpoints. Closes Dipraise1#23
|
Someone 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.
Summary
This PR adds a comprehensive OpenAPI 3.0.3 specification for all 24 miner HTTP endpoints, addressing issue #23.
Changes
docs/openapi.yaml — Full OpenAPI 3.0.3 Specification
docs/index.html — Redoc Rendered Documentation
scripts/check_openapi_sync.py — CI Sync Check
Closes #23