@apimatic/cli 1.0.1-alpha.8 → 1.0.1-alpha.9
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/README.md +12 -11
- package/lib/commands/api/transform.js +2 -4
- package/lib/commands/sdk/generate.js +2 -3
- package/oclif.manifest.json +1 -1
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -19,7 +19,7 @@ $ npm install -g @apimatic/cli
|
|
|
19
19
|
$ apimatic COMMAND
|
|
20
20
|
running command...
|
|
21
21
|
$ apimatic (-v|--version|version)
|
|
22
|
-
@apimatic/cli/1.0.1-alpha.
|
|
22
|
+
@apimatic/cli/1.0.1-alpha.9 linux-x64 node-v16.13.0
|
|
23
23
|
$ apimatic --help [COMMAND]
|
|
24
24
|
USAGE
|
|
25
25
|
$ apimatic COMMAND
|
|
@@ -57,8 +57,8 @@ OPTIONS
|
|
|
57
57
|
--file=file path to the API specification file to transform
|
|
58
58
|
|
|
59
59
|
--format=format (required) specification format to transform API specification into
|
|
60
|
-
|
|
61
|
-
|
|
60
|
+
APIMATIC|WADL2009|WSDL|SWAGGER10|SWAGGER20|SWAGGERYAML|OAS3|OPENAPI3YAML|APIBLUEPRINT|RAML|
|
|
61
|
+
RAML10|POSTMAN10|POSTMAN20|GRAPHQLSCHEMA
|
|
62
62
|
|
|
63
63
|
--url=url URL to the API specification file to transform. Can be used in place of the --file option
|
|
64
64
|
if the API specification is publicly available.
|
|
@@ -71,7 +71,7 @@ EXAMPLES
|
|
|
71
71
|
Success! Your transformed file is located at D:/swagger_raml.yaml
|
|
72
72
|
```
|
|
73
73
|
|
|
74
|
-
_See code: [src/commands/api/transform.ts](https://github.com/apimatic/apimatic-cli/blob/v1.0.1-alpha.
|
|
74
|
+
_See code: [src/commands/api/transform.ts](https://github.com/apimatic/apimatic-cli/blob/v1.0.1-alpha.9/src/commands/api/transform.ts)_
|
|
75
75
|
|
|
76
76
|
## `apimatic api:validate`
|
|
77
77
|
|
|
@@ -96,7 +96,7 @@ EXAMPLES
|
|
|
96
96
|
Specification file provided is valid
|
|
97
97
|
```
|
|
98
98
|
|
|
99
|
-
_See code: [src/commands/api/validate.ts](https://github.com/apimatic/apimatic-cli/blob/v1.0.1-alpha.
|
|
99
|
+
_See code: [src/commands/api/validate.ts](https://github.com/apimatic/apimatic-cli/blob/v1.0.1-alpha.9/src/commands/api/validate.ts)_
|
|
100
100
|
|
|
101
101
|
## `apimatic auth:login`
|
|
102
102
|
|
|
@@ -120,7 +120,7 @@ EXAMPLES
|
|
|
120
120
|
Authentication key successfully set
|
|
121
121
|
```
|
|
122
122
|
|
|
123
|
-
_See code: [src/commands/auth/login.ts](https://github.com/apimatic/apimatic-cli/blob/v1.0.1-alpha.
|
|
123
|
+
_See code: [src/commands/auth/login.ts](https://github.com/apimatic/apimatic-cli/blob/v1.0.1-alpha.9/src/commands/auth/login.ts)_
|
|
124
124
|
|
|
125
125
|
## `apimatic auth:logout`
|
|
126
126
|
|
|
@@ -135,7 +135,7 @@ EXAMPLE
|
|
|
135
135
|
Logged out
|
|
136
136
|
```
|
|
137
137
|
|
|
138
|
-
_See code: [src/commands/auth/logout.ts](https://github.com/apimatic/apimatic-cli/blob/v1.0.1-alpha.
|
|
138
|
+
_See code: [src/commands/auth/logout.ts](https://github.com/apimatic/apimatic-cli/blob/v1.0.1-alpha.9/src/commands/auth/logout.ts)_
|
|
139
139
|
|
|
140
140
|
## `apimatic auth:status`
|
|
141
141
|
|
|
@@ -150,7 +150,7 @@ EXAMPLE
|
|
|
150
150
|
Currently logged in as apimatic-client@gmail.com
|
|
151
151
|
```
|
|
152
152
|
|
|
153
|
-
_See code: [src/commands/auth/status.ts](https://github.com/apimatic/apimatic-cli/blob/v1.0.1-alpha.
|
|
153
|
+
_See code: [src/commands/auth/status.ts](https://github.com/apimatic/apimatic-cli/blob/v1.0.1-alpha.9/src/commands/auth/status.ts)_
|
|
154
154
|
|
|
155
155
|
## `apimatic autocomplete [SHELL]`
|
|
156
156
|
|
|
@@ -190,7 +190,7 @@ OPTIONS
|
|
|
190
190
|
--all see all commands in CLI
|
|
191
191
|
```
|
|
192
192
|
|
|
193
|
-
_See code: [@oclif/plugin-help](https://github.com/oclif/plugin-help/blob/v3.2.
|
|
193
|
+
_See code: [@oclif/plugin-help](https://github.com/oclif/plugin-help/blob/v3.2.12/src/commands/help.ts)_
|
|
194
194
|
|
|
195
195
|
## `apimatic portal:generate`
|
|
196
196
|
|
|
@@ -212,7 +212,7 @@ EXAMPLE
|
|
|
212
212
|
Your portal has been generated at D:/
|
|
213
213
|
```
|
|
214
214
|
|
|
215
|
-
_See code: [src/commands/portal/generate.ts](https://github.com/apimatic/apimatic-cli/blob/v1.0.1-alpha.
|
|
215
|
+
_See code: [src/commands/portal/generate.ts](https://github.com/apimatic/apimatic-cli/blob/v1.0.1-alpha.9/src/commands/portal/generate.ts)_
|
|
216
216
|
|
|
217
217
|
## `apimatic sdk:generate`
|
|
218
218
|
|
|
@@ -247,11 +247,12 @@ EXAMPLES
|
|
|
247
247
|
Generating SDK... done
|
|
248
248
|
Downloading SDK... done
|
|
249
249
|
Success! Your SDK is located at swagger_sdk_csharp
|
|
250
|
+
|
|
250
251
|
$ apimatic sdk:generate --platform="CSHARP" --url=https://petstore.swagger.io/v2/swagger.json
|
|
251
252
|
Generating SDK... done
|
|
252
253
|
Downloading SDK... done
|
|
253
254
|
Success! Your SDK is located at swagger_sdk_csharp
|
|
254
255
|
```
|
|
255
256
|
|
|
256
|
-
_See code: [src/commands/sdk/generate.ts](https://github.com/apimatic/apimatic-cli/blob/v1.0.1-alpha.
|
|
257
|
+
_See code: [src/commands/sdk/generate.ts](https://github.com/apimatic/apimatic-cli/blob/v1.0.1-alpha.9/src/commands/sdk/generate.ts)_
|
|
257
258
|
<!-- commandsstop -->
|
|
@@ -2,13 +2,13 @@
|
|
|
2
2
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
3
|
const fs = require("fs-extra");
|
|
4
4
|
const path = require("path");
|
|
5
|
-
const cli_ux_1 = require("cli-ux");
|
|
6
5
|
const sdk_1 = require("@apimatic/sdk");
|
|
7
6
|
const command_1 = require("@oclif/command");
|
|
8
7
|
const sdk_client_1 = require("../../client-utils/sdk-client");
|
|
9
8
|
const utils_1 = require("../../utils/utils");
|
|
10
9
|
const transform_1 = require("../../types/api/transform");
|
|
11
10
|
const transform_2 = require("../../controllers/api/transform");
|
|
11
|
+
const formats = Object.keys(sdk_1.ExportFormats).join("|");
|
|
12
12
|
class Transform extends command_1.Command {
|
|
13
13
|
async run() {
|
|
14
14
|
const { flags } = this.parse(Transform);
|
|
@@ -40,7 +40,6 @@ class Transform extends command_1.Command {
|
|
|
40
40
|
this.log(`Success! Your transformed file is located at ${savedTransformationFile}`);
|
|
41
41
|
}
|
|
42
42
|
catch (error) {
|
|
43
|
-
cli_ux_1.default.action.stop();
|
|
44
43
|
if (error.result) {
|
|
45
44
|
const apiError = error;
|
|
46
45
|
// TODO: Hopefully, this type-cast won't be necessary when the SDK is
|
|
@@ -85,8 +84,7 @@ Transform.flags = {
|
|
|
85
84
|
parse: (format) => transform_2.getValidFormat(format.toUpperCase()),
|
|
86
85
|
required: true,
|
|
87
86
|
description: `specification format to transform API specification into
|
|
88
|
-
|
|
89
|
-
Swagger20|SwaggerYaml|RAML|RAML10|Postman10|Postman20)`
|
|
87
|
+
${formats}`
|
|
90
88
|
}),
|
|
91
89
|
file: command_1.flags.string({
|
|
92
90
|
parse: (input) => path.resolve(input),
|
|
@@ -2,7 +2,6 @@
|
|
|
2
2
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
3
|
const fs = require("fs-extra");
|
|
4
4
|
const path = require("path");
|
|
5
|
-
const cli_ux_1 = require("cli-ux");
|
|
6
5
|
const sdk_1 = require("@apimatic/sdk");
|
|
7
6
|
const command_1 = require("@oclif/command");
|
|
8
7
|
const sdk_client_1 = require("../../client-utils/sdk-client");
|
|
@@ -45,7 +44,6 @@ class SdkGenerate extends command_1.Command {
|
|
|
45
44
|
this.log(`Success! Your SDK is located at ${sdkPath}`);
|
|
46
45
|
}
|
|
47
46
|
catch (error) {
|
|
48
|
-
cli_ux_1.default.action.stop();
|
|
49
47
|
if (error.result) {
|
|
50
48
|
const apiError = error;
|
|
51
49
|
const result = apiError.result;
|
|
@@ -122,7 +120,8 @@ SdkGenerate.examples = [
|
|
|
122
120
|
Generating SDK... done
|
|
123
121
|
Downloading SDK... done
|
|
124
122
|
Success! Your SDK is located at swagger_sdk_csharp`,
|
|
125
|
-
|
|
123
|
+
`
|
|
124
|
+
$ apimatic sdk:generate --platform="CSHARP" --url=https://petstore.swagger.io/v2/swagger.json
|
|
126
125
|
Generating SDK... done
|
|
127
126
|
Downloading SDK... done
|
|
128
127
|
Success! Your SDK is located at swagger_sdk_csharp
|
package/oclif.manifest.json
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":"1.0.1-alpha.
|
|
1
|
+
{"version":"1.0.1-alpha.9","commands":{"api:transform":{"id":"api:transform","description":"Transform API specifications from one format to another. Supports [10+ different formats](https://www.apimatic.io/transformer/#supported-formats) including OpenApi/Swagger, RAML, WSDL and Postman Collections.","pluginName":"@apimatic/cli","pluginType":"core","aliases":[],"examples":["$ apimatic api:transform --format=\"OpenApi3Json\" --file=\"./specs/sample.json\" --destination=\"D:/\"\nSuccess! Your transformed file is located at D:/Transformed_OpenApi3Json.json\n","$ apimatic api:transform --format=RAML --url=\"https://petstore.swagger.io/v2/swagger.json\" --destination=\"D:/\"\nSuccess! Your transformed file is located at D:/swagger_raml.yaml\n"],"flags":{"format":{"name":"format","type":"option","description":"specification format to transform API specification into\nAPIMATIC|WADL2009|WSDL|SWAGGER10|SWAGGER20|SWAGGERYAML|OAS3|OPENAPI3YAML|APIBLUEPRINT|RAML|RAML10|POSTMAN10|POSTMAN20|GRAPHQLSCHEMA","required":true},"file":{"name":"file","type":"option","description":"path to the API specification file to transform","default":""},"url":{"name":"url","type":"option","description":"URL to the API specification file to transform. Can be used in place of the --file option if the API specification is publicly available.","default":""},"destination":{"name":"destination","type":"option","description":"directory to download transformed file to","default":"/home/runner/work/apimatic-cli/apimatic-cli/cli"},"force":{"name":"force","type":"boolean","char":"f","description":"overwrite if same file exist in the destination","allowNo":false},"auth-key":{"name":"auth-key","type":"option","description":"override current authentication state with an authentication key"}},"args":[]},"api:validate":{"id":"api:validate","description":"Validate the syntactic and semantic correctness of an API specification","pluginName":"@apimatic/cli","pluginType":"core","aliases":[],"examples":["$ apimatic api:validate --file=\"./specs/sample.json\"\nSpecification file provided is valid\n","$ apimatic api:validate --url=https://petstore.swagger.io/v2/swagger.json\nSpecification file provided is valid\n"],"flags":{"file":{"name":"file","type":"option","description":"Path to the API specification file to validate","default":""},"url":{"name":"url","type":"option","description":"URL to the specification file to validate. Can be used in place of the --file option if the API specification is publicly available.","default":""},"auth-key":{"name":"auth-key","type":"option","description":"override current authentication state with an authentication key"}},"args":[]},"auth:login":{"id":"auth:login","description":"Login using your APIMatic credentials or an API Key","pluginName":"@apimatic/cli","pluginType":"core","aliases":[],"examples":["$ apimatic auth:login\nPlease enter your registered email: apimatic-user@gmail.com\nPlease enter your password: *********\n\nYou have successfully logged into APIMatic\n","$ apimatic auth:login --auth-key=xxxxxx\nAuthentication key successfully set"],"flags":{"auth-key":{"name":"auth-key","type":"option","description":"Set authentication key for all commands","default":""}},"args":[]},"auth:logout":{"id":"auth:logout","description":"Clear local login credentials","pluginName":"@apimatic/cli","pluginType":"core","aliases":[],"examples":["$ apimatic auth:logout\nLogged out\n"],"flags":{},"args":[]},"auth:status":{"id":"auth:status","description":"View current authentication state","pluginName":"@apimatic/cli","pluginType":"core","aliases":[],"examples":["$ apimatic auth:status\nCurrently logged in as apimatic-client@gmail.com\n"],"flags":{},"args":[]},"portal:generate":{"id":"portal:generate","description":"Generate and download a static API Documentation portal. Requires an input directory containing API specifications, a config file and optionally, markdown guides. For details, refer to the [documentation](https://portal-api-docs.apimatic.io/#/http/generating-api-portal/build-file)","pluginName":"@apimatic/cli","pluginType":"core","aliases":[],"examples":["$ apimatic portal:generate --folder=\"./portal/\" --destination=\"D:/\"\nYour portal has been generated at D:/\n"],"flags":{"folder":{"name":"folder","type":"option","description":"path to the input directory containing API specifications and config files","default":"./"},"destination":{"name":"destination","type":"option","description":"path to the downloaded portal","default":"/home/runner/work/apimatic-cli/apimatic-cli/cli"},"force":{"name":"force","type":"boolean","char":"f","description":"overwrite if a portal exists in the destination","allowNo":false},"zip":{"name":"zip","type":"boolean","description":"download the generated portal as a .zip archive","allowNo":false},"auth-key":{"name":"auth-key","type":"option","description":"override current authentication state with an authentication key","default":""}},"args":[]},"sdk:generate":{"id":"sdk:generate","description":"Generate SDK for your APIs","pluginName":"@apimatic/cli","pluginType":"core","aliases":[],"examples":["$ apimatic sdk:generate --platform=\"CSHARP\" --file=\"./specs/sample.json\"\nGenerating SDK... done\nDownloading SDK... done\nSuccess! Your SDK is located at swagger_sdk_csharp","\n$ apimatic sdk:generate --platform=\"CSHARP\" --url=https://petstore.swagger.io/v2/swagger.json\nGenerating SDK... done\nDownloading SDK... done\nSuccess! Your SDK is located at swagger_sdk_csharp\n"],"flags":{"platform":{"name":"platform","type":"option","description":"language platform for sdk\nSimple: CSHARP|JAVA|PYTHON|RUBY|PHP|TYPESCRIPT\nLegacy: CS_NET_STANDARD_LIB|CS_PORTABLE_NET_LIB|CS_UNIVERSAL_WINDOWS_PLATFORM_LIB|\n JAVA_ECLIPSE_JRE_LIB|PHP_GENERIC_LIB|PYTHON_GENERIC_LIB|RUBY_GENERIC_LIB|\n TS_GENERIC_LIB","required":true},"file":{"name":"file","type":"option","description":"path to the API specification to generate SDKs for","default":""},"url":{"name":"url","type":"option","description":"URL to the API specification to generate SDKs for. Can be used in place of the --file option if the API specification is publicly available.","default":""},"destination":{"name":"destination","type":"option","description":"directory to download the generated SDK to","default":"/home/runner/work/apimatic-cli/apimatic-cli/cli"},"force":{"name":"force","type":"boolean","char":"f","description":"overwrite if an SDK already exists in the destination","allowNo":false},"zip":{"name":"zip","type":"boolean","description":"download the generated SDK as a .zip archive","allowNo":false},"auth-key":{"name":"auth-key","type":"option","description":"override current authentication state with an authentication key","default":""}},"args":[]}}}
|