actions-marketplace-validations/API documentation on Bump
Generate your API doc and an automatic changelog from any OpenAPI or AsyncAPI file.
View on GitHubTrust Signals
- Scorecard Score
- not yet scored
- Maintenance Recency
- Stale
- License
- None
- Runtime
- Deprecated runtime
Inputs
| name | description | required | default |
|---|---|---|---|
| file | Relative path to the documentation file | yes | api-contract.yml |
| doc | Documentation id. Can be found in the documentation settings on https://bump.sh | — | — |
| token | Documentation token. Can be found in the documentation settings on https://bump.sh | — | — |
| hub | Hub slug or id. Needed when deploying to a documentation attached to a Hub. Can be found in the hub settings on https://bump.sh | — | — |
| branch | Branch name used during `deploy` or `diff` commands. This can be useful to maintain multiple API reference history and make it available in your API documentation. | — | — |
| command | Bump command: deploy/dry-run/preview | — | deploy |
Outputs
no outputs