What this API does
The Bump.sh API Documentation Tool automates the management of API documentation, featuring automatic changelog generation and breaking change detection directly from CI/CD pipelines. It supports major API specification formats such as OpenAPI 3.0 and AsyncAPI, making it versatile for various API implementations.
How it works
Developers can upload new API specifications and retrieve version histories through simple API calls. The tool integrates smoothly with continuous integration workflows, ensuring documentation is automatically updated alongside application changes. It allows embedding interactive documentation into websites or internal portals.
Authentication
The Bump.sh API requires secure API token-based authentication. Developers must generate an API token from the Bump.sh dashboard to access the endpoints securely.
Example usage
POST /api/docs/upload- Uploads new API specifications.GET /api/docs/history- Retrieves the version history of a specific API.GET /api/docs/{version}- Fetches interactive documentation for a specified version.
Limits
Currently, the free Starter plan supports one API and does not specify precise rate limits. Developers should monitor their usage to ensure optimal performance.
Ideal use cases
- Continuous API documentation updates in CI/CD workflows.
- Collaborative projects requiring transparent documentation changes.
- Integration with GitHub Actions for automated documentation management.
- Embedding API documentation in developer portals for easy access.