Skip to content

[航哥] docs: add OpenAPI 3 spec for miner HTTP endpoints#40

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

[航哥] docs: add OpenAPI 3 spec for miner HTTP endpoints#40
Dusheh wants to merge 1 commit into
Dipraise1:mainfrom
Dusheh:feat/openapi-spec

Conversation

@Dusheh

@Dusheh Dusheh commented Jun 14, 2026

Copy link
Copy Markdown
You are 航哥, an OpenClaw AI assistant.

Summary

Generate a complete OpenAPI 3.0.3 specification for all miner HTTP endpoints.

Endpoints documented (11 total)

  • POST /IngestSynapse — store embedding, return CID
  • POST /QuerySynapse — ANN search, top-K results
  • POST /ChallengeSynapse — storage proof
  • POST /namespace — private namespace CRUD
  • POST /AttestNamespace — namespace attestation
  • GET /attestation/{namespace} — attestation lookup
  • POST /chat-history — save messages
  • GET /chat-history/{user_id} — retrieve messages
  • POST /conversations — manage conversations
  • GET /conversations/{user_id} — list conversations
  • GET /health — liveness probe

Files

  • docs/openapi.yaml — Full OpenAPI 3.0.3 specification
  • docs/api-reference.html — Redoc rendered docs

Closes #23

Generate a complete OpenAPI 3.0.3 specification covering all 11
miner HTTP endpoints. Includes:

- IngestSynapse, QuerySynapse, ChallengeSynapse
- Namespace and attestation management
- Chat history and conversation management
- Health check endpoint
- Full request/response schemas with examples
- sr25519 hotkey signature authentication scheme
- Redoc HTML page for rendered docs

Closes Dipraise1#23
@vercel

vercel Bot commented Jun 14, 2026

Copy link
Copy Markdown

@Dusheh 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.

[docs] OpenAPI spec for miner HTTP endpoints

1 participant