docs: enhance OpenAPI specs with metadata and improve README #11
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
OpenAPI Spec Improvements: - Add description, contact, termsOfService, and license to info section - Add externalDocs linking to CoinGecko documentation - Add descriptions to all security schemes (apiKeyAuth, apiKeyQueryParam) - Add descriptions to all component schemas (142 total across all specs) README Improvements: - Add badges for OpenAPI version, documentation, and API pricing - Add table of contents for easy navigation - Add tables with spec descriptions and download links - Add usage section with Swagger UI, Postman, and code generation examples - Add contributing guidelines - Add resources section with useful links Files updated: - coingecko-pro.json (58 schema descriptions) - coingecko-demo.json (45 schema descriptions) - onchain-pro.json (23 schema descriptions) - onchain-demo.json (16 schema descriptions) - README.md
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.
Summary
This PR adds missing OpenAPI metadata to all specification files and enhances the README with practical usage examples.
Changes
OpenAPI Spec Enhancements (all 4 files)
info.descriptioninfo.contactinfo.licenseinfo.termsOfServiceexternalDocsSchema Descriptions Added
coingecko-pro.jsoncoingecko-demo.jsononchain-pro.jsononchain-demo.jsonREADME Enhancements
Why This Matters
infometadata enables better code generationNote