Skip to content

Add generated miner OpenAPI docs#43

Open
abulasa1 wants to merge 1 commit into
Dipraise1:mainfrom
abulasa1:codex/miner-openapi-spec
Open

Add generated miner OpenAPI docs#43
abulasa1 wants to merge 1 commit into
Dipraise1:mainfrom
abulasa1:codex/miner-openapi-spec

Conversation

@abulasa1

Copy link
Copy Markdown

Summary

Adds a generated OpenAPI 3.1 reference for the miner HTTP API.

Changes

  • Add scripts/generate_miner_openapi.py to statically extract app.router.add_* routes from neurons/miner.py
  • Add generated docs/miner-openapi.json
  • Add docs/miner-api.html Redoc viewer
  • Document the generation/check commands in docs/miner.md
  • Add tests that compare the generated OpenAPI paths against the aiohttp route table

Auth Coverage

The spec documents the two auth patterns currently used by miner endpoints:

  • Signed request-body fields: hotkey, nonce, signature
  • Namespace ownership fields: namespace_hotkey, namespace_sig, namespace_timestamp_ms

Validation

Static validation performed locally:

  • Parsed docs/miner-openapi.json as JSON
  • Confirmed OpenAPI version is 3.1.0
  • Confirmed 26 OpenAPI operations match the 26 neurons/miner.py aiohttp route registrations
  • Confirmed SignedBody and NamespaceSignature security scheme entries are present

I could not run pytest in this environment because the available python.exe is the Windows Store placeholder rather than a working Python runtime.

Closes #23

@vercel

vercel Bot commented Jun 14, 2026

Copy link
Copy Markdown

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