Skip to content

Commit 750ea12

Browse files
committed
Fix developers.bump.sh redirection
We'll move our Bump.sh documentation in hub, and transfer the custom domain from a Api to a Hub: https://developers.bump.sh/ -> https://developers.bump.sh/doc/workspace/ Most of these changes will be ensured [via redirection](https://itducks.slack.com/archives/C08294CTDM3/p1780661912150059), but let's be as clean and consistent as possible. (especially for https://developers.bump.sh/source.md that will be transferred valid for the Hub)
1 parent 8fcb5be commit 750ea12

5 files changed

Lines changed: 12 additions & 12 deletions

File tree

README.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ Using [OpenAPI](https://github.com/OAI/OpenAPI-Specification) (v3.x and v2.0) or
1616
- Validate an API document before publishing to your documentation.
1717
- [Publish an API document](#the-deploy-command) to your Bump.sh documentation or hubs.
1818
- [Compare two API documents](#the-diff-command) to generate a human-readable diff from your API definition.
19-
Under the hood, it uses the API of [developers.bump.sh](https://developers.bump.sh). And is built with the [`oclif`](https://oclif.io) framework in Typescript.
19+
Under the hood, it uses the workspace API of [developers.bump.sh](https://developers.bump.sh/doc/workspace/). And is built with the [`oclif`](https://oclif.io) framework in Typescript.
2020

2121
Using [Flower](https://docs.bump.sh/help/mcp-servers/specification-support/flower-support/) or [Arazzo](https://docs.bump.sh/arazzo/v1.0/), you can:
2222

@@ -83,7 +83,7 @@ npx bump --help
8383

8484
### Can I install Bump.sh CLI without using NodeJS?
8585

86-
Unfortunately, at the moment we only support the Node environment. However, you can download a standalone package directly from the [latest Github release](https://github.com/bump-sh/cli/releases) assets which you can run as a standalone binary. Or you can push your documentation using [our API](https://developers.bump.sh/) (advanced usage only).
86+
Unfortunately, at the moment we only support the Node environment. However, you can download a standalone package directly from the [latest Github release](https://github.com/bump-sh/cli/releases) assets which you can run as a standalone binary. Or you can push your documentation using [our API](https://developers.bump.sh/doc/workspace/) (advanced usage only).
8787

8888
## Usage
8989

@@ -284,7 +284,7 @@ bump preview path/to/file.json
284284
You can also preview a document available via a URL:
285285

286286
```shell
287-
bump preview https://developers.bump.sh/source.yaml
287+
bump preview https://developers.bump.sh/doc/workspace/source.yaml
288288
```
289289

290290
#### Live preview
@@ -384,7 +384,7 @@ For example to generate a preview:
384384
> Your preview is visible at: https://bump.sh/preview/42
385385
```
386386

387-
Please note that even if CLI is running locally, by default requests are sent to [Bump.sh API](https://developers.bump.sh/).
387+
Please note that even if CLI is running locally, by default requests are sent to [Bump.sh API](https://developers.bump.sh/doc/workspace/).
388388

389389
If you have a local version of the Bump.sh API, you can run CLI 100% in local environment
390390
by setting the environment variable `BUMP_HOST`:

examples/valid/openapi.v3.2.yml

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -603,7 +603,7 @@ components:
603603
humanUrl:
604604
type: string
605605
description: public documentation URL
606-
example: https://developers.bump.sh/
606+
example: https://developers.bump.sh/doc/workspace/
607607
tags:
608608
type: array
609609
items:
@@ -635,7 +635,7 @@ components:
635635
description: Content of the extra property (`data` or `url`)
636636
example:
637637
type: "OpenAPI"
638-
url: "https://developers.bump.sh/source.json"
638+
url: "https://developers.bump.sh/doc/workspace/source.json"
639639
created:
640640
type: date
641641
description: Creation date of this API
@@ -751,11 +751,11 @@ components:
751751
previous_version_url:
752752
type: string
753753
description: URL of previous version specification, in JSON format
754-
example: https://developers.bump.sh/changes/750f15d8/previous.json
754+
example: https://developers.bump.sh/doc/workspace/changes/750f15d8/previous.json
755755
current_version_url:
756756
type: string
757757
description: URL of current version specification, in JSON format
758-
example: https://developers.bump.sh/changes/750f15d8/current.json
758+
example: https://developers.bump.sh/doc/workspace/changes/750f15d8/current.json
759759
DiffItem:
760760
properties:
761761
id:

package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "bump-cli",
3-
"description": "The Bump CLI is used to interact with your API documentation hosted on Bump.sh by using the API of developers.bump.sh",
3+
"description": "The Bump CLI is used to interact with your API documentation hosted on Bump.sh by using the APIs of developers.bump.sh",
44
"version": "2.10.0",
55
"author": "Paul Bonaud <paulr@bump.sh>",
66
"bin": {

src/api/models.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
/*
2-
Please see https://developers.bump.sh/ for the API documentation
2+
Please see https://developers.bump.sh/doc/workspace/ for the API documentation
33
The types defined here should align with the API definition
44
*/
55
export interface PingResponse {

test/commands/deploy.test.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -192,14 +192,14 @@ describe('deploy subcommand', () => {
192192
.post('/api/v1/versions', (body) => body.documentation === 'coucou' && !body.branch_name)
193193
.reply(201, {doc_public_url: 'http://localhost/doc/1'})
194194

195-
nock('https://developers.bump.sh')
195+
nock('https://developers.bump.sh/doc/workspace/')
196196
.get('/source.json')
197197
.replyWithFile(200, 'examples/valid/asyncapi.no-refs.v2.yml', {
198198
'Content-Type': 'application/json',
199199
})
200200

201201
const {stdout} = await runCommand(
202-
['deploy', 'https://developers.bump.sh/source.json', '--doc', 'coucou'].join(' '),
202+
['deploy', 'https://developers.bump.sh/doc/workspace/source.json', '--doc', 'coucou'].join(' '),
203203
)
204204
expect(stdout).to.contain(
205205
'Your coucou documentation...has received a new deployment which will soon be ready at:\nhttp://localhost/doc/1',

0 commit comments

Comments
 (0)