docs: OpenAPI 3.0 spec for all miner HTTP endpoints (#23)#55
Open
kaising-openclaw1 wants to merge 1 commit into
Open
docs: OpenAPI 3.0 spec for all miner HTTP endpoints (#23)#55kaising-openclaw1 wants to merge 1 commit into
kaising-openclaw1 wants to merge 1 commit into
Conversation
Generate a complete OpenAPI 3.0.3 specification covering all 24 miner
HTTP endpoints, including:
- Core storage: /IngestSynapse, /QuerySynapse, /retrieve/{cid}, /list
- Validation: /ChallengeSynapse, /RepairSynapse, /commitment, /prove-memory
- Key management: /KeyShareSynapse, /KeyShareRetrieve, /namespace,
/AttestNamespace, /attestation/{namespace}
- Chat: /chat-history, /conversations
- Operations: /health, /stats, /metagraph, /metrics, /wallet-stats
Includes sr25519 auth scheme documentation, private namespace auth modes,
rate limiting notes, and all request/response schemas.
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
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.3 specification for all 24 miner HTTP endpoints, addressing issue #23.
Endpoints Covered
Storage
POST /IngestSynapse— store embeddings (text or raw vector)POST /QuerySynapse— ANN search with metadata filteringGET /retrieve/{cid}— retrieve metadata for a CIDDELETE /retrieve/{cid}— delete a stored memoryPOST /list— paginate and filter stored memoriesValidation
POST /ChallengeSynapse— storage proof challenge-responsePOST /RepairSynapse— retrieve full embedding for replicationGET /commitment— Merkle root of miner's memory corpusPOST /prove-memory— Merkle inclusion proof for a CIDKey Management
POST /KeyShareSynapse— store Shamir key sharePOST /KeyShareRetrieve— retrieve key sharePOST /namespace— namespace CRUD (localhost only)POST /AttestNamespace— attest namespace to hotkeyGET /attestation/{namespace}— attestation infoChat
GET /chat-history/{user_id}— load chat historyPOST /chat-history— save chat historyGET /conversations/{user_id}— list conversationsPOST /conversations— create conversationPATCH /conversations/{conv_id}— rename conversationDELETE /conversations/{conv_id}— delete conversationOperations
GET /health— liveness probeGET /stats— public miner statisticsGET /metagraph— metagraph snapshotGET /metrics— Prometheus metrics (localhost)GET /wallet-stats— wallet activity (localhost)Documentation Included
CI Check
The spec is YAML-valid and ready for Redoc or Swagger UI rendering.