[docs] OpenAPI spec for miner HTTP endpoints

[Dipraise1]

Context

Miner HTTP endpoints (neurons/miner.py: ingest, query, KeyShareSynapse/KeyShareRetrieve, etc.) have no machine-readable API spec, which blocks third-party clients and the TypeScript SDK.

Tasks

• Generate an OpenAPI 3 spec from the miner's route definitions (auto-generated from code preferred over hand-written)
• Include auth scheme docs (sr25519 signed-challenge headers)
• Publish rendered docs (e.g. Redoc page under docs/ or theengram.space)
• CI check that the spec stays in sync with routes

Listed as an open bounty in ROADMAP.md.

[codeboost-tr]

C:/Program Files/Git/attempt

[iHateThisGameSo]

Hi, I can take a look at the OpenAPI spec generation path for the miner endpoints.

Before I start implementation, can you confirm the bounty amount and preferred claim process for this issue?

If useful, I would propose a first PR that generates and validates an OpenAPI 3 spec from the current miner routes, documents the sr25519 signed-request headers, publishes rendered docs under docs/, and adds a CI check so the spec stays in sync with the route definitions.

[go165]

/claim #23

Submitted PR #30: #30

This implements OpenAPI spec generation for the miner HTTP endpoints by adding a shared route registry consumed by both neurons/miner.py and the OpenAPI generator. The PR includes:

• docs/openapi.json OpenAPI 3.1 output
• docs/miner-openapi.html Redoc viewer
• sr25519 signed-body auth documentation for hotkey, nonce, and signature
• namespace signature schema fields
• scripts/generate_openapi.py --check for route/spec drift detection
• tests covering route/spec sync and generated-file freshness

Validation performed locally:

python3 scripts/generate_openapi.py --check
python3 -m py_compile engram/miner/openapi.py scripts/generate_openapi.py neurons/miner.py tests/test_openapi.py
git diff --check

I also ran a direct OpenAPI smoke check confirming the generated file matches build_openapi_spec(), route pairs match MINER_HTTP_ROUTES, and the sr25519 auth description is present.

[abulasa1]

Hi, I would like to work on this OpenAPI bounty.

I have a focused implementation ready that:

• statically extracts the aiohttp route table from neurons/miner.py
• generates docs/miner-openapi.json as OpenAPI 3.1
• includes auth documentation for signed request-body fields and namespace signatures
• adds a Redoc viewer at docs/miner-api.html
• adds a sync test so route changes fail if the checked-in spec is stale

Before I open the PR, can you confirm this issue is still available to claim and whether there is any preferred bounty claim flow beyond the issue/PR?