docs: add OpenAPI 3 spec for miner HTTP API + Redoc reference + CI validation#38
Open
laeeH wants to merge 1 commit into
Open
docs: add OpenAPI 3 spec for miner HTTP API + Redoc reference + CI validation#38laeeH wants to merge 1 commit into
laeeH wants to merge 1 commit into
Conversation
|
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
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 complete OpenAPI 3.0 specification for the Engram Miner HTTP API (served on port 8091) and a rendered Redoc reference page.
Changes
docs/openapi.yaml— Full OpenAPI 3.0 spec covering all miner endpoints:/health,/stats,/metagraph/IngestSynapse,/QuerySynapse,/ChallengeSynapse,/retrieve/{cid}/namespace,/AttestNamespace,/attestation/{namespace},/KeyShareSynapse,/KeyShareRetrieve/RepairSynapse,/list/commitment,/prove-memorydocs/api-reference.html— Interactive Redoc page for browsing the APIdocs/miner.md— Added API Reference section with links.github/workflows/ci.yml— Addedopenapi-lintjob using Spectral to validate the spec on every PRRelated Issue
Addresses #23 (OpenAPI spec for miner HTTP endpoints)
Bounty
This PR addresses the bounty listed in ROADMAP.md for generating an OpenAPI spec from the miner's route definitions.