feat: add OpenAPI 3 spec for miner HTTP endpoints (closes #23)#45
Closed
chrisyangxiaoqi wants to merge 1 commit into
Closed
feat: add OpenAPI 3 spec for miner HTTP endpoints (closes #23)#45chrisyangxiaoqi wants to merge 1 commit into
chrisyangxiaoqi wants to merge 1 commit into
Conversation
|
@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. |
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! |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
This PR adds a machine-readable OpenAPI 3 specification for the Engram miner HTTP endpoints, as requested in issue #23.
Changes
docs/openapi.yamlwith OpenAPI 3 spec/ingest,/query,/healthImplementation Notes
neurons/miner.pyNext Steps (mentioned in issue)
docs/or theengram.space)Acceptance Criteria
Closes #23
Feedback Requested
Please review the spec and let me know if I missed any endpoints or need to adjust the authentication documentation.