Skip to content

Commit

Permalink
added final information regarding the API/hub relation
Browse files Browse the repository at this point in the history
  • Loading branch information
jayk-u committed Oct 19, 2023
1 parent b0a1f5b commit 4bd83b7
Showing 1 changed file with 14 additions and 2 deletions.
16 changes: 14 additions & 2 deletions src/_help/hubs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -43,11 +43,23 @@ The CLI allows you to deploy new documentation directly to a hub. It does not su

To deploy a new doc to a hub, execute the following command:

bump deploy your/doc.yml --doc my-doc --hub hub-slug-or-id --token my-doc-token
``bump deploy your/doc.yml --doc my-doc --hub hub-slug-or-id --token my-doc-token``

Find here the commands and more information about the CLI.
### Using the API

Bump.sh's API allows you to upload new versions of your API documentation directly to your hub.
The Bump.sh API allows for several actions on your hub and the documentation it contains:

- Deploy a new version of a documentation present in a hub.
- Validate a version (pre-deployment check) for a documentation in a hub.
- List the documentation in a hub.

However, the API does not currently support the following actions:

- Deleting a documentation from a hub.
- Attaching an existing documentation (outside of the hub) to a hub.
- Modifying the metadata of a hub (title, description, settings, etc.).
- Deleting a hub.

[For more information, please refer to our API documentation.](https://developers.bump.sh/group/endpoint-versions)

Expand Down

0 comments on commit 4bd83b7

Please sign in to comment.