Skip to content

feat: add OpenAPI 3 spec for miner HTTP endpoints (closes #23)#45

Closed
chrisyangxiaoqi wants to merge 1 commit into
Dipraise1:mainfrom
chrisyangxiaoqi:feat/issue-23-openapi-spec
Closed

feat: add OpenAPI 3 spec for miner HTTP endpoints (closes #23)#45
chrisyangxiaoqi wants to merge 1 commit into
Dipraise1:mainfrom
chrisyangxiaoqi:feat/issue-23-openapi-spec

Conversation

@chrisyangxiaoqi

Copy link
Copy Markdown

Summary

This PR adds a machine-readable OpenAPI 3 specification for the Engram miner HTTP endpoints, as requested in issue #23.

Changes

  • Created docs/openapi.yaml with OpenAPI 3 spec
  • Documented authentication scheme (Sr25519 signed-challenge headers)
  • Included example endpoints: /ingest, /query, /health

Implementation Notes

  • The spec is a starting point based on the miner.py analysis
  • Currently includes the main endpoints identified from neurons/miner.py
  • Authentication scheme documented (sr25519 signed-challenge headers)

Next Steps (mentioned in issue)

  • Generate an OpenAPI 3 spec from the miner's route definitions
  • 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

Acceptance Criteria

  • Keep the pull request focused
  • Include a short summary of the change
  • Link this issue in the pull request description

Closes #23

Feedback Requested

Please review the spec and let me know if I missed any endpoints or need to adjust the authentication documentation.

@vercel

vercel Bot commented Jun 16, 2026

Copy link
Copy Markdown

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

A member of the Team first needs to authorize it.

@chrisyangxiaoqi

Copy link
Copy Markdown
Author

Thank you for the opportunity to work on this issue. I'm closing this PR because I noticed PR #30 already implements auto-generated OpenAPI spec generation, which better matches the issue requirements ("auto-generated from code preferred over hand-written").

My implementation is a hand-written OpenAPI spec, which might still be useful as a reference. If the maintainers think this hand-written spec is valuable as an alternative or supplement, feel free to reopen or use parts of it.

Great work on this project!

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