Skip to content

[docs] OpenAPI 3 spec for miner HTTP endpoints (#23)#50

Open
5AIBountyHunter wants to merge 2 commits into
Dipraise1:mainfrom
5AIBountyHunter:main
Open

[docs] OpenAPI 3 spec for miner HTTP endpoints (#23)#50
5AIBountyHunter wants to merge 2 commits into
Dipraise1:mainfrom
5AIBountyHunter:main

Conversation

@5AIBountyHunter

Copy link
Copy Markdown

Summary

Adds an OpenAPI 3.0.3 specification covering all 24 registered miner HTTP endpoints, including auth scheme documentation and a CI validation workflow.

Changes

New files:

  • docs/openapi.yaml — Complete OpenAPI 3 spec covering:
    • Ingest, Query, Challenge, Namespace, Attestation operations
    • KeyShare store/retrieve, Repair, List, Health, Stats
    • Chat history CRUD, Conversations CRUD
    • Commitment, Prove-memory, Wallet-stats, Metagraph, Metrics
    • sr25519 signed-challenge auth scheme documentation
  • .github/workflows/openapi-check.yml — CI workflow to validate spec stays in sync

Details

  • All 24 endpoints synced from neurons/miner.py route registrations
  • Request/response schemas documented for key operations
  • Auth section explains both signature-based and key-based modes
  • Spec validated against OpenAPI 3.0.3 schema

Closes #23

@vercel

vercel Bot commented Jun 20, 2026

Copy link
Copy Markdown

@5AIBountyHunter is attempting to deploy a commit to the praise's projects Team on Vercel.

A member of the Team first needs to authorize it.

@5AIBountyHunter

Copy link
Copy Markdown
Author

Hi @Dipraise1, this PR adds the OpenAPI spec requested in #23. I also have PR #37 open for the TypeScript SDK. Both are related — the OpenAPI spec is useful for auto-generating the TS client.

Please review when you have a chance. Happy to adjust!

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