[docs] Add OpenAPI spec for miner HTTP endpoints#46
Open
zjwjing wants to merge 6 commits into
Open
Conversation
|
@zjwjing is attempting to deploy a commit to the praise's projects Team on Vercel. A member of the Team first needs to authorize it. |
zjwjing
commented
Jun 19, 2026
zjwjing
left a comment
Author
There was a problem hiding this comment.
Hi maintainers,
I have completed all the requested changes and the PR is ready for review.
Please let me know if you need any additional modifications.
Thank you!
Author
|
Hi @Dipraise1 — checking in on this PR. The OpenAPI spec is ready for review. Happy to make any changes needed. Thanks! |
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.
What does this PR do?
Adds OpenAPI 3.0 specification for Engram miner HTTP endpoints, enabling machine-readable API documentation for third-party clients and SDK development.
Closes #23
Changes
docs/openapi.yaml- Complete OpenAPI 3.0 spec covering 23 miner endpointsdocs/index.html- Redoc documentation page for visual API browsingEndpoints Documented
Core Operations
Chat & Conversations
Key Share Management
Namespace & Attestation
System & Monitoring
How to test