feat: Automate OpenAPI generation from JSON Schema #178
+920
−147
Conversation
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
- Create server-json-to-openapi-sync tool to convert JSON Schema to OpenAPI components - Set up generation workflow with separate manual and generated files - Organize generation files in docs/server-registry-api/generation/ - Add go generate support for running the full pipeline - Preserve existing OpenAPI structure while enabling DRY schema management
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.
Just FYI @toby @joelverhagen @modelcontextprotocol/registry I am WIP on this. Don't quite love where it's at right now, will be working more on it.
This is part of #159 and the mission to make our server.json/openapi spec DRY.
Summary
This PR introduces automated generation of OpenAPI schemas from our canonical
server.jsonJSON Schema, ensuring that shared data models stay in sync between the two specifications.What's changed
tools/server-json-to-openapi-sync/- a Go tool that converts JSON Schema definitions to OpenAPI component schemasdocs/server-registry-api/generation/:openapi-manual.yaml- Hand-written API endpoints and registry-specific schemasopenapi-components-generated.yaml- Auto-generated from server.jsonopenapi.yamlis generated by bundling these togethergo generatesupport for running the generation pipelineidon Server) remain manually definedHow it works
go generate -tags generate ./...ormake -C docs/server-registry-api/generation alldocs/server-json/schema.json→ OpenAPI componentsopenapi.yamlBenefits
TODO before review