Skip to content

docs: add OpenAPI 3.0 spec for miner HTTP endpoints#56

Open
BWM0223 wants to merge 1 commit into
Dipraise1:mainfrom
BWM0223:docs/openapi-miner-spec
Open

docs: add OpenAPI 3.0 spec for miner HTTP endpoints#56
BWM0223 wants to merge 1 commit into
Dipraise1:mainfrom
BWM0223:docs/openapi-miner-spec

Conversation

@BWM0223

@BWM0223 BWM0223 commented Jun 25, 2026

Copy link
Copy Markdown

Summary

Fixes #23 - OpenAPI spec for miner HTTP endpoints

Changes

  • Added docs/openapi.yaml (OpenAPI 3.0.3)
  • Covers: /health, /auth/challenge, /ingest, /query, /key-share/synapse, /key-share/retrieve
  • Full sr25519 auth scheme documented
  • Request/response schemas for all endpoints
  • Machine-readable spec to unblock TypeScript SDK

Acceptance Criteria

  • OpenAPI 3 spec from miner route definitions
  • Auth scheme docs (sr25519 signed-challenge)
  • All key endpoints covered

@vercel

vercel Bot commented Jun 25, 2026

Copy link
Copy Markdown

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