Skip to content

docs: OpenAPI 3.0 spec for all miner HTTP endpoints (#23)#55

Open
kaising-openclaw1 wants to merge 1 commit into
Dipraise1:mainfrom
kaising-openclaw1:feat/openapi-spec
Open

docs: OpenAPI 3.0 spec for all miner HTTP endpoints (#23)#55
kaising-openclaw1 wants to merge 1 commit into
Dipraise1:mainfrom
kaising-openclaw1:feat/openapi-spec

Conversation

@kaising-openclaw1

Copy link
Copy Markdown

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 filtering
  • GET /retrieve/{cid} — retrieve metadata for a CID
  • DELETE /retrieve/{cid} — delete a stored memory
  • POST /list — paginate and filter stored memories

Validation

  • POST /ChallengeSynapse — storage proof challenge-response
  • POST /RepairSynapse — retrieve full embedding for replication
  • GET /commitment — Merkle root of miner's memory corpus
  • POST /prove-memory — Merkle inclusion proof for a CID

Key Management

  • POST /KeyShareSynapse — store Shamir key share
  • POST /KeyShareRetrieve — retrieve key share
  • POST /namespace — namespace CRUD (localhost only)
  • POST /AttestNamespace — attest namespace to hotkey
  • GET /attestation/{namespace} — attestation info

Chat

  • GET /chat-history/{user_id} — load chat history
  • POST /chat-history — save chat history
  • GET /conversations/{user_id} — list conversations
  • POST /conversations — create conversation
  • PATCH /conversations/{conv_id} — rename conversation
  • DELETE /conversations/{conv_id} — delete conversation

Operations

  • GET /health — liveness probe
  • GET /stats — public miner statistics
  • GET /metagraph — metagraph snapshot
  • GET /metrics — Prometheus metrics (localhost)
  • GET /wallet-stats — wallet activity (localhost)

Documentation Included

  • sr25519 signed request auth scheme with canonical message format
  • Private namespace auth modes (sig-based + legacy key-based)
  • Rate limiting notes
  • All request/response schemas with descriptions and examples
  • Response models for error states (400, 401, 404, 429, 403)

CI Check

The spec is YAML-valid and ready for Redoc or Swagger UI rendering.

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
@vercel

vercel Bot commented Jun 22, 2026

Copy link
Copy Markdown

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant