Skip to content

feat: auto-generate OpenAPI spec for miner HTTP endpoints#32

Open
Tne-max wants to merge 2 commits into
Dipraise1:mainfrom
Tne-max:feat/openapi-spec
Open

feat: auto-generate OpenAPI spec for miner HTTP endpoints#32
Tne-max wants to merge 2 commits into
Dipraise1:mainfrom
Tne-max:feat/openapi-spec

Conversation

@Tne-max

@Tne-max Tne-max commented Jun 13, 2026

Copy link
Copy Markdown

Closes #23

This PR fulfills the requested bounty to add an OpenAPI 3 spec for the miner HTTP endpoints.

Changes:

  • Adds scripts/generate_openapi.py to programmatically generate an OpenAPI JSON schema from the existing Pydantic models in engram.protocol without rewriting all the �iohttp route handlers.
  • Documents the sr25519 signed-challenge header auth scheme.
  • Adds docs/openapi.json and docs/index.html (Redoc UI).
  • Adds a GitHub Actions workflow (openapi_sync.yml) to ensure the openapi.json spec stays fully synchronized with code changes.

Twitter: @HELIOOOSSSSS
Wallet: 0x43991A9dC8Ddf492eab6E55685644c2cb9B001D2

@vercel

vercel Bot commented Jun 13, 2026

Copy link
Copy Markdown

@rhoggs-bot-test-account 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