feat: add OpenAPI specification and Swagger UI for API documentation#17
Open
reldothescribe wants to merge 1 commit intoethpandaops:masterfrom
Open
feat: add OpenAPI specification and Swagger UI for API documentation#17reldothescribe wants to merge 1 commit intoethpandaops:masterfrom
reldothescribe wants to merge 1 commit intoethpandaops:masterfrom
Conversation
- Create comprehensive OpenAPI 3.0 spec for all endpoints (/mcp, /health, /sandbox, /auth, /clickhouse, etc.) - Serve spec at /openapi.json and /openapi.yaml - Serve Swagger UI at /docs for interactive API exploration - Document all request/response schemas with examples - Include MCP protocol, OAuth authentication, and proxy endpoints
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
1 participant
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.
This PR adds comprehensive OpenAPI documentation for the ethpandaops MCP server.
Changes
OpenAPI 3.0 Specification (
docs/openapi.yaml): Complete API spec covering:New
pkg/openapiPackage: Handler to serve:/openapi.json- OpenAPI spec in JSON format/openapi.yaml- OpenAPI spec in YAML format/docs- Swagger UI for interactive API explorationIntegration: Both MCP server and proxy server now serve the OpenAPI documentation
Testing
go build ./...Endpoints Added
GET /openapi.jsonGET /openapi.yamlGET /docs