bump-cli 2.7.1 → 2.7.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/lib/api/error.js +1 -1
- package/lib/definition.d.ts +3 -2
- package/lib/definition.js +7 -7
- package/oclif.manifest.json +1 -1
- package/package.json +3 -3
package/lib/api/error.js
CHANGED
|
@@ -39,7 +39,7 @@ class APIError extends errors_1.CLIError {
|
|
|
39
39
|
return [
|
|
40
40
|
[
|
|
41
41
|
genericMessage,
|
|
42
|
-
`In a hub context you might want to try the ${chalk_1.default.dim('--auto-create')} flag.\nOtherwise, please check the given ${chalk_1.default.dim('--
|
|
42
|
+
`In a hub context you might want to try the ${chalk_1.default.dim('--auto-create')} flag.\nOtherwise, please check the given ${chalk_1.default.dim('--doc')}, ${chalk_1.default.dim('--token')} or ${chalk_1.default.dim('--hub')} flags`,
|
|
43
43
|
],
|
|
44
44
|
104,
|
|
45
45
|
];
|
package/lib/definition.d.ts
CHANGED
|
@@ -1,5 +1,6 @@
|
|
|
1
1
|
import $RefParser from '@apidevtools/json-schema-ref-parser';
|
|
2
|
-
import { JSONSchema4Object, JSONSchema6Object } from 'json-schema';
|
|
2
|
+
import { JSONSchema4, JSONSchema4Object, JSONSchema6, JSONSchema6Object, JSONSchema7 } from 'json-schema';
|
|
3
|
+
declare type SpecSchema = JSONSchema4 | JSONSchema6 | JSONSchema7;
|
|
3
4
|
declare class SupportedFormat {
|
|
4
5
|
static readonly openapi: Record<string, SpecSchema>;
|
|
5
6
|
static readonly asyncapi: Record<string, SpecSchema>;
|
|
@@ -13,7 +14,7 @@ declare class API {
|
|
|
13
14
|
readonly specName: string;
|
|
14
15
|
readonly spec?: SpecSchema;
|
|
15
16
|
constructor(location: string, $refs: $RefParser.$Refs);
|
|
16
|
-
getSpec(definition: APIDefinition):
|
|
17
|
+
getSpec(definition: APIDefinition): SpecSchema;
|
|
17
18
|
getSpecName(definition: APIDefinition): string;
|
|
18
19
|
getVersion(definition: APIDefinition): string;
|
|
19
20
|
versionWithoutPatch(): string;
|
package/lib/definition.js
CHANGED
|
@@ -16,13 +16,13 @@ SupportedFormat.openapi = {
|
|
|
16
16
|
'3.1': require('oas-schemas/schemas/v3.1/schema.json'),
|
|
17
17
|
};
|
|
18
18
|
SupportedFormat.asyncapi = {
|
|
19
|
-
'2.0': specs_1.default['2.0.0'],
|
|
20
|
-
'2.1': specs_1.default['2.1.0'],
|
|
21
|
-
'2.2': specs_1.default['2.2.0'],
|
|
22
|
-
'2.3': specs_1.default['2.3.0'],
|
|
23
|
-
'2.4': specs_1.default['2.4.0'],
|
|
24
|
-
'2.5': specs_1.default['2.5.0'],
|
|
25
|
-
'2.6': specs_1.default['2.6.0'],
|
|
19
|
+
'2.0': specs_1.default.schemas['2.0.0'],
|
|
20
|
+
'2.1': specs_1.default.schemas['2.1.0'],
|
|
21
|
+
'2.2': specs_1.default.schemas['2.2.0'],
|
|
22
|
+
'2.3': specs_1.default.schemas['2.3.0'],
|
|
23
|
+
'2.4': specs_1.default.schemas['2.4.0'],
|
|
24
|
+
'2.5': specs_1.default.schemas['2.5.0'],
|
|
25
|
+
'2.6': specs_1.default.schemas['2.6.0'],
|
|
26
26
|
};
|
|
27
27
|
class UnsupportedFormat extends errors_1.CLIError {
|
|
28
28
|
constructor(message = '') {
|
package/oclif.manifest.json
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":"2.7.
|
|
1
|
+
{"version":"2.7.2","commands":{"deploy":{"id":"deploy","description":"Create a new version of your documentation from the given file or URL.","pluginName":"bump-cli","pluginType":"core","aliases":[],"examples":["Deploy a new version of an existing documentation\n\n$ bump deploy FILE --doc <your_doc_id_or_slug> --token <your_doc_token>\n* Let's deploy a new documentation version on Bump... done\n* Your new documentation version will soon be ready\n","Deploy a new version of an existing documentation attached to a hub\n\n$ bump deploy FILE --doc <doc_slug> --hub <your_hub_id_or_slug> --token <your_doc_token>\n* Let's deploy a new documentation version on Bump... done\n* Your new documentation version will soon be ready\n","Deploy a whole directory of API definitions files to a hub\n\n$ bump deploy DIR --filename-pattern *-{slug}-api --hub <hub_slug> --token <hub_token>\nWe've found 2 valid API definitions to deploy\n└─ DIR\n └─ source-my-service-api.yml (OpenAPI spec version 3.1.0)\n └─ source-my-jobs-service-api.yml (AsyncAPI spec version 2.6.0)\n\nLet's deploy those documentations to your <hub_slug> hub on Bump.sh\n\n* Your new documentation version will soon be ready\nLet's deploy a new version to your my-service documentation on Bump.sh... done\n\n* Your new documentation version will soon be ready\nLet's deploy a new version to your my-jobs-service documentation on Bump.sh... done\n","Validate a new documentation version before deploying it\n\n$ bump deploy FILE --dry-run --doc <doc_slug> --token <your_doc_token>\n* Let's validate a new documentation version on Bump... done\n* Definition is valid\n"],"flags":{"help":{"name":"help","type":"boolean","char":"h","description":"show CLI help","allowNo":false},"doc":{"name":"doc","type":"option","char":"d","description":"Documentation public id or slug. Can be provided via BUMP_ID environment variable"},"doc-name":{"name":"doc-name","type":"option","char":"n","description":"Documentation name. Used with --auto-create flag."},"hub":{"name":"hub","type":"option","char":"b","description":"Hub id or slug. Can be provided via BUMP_HUB_ID environment variable"},"branch":{"name":"branch","type":"option","char":"B","description":"Branch name. Can be provided via BUMP_BRANCH_NAME environment variable"},"token":{"name":"token","type":"option","char":"t","description":"Documentation or Hub token. Can be provided via BUMP_TOKEN environment variable","required":true},"auto-create":{"name":"auto-create","type":"boolean","description":"Automatically create the documentation if needed (only available with a --hub flag). Documentation name can be provided with --doc-name flag. Default: false","allowNo":false},"interactive":{"name":"interactive","type":"boolean","description":"Interactively create a configuration file to deploy a Hub (only available with a --hub flag). This will start an interactive process if you don't have a CLI configuration file. Default: false","allowNo":false},"filename-pattern":{"name":"filename-pattern","type":"option","description":"Pattern to extract the documentation slug from filenames when deploying a DIRECTORY. Pattern uses only '*' and '{slug}' as special characters to extract the slug from a filename without extension. Used with --hub flag only.","default":"{slug}-api"},"dry-run":{"name":"dry-run","type":"boolean","description":"Validate a new documentation version. Does everything a normal deploy would do except publishing the new version. Useful in automated environments such as test platforms or continuous integration. Default: false","allowNo":false}},"args":[{"name":"FILE","description":"Path or URL to your API documentation file. OpenAPI (2.0 to 3.1.0) and AsyncAPI (2.x) specifications are currently supported.\nPath can also be a directory when deploying to a Hub.","required":true}]},"diff":{"id":"diff","description":"Get a comparison diff with your documentation from the given file or URL.","pluginName":"bump-cli","pluginType":"core","aliases":[],"examples":["Compare a potential new version with the currently published one:\n\n $ bump diff FILE --doc <your_doc_id_or_slug> --token <your_doc_token>\n * Comparing the given definition file with the currently deployed one... done\n Removed: GET /compare\n Added: GET /versions/{versionId}\n","Store the diff in a dedicated file:\n\n $ bump diff FILE --doc <doc_slug> --token <doc_token> > /tmp/my-saved-diff\n * Comparing the given definition file with the currently deployed one... done\n\n $ cat /tmp/my-saved-diff\n Removed: GET /compare\n Added: GET /versions/{versionId}\n","In case of a non modified definition FILE compared to your existing documentation, no changes are output:\n\n $ bump diff FILE --doc <doc_slug> --token <your_doc_token>\n * Comparing the given definition file with the currently deployed one... done\n › Warning: Your documentation has not changed\n","Compare two different input files or URL independently to the one published on bump.sh\n\n $ bump diff FILE FILE2 --doc <doc_slug> --token <your_doc_token>\n * Comparing the two given definition files... done\n Updated: POST /versions\n Body attribute added: previous_version_id\n"],"flags":{"help":{"name":"help","type":"boolean","char":"h","description":"show CLI help","allowNo":false},"doc":{"name":"doc","type":"option","char":"d","description":"Documentation public id or slug. Can be provided via BUMP_ID environment variable"},"hub":{"name":"hub","type":"option","char":"b","description":"Hub id or slug. Can be provided via BUMP_HUB_ID environment variable"},"branch":{"name":"branch","type":"option","char":"B","description":"Branch name. Can be provided via BUMP_BRANCH_NAME environment variable"},"token":{"name":"token","type":"option","char":"t","description":"Documentation or Hub token. Can be provided via BUMP_TOKEN environment variable","required":false},"open":{"name":"open","type":"boolean","char":"o","description":"Open the visual diff in your browser","allowNo":false},"fail-on-breaking":{"name":"fail-on-breaking","type":"boolean","char":"F","description":"Fail when diff contains a breaking change","allowNo":false},"format":{"name":"format","type":"option","char":"f","description":"Format in which to provide the diff result","options":["text","markdown","json","html"],"default":"text"},"expires":{"name":"expires","type":"option","char":"e","description":"Specify a longer expiration date for public diffs (defaults to 1 day). Use iso8601 format to provide a date, or you can use `--expires 'never'` to keep the result live indefinitely."}},"args":[{"name":"FILE","description":"Path or URL to your API documentation file. OpenAPI (2.0 to 3.1.0) and AsyncAPI (2.x) specifications are currently supported.\nPath can also be a directory when deploying to a Hub.","required":true},{"name":"FILE2","description":"Path or URL to a second API documentation file to compute its diff"}]},"preview":{"id":"preview","description":"Create a documentation preview from the given file or URL.","pluginName":"bump-cli","pluginType":"core","aliases":[],"examples":["$ bump preview FILE\n* Your preview is visible at: https://bump.sh/preview/45807371-9a32-48a7-b6e4-1cb7088b5b9b\n"],"flags":{"help":{"name":"help","type":"boolean","char":"h","description":"show CLI help","allowNo":false},"live":{"name":"live","type":"boolean","char":"l","description":"Generate a preview each time you save the given file","allowNo":false},"open":{"name":"open","type":"boolean","char":"o","description":"Open the generated preview URL in your browser","allowNo":false}},"args":[{"name":"FILE","description":"Path or URL to your API documentation file. OpenAPI (2.0 to 3.1.0) and AsyncAPI (2.x) specifications are currently supported.\nPath can also be a directory when deploying to a Hub.","required":true}]}}}
|
package/package.json
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "bump-cli",
|
|
3
3
|
"description": "The Bump CLI is used to interact with your API documentation hosted on Bump by using the API of developers.bump.sh",
|
|
4
|
-
"version": "2.7.
|
|
4
|
+
"version": "2.7.2",
|
|
5
5
|
"author": "Paul Bonaud <paulr@bump.sh>",
|
|
6
6
|
"bin": {
|
|
7
7
|
"bump": "./bin/run"
|
|
@@ -12,7 +12,7 @@
|
|
|
12
12
|
"@oclif/test": "^2.0.3",
|
|
13
13
|
"@types/debug": "^4.1.5",
|
|
14
14
|
"@types/mocha": "^10.0.0",
|
|
15
|
-
"@types/node": "^
|
|
15
|
+
"@types/node": "^20.7.0",
|
|
16
16
|
"@typescript-eslint/eslint-plugin": "^5.21.0",
|
|
17
17
|
"@typescript-eslint/parser": "^5.21.0",
|
|
18
18
|
"chai": "^4.3.4",
|
|
@@ -82,7 +82,7 @@
|
|
|
82
82
|
"types": "lib/index.d.ts",
|
|
83
83
|
"dependencies": {
|
|
84
84
|
"@apidevtools/json-schema-ref-parser": "^9.0.7",
|
|
85
|
-
"@asyncapi/specs": "^
|
|
85
|
+
"@asyncapi/specs": "^5.1.0",
|
|
86
86
|
"@clack/prompts": "^0.6.3",
|
|
87
87
|
"@oclif/command": "^1.8.16",
|
|
88
88
|
"@oclif/config": "^1.17.0",
|