stepzen 0.44.0 → 0.45.0-beta.0
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 +76 -71
- package/bin/dev.cmd +1 -1
- package/bin/dev.js +6 -0
- package/bin/{run → run.js} +6 -20
- package/lib/commands/delete.d.ts +3 -3
- package/lib/commands/delete.d.ts.map +1 -1
- package/lib/commands/delete.js +32 -33
- package/lib/commands/delete.js.map +1 -1
- package/lib/commands/deploy.d.ts +10 -12
- package/lib/commands/deploy.d.ts.map +1 -1
- package/lib/commands/deploy.js +98 -98
- package/lib/commands/deploy.js.map +1 -1
- package/lib/commands/import/curl.d.ts +17 -24
- package/lib/commands/import/curl.d.ts.map +1 -1
- package/lib/commands/import/curl.js +85 -85
- package/lib/commands/import/curl.js.map +1 -1
- package/lib/commands/import/db2.d.ts +20 -28
- package/lib/commands/import/db2.d.ts.map +1 -1
- package/lib/commands/import/db2.js +59 -62
- package/lib/commands/import/db2.js.map +1 -1
- package/lib/commands/import/flow.d.ts +10 -71
- package/lib/commands/import/flow.d.ts.map +1 -1
- package/lib/commands/import/flow.js +39 -43
- package/lib/commands/import/flow.js.map +1 -1
- package/lib/commands/import/graphql.d.ts +10 -18
- package/lib/commands/import/graphql.d.ts.map +1 -1
- package/lib/commands/import/graphql.js +38 -42
- package/lib/commands/import/graphql.js.map +1 -1
- package/lib/commands/import/index.d.ts +7 -10
- package/lib/commands/import/index.d.ts.map +1 -1
- package/lib/commands/import/index.js +52 -53
- package/lib/commands/import/index.js.map +1 -1
- package/lib/commands/import/mysql.d.ts +14 -22
- package/lib/commands/import/mysql.d.ts.map +1 -1
- package/lib/commands/import/mysql.js +53 -56
- package/lib/commands/import/mysql.js.map +1 -1
- package/lib/commands/import/openapi.d.ts +9 -16
- package/lib/commands/import/openapi.d.ts.map +1 -1
- package/lib/commands/import/openapi.js +38 -41
- package/lib/commands/import/openapi.js.map +1 -1
- package/lib/commands/import/oracle.d.ts +19 -26
- package/lib/commands/import/oracle.d.ts.map +1 -1
- package/lib/commands/import/oracle.js +56 -59
- package/lib/commands/import/oracle.js.map +1 -1
- package/lib/commands/import/postgresql.d.ts +15 -23
- package/lib/commands/import/postgresql.d.ts.map +1 -1
- package/lib/commands/import/postgresql.js +54 -57
- package/lib/commands/import/postgresql.js.map +1 -1
- package/lib/commands/import/presto.d.ts +14 -22
- package/lib/commands/import/presto.d.ts.map +1 -1
- package/lib/commands/import/presto.js +57 -60
- package/lib/commands/import/presto.js.map +1 -1
- package/lib/commands/import/snowflake.d.ts +16 -24
- package/lib/commands/import/snowflake.d.ts.map +1 -1
- package/lib/commands/import/snowflake.js +61 -64
- package/lib/commands/import/snowflake.js.map +1 -1
- package/lib/commands/init.d.ts +5 -7
- package/lib/commands/init.d.ts.map +1 -1
- package/lib/commands/init.js +22 -22
- package/lib/commands/init.js.map +1 -1
- package/lib/commands/lint.d.ts +2 -4
- package/lib/commands/lint.d.ts.map +1 -1
- package/lib/commands/lint.js +15 -18
- package/lib/commands/lint.js.map +1 -1
- package/lib/commands/list.d.ts +4 -6
- package/lib/commands/list.d.ts.map +1 -1
- package/lib/commands/list.js +66 -63
- package/lib/commands/list.js.map +1 -1
- package/lib/commands/login.d.ts +8 -10
- package/lib/commands/login.d.ts.map +1 -1
- package/lib/commands/login.js +94 -92
- package/lib/commands/login.js.map +1 -1
- package/lib/commands/logout.d.ts +2 -3
- package/lib/commands/logout.d.ts.map +1 -1
- package/lib/commands/logout.js +8 -11
- package/lib/commands/logout.js.map +1 -1
- package/lib/commands/request.d.ts +10 -12
- package/lib/commands/request.d.ts.map +1 -1
- package/lib/commands/request.js +127 -129
- package/lib/commands/request.js.map +1 -1
- package/lib/commands/service.d.ts +9 -11
- package/lib/commands/service.d.ts.map +1 -1
- package/lib/commands/service.js +203 -203
- package/lib/commands/service.js.map +1 -1
- package/lib/commands/start.d.ts +13 -15
- package/lib/commands/start.d.ts.map +1 -1
- package/lib/commands/start.js +61 -60
- package/lib/commands/start.js.map +1 -1
- package/lib/commands/transpile.d.ts +8 -10
- package/lib/commands/transpile.d.ts.map +1 -1
- package/lib/commands/transpile.js +31 -34
- package/lib/commands/transpile.js.map +1 -1
- package/lib/commands/upload.d.ts +6 -8
- package/lib/commands/upload.d.ts.map +1 -1
- package/lib/commands/upload.js +41 -44
- package/lib/commands/upload.js.map +1 -1
- package/lib/commands/validate.d.ts +3 -4
- package/lib/commands/validate.d.ts.map +1 -1
- package/lib/commands/validate.js +23 -26
- package/lib/commands/validate.js.map +1 -1
- package/lib/commands/whoami.d.ts +6 -8
- package/lib/commands/whoami.d.ts.map +1 -1
- package/lib/commands/whoami.js +39 -48
- package/lib/commands/whoami.js.map +1 -1
- package/lib/generate/curl2sdl.d.ts +8 -8
- package/lib/generate/curl2sdl.d.ts.map +1 -1
- package/lib/generate/curl2sdl.js +16 -20
- package/lib/generate/curl2sdl.js.map +1 -1
- package/lib/generate/flags.d.ts +11 -11
- package/lib/generate/flags.d.ts.map +1 -1
- package/lib/generate/flags.js +16 -17
- package/lib/generate/flags.js.map +1 -1
- package/lib/generate/flow2sdl.d.ts +5 -5
- package/lib/generate/flow2sdl.d.ts.map +1 -1
- package/lib/generate/flow2sdl.js +13 -19
- package/lib/generate/flow2sdl.js.map +1 -1
- package/lib/generate/graphql2sdl.d.ts +5 -5
- package/lib/generate/graphql2sdl.d.ts.map +1 -1
- package/lib/generate/graphql2sdl.js +22 -28
- package/lib/generate/graphql2sdl.js.map +1 -1
- package/lib/generate/helpers.d.ts +5 -5
- package/lib/generate/helpers.d.ts.map +1 -1
- package/lib/generate/helpers.js +39 -44
- package/lib/generate/helpers.js.map +1 -1
- package/lib/generate/import-command.d.ts +7 -13
- package/lib/generate/import-command.d.ts.map +1 -1
- package/lib/generate/import-command.js +51 -52
- package/lib/generate/import-command.js.map +1 -1
- package/lib/generate/openapi2sdl.d.ts +4 -4
- package/lib/generate/openapi2sdl.d.ts.map +1 -1
- package/lib/generate/openapi2sdl.js +10 -16
- package/lib/generate/openapi2sdl.js.map +1 -1
- package/lib/generate/questions.d.ts.map +1 -1
- package/lib/generate/questions.js +4 -7
- package/lib/generate/questions.js.map +1 -1
- package/lib/generate/sql2sdl.d.ts +13 -13
- package/lib/generate/sql2sdl.d.ts.map +1 -1
- package/lib/generate/sql2sdl.js +13 -16
- package/lib/generate/sql2sdl.js.map +1 -1
- package/lib/hooks/init/version.d.ts +1 -1
- package/lib/hooks/init/version.d.ts.map +1 -1
- package/lib/hooks/init/version.js +11 -9
- package/lib/hooks/init/version.js.map +1 -1
- package/lib/hooks/prerun/check-upgrade.d.ts +1 -1
- package/lib/hooks/prerun/check-upgrade.d.ts.map +1 -1
- package/lib/hooks/prerun/check-upgrade.js +42 -46
- package/lib/hooks/prerun/check-upgrade.js.map +1 -1
- package/lib/hooks/prerun/ensure-config-file.d.ts +1 -1
- package/lib/hooks/prerun/ensure-config-file.d.ts.map +1 -1
- package/lib/hooks/prerun/ensure-config-file.js +9 -11
- package/lib/hooks/prerun/ensure-config-file.js.map +1 -1
- package/lib/hooks/prerun/ensure-permissions.d.ts +1 -1
- package/lib/hooks/prerun/ensure-permissions.d.ts.map +1 -1
- package/lib/hooks/prerun/ensure-permissions.js +15 -11
- package/lib/hooks/prerun/ensure-permissions.js.map +1 -1
- package/lib/index.js +1 -5
- package/lib/index.js.map +1 -1
- package/lib/shared/actions.d.ts +2 -2
- package/lib/shared/actions.d.ts.map +1 -1
- package/lib/shared/actions.js +15 -21
- package/lib/shared/actions.js.map +1 -1
- package/lib/shared/configuration.d.ts +5 -3
- package/lib/shared/configuration.d.ts.map +1 -1
- package/lib/shared/configuration.js +39 -52
- package/lib/shared/configuration.js.map +1 -1
- package/lib/shared/constants.d.ts +7 -4
- package/lib/shared/constants.d.ts.map +1 -1
- package/lib/shared/constants.js +70 -86
- package/lib/shared/constants.js.map +1 -1
- package/lib/shared/curl-parser.d.ts +2 -2
- package/lib/shared/curl-parser.d.ts.map +1 -1
- package/lib/shared/curl-parser.js +9 -13
- package/lib/shared/curl-parser.js.map +1 -1
- package/lib/shared/docker.d.ts +2 -4
- package/lib/shared/docker.d.ts.map +1 -1
- package/lib/shared/docker.js +40 -48
- package/lib/shared/docker.js.map +1 -1
- package/lib/shared/errors.js +7 -11
- package/lib/shared/errors.js.map +1 -1
- package/lib/shared/header-params-parser.d.ts +2 -4
- package/lib/shared/header-params-parser.d.ts.map +1 -1
- package/lib/shared/header-params-parser.js +23 -29
- package/lib/shared/header-params-parser.js.map +1 -1
- package/lib/shared/header.d.ts +7 -7
- package/lib/shared/header.d.ts.map +1 -1
- package/lib/shared/header.js +5 -10
- package/lib/shared/header.js.map +1 -1
- package/lib/shared/inquirer.d.ts +7 -6
- package/lib/shared/inquirer.d.ts.map +1 -1
- package/lib/shared/inquirer.js +29 -37
- package/lib/shared/inquirer.js.map +1 -1
- package/lib/shared/moniker.js +4 -9
- package/lib/shared/moniker.js.map +1 -1
- package/lib/shared/path-params-parser.d.ts +2 -2
- package/lib/shared/path-params-parser.d.ts.map +1 -1
- package/lib/shared/path-params-parser.js +6 -12
- package/lib/shared/path-params-parser.js.map +1 -1
- package/lib/shared/request-variables-parser.d.ts +4 -4
- package/lib/shared/request-variables-parser.d.ts.map +1 -1
- package/lib/shared/request-variables-parser.js +10 -14
- package/lib/shared/request-variables-parser.js.map +1 -1
- package/lib/shared/rmtemp.d.ts +1 -0
- package/lib/shared/rmtemp.d.ts.map +1 -1
- package/lib/shared/rmtemp.js +7 -10
- package/lib/shared/rmtemp.js.map +1 -1
- package/lib/shared/segment.d.ts +10 -0
- package/lib/shared/segment.d.ts.map +1 -0
- package/lib/shared/segment.js +162 -0
- package/lib/shared/segment.js.map +1 -0
- package/lib/shared/stepzen-sdk.d.ts +8 -8
- package/lib/shared/stepzen-sdk.d.ts.map +1 -1
- package/lib/shared/stepzen-sdk.js +27 -36
- package/lib/shared/stepzen-sdk.js.map +1 -1
- package/lib/shared/types.d.ts +13 -11
- package/lib/shared/types.d.ts.map +1 -1
- package/lib/shared/types.js +1 -2
- package/lib/shared/url-helpers.d.ts.map +1 -1
- package/lib/shared/url-helpers.js +7 -14
- package/lib/shared/url-helpers.js.map +1 -1
- package/lib/shared/utils.d.ts +2 -2
- package/lib/shared/utils.d.ts.map +1 -1
- package/lib/shared/utils.js +55 -71
- package/lib/shared/utils.js.map +1 -1
- package/lib/shared/validation.js +12 -17
- package/lib/shared/validation.js.map +1 -1
- package/lib/shared/workspace.d.ts +1 -1
- package/lib/shared/workspace.d.ts.map +1 -1
- package/lib/shared/workspace.js +34 -45
- package/lib/shared/workspace.js.map +1 -1
- package/lib/shared/zen-command.d.ts +5 -10
- package/lib/shared/zen-command.d.ts.map +1 -1
- package/lib/shared/zen-command.js +132 -113
- package/lib/shared/zen-command.js.map +1 -1
- package/oclif.manifest.json +1281 -945
- package/package.json +35 -33
- package/bin/dev +0 -23
package/oclif.manifest.json
CHANGED
|
@@ -1,1850 +1,2186 @@
|
|
|
1
1
|
{
|
|
2
|
-
"version": "0.44.0",
|
|
3
2
|
"commands": {
|
|
4
3
|
"delete": {
|
|
5
|
-
"id": "delete",
|
|
6
|
-
"description": "Delete an endpoint from your StepZen account.",
|
|
7
|
-
"strict": true,
|
|
8
|
-
"pluginName": "stepzen",
|
|
9
|
-
"pluginAlias": "stepzen",
|
|
10
|
-
"pluginType": "core",
|
|
11
4
|
"aliases": [],
|
|
5
|
+
"args": {
|
|
6
|
+
"endpoint": {
|
|
7
|
+
"description": "name of the endpoint (e.g. api/customers)",
|
|
8
|
+
"name": "endpoint",
|
|
9
|
+
"required": true
|
|
10
|
+
}
|
|
11
|
+
},
|
|
12
|
+
"description": "Delete an endpoint from your StepZen account.",
|
|
12
13
|
"flags": {
|
|
13
14
|
"help": {
|
|
14
|
-
"name": "help",
|
|
15
|
-
"type": "boolean",
|
|
16
15
|
"char": "h",
|
|
17
16
|
"description": "Show CLI help",
|
|
18
|
-
"
|
|
17
|
+
"name": "help",
|
|
18
|
+
"allowNo": false,
|
|
19
|
+
"type": "boolean"
|
|
19
20
|
},
|
|
20
21
|
"non-interactive": {
|
|
21
|
-
"name": "non-interactive",
|
|
22
|
-
"type": "boolean",
|
|
23
22
|
"description": "Disable all interactive prompts",
|
|
24
|
-
"
|
|
23
|
+
"name": "non-interactive",
|
|
24
|
+
"allowNo": false,
|
|
25
|
+
"type": "boolean"
|
|
25
26
|
}
|
|
26
27
|
},
|
|
28
|
+
"hasDynamicHelp": false,
|
|
29
|
+
"hiddenAliases": [],
|
|
30
|
+
"id": "delete",
|
|
31
|
+
"pluginAlias": "stepzen",
|
|
32
|
+
"pluginName": "stepzen",
|
|
33
|
+
"pluginType": "core",
|
|
34
|
+
"strict": true,
|
|
35
|
+
"enableJsonFlag": false,
|
|
36
|
+
"isESM": true,
|
|
37
|
+
"relativePath": [
|
|
38
|
+
"lib",
|
|
39
|
+
"commands",
|
|
40
|
+
"delete.js"
|
|
41
|
+
]
|
|
42
|
+
},
|
|
43
|
+
"deploy": {
|
|
44
|
+
"aliases": [],
|
|
27
45
|
"args": {
|
|
28
46
|
"endpoint": {
|
|
47
|
+
"description": "name of the endpoint (e.g. api/customers)\n [default: use the endpoint property from stepzen.config.json]",
|
|
29
48
|
"name": "endpoint",
|
|
30
|
-
"
|
|
31
|
-
"required": true
|
|
49
|
+
"required": false
|
|
32
50
|
}
|
|
33
|
-
}
|
|
34
|
-
},
|
|
35
|
-
"deploy": {
|
|
36
|
-
"id": "deploy",
|
|
51
|
+
},
|
|
37
52
|
"description": "Deploy to StepZen.",
|
|
38
|
-
"strict": true,
|
|
39
|
-
"usage": "deploy [ENDPOINT] [--config=path/to/config.yaml] [--dir=path/to/workspace]\n\n-- OR (deprecated) --\n\n$ stepzen deploy ENDPOINT --schema=schema [--configurationsets=cs1[,cs2[,..]]]",
|
|
40
|
-
"pluginName": "stepzen",
|
|
41
|
-
"pluginAlias": "stepzen",
|
|
42
|
-
"pluginType": "core",
|
|
43
|
-
"aliases": [],
|
|
44
53
|
"flags": {
|
|
45
54
|
"help": {
|
|
46
|
-
"name": "help",
|
|
47
|
-
"type": "boolean",
|
|
48
55
|
"char": "h",
|
|
49
56
|
"description": "Show CLI help",
|
|
50
|
-
"
|
|
57
|
+
"name": "help",
|
|
58
|
+
"allowNo": false,
|
|
59
|
+
"type": "boolean"
|
|
51
60
|
},
|
|
52
61
|
"non-interactive": {
|
|
53
|
-
"name": "non-interactive",
|
|
54
|
-
"type": "boolean",
|
|
55
62
|
"description": "Disable all interactive prompts",
|
|
56
|
-
"
|
|
63
|
+
"name": "non-interactive",
|
|
64
|
+
"allowNo": false,
|
|
65
|
+
"type": "boolean"
|
|
57
66
|
},
|
|
58
67
|
"dir": {
|
|
59
|
-
"name": "dir",
|
|
60
|
-
"type": "option",
|
|
61
68
|
"description": "Working directory",
|
|
62
|
-
"
|
|
69
|
+
"name": "dir",
|
|
70
|
+
"hasDynamicHelp": false,
|
|
71
|
+
"multiple": false,
|
|
72
|
+
"type": "option"
|
|
63
73
|
},
|
|
64
74
|
"silent": {
|
|
65
75
|
"name": "silent",
|
|
66
|
-
"
|
|
67
|
-
"
|
|
76
|
+
"allowNo": false,
|
|
77
|
+
"type": "boolean"
|
|
68
78
|
},
|
|
69
79
|
"configurationsets": {
|
|
70
|
-
"name": "configurationsets",
|
|
71
|
-
"type": "option",
|
|
72
80
|
"description": "\n Name(s) of configuration sets uploaded earlier with stepzen upload\n [DEPRECATED: this flag will be removed in future versions]\n \n Instead, please use one of these options:\n - stepzen deploy (without the --configurationsets flag)\n \tto use the configuration from the config.yaml file in the current directory (if exists)\n - stepzen deploy --config path/to/config.yaml\n \tto explicitly specify the configuration file",
|
|
73
|
-
"multiple": false,
|
|
74
81
|
"exclusive": [
|
|
75
82
|
"config",
|
|
76
83
|
"dir"
|
|
77
|
-
]
|
|
84
|
+
],
|
|
85
|
+
"name": "configurationsets",
|
|
86
|
+
"hasDynamicHelp": false,
|
|
87
|
+
"multiple": false,
|
|
88
|
+
"type": "option"
|
|
78
89
|
},
|
|
79
90
|
"config": {
|
|
80
|
-
"name": "config",
|
|
81
|
-
"type": "option",
|
|
82
91
|
"description": "[default: config.yaml] Configuration file to use (relative to the current directory)",
|
|
92
|
+
"name": "config",
|
|
93
|
+
"hasDynamicHelp": false,
|
|
83
94
|
"helpValue": "path/to/config.yaml",
|
|
84
|
-
"multiple": false
|
|
95
|
+
"multiple": false,
|
|
96
|
+
"type": "option"
|
|
85
97
|
},
|
|
86
98
|
"schema": {
|
|
87
|
-
"name": "schema",
|
|
88
|
-
"type": "option",
|
|
89
99
|
"description": "\n Name of a schema uploaded earlier with stepzen upload\n [DEPRECATED: this flag will be removed in future versions]\n \n Instead, please use one of these options:\n - stepzen deploy (without the --schema flag)\n \tto deploy the schema from a StepZen workspace in your current directory\n - stepzen deploy --dir path/to/workspace\n \tto deploy from a StepZen workspace in another folder",
|
|
90
|
-
"multiple": false,
|
|
91
100
|
"exclusive": [
|
|
92
101
|
"config",
|
|
93
102
|
"dir"
|
|
94
|
-
]
|
|
103
|
+
],
|
|
104
|
+
"name": "schema",
|
|
105
|
+
"hasDynamicHelp": false,
|
|
106
|
+
"multiple": false,
|
|
107
|
+
"type": "option"
|
|
95
108
|
}
|
|
96
109
|
},
|
|
97
|
-
"
|
|
98
|
-
|
|
99
|
-
|
|
100
|
-
"description": "name of the endpoint (e.g. api/customers)\n [default: use the endpoint property from stepzen.config.json]",
|
|
101
|
-
"required": false
|
|
102
|
-
}
|
|
103
|
-
}
|
|
104
|
-
},
|
|
105
|
-
"init": {
|
|
106
|
-
"id": "init",
|
|
107
|
-
"description": "Initialize a StepZen workspace in the current directory.",
|
|
108
|
-
"strict": true,
|
|
109
|
-
"pluginName": "stepzen",
|
|
110
|
+
"hasDynamicHelp": false,
|
|
111
|
+
"hiddenAliases": [],
|
|
112
|
+
"id": "deploy",
|
|
110
113
|
"pluginAlias": "stepzen",
|
|
114
|
+
"pluginName": "stepzen",
|
|
111
115
|
"pluginType": "core",
|
|
116
|
+
"strict": true,
|
|
117
|
+
"usage": "deploy [ENDPOINT] [--config=path/to/config.yaml] [--dir=path/to/workspace]\n\n-- OR (deprecated) --\n\n$ stepzen deploy ENDPOINT --schema=schema [--configurationsets=cs1[,cs2[,..]]]",
|
|
118
|
+
"enableJsonFlag": false,
|
|
119
|
+
"isESM": true,
|
|
120
|
+
"relativePath": [
|
|
121
|
+
"lib",
|
|
122
|
+
"commands",
|
|
123
|
+
"deploy.js"
|
|
124
|
+
]
|
|
125
|
+
},
|
|
126
|
+
"init": {
|
|
112
127
|
"aliases": [],
|
|
128
|
+
"args": {
|
|
129
|
+
"directory": {
|
|
130
|
+
"hidden": true,
|
|
131
|
+
"name": "directory"
|
|
132
|
+
}
|
|
133
|
+
},
|
|
134
|
+
"description": "Initialize a StepZen workspace in the current directory.",
|
|
113
135
|
"flags": {
|
|
114
136
|
"help": {
|
|
115
|
-
"name": "help",
|
|
116
|
-
"type": "boolean",
|
|
117
137
|
"char": "h",
|
|
118
138
|
"description": "Show CLI help",
|
|
119
|
-
"
|
|
139
|
+
"name": "help",
|
|
140
|
+
"allowNo": false,
|
|
141
|
+
"type": "boolean"
|
|
120
142
|
},
|
|
121
143
|
"non-interactive": {
|
|
122
|
-
"name": "non-interactive",
|
|
123
|
-
"type": "boolean",
|
|
124
144
|
"description": "Disable all interactive prompts",
|
|
125
|
-
"
|
|
145
|
+
"name": "non-interactive",
|
|
146
|
+
"allowNo": false,
|
|
147
|
+
"type": "boolean"
|
|
126
148
|
},
|
|
127
149
|
"endpoint": {
|
|
128
|
-
"name": "endpoint",
|
|
129
|
-
"type": "option",
|
|
130
150
|
"description": "Endpoint name (e.g. api/myapp)",
|
|
131
|
-
"
|
|
151
|
+
"name": "endpoint",
|
|
152
|
+
"hasDynamicHelp": false,
|
|
153
|
+
"multiple": false,
|
|
154
|
+
"type": "option"
|
|
132
155
|
},
|
|
133
156
|
"yes": {
|
|
134
|
-
"name": "yes",
|
|
135
|
-
"type": "boolean",
|
|
136
157
|
"description": "Accept default answers to interactive prompts",
|
|
137
|
-
"
|
|
158
|
+
"name": "yes",
|
|
159
|
+
"allowNo": false,
|
|
160
|
+
"type": "boolean"
|
|
138
161
|
}
|
|
139
162
|
},
|
|
140
|
-
"
|
|
141
|
-
|
|
142
|
-
|
|
143
|
-
"hidden": true
|
|
144
|
-
}
|
|
145
|
-
}
|
|
146
|
-
},
|
|
147
|
-
"lint": {
|
|
148
|
-
"id": "lint",
|
|
149
|
-
"description": "StepZen lint.",
|
|
150
|
-
"strict": true,
|
|
151
|
-
"pluginName": "stepzen",
|
|
163
|
+
"hasDynamicHelp": false,
|
|
164
|
+
"hiddenAliases": [],
|
|
165
|
+
"id": "init",
|
|
152
166
|
"pluginAlias": "stepzen",
|
|
167
|
+
"pluginName": "stepzen",
|
|
153
168
|
"pluginType": "core",
|
|
154
|
-
"
|
|
169
|
+
"strict": true,
|
|
170
|
+
"enableJsonFlag": false,
|
|
171
|
+
"isESM": true,
|
|
172
|
+
"relativePath": [
|
|
173
|
+
"lib",
|
|
174
|
+
"commands",
|
|
175
|
+
"init.js"
|
|
176
|
+
]
|
|
177
|
+
},
|
|
178
|
+
"lint": {
|
|
155
179
|
"aliases": [],
|
|
180
|
+
"args": {},
|
|
181
|
+
"description": "StepZen lint.",
|
|
156
182
|
"flags": {
|
|
157
183
|
"help": {
|
|
158
|
-
"name": "help",
|
|
159
|
-
"type": "boolean",
|
|
160
184
|
"char": "h",
|
|
161
185
|
"description": "Show CLI help",
|
|
162
|
-
"
|
|
186
|
+
"name": "help",
|
|
187
|
+
"allowNo": false,
|
|
188
|
+
"type": "boolean"
|
|
163
189
|
},
|
|
164
190
|
"non-interactive": {
|
|
165
|
-
"name": "non-interactive",
|
|
166
|
-
"type": "boolean",
|
|
167
191
|
"description": "Disable all interactive prompts",
|
|
168
|
-
"
|
|
192
|
+
"name": "non-interactive",
|
|
193
|
+
"allowNo": false,
|
|
194
|
+
"type": "boolean"
|
|
169
195
|
},
|
|
170
196
|
"dir": {
|
|
171
|
-
"name": "dir",
|
|
172
|
-
"type": "option",
|
|
173
197
|
"hidden": true,
|
|
174
|
-
"
|
|
198
|
+
"name": "dir",
|
|
199
|
+
"hasDynamicHelp": false,
|
|
200
|
+
"multiple": false,
|
|
201
|
+
"type": "option"
|
|
175
202
|
}
|
|
176
203
|
},
|
|
177
|
-
"
|
|
178
|
-
|
|
179
|
-
|
|
180
|
-
"id": "
|
|
181
|
-
"description": "List endpoints, schemas and configuration sets in your StepZen account.\nAll timestamps displayed by stepzen list endpoints are in your local time zone.",
|
|
182
|
-
"strict": true,
|
|
183
|
-
"pluginName": "stepzen",
|
|
204
|
+
"hasDynamicHelp": false,
|
|
205
|
+
"hidden": true,
|
|
206
|
+
"hiddenAliases": [],
|
|
207
|
+
"id": "lint",
|
|
184
208
|
"pluginAlias": "stepzen",
|
|
209
|
+
"pluginName": "stepzen",
|
|
185
210
|
"pluginType": "core",
|
|
211
|
+
"strict": true,
|
|
212
|
+
"enableJsonFlag": false,
|
|
213
|
+
"isESM": true,
|
|
214
|
+
"relativePath": [
|
|
215
|
+
"lib",
|
|
216
|
+
"commands",
|
|
217
|
+
"lint.js"
|
|
218
|
+
]
|
|
219
|
+
},
|
|
220
|
+
"list": {
|
|
186
221
|
"aliases": [],
|
|
222
|
+
"args": {
|
|
223
|
+
"type": {
|
|
224
|
+
"default": "endpoints",
|
|
225
|
+
"description": "\n \n The type of entities to list:\n \tendpoints - GraphQL API endpoints deployed with stepzen deploy (or stepzen start)\n \tschemas [DEPRECATED] - StepZen schemas uploaded with stepzen upload (or stepzen start)\n \tconfigurationsets [DEPRECATED] - StepZen configuration sets uploaded with stepzen upload (or stepzen start)",
|
|
226
|
+
"name": "type",
|
|
227
|
+
"options": [
|
|
228
|
+
"endpoints",
|
|
229
|
+
"configurationsets",
|
|
230
|
+
"schemas"
|
|
231
|
+
]
|
|
232
|
+
}
|
|
233
|
+
},
|
|
234
|
+
"description": "List endpoints, schemas and configuration sets in your StepZen account.\nAll timestamps displayed by stepzen list endpoints are in your local time zone.",
|
|
187
235
|
"flags": {
|
|
188
236
|
"help": {
|
|
189
|
-
"name": "help",
|
|
190
|
-
"type": "boolean",
|
|
191
237
|
"char": "h",
|
|
192
238
|
"description": "Show CLI help",
|
|
193
|
-
"
|
|
239
|
+
"name": "help",
|
|
240
|
+
"allowNo": false,
|
|
241
|
+
"type": "boolean"
|
|
194
242
|
},
|
|
195
243
|
"non-interactive": {
|
|
196
|
-
"name": "non-interactive",
|
|
197
|
-
"type": "boolean",
|
|
198
244
|
"description": "Disable all interactive prompts",
|
|
199
|
-
"
|
|
245
|
+
"name": "non-interactive",
|
|
246
|
+
"allowNo": false,
|
|
247
|
+
"type": "boolean"
|
|
200
248
|
},
|
|
201
249
|
"folder": {
|
|
202
|
-
"name": "folder",
|
|
203
|
-
"type": "option",
|
|
204
250
|
"description": "Filter the list to only show endpoints within a specific folder. example usage --folder folder_name or --folder !folder_name",
|
|
205
|
-
"
|
|
251
|
+
"name": "folder",
|
|
252
|
+
"hasDynamicHelp": false,
|
|
253
|
+
"multiple": false,
|
|
254
|
+
"type": "option"
|
|
206
255
|
},
|
|
207
256
|
"name": {
|
|
208
|
-
"name": "name",
|
|
209
|
-
"type": "option",
|
|
210
257
|
"description": "Filter the list to only show endpoints with a specific name. example usage --name endpoint_name or --name '!endpoint_name'",
|
|
211
|
-
"
|
|
258
|
+
"name": "name",
|
|
259
|
+
"hasDynamicHelp": false,
|
|
260
|
+
"multiple": false,
|
|
261
|
+
"type": "option"
|
|
212
262
|
}
|
|
213
263
|
},
|
|
214
|
-
"
|
|
215
|
-
|
|
216
|
-
|
|
217
|
-
"description": "\n \n The type of entities to list:\n \tendpoints - GraphQL API endpoints deployed with stepzen deploy (or stepzen start)\n \tschemas [DEPRECATED] - StepZen schemas uploaded with stepzen upload (or stepzen start)\n \tconfigurationsets [DEPRECATED] - StepZen configuration sets uploaded with stepzen upload (or stepzen start)",
|
|
218
|
-
"options": [
|
|
219
|
-
"endpoints",
|
|
220
|
-
"configurationsets",
|
|
221
|
-
"schemas"
|
|
222
|
-
],
|
|
223
|
-
"default": "endpoints"
|
|
224
|
-
}
|
|
225
|
-
}
|
|
226
|
-
},
|
|
227
|
-
"login": {
|
|
228
|
-
"id": "login",
|
|
229
|
-
"description": "Log in to StepZen.",
|
|
230
|
-
"strict": true,
|
|
231
|
-
"pluginName": "stepzen",
|
|
264
|
+
"hasDynamicHelp": false,
|
|
265
|
+
"hiddenAliases": [],
|
|
266
|
+
"id": "list",
|
|
232
267
|
"pluginAlias": "stepzen",
|
|
268
|
+
"pluginName": "stepzen",
|
|
233
269
|
"pluginType": "core",
|
|
270
|
+
"strict": true,
|
|
271
|
+
"enableJsonFlag": false,
|
|
272
|
+
"isESM": true,
|
|
273
|
+
"relativePath": [
|
|
274
|
+
"lib",
|
|
275
|
+
"commands",
|
|
276
|
+
"list.js"
|
|
277
|
+
]
|
|
278
|
+
},
|
|
279
|
+
"login": {
|
|
234
280
|
"aliases": [],
|
|
281
|
+
"args": {
|
|
282
|
+
"domain": {
|
|
283
|
+
"description": "Domain of the StepZen service to login to (e.g. us-east-a.ibm.stepzen.net or eu-central-a.ibm.stepzen.net). If no domain is provided, stepzen.net is used by default. Check you domain from the StepZen Dashboard.",
|
|
284
|
+
"name": "domain",
|
|
285
|
+
"required": false
|
|
286
|
+
}
|
|
287
|
+
},
|
|
288
|
+
"description": "Log in to StepZen.",
|
|
235
289
|
"flags": {
|
|
236
290
|
"help": {
|
|
237
|
-
"name": "help",
|
|
238
|
-
"type": "boolean",
|
|
239
291
|
"char": "h",
|
|
240
292
|
"description": "Show CLI help",
|
|
241
|
-
"
|
|
293
|
+
"name": "help",
|
|
294
|
+
"allowNo": false,
|
|
295
|
+
"type": "boolean"
|
|
242
296
|
},
|
|
243
297
|
"non-interactive": {
|
|
244
|
-
"name": "non-interactive",
|
|
245
|
-
"type": "boolean",
|
|
246
298
|
"description": "Disable all interactive prompts",
|
|
247
|
-
"
|
|
299
|
+
"name": "non-interactive",
|
|
300
|
+
"allowNo": false,
|
|
301
|
+
"type": "boolean"
|
|
248
302
|
},
|
|
249
303
|
"account": {
|
|
250
|
-
"name": "account",
|
|
251
|
-
"type": "option",
|
|
252
304
|
"char": "a",
|
|
253
305
|
"description": "StepZen account name (copy from https://stepzen.com/account). If not provided, the CLI prompts the users to enter one.",
|
|
254
|
-
"multiple": false,
|
|
255
306
|
"exclusive": [
|
|
256
307
|
"config",
|
|
257
308
|
"public"
|
|
258
|
-
]
|
|
309
|
+
],
|
|
310
|
+
"name": "account",
|
|
311
|
+
"hasDynamicHelp": false,
|
|
312
|
+
"multiple": false,
|
|
313
|
+
"type": "option"
|
|
259
314
|
},
|
|
260
315
|
"adminkey": {
|
|
261
|
-
"name": "adminkey",
|
|
262
|
-
"type": "option",
|
|
263
316
|
"char": "k",
|
|
264
317
|
"description": "Admin key (copy from https://stepzen.com/account) If not provided, the CLI prompts the users to enter one.",
|
|
265
|
-
"multiple": false,
|
|
266
318
|
"exclusive": [
|
|
267
319
|
"config",
|
|
268
320
|
"public"
|
|
269
|
-
]
|
|
321
|
+
],
|
|
322
|
+
"name": "adminkey",
|
|
323
|
+
"hasDynamicHelp": false,
|
|
324
|
+
"multiple": false,
|
|
325
|
+
"type": "option"
|
|
270
326
|
},
|
|
271
327
|
"public": {
|
|
272
|
-
"name": "public",
|
|
273
|
-
"type": "boolean",
|
|
274
328
|
"description": "Create a public anonymous StepZen account and use it. This is handy for trying StepZen out, but it not suitable for handling private data as all endpoints created with a public account will be public.",
|
|
275
|
-
"allowNo": false,
|
|
276
329
|
"exclusive": [
|
|
277
330
|
"config",
|
|
278
331
|
"account",
|
|
279
332
|
"adminkey"
|
|
280
|
-
]
|
|
333
|
+
],
|
|
334
|
+
"name": "public",
|
|
335
|
+
"allowNo": false,
|
|
336
|
+
"type": "boolean"
|
|
281
337
|
},
|
|
282
338
|
"introspection": {
|
|
283
|
-
"name": "introspection",
|
|
284
|
-
"type": "option",
|
|
285
339
|
"description": "Override the default StepZen introspection service URL for all stepzen import commands. If not provided, use the default introspection URL.\n\nExample:\nstepzen login --introspection stepzen-introspection.mydomain.com",
|
|
286
|
-
"
|
|
340
|
+
"name": "introspection",
|
|
341
|
+
"hasDynamicHelp": false,
|
|
342
|
+
"multiple": false,
|
|
343
|
+
"type": "option"
|
|
287
344
|
},
|
|
288
345
|
"config": {
|
|
289
|
-
"name": "config",
|
|
290
|
-
"type": "option",
|
|
291
|
-
"hidden": true,
|
|
292
|
-
"multiple": false,
|
|
293
346
|
"exclusive": [
|
|
294
347
|
"account",
|
|
295
348
|
"adminkey",
|
|
296
349
|
"public"
|
|
297
|
-
]
|
|
350
|
+
],
|
|
351
|
+
"hidden": true,
|
|
352
|
+
"name": "config",
|
|
353
|
+
"hasDynamicHelp": false,
|
|
354
|
+
"multiple": false,
|
|
355
|
+
"type": "option"
|
|
298
356
|
}
|
|
299
357
|
},
|
|
300
|
-
"
|
|
301
|
-
|
|
302
|
-
|
|
303
|
-
"description": "Domain of the StepZen service to login to (e.g. us-east-a.ibm.stepzen.net or eu-central-a.ibm.stepzen.net). If no domain is provided, stepzen.net is used by default. Check you domain from the StepZen Dashboard.",
|
|
304
|
-
"required": false
|
|
305
|
-
}
|
|
306
|
-
}
|
|
307
|
-
},
|
|
308
|
-
"logout": {
|
|
309
|
-
"id": "logout",
|
|
310
|
-
"description": "Log out of StepZen.",
|
|
311
|
-
"strict": true,
|
|
312
|
-
"pluginName": "stepzen",
|
|
358
|
+
"hasDynamicHelp": false,
|
|
359
|
+
"hiddenAliases": [],
|
|
360
|
+
"id": "login",
|
|
313
361
|
"pluginAlias": "stepzen",
|
|
362
|
+
"pluginName": "stepzen",
|
|
314
363
|
"pluginType": "core",
|
|
364
|
+
"strict": true,
|
|
365
|
+
"enableJsonFlag": false,
|
|
366
|
+
"isESM": true,
|
|
367
|
+
"relativePath": [
|
|
368
|
+
"lib",
|
|
369
|
+
"commands",
|
|
370
|
+
"login.js"
|
|
371
|
+
]
|
|
372
|
+
},
|
|
373
|
+
"logout": {
|
|
315
374
|
"aliases": [],
|
|
375
|
+
"args": {},
|
|
376
|
+
"description": "Log out of StepZen.",
|
|
316
377
|
"flags": {
|
|
317
378
|
"help": {
|
|
318
|
-
"name": "help",
|
|
319
|
-
"type": "boolean",
|
|
320
379
|
"char": "h",
|
|
321
380
|
"description": "Show CLI help",
|
|
322
|
-
"
|
|
381
|
+
"name": "help",
|
|
382
|
+
"allowNo": false,
|
|
383
|
+
"type": "boolean"
|
|
323
384
|
},
|
|
324
385
|
"non-interactive": {
|
|
325
|
-
"name": "non-interactive",
|
|
326
|
-
"type": "boolean",
|
|
327
386
|
"description": "Disable all interactive prompts",
|
|
328
|
-
"
|
|
387
|
+
"name": "non-interactive",
|
|
388
|
+
"allowNo": false,
|
|
389
|
+
"type": "boolean"
|
|
329
390
|
}
|
|
330
391
|
},
|
|
331
|
-
"
|
|
332
|
-
|
|
333
|
-
|
|
334
|
-
"id": "request",
|
|
335
|
-
"description": "Send a GraphQL request to a StepZen endpoint and print the response, using the API key and the target endpoint from the current StepZen workspace.",
|
|
336
|
-
"strict": true,
|
|
337
|
-
"pluginName": "stepzen",
|
|
392
|
+
"hasDynamicHelp": false,
|
|
393
|
+
"hiddenAliases": [],
|
|
394
|
+
"id": "logout",
|
|
338
395
|
"pluginAlias": "stepzen",
|
|
396
|
+
"pluginName": "stepzen",
|
|
339
397
|
"pluginType": "core",
|
|
398
|
+
"strict": true,
|
|
399
|
+
"enableJsonFlag": false,
|
|
400
|
+
"isESM": true,
|
|
401
|
+
"relativePath": [
|
|
402
|
+
"lib",
|
|
403
|
+
"commands",
|
|
404
|
+
"logout.js"
|
|
405
|
+
]
|
|
406
|
+
},
|
|
407
|
+
"request": {
|
|
340
408
|
"aliases": [],
|
|
409
|
+
"args": {
|
|
410
|
+
"query": {
|
|
411
|
+
"description": "GraphQL query (could include a query, a mutation or a subscription).\nThis argument is required unless you provide the query as a file with --file=file.",
|
|
412
|
+
"name": "query"
|
|
413
|
+
}
|
|
414
|
+
},
|
|
415
|
+
"description": "Send a GraphQL request to a StepZen endpoint and print the response, using the API key and the target endpoint from the current StepZen workspace.",
|
|
341
416
|
"flags": {
|
|
342
417
|
"help": {
|
|
343
|
-
"name": "help",
|
|
344
|
-
"type": "boolean",
|
|
345
418
|
"char": "h",
|
|
346
419
|
"description": "Show CLI help",
|
|
347
|
-
"
|
|
420
|
+
"name": "help",
|
|
421
|
+
"allowNo": false,
|
|
422
|
+
"type": "boolean"
|
|
348
423
|
},
|
|
349
424
|
"non-interactive": {
|
|
350
|
-
"name": "non-interactive",
|
|
351
|
-
"type": "boolean",
|
|
352
425
|
"description": "Disable all interactive prompts",
|
|
353
|
-
"
|
|
426
|
+
"name": "non-interactive",
|
|
427
|
+
"allowNo": false,
|
|
428
|
+
"type": "boolean"
|
|
354
429
|
},
|
|
355
430
|
"dir": {
|
|
356
|
-
"name": "dir",
|
|
357
|
-
"type": "option",
|
|
358
431
|
"description": "StepZen workspace directory (defaults to the current directory)",
|
|
359
|
-
"multiple": false,
|
|
360
432
|
"exclusive": [
|
|
361
433
|
"endpoint"
|
|
362
|
-
]
|
|
434
|
+
],
|
|
435
|
+
"name": "dir",
|
|
436
|
+
"hasDynamicHelp": false,
|
|
437
|
+
"multiple": false,
|
|
438
|
+
"type": "option"
|
|
363
439
|
},
|
|
364
440
|
"endpoint": {
|
|
365
|
-
"name": "endpoint",
|
|
366
|
-
"type": "option",
|
|
367
441
|
"description": "StepZen endpoint to call (defaults to the endpoint in current StepZen workspace)",
|
|
368
|
-
"multiple": false,
|
|
369
442
|
"exclusive": [
|
|
370
443
|
"dir"
|
|
371
|
-
]
|
|
444
|
+
],
|
|
445
|
+
"name": "endpoint",
|
|
446
|
+
"hasDynamicHelp": false,
|
|
447
|
+
"multiple": false,
|
|
448
|
+
"type": "option"
|
|
372
449
|
},
|
|
373
450
|
"header": {
|
|
374
|
-
"name": "header",
|
|
375
|
-
"type": "option",
|
|
376
451
|
"char": "H",
|
|
377
452
|
"description": "Add an additional HTTP header to the request. This is useful for schemas where @rest or @graphql directives enable header forwarding with forwardheaders.\n\nExample:\nstepzen request '{ user(id: \"u123\") { email } }' \\\n\t-H \"X-API-Token: SecretAPIToken\"\n\nUse the -H \"Header-Name:\" syntax to drop a default header, and the -H \"Header-Name;\" syntax to send a header with an empty value.",
|
|
378
|
-
"
|
|
453
|
+
"name": "header",
|
|
454
|
+
"hasDynamicHelp": false,
|
|
455
|
+
"multiple": true,
|
|
456
|
+
"type": "option"
|
|
379
457
|
},
|
|
380
458
|
"operation-name": {
|
|
381
|
-
"name": "operation-name",
|
|
382
|
-
"type": "option",
|
|
383
459
|
"description": "Specify the operation name (in case if the provided query includes multiple operations)",
|
|
384
|
-
"
|
|
460
|
+
"name": "operation-name",
|
|
461
|
+
"hasDynamicHelp": false,
|
|
462
|
+
"multiple": false,
|
|
463
|
+
"type": "option"
|
|
385
464
|
},
|
|
386
465
|
"var": {
|
|
387
|
-
"name": "var",
|
|
388
|
-
"type": "option",
|
|
389
466
|
"description": "Add a request variable, in the name=value format.\n\nExample:\nstepzen request 'query OrdersQuery($search: String!, $limit: Int) {\n\t\torders(search: $search, limit: $limit) { id createdAt }\n\t}' \\\n\t--var 'search=space ninja' \\\n\t--var limit=5",
|
|
390
|
-
"
|
|
467
|
+
"name": "var",
|
|
468
|
+
"hasDynamicHelp": false,
|
|
469
|
+
"multiple": true,
|
|
470
|
+
"type": "option"
|
|
391
471
|
},
|
|
392
472
|
"var-file": {
|
|
393
|
-
"name": "var-file",
|
|
394
|
-
"type": "option",
|
|
395
473
|
"description": "Read request variables from a JSON file. In case when the same variable value is provided both via --var-file and --var, the priority is given to the latter.\n\nExample:\nstepzen request 'query OrdersQuery($search: String!, $limit: Int) {\n\t\torders(search: $search, limit: $limit) { id createdAt }\n\t}' \\\n\t--var-file ./vars.json",
|
|
396
|
-
"
|
|
474
|
+
"name": "var-file",
|
|
475
|
+
"hasDynamicHelp": false,
|
|
476
|
+
"multiple": false,
|
|
477
|
+
"type": "option"
|
|
397
478
|
},
|
|
398
479
|
"file": {
|
|
399
|
-
"name": "file",
|
|
400
|
-
"type": "option",
|
|
401
480
|
"char": "f",
|
|
402
481
|
"description": "Read the query text from a file instead of the command line.\n\nExample:\nstepzen request -f query.graphql",
|
|
403
|
-
"
|
|
482
|
+
"name": "file",
|
|
483
|
+
"hasDynamicHelp": false,
|
|
484
|
+
"multiple": false,
|
|
485
|
+
"type": "option"
|
|
404
486
|
}
|
|
405
487
|
},
|
|
406
|
-
"
|
|
407
|
-
|
|
408
|
-
|
|
409
|
-
"description": "GraphQL query (could include a query, a mutation or a subscription).\nThis argument is required unless you provide the query as a file with --file=file."
|
|
410
|
-
}
|
|
411
|
-
}
|
|
412
|
-
},
|
|
413
|
-
"service": {
|
|
414
|
-
"id": "service",
|
|
415
|
-
"description": "Manage the local StepZen service instance (requires Docker).\nYou can use a local StepZen service instance instead of the StepZen cloud to develop and test GraphQL endpoints locally. This way you can try StepZen out without giving the StepZen cloud access to your data sources and API endpoints.\n\nLocal StepZen service instances are not suitable for production use. Please refer to the documentation at https://stepzen.com/docs/deployment/local-docker for more information and examples.",
|
|
416
|
-
"strict": true,
|
|
417
|
-
"pluginName": "stepzen",
|
|
488
|
+
"hasDynamicHelp": false,
|
|
489
|
+
"hiddenAliases": [],
|
|
490
|
+
"id": "request",
|
|
418
491
|
"pluginAlias": "stepzen",
|
|
492
|
+
"pluginName": "stepzen",
|
|
419
493
|
"pluginType": "core",
|
|
494
|
+
"strict": true,
|
|
495
|
+
"enableJsonFlag": false,
|
|
496
|
+
"isESM": true,
|
|
497
|
+
"relativePath": [
|
|
498
|
+
"lib",
|
|
499
|
+
"commands",
|
|
500
|
+
"request.js"
|
|
501
|
+
]
|
|
502
|
+
},
|
|
503
|
+
"service": {
|
|
420
504
|
"aliases": [],
|
|
505
|
+
"args": {
|
|
506
|
+
"action": {
|
|
507
|
+
"description": "\n \tstart\tstart a local StepZen service instance in a Docker container\n \t\tThis command pulls the latest StepZen service instance Docker image so that the\n \t\tversion of StepZen you run locally is the same as the one running on\n \t\tstepzen.net.\n \n \tstop\tstop the local StepZen service instance (if running)\n \t\tThis command deletes the Docker container with the StepZen service instance,\n \t\tbut all your endpoints are persistently stored in the metadata database. They\n \t\tremain available when running stepzen service start next time.\n \n \tupgrade\tupgrade the local StepZen service instance if it is running\n \t\tThis command checks if a newer version of the StepZen service instance Docker\n \t\timage is available, and if it is then stops and deletes the currently running\n \t\tcontainer, pulls the latest image, and starts it. All endpoints are preserved.\n\n If no action is provided, print the service status and exit.",
|
|
508
|
+
"name": "action",
|
|
509
|
+
"options": [
|
|
510
|
+
"start",
|
|
511
|
+
"stop",
|
|
512
|
+
"upgrade"
|
|
513
|
+
],
|
|
514
|
+
"required": false
|
|
515
|
+
}
|
|
516
|
+
},
|
|
517
|
+
"description": "Manage the local StepZen service instance (requires Docker).\nYou can use a local StepZen service instance instead of the StepZen cloud to develop and test GraphQL endpoints locally. This way you can try StepZen out without giving the StepZen cloud access to your data sources and API endpoints.\n\nLocal StepZen service instances are not suitable for production use. Please refer to the documentation at https://stepzen.com/docs/deployment/local-docker for more information and examples.",
|
|
421
518
|
"flags": {
|
|
422
519
|
"help": {
|
|
423
|
-
"name": "help",
|
|
424
|
-
"type": "boolean",
|
|
425
520
|
"char": "h",
|
|
426
521
|
"description": "Show CLI help",
|
|
427
|
-
"
|
|
522
|
+
"name": "help",
|
|
523
|
+
"allowNo": false,
|
|
524
|
+
"type": "boolean"
|
|
428
525
|
},
|
|
429
526
|
"non-interactive": {
|
|
430
|
-
"name": "non-interactive",
|
|
431
|
-
"type": "boolean",
|
|
432
527
|
"description": "Disable all interactive prompts",
|
|
433
|
-
"
|
|
528
|
+
"name": "non-interactive",
|
|
529
|
+
"allowNo": false,
|
|
530
|
+
"type": "boolean"
|
|
434
531
|
},
|
|
435
532
|
"dsn": {
|
|
436
|
-
"name": "dsn",
|
|
437
|
-
"type": "option",
|
|
438
533
|
"description": "DSN of a StepZen metadata database, e.g. postgres://user:password@172.17.0.1:5432/zenctl",
|
|
439
|
-
"multiple": false,
|
|
440
534
|
"exclusive": [
|
|
441
535
|
"reset-auto",
|
|
442
536
|
"prompt"
|
|
443
|
-
]
|
|
537
|
+
],
|
|
538
|
+
"name": "dsn",
|
|
539
|
+
"hasDynamicHelp": false,
|
|
540
|
+
"multiple": false,
|
|
541
|
+
"type": "option"
|
|
444
542
|
},
|
|
445
543
|
"reset-auto": {
|
|
446
|
-
"name": "reset-auto",
|
|
447
|
-
"type": "boolean",
|
|
448
544
|
"description": "Create fresh empty metadata database. Note: all existing endpoints will be deleted and you will be logged out.",
|
|
449
|
-
"allowNo": false,
|
|
450
545
|
"exclusive": [
|
|
451
546
|
"dsn",
|
|
452
547
|
"prompt"
|
|
453
|
-
]
|
|
548
|
+
],
|
|
549
|
+
"name": "reset-auto",
|
|
550
|
+
"allowNo": false,
|
|
551
|
+
"type": "boolean"
|
|
454
552
|
},
|
|
455
553
|
"prompt": {
|
|
456
|
-
"name": "prompt",
|
|
457
|
-
"type": "boolean",
|
|
458
554
|
"description": "Opens an interactive prompt to ask for database details (or fails, if running in a non-interactive mode).",
|
|
459
|
-
"allowNo": false,
|
|
460
555
|
"exclusive": [
|
|
461
556
|
"dsn",
|
|
462
557
|
"non-interactive"
|
|
463
|
-
]
|
|
558
|
+
],
|
|
559
|
+
"name": "prompt",
|
|
560
|
+
"allowNo": false,
|
|
561
|
+
"type": "boolean"
|
|
464
562
|
},
|
|
465
563
|
"port": {
|
|
466
|
-
"name": "port",
|
|
467
|
-
"type": "option",
|
|
468
564
|
"description": "Override the TCP port on which the local StepZen service instance will listen for connections (port 9000 by default).",
|
|
469
|
-
"
|
|
565
|
+
"name": "port",
|
|
566
|
+
"hasDynamicHelp": false,
|
|
567
|
+
"multiple": false,
|
|
568
|
+
"type": "option"
|
|
470
569
|
}
|
|
471
570
|
},
|
|
472
|
-
"
|
|
473
|
-
|
|
474
|
-
|
|
475
|
-
"description": "\n \tstart\tstart a local StepZen service instance in a Docker container\n \t\tThis command pulls the latest StepZen service instance Docker image so that the\n \t\tversion of StepZen you run locally is the same as the one running on\n \t\tstepzen.net.\n \n \tstop\tstop the local StepZen service instance (if running)\n \t\tThis command deletes the Docker container with the StepZen service instance,\n \t\tbut all your endpoints are persistently stored in the metadata database. They\n \t\tremain available when running stepzen service start next time.\n \n \tupgrade\tupgrade the local StepZen service instance if it is running\n \t\tThis command checks if a newer version of the StepZen service instance Docker\n \t\timage is available, and if it is then stops and deletes the currently running\n \t\tcontainer, pulls the latest image, and starts it. All endpoints are preserved.\n\n If no action is provided, print the service status and exit.",
|
|
476
|
-
"required": false,
|
|
477
|
-
"options": [
|
|
478
|
-
"start",
|
|
479
|
-
"stop",
|
|
480
|
-
"upgrade"
|
|
481
|
-
]
|
|
482
|
-
}
|
|
483
|
-
}
|
|
484
|
-
},
|
|
485
|
-
"start": {
|
|
486
|
-
"id": "start",
|
|
487
|
-
"description": "Deploy your schema to StepZen, and then redeploy on every change.",
|
|
488
|
-
"strict": true,
|
|
489
|
-
"pluginName": "stepzen",
|
|
571
|
+
"hasDynamicHelp": false,
|
|
572
|
+
"hiddenAliases": [],
|
|
573
|
+
"id": "service",
|
|
490
574
|
"pluginAlias": "stepzen",
|
|
575
|
+
"pluginName": "stepzen",
|
|
491
576
|
"pluginType": "core",
|
|
577
|
+
"strict": true,
|
|
578
|
+
"enableJsonFlag": false,
|
|
579
|
+
"isESM": true,
|
|
580
|
+
"relativePath": [
|
|
581
|
+
"lib",
|
|
582
|
+
"commands",
|
|
583
|
+
"service.js"
|
|
584
|
+
]
|
|
585
|
+
},
|
|
586
|
+
"start": {
|
|
492
587
|
"aliases": [],
|
|
588
|
+
"args": {},
|
|
589
|
+
"description": "Deploy your schema to StepZen, and then redeploy on every change.",
|
|
493
590
|
"flags": {
|
|
494
591
|
"help": {
|
|
495
|
-
"name": "help",
|
|
496
|
-
"type": "boolean",
|
|
497
592
|
"char": "h",
|
|
498
593
|
"description": "Show CLI help",
|
|
499
|
-
"
|
|
594
|
+
"name": "help",
|
|
595
|
+
"allowNo": false,
|
|
596
|
+
"type": "boolean"
|
|
500
597
|
},
|
|
501
598
|
"non-interactive": {
|
|
502
|
-
"name": "non-interactive",
|
|
503
|
-
"type": "boolean",
|
|
504
599
|
"description": "Disable all interactive prompts",
|
|
505
|
-
"
|
|
600
|
+
"name": "non-interactive",
|
|
601
|
+
"allowNo": false,
|
|
602
|
+
"type": "boolean"
|
|
506
603
|
},
|
|
507
604
|
"dir": {
|
|
508
|
-
"name": "dir",
|
|
509
|
-
"type": "option",
|
|
510
605
|
"description": "Working directory",
|
|
511
|
-
"
|
|
606
|
+
"name": "dir",
|
|
607
|
+
"hasDynamicHelp": false,
|
|
608
|
+
"multiple": false,
|
|
609
|
+
"type": "option"
|
|
512
610
|
},
|
|
513
611
|
"endpoint": {
|
|
514
|
-
"name": "endpoint",
|
|
515
|
-
"type": "option",
|
|
516
612
|
"description": "Override workspace endpoint",
|
|
517
|
-
"
|
|
613
|
+
"name": "endpoint",
|
|
614
|
+
"hasDynamicHelp": false,
|
|
615
|
+
"multiple": false,
|
|
616
|
+
"type": "option"
|
|
518
617
|
},
|
|
519
618
|
"dashboard": {
|
|
520
|
-
"name": "dashboard",
|
|
521
|
-
"type": "option",
|
|
522
619
|
"description": "Which GraphiQL dashboard to use to explore the deployed endpoint.\n\t- web [default]: use GraphiQL at dashboard.stepzen.com\n\t- local: start a local GraphiQL dashboard on localhost:5001 (change the port with the --port flag)\n\t- none: do not use GraphiQL at all",
|
|
620
|
+
"name": "dashboard",
|
|
621
|
+
"hasDynamicHelp": false,
|
|
523
622
|
"multiple": false,
|
|
524
623
|
"options": [
|
|
525
624
|
"web",
|
|
526
625
|
"local",
|
|
527
626
|
"none"
|
|
528
|
-
]
|
|
627
|
+
],
|
|
628
|
+
"type": "option"
|
|
529
629
|
},
|
|
530
630
|
"port": {
|
|
531
|
-
"name": "port",
|
|
532
|
-
"type": "option",
|
|
533
631
|
"description": "Port for the local GraphiQL dashboard (when using --dashboard=local)",
|
|
632
|
+
"env": "PORT",
|
|
633
|
+
"name": "port",
|
|
634
|
+
"default": 5001,
|
|
635
|
+
"hasDynamicHelp": false,
|
|
534
636
|
"multiple": false,
|
|
535
|
-
"
|
|
637
|
+
"type": "option"
|
|
536
638
|
},
|
|
537
639
|
"no-console": {
|
|
538
|
-
"name": "no-console",
|
|
539
|
-
"type": "boolean",
|
|
540
640
|
"hidden": true,
|
|
541
|
-
"
|
|
641
|
+
"name": "no-console",
|
|
642
|
+
"allowNo": false,
|
|
643
|
+
"type": "boolean"
|
|
542
644
|
},
|
|
543
645
|
"no-dashboard": {
|
|
544
|
-
"name": "no-dashboard",
|
|
545
|
-
"type": "boolean",
|
|
546
646
|
"hidden": true,
|
|
547
|
-
"
|
|
647
|
+
"name": "no-dashboard",
|
|
648
|
+
"allowNo": false,
|
|
649
|
+
"type": "boolean"
|
|
548
650
|
},
|
|
549
651
|
"no-init": {
|
|
550
|
-
"name": "no-init",
|
|
551
|
-
"type": "boolean",
|
|
552
652
|
"hidden": true,
|
|
553
|
-
"
|
|
653
|
+
"name": "no-init",
|
|
654
|
+
"allowNo": false,
|
|
655
|
+
"type": "boolean"
|
|
554
656
|
},
|
|
555
657
|
"no-validate": {
|
|
556
|
-
"name": "no-validate",
|
|
557
|
-
"type": "boolean",
|
|
558
658
|
"hidden": true,
|
|
559
|
-
"
|
|
659
|
+
"name": "no-validate",
|
|
660
|
+
"allowNo": false,
|
|
661
|
+
"type": "boolean"
|
|
560
662
|
},
|
|
561
663
|
"no-watcher": {
|
|
562
|
-
"name": "no-watcher",
|
|
563
|
-
"type": "boolean",
|
|
564
664
|
"hidden": true,
|
|
565
|
-
"
|
|
665
|
+
"name": "no-watcher",
|
|
666
|
+
"allowNo": false,
|
|
667
|
+
"type": "boolean"
|
|
566
668
|
}
|
|
567
669
|
},
|
|
568
|
-
"
|
|
569
|
-
|
|
570
|
-
|
|
571
|
-
"id": "transpile",
|
|
572
|
-
"description": "Transpile a GraphQL schema.",
|
|
573
|
-
"strict": true,
|
|
574
|
-
"pluginName": "stepzen",
|
|
670
|
+
"hasDynamicHelp": false,
|
|
671
|
+
"hiddenAliases": [],
|
|
672
|
+
"id": "start",
|
|
575
673
|
"pluginAlias": "stepzen",
|
|
674
|
+
"pluginName": "stepzen",
|
|
576
675
|
"pluginType": "core",
|
|
577
|
-
"
|
|
676
|
+
"strict": true,
|
|
677
|
+
"enableJsonFlag": false,
|
|
678
|
+
"isESM": true,
|
|
679
|
+
"relativePath": [
|
|
680
|
+
"lib",
|
|
681
|
+
"commands",
|
|
682
|
+
"start.js"
|
|
683
|
+
]
|
|
684
|
+
},
|
|
685
|
+
"transpile": {
|
|
578
686
|
"aliases": [],
|
|
687
|
+
"args": {
|
|
688
|
+
"folder": {
|
|
689
|
+
"name": "folder",
|
|
690
|
+
"required": true
|
|
691
|
+
}
|
|
692
|
+
},
|
|
693
|
+
"description": "Transpile a GraphQL schema.",
|
|
579
694
|
"flags": {
|
|
580
695
|
"help": {
|
|
581
|
-
"name": "help",
|
|
582
|
-
"type": "boolean",
|
|
583
696
|
"char": "h",
|
|
584
697
|
"description": "Show CLI help",
|
|
585
|
-
"
|
|
698
|
+
"name": "help",
|
|
699
|
+
"allowNo": false,
|
|
700
|
+
"type": "boolean"
|
|
586
701
|
},
|
|
587
702
|
"non-interactive": {
|
|
588
|
-
"name": "non-interactive",
|
|
589
|
-
"type": "boolean",
|
|
590
703
|
"description": "Disable all interactive prompts",
|
|
591
|
-
"
|
|
704
|
+
"name": "non-interactive",
|
|
705
|
+
"allowNo": false,
|
|
706
|
+
"type": "boolean"
|
|
592
707
|
},
|
|
593
708
|
"config": {
|
|
594
|
-
"name": "config",
|
|
595
|
-
"type": "option",
|
|
596
709
|
"hidden": true,
|
|
597
|
-
"
|
|
710
|
+
"name": "config",
|
|
711
|
+
"hasDynamicHelp": false,
|
|
712
|
+
"multiple": false,
|
|
713
|
+
"type": "option"
|
|
598
714
|
},
|
|
599
715
|
"hide-output": {
|
|
600
|
-
"name": "hide-output",
|
|
601
|
-
"type": "boolean",
|
|
602
716
|
"hidden": true,
|
|
603
|
-
"
|
|
717
|
+
"name": "hide-output",
|
|
718
|
+
"allowNo": false,
|
|
719
|
+
"type": "boolean"
|
|
604
720
|
},
|
|
605
721
|
"inspect": {
|
|
606
|
-
"name": "inspect",
|
|
607
|
-
"type": "boolean",
|
|
608
722
|
"char": "i",
|
|
609
723
|
"hidden": true,
|
|
610
|
-
"
|
|
724
|
+
"name": "inspect",
|
|
725
|
+
"allowNo": false,
|
|
726
|
+
"type": "boolean"
|
|
611
727
|
},
|
|
612
728
|
"inspect-after": {
|
|
613
|
-
"name": "inspect-after",
|
|
614
|
-
"type": "boolean",
|
|
615
729
|
"hidden": true,
|
|
616
|
-
"
|
|
730
|
+
"name": "inspect-after",
|
|
731
|
+
"allowNo": false,
|
|
732
|
+
"type": "boolean"
|
|
617
733
|
},
|
|
618
734
|
"output-configuration": {
|
|
619
735
|
"name": "output-configuration",
|
|
620
|
-
"
|
|
621
|
-
"
|
|
736
|
+
"allowNo": false,
|
|
737
|
+
"type": "boolean"
|
|
622
738
|
},
|
|
623
739
|
"silent": {
|
|
624
740
|
"name": "silent",
|
|
625
|
-
"
|
|
626
|
-
"
|
|
741
|
+
"allowNo": false,
|
|
742
|
+
"type": "boolean"
|
|
627
743
|
}
|
|
628
744
|
},
|
|
745
|
+
"hasDynamicHelp": false,
|
|
746
|
+
"hidden": true,
|
|
747
|
+
"hiddenAliases": [],
|
|
748
|
+
"id": "transpile",
|
|
749
|
+
"pluginAlias": "stepzen",
|
|
750
|
+
"pluginName": "stepzen",
|
|
751
|
+
"pluginType": "core",
|
|
752
|
+
"strict": true,
|
|
753
|
+
"enableJsonFlag": false,
|
|
754
|
+
"isESM": true,
|
|
755
|
+
"relativePath": [
|
|
756
|
+
"lib",
|
|
757
|
+
"commands",
|
|
758
|
+
"transpile.js"
|
|
759
|
+
]
|
|
760
|
+
},
|
|
761
|
+
"upload": {
|
|
762
|
+
"aliases": [],
|
|
629
763
|
"args": {
|
|
630
|
-
"
|
|
631
|
-
"
|
|
764
|
+
"type": {
|
|
765
|
+
"description": "type",
|
|
766
|
+
"name": "type",
|
|
767
|
+
"options": [
|
|
768
|
+
"configurationset",
|
|
769
|
+
"schema"
|
|
770
|
+
],
|
|
771
|
+
"required": true
|
|
772
|
+
},
|
|
773
|
+
"destination": {
|
|
774
|
+
"description": "destination",
|
|
775
|
+
"name": "destination",
|
|
632
776
|
"required": true
|
|
633
777
|
}
|
|
634
|
-
}
|
|
635
|
-
},
|
|
636
|
-
"upload": {
|
|
637
|
-
"id": "upload",
|
|
778
|
+
},
|
|
638
779
|
"description": "[DEPRECATED] Upload a schema or a configuration set to StepZen.\nstepzen upload is deprecated in favor of stepzen deploy\nStepZen CLI is moving away from a two-step \"upload\" + \"deploy\" flow to a single-step \"deploy\" flow.",
|
|
639
|
-
"strict": true,
|
|
640
|
-
"pluginName": "stepzen",
|
|
641
|
-
"pluginAlias": "stepzen",
|
|
642
|
-
"pluginType": "core",
|
|
643
|
-
"aliases": [],
|
|
644
780
|
"flags": {
|
|
645
781
|
"help": {
|
|
646
|
-
"name": "help",
|
|
647
|
-
"type": "boolean",
|
|
648
782
|
"char": "h",
|
|
649
783
|
"description": "Show CLI help",
|
|
650
|
-
"
|
|
784
|
+
"name": "help",
|
|
785
|
+
"allowNo": false,
|
|
786
|
+
"type": "boolean"
|
|
651
787
|
},
|
|
652
788
|
"non-interactive": {
|
|
653
|
-
"name": "non-interactive",
|
|
654
|
-
"type": "boolean",
|
|
655
789
|
"description": "Disable all interactive prompts",
|
|
656
|
-
"
|
|
790
|
+
"name": "non-interactive",
|
|
791
|
+
"allowNo": false,
|
|
792
|
+
"type": "boolean"
|
|
657
793
|
},
|
|
658
794
|
"dir": {
|
|
659
|
-
"name": "dir",
|
|
660
|
-
"type": "option",
|
|
661
795
|
"description": "A directory to upload",
|
|
662
|
-
"multiple": false,
|
|
663
796
|
"exclusive": [
|
|
664
797
|
"file"
|
|
665
|
-
]
|
|
798
|
+
],
|
|
799
|
+
"name": "dir",
|
|
800
|
+
"hasDynamicHelp": false,
|
|
801
|
+
"multiple": false,
|
|
802
|
+
"type": "option"
|
|
666
803
|
},
|
|
667
804
|
"file": {
|
|
668
|
-
"name": "file",
|
|
669
|
-
"type": "option",
|
|
670
805
|
"description": "A file to upload",
|
|
671
|
-
"multiple": false,
|
|
672
806
|
"exclusive": [
|
|
673
807
|
"dir"
|
|
674
|
-
]
|
|
808
|
+
],
|
|
809
|
+
"name": "file",
|
|
810
|
+
"hasDynamicHelp": false,
|
|
811
|
+
"multiple": false,
|
|
812
|
+
"type": "option"
|
|
675
813
|
},
|
|
676
814
|
"silent": {
|
|
677
815
|
"name": "silent",
|
|
678
|
-
"
|
|
679
|
-
"
|
|
816
|
+
"allowNo": false,
|
|
817
|
+
"type": "boolean"
|
|
680
818
|
}
|
|
681
819
|
},
|
|
820
|
+
"hasDynamicHelp": false,
|
|
821
|
+
"hiddenAliases": [],
|
|
822
|
+
"id": "upload",
|
|
823
|
+
"pluginAlias": "stepzen",
|
|
824
|
+
"pluginName": "stepzen",
|
|
825
|
+
"pluginType": "core",
|
|
826
|
+
"strict": true,
|
|
827
|
+
"enableJsonFlag": false,
|
|
828
|
+
"isESM": true,
|
|
829
|
+
"relativePath": [
|
|
830
|
+
"lib",
|
|
831
|
+
"commands",
|
|
832
|
+
"upload.js"
|
|
833
|
+
]
|
|
834
|
+
},
|
|
835
|
+
"validate": {
|
|
836
|
+
"aliases": [],
|
|
682
837
|
"args": {
|
|
683
|
-
"
|
|
684
|
-
"name": "
|
|
685
|
-
"description": "type",
|
|
686
|
-
"required": true,
|
|
687
|
-
"options": [
|
|
688
|
-
"configurationset",
|
|
689
|
-
"schema"
|
|
690
|
-
]
|
|
691
|
-
},
|
|
692
|
-
"destination": {
|
|
693
|
-
"name": "destination",
|
|
694
|
-
"description": "destination",
|
|
838
|
+
"folder": {
|
|
839
|
+
"name": "folder",
|
|
695
840
|
"required": true
|
|
696
841
|
}
|
|
697
|
-
}
|
|
698
|
-
},
|
|
699
|
-
"validate": {
|
|
700
|
-
"id": "validate",
|
|
842
|
+
},
|
|
701
843
|
"description": "Validate a GraphQL schema.",
|
|
702
|
-
"strict": true,
|
|
703
|
-
"pluginName": "stepzen",
|
|
704
|
-
"pluginAlias": "stepzen",
|
|
705
|
-
"pluginType": "core",
|
|
706
|
-
"hidden": true,
|
|
707
|
-
"aliases": [],
|
|
708
844
|
"flags": {
|
|
709
845
|
"help": {
|
|
710
|
-
"name": "help",
|
|
711
|
-
"type": "boolean",
|
|
712
846
|
"char": "h",
|
|
713
847
|
"description": "Show CLI help",
|
|
714
|
-
"
|
|
848
|
+
"name": "help",
|
|
849
|
+
"allowNo": false,
|
|
850
|
+
"type": "boolean"
|
|
715
851
|
},
|
|
716
852
|
"non-interactive": {
|
|
717
|
-
"name": "non-interactive",
|
|
718
|
-
"type": "boolean",
|
|
719
853
|
"description": "Disable all interactive prompts",
|
|
720
|
-
"
|
|
854
|
+
"name": "non-interactive",
|
|
855
|
+
"allowNo": false,
|
|
856
|
+
"type": "boolean"
|
|
721
857
|
}
|
|
722
858
|
},
|
|
723
|
-
"
|
|
724
|
-
|
|
725
|
-
|
|
726
|
-
|
|
727
|
-
}
|
|
728
|
-
}
|
|
729
|
-
},
|
|
730
|
-
"whoami": {
|
|
731
|
-
"id": "whoami",
|
|
732
|
-
"description": "View your StepZen credentials.",
|
|
733
|
-
"strict": true,
|
|
734
|
-
"pluginName": "stepzen",
|
|
859
|
+
"hasDynamicHelp": false,
|
|
860
|
+
"hidden": true,
|
|
861
|
+
"hiddenAliases": [],
|
|
862
|
+
"id": "validate",
|
|
735
863
|
"pluginAlias": "stepzen",
|
|
864
|
+
"pluginName": "stepzen",
|
|
736
865
|
"pluginType": "core",
|
|
866
|
+
"strict": true,
|
|
867
|
+
"enableJsonFlag": false,
|
|
868
|
+
"isESM": true,
|
|
869
|
+
"relativePath": [
|
|
870
|
+
"lib",
|
|
871
|
+
"commands",
|
|
872
|
+
"validate.js"
|
|
873
|
+
]
|
|
874
|
+
},
|
|
875
|
+
"whoami": {
|
|
737
876
|
"aliases": [],
|
|
877
|
+
"args": {},
|
|
878
|
+
"description": "View your StepZen credentials.",
|
|
738
879
|
"flags": {
|
|
739
880
|
"help": {
|
|
740
|
-
"name": "help",
|
|
741
|
-
"type": "boolean",
|
|
742
881
|
"char": "h",
|
|
743
882
|
"description": "Show CLI help",
|
|
744
|
-
"
|
|
883
|
+
"name": "help",
|
|
884
|
+
"allowNo": false,
|
|
885
|
+
"type": "boolean"
|
|
745
886
|
},
|
|
746
887
|
"non-interactive": {
|
|
747
|
-
"name": "non-interactive",
|
|
748
|
-
"type": "boolean",
|
|
749
888
|
"description": "Disable all interactive prompts",
|
|
750
|
-
"
|
|
889
|
+
"name": "non-interactive",
|
|
890
|
+
"allowNo": false,
|
|
891
|
+
"type": "boolean"
|
|
751
892
|
},
|
|
752
893
|
"showkeys": {
|
|
753
|
-
"name": "showkeys",
|
|
754
|
-
"type": "boolean",
|
|
755
|
-
"allowNo": false,
|
|
756
894
|
"exclusive": [
|
|
757
895
|
"account",
|
|
758
896
|
"adminkey",
|
|
759
897
|
"apikey",
|
|
760
898
|
"domain"
|
|
761
|
-
]
|
|
899
|
+
],
|
|
900
|
+
"name": "showkeys",
|
|
901
|
+
"allowNo": false,
|
|
902
|
+
"type": "boolean"
|
|
762
903
|
},
|
|
763
904
|
"account": {
|
|
764
|
-
"name": "account",
|
|
765
|
-
"type": "boolean",
|
|
766
|
-
"allowNo": false,
|
|
767
905
|
"exclusive": [
|
|
768
906
|
"showkeys",
|
|
769
907
|
"adminkey",
|
|
770
908
|
"apikey",
|
|
771
909
|
"domain"
|
|
772
|
-
]
|
|
910
|
+
],
|
|
911
|
+
"name": "account",
|
|
912
|
+
"allowNo": false,
|
|
913
|
+
"type": "boolean"
|
|
773
914
|
},
|
|
774
915
|
"adminkey": {
|
|
775
|
-
"name": "adminkey",
|
|
776
|
-
"type": "boolean",
|
|
777
|
-
"allowNo": false,
|
|
778
916
|
"exclusive": [
|
|
779
917
|
"showkeys",
|
|
780
918
|
"account",
|
|
781
919
|
"apikey",
|
|
782
920
|
"domain"
|
|
783
|
-
]
|
|
921
|
+
],
|
|
922
|
+
"name": "adminkey",
|
|
923
|
+
"allowNo": false,
|
|
924
|
+
"type": "boolean"
|
|
784
925
|
},
|
|
785
926
|
"apikey": {
|
|
786
|
-
"name": "apikey",
|
|
787
|
-
"type": "boolean",
|
|
788
|
-
"allowNo": false,
|
|
789
927
|
"exclusive": [
|
|
790
928
|
"showkeys",
|
|
791
929
|
"account",
|
|
792
930
|
"adminkey",
|
|
793
931
|
"domain"
|
|
794
|
-
]
|
|
932
|
+
],
|
|
933
|
+
"name": "apikey",
|
|
934
|
+
"allowNo": false,
|
|
935
|
+
"type": "boolean"
|
|
795
936
|
},
|
|
796
937
|
"domain": {
|
|
797
|
-
"name": "domain",
|
|
798
|
-
"type": "boolean",
|
|
799
|
-
"allowNo": false,
|
|
800
938
|
"exclusive": [
|
|
801
939
|
"showkeys",
|
|
802
940
|
"account",
|
|
803
941
|
"adminkey",
|
|
804
942
|
"apikey"
|
|
805
|
-
]
|
|
943
|
+
],
|
|
944
|
+
"name": "domain",
|
|
945
|
+
"allowNo": false,
|
|
946
|
+
"type": "boolean"
|
|
806
947
|
}
|
|
807
948
|
},
|
|
808
|
-
"
|
|
809
|
-
|
|
810
|
-
|
|
811
|
-
"id": "import:curl",
|
|
812
|
-
"description": "Import a schema for a REST endpoint into your GraphQL API (uses the curl syntax).\n\nstepzen import curl automatically introspects a REST endpoint, generates a GraphQL schema for accessing this endpoint through a StepZen API, and adds the generated types and a query field into your GraphQL schema.",
|
|
813
|
-
"strict": false,
|
|
814
|
-
"pluginName": "stepzen",
|
|
949
|
+
"hasDynamicHelp": false,
|
|
950
|
+
"hiddenAliases": [],
|
|
951
|
+
"id": "whoami",
|
|
815
952
|
"pluginAlias": "stepzen",
|
|
953
|
+
"pluginName": "stepzen",
|
|
816
954
|
"pluginType": "core",
|
|
955
|
+
"strict": true,
|
|
956
|
+
"enableJsonFlag": false,
|
|
957
|
+
"isESM": true,
|
|
958
|
+
"relativePath": [
|
|
959
|
+
"lib",
|
|
960
|
+
"commands",
|
|
961
|
+
"whoami.js"
|
|
962
|
+
]
|
|
963
|
+
},
|
|
964
|
+
"import:curl": {
|
|
817
965
|
"aliases": [],
|
|
966
|
+
"args": {},
|
|
967
|
+
"description": "Import a schema for a REST endpoint into your GraphQL API (uses the curl syntax).\n\nstepzen import curl automatically introspects a REST endpoint, generates a GraphQL schema for accessing this endpoint through a StepZen API, and adds the generated types and a query field into your GraphQL schema.",
|
|
818
968
|
"flags": {
|
|
819
969
|
"help": {
|
|
820
|
-
"name": "help",
|
|
821
|
-
"type": "boolean",
|
|
822
970
|
"char": "h",
|
|
823
971
|
"description": "Show CLI help",
|
|
824
|
-
"
|
|
972
|
+
"name": "help",
|
|
973
|
+
"allowNo": false,
|
|
974
|
+
"type": "boolean"
|
|
825
975
|
},
|
|
826
976
|
"non-interactive": {
|
|
827
|
-
"name": "non-interactive",
|
|
828
|
-
"type": "boolean",
|
|
829
977
|
"description": "Disable all interactive prompts",
|
|
830
|
-
"
|
|
978
|
+
"name": "non-interactive",
|
|
979
|
+
"allowNo": false,
|
|
980
|
+
"type": "boolean"
|
|
831
981
|
},
|
|
832
982
|
"dir": {
|
|
833
|
-
"name": "dir",
|
|
834
|
-
"type": "option",
|
|
835
983
|
"description": "Working directory",
|
|
836
|
-
"
|
|
984
|
+
"name": "dir",
|
|
985
|
+
"hasDynamicHelp": false,
|
|
986
|
+
"multiple": false,
|
|
987
|
+
"type": "option"
|
|
837
988
|
},
|
|
838
989
|
"silent": {
|
|
839
|
-
"name": "silent",
|
|
840
|
-
"type": "boolean",
|
|
841
990
|
"description": "This is an internal flag passed by the (no-arg) Import command when it launches a data-source specific import command. The intent is to avoid showing a welcome message twice (if its already been shown by the (no-arg) Import command).",
|
|
842
991
|
"hidden": true,
|
|
843
|
-
"
|
|
992
|
+
"name": "silent",
|
|
993
|
+
"allowNo": false,
|
|
994
|
+
"type": "boolean"
|
|
844
995
|
},
|
|
845
996
|
"name": {
|
|
846
|
-
"name": "name",
|
|
847
|
-
"type": "option",
|
|
848
997
|
"description": "Subfolder inside the workspace folder to save the imported schema files to. Defaults to the name of the imported schema.",
|
|
849
|
-
"
|
|
998
|
+
"name": "name",
|
|
999
|
+
"hasDynamicHelp": false,
|
|
1000
|
+
"multiple": false,
|
|
1001
|
+
"type": "option"
|
|
850
1002
|
},
|
|
851
1003
|
"overwrite": {
|
|
852
|
-
"
|
|
853
|
-
|
|
1004
|
+
"dependsOn": [
|
|
1005
|
+
"name"
|
|
1006
|
+
],
|
|
854
1007
|
"description": "Overwrite any existing schema with the same name. Cannot be used without also providing a --name flag.",
|
|
855
1008
|
"hidden": true,
|
|
1009
|
+
"name": "overwrite",
|
|
856
1010
|
"allowNo": false,
|
|
857
|
-
"
|
|
858
|
-
"name"
|
|
859
|
-
]
|
|
1011
|
+
"type": "boolean"
|
|
860
1012
|
},
|
|
861
1013
|
"prefix": {
|
|
862
|
-
"name": "prefix",
|
|
863
|
-
"type": "option",
|
|
864
1014
|
"description": "Prefix to add to every type in the generated schema",
|
|
865
|
-
"
|
|
1015
|
+
"name": "prefix",
|
|
1016
|
+
"hasDynamicHelp": false,
|
|
1017
|
+
"multiple": false,
|
|
1018
|
+
"type": "option"
|
|
866
1019
|
},
|
|
867
1020
|
"data": {
|
|
868
|
-
"name": "data",
|
|
869
|
-
"type": "option",
|
|
870
|
-
"char": "d",
|
|
871
|
-
"hidden": true,
|
|
872
|
-
"multiple": true,
|
|
873
1021
|
"aliases": [
|
|
874
1022
|
"data-ascii",
|
|
875
1023
|
"data-raw",
|
|
876
1024
|
"data-binary"
|
|
877
|
-
]
|
|
1025
|
+
],
|
|
1026
|
+
"char": "d",
|
|
1027
|
+
"hidden": true,
|
|
1028
|
+
"name": "data",
|
|
1029
|
+
"hasDynamicHelp": false,
|
|
1030
|
+
"multiple": true,
|
|
1031
|
+
"type": "option"
|
|
878
1032
|
},
|
|
879
1033
|
"request": {
|
|
880
|
-
"name": "request",
|
|
881
|
-
"type": "option",
|
|
882
1034
|
"char": "X",
|
|
883
1035
|
"hidden": true,
|
|
884
|
-
"
|
|
1036
|
+
"name": "request",
|
|
1037
|
+
"hasDynamicHelp": false,
|
|
1038
|
+
"multiple": false,
|
|
1039
|
+
"type": "option"
|
|
885
1040
|
},
|
|
886
1041
|
"url": {
|
|
887
|
-
"name": "url",
|
|
888
|
-
"type": "option",
|
|
889
1042
|
"hidden": true,
|
|
890
|
-
"
|
|
1043
|
+
"name": "url",
|
|
1044
|
+
"hasDynamicHelp": false,
|
|
1045
|
+
"multiple": true,
|
|
1046
|
+
"type": "option"
|
|
891
1047
|
},
|
|
892
1048
|
"header": {
|
|
893
|
-
"name": "header",
|
|
894
|
-
"type": "option",
|
|
895
1049
|
"char": "H",
|
|
896
1050
|
"description": "Specifies a request header to pass\n\nExample:\nstepzen import curl https://example.com/api/customers \\\n\t-H \"Authorization: apikey SecretAPIKeyValue\"",
|
|
897
|
-
"
|
|
1051
|
+
"name": "header",
|
|
1052
|
+
"hasDynamicHelp": false,
|
|
1053
|
+
"multiple": true,
|
|
1054
|
+
"type": "option"
|
|
898
1055
|
},
|
|
899
1056
|
"header-param": {
|
|
900
|
-
"name": "header-param",
|
|
901
|
-
"type": "option",
|
|
902
1057
|
"description": "Specifies a parameter in a header value. Can be formed by taking a -H, --header flag and replacing the variable part of the header value with a $paramName placeholder. Repeat this flag once for each header with a parameter.\n\nExample:\nstepzen import curl https://example.com/api/customers \\\n\t-H \"Authorization: apikey SecretAPIKeyValue\" \\\n\t--header-param 'Authorization: apikey $apikey'",
|
|
903
|
-
"
|
|
1058
|
+
"name": "header-param",
|
|
1059
|
+
"hasDynamicHelp": false,
|
|
1060
|
+
"multiple": true,
|
|
1061
|
+
"type": "option"
|
|
904
1062
|
},
|
|
905
1063
|
"query-name": {
|
|
906
|
-
"name": "query-name",
|
|
907
|
-
"type": "option",
|
|
908
1064
|
"description": "Property name to add to the Query type as a way to access the imported endpoint",
|
|
909
|
-
"
|
|
1065
|
+
"name": "query-name",
|
|
1066
|
+
"hasDynamicHelp": false,
|
|
1067
|
+
"multiple": false,
|
|
1068
|
+
"type": "option"
|
|
910
1069
|
},
|
|
911
1070
|
"query-type": {
|
|
912
|
-
"name": "query-type",
|
|
913
|
-
"type": "option",
|
|
914
1071
|
"description": "Name for the type returned by the curl request in the generated schema. The name specified by --query-type is not prefixed by --prefix if both flags are present.",
|
|
915
|
-
"
|
|
1072
|
+
"name": "query-type",
|
|
1073
|
+
"hasDynamicHelp": false,
|
|
1074
|
+
"multiple": false,
|
|
1075
|
+
"type": "option"
|
|
916
1076
|
},
|
|
917
1077
|
"path-params": {
|
|
918
|
-
"name": "path-params",
|
|
919
|
-
"type": "option",
|
|
920
1078
|
"description": "Specifies path parameters in the URL path. Can be formed by taking the original path and replacing the variable segments with $paramName placeholders.\n\nExample:\nstepzen import curl https://example.com/users/jane/posts/12 --path-params '/users/$userId/posts/$postId'",
|
|
921
|
-
"
|
|
1079
|
+
"name": "path-params",
|
|
1080
|
+
"hasDynamicHelp": false,
|
|
1081
|
+
"multiple": false,
|
|
1082
|
+
"type": "option"
|
|
922
1083
|
}
|
|
923
1084
|
},
|
|
924
|
-
"
|
|
925
|
-
|
|
926
|
-
|
|
927
|
-
"id": "import:db2",
|
|
928
|
-
"description": "Import a schema for a Db2 data source into your GraphQL API.\n\nstepzen import db2 automatically introspects a Db2 database, generates a GraphQL schema for accessing this database through a StepZen API, and merges the generated types, queries and mutations into your GraphQL schema.",
|
|
929
|
-
"strict": true,
|
|
930
|
-
"pluginName": "stepzen",
|
|
1085
|
+
"hasDynamicHelp": false,
|
|
1086
|
+
"hiddenAliases": [],
|
|
1087
|
+
"id": "import:curl",
|
|
931
1088
|
"pluginAlias": "stepzen",
|
|
1089
|
+
"pluginName": "stepzen",
|
|
932
1090
|
"pluginType": "core",
|
|
1091
|
+
"strict": false,
|
|
1092
|
+
"enableJsonFlag": false,
|
|
1093
|
+
"isESM": true,
|
|
1094
|
+
"relativePath": [
|
|
1095
|
+
"lib",
|
|
1096
|
+
"commands",
|
|
1097
|
+
"import",
|
|
1098
|
+
"curl.js"
|
|
1099
|
+
]
|
|
1100
|
+
},
|
|
1101
|
+
"import:db2": {
|
|
933
1102
|
"aliases": [],
|
|
1103
|
+
"args": {
|
|
1104
|
+
"dsn": {
|
|
1105
|
+
"description": "(optional) Data Source Name (DSN) of a Db2 database.\nExample: 'jdbc:db2://host:port/db:user=username;password=password;schema=schema;sslConnection=true/false;'\n\nFlags, such as --db-host, override the corresponding parts of the DSN (if both are provided).",
|
|
1106
|
+
"name": "dsn"
|
|
1107
|
+
}
|
|
1108
|
+
},
|
|
1109
|
+
"description": "Import a schema for a Db2 data source into your GraphQL API.\n\nstepzen import db2 automatically introspects a Db2 database, generates a GraphQL schema for accessing this database through a StepZen API, and merges the generated types, queries and mutations into your GraphQL schema.",
|
|
934
1110
|
"flags": {
|
|
935
1111
|
"help": {
|
|
936
|
-
"name": "help",
|
|
937
|
-
"type": "boolean",
|
|
938
1112
|
"char": "h",
|
|
939
1113
|
"description": "Show CLI help",
|
|
940
|
-
"
|
|
1114
|
+
"name": "help",
|
|
1115
|
+
"allowNo": false,
|
|
1116
|
+
"type": "boolean"
|
|
941
1117
|
},
|
|
942
1118
|
"non-interactive": {
|
|
943
|
-
"name": "non-interactive",
|
|
944
|
-
"type": "boolean",
|
|
945
1119
|
"description": "Disable all interactive prompts",
|
|
946
|
-
"
|
|
1120
|
+
"name": "non-interactive",
|
|
1121
|
+
"allowNo": false,
|
|
1122
|
+
"type": "boolean"
|
|
947
1123
|
},
|
|
948
1124
|
"dir": {
|
|
949
|
-
"name": "dir",
|
|
950
|
-
"type": "option",
|
|
951
1125
|
"description": "Working directory",
|
|
952
|
-
"
|
|
1126
|
+
"name": "dir",
|
|
1127
|
+
"hasDynamicHelp": false,
|
|
1128
|
+
"multiple": false,
|
|
1129
|
+
"type": "option"
|
|
953
1130
|
},
|
|
954
1131
|
"silent": {
|
|
955
|
-
"name": "silent",
|
|
956
|
-
"type": "boolean",
|
|
957
1132
|
"description": "This is an internal flag passed by the (no-arg) Import command when it launches a data-source specific import command. The intent is to avoid showing a welcome message twice (if its already been shown by the (no-arg) Import command).",
|
|
958
1133
|
"hidden": true,
|
|
959
|
-
"
|
|
1134
|
+
"name": "silent",
|
|
1135
|
+
"allowNo": false,
|
|
1136
|
+
"type": "boolean"
|
|
960
1137
|
},
|
|
961
1138
|
"name": {
|
|
962
|
-
"name": "name",
|
|
963
|
-
"type": "option",
|
|
964
1139
|
"description": "Subfolder inside the workspace folder to save the imported schema files to. Defaults to the name of the imported schema.",
|
|
965
|
-
"
|
|
1140
|
+
"name": "name",
|
|
1141
|
+
"hasDynamicHelp": false,
|
|
1142
|
+
"multiple": false,
|
|
1143
|
+
"type": "option"
|
|
966
1144
|
},
|
|
967
1145
|
"overwrite": {
|
|
968
|
-
"
|
|
969
|
-
|
|
1146
|
+
"dependsOn": [
|
|
1147
|
+
"name"
|
|
1148
|
+
],
|
|
970
1149
|
"description": "Overwrite any existing schema with the same name. Cannot be used without also providing a --name flag.",
|
|
971
1150
|
"hidden": true,
|
|
1151
|
+
"name": "overwrite",
|
|
972
1152
|
"allowNo": false,
|
|
973
|
-
"
|
|
974
|
-
"name"
|
|
975
|
-
]
|
|
1153
|
+
"type": "boolean"
|
|
976
1154
|
},
|
|
977
1155
|
"db-host": {
|
|
978
|
-
"name": "db-host",
|
|
979
|
-
"type": "option",
|
|
980
1156
|
"description": "Database host and optional port (as HOST[:PORT])",
|
|
981
|
-
"
|
|
1157
|
+
"name": "db-host",
|
|
1158
|
+
"hasDynamicHelp": false,
|
|
1159
|
+
"multiple": false,
|
|
1160
|
+
"type": "option"
|
|
982
1161
|
},
|
|
983
1162
|
"db-user": {
|
|
984
|
-
"name": "db-user",
|
|
985
|
-
"type": "option",
|
|
986
1163
|
"description": "Database user name",
|
|
987
|
-
"
|
|
1164
|
+
"name": "db-user",
|
|
1165
|
+
"hasDynamicHelp": false,
|
|
1166
|
+
"multiple": false,
|
|
1167
|
+
"type": "option"
|
|
988
1168
|
},
|
|
989
1169
|
"db-password": {
|
|
990
|
-
"name": "db-password",
|
|
991
|
-
"type": "option",
|
|
992
1170
|
"description": "Database password",
|
|
993
|
-
"
|
|
1171
|
+
"name": "db-password",
|
|
1172
|
+
"hasDynamicHelp": false,
|
|
1173
|
+
"multiple": false,
|
|
1174
|
+
"type": "option"
|
|
994
1175
|
},
|
|
995
1176
|
"db-database": {
|
|
996
|
-
"name": "db-database",
|
|
997
|
-
"type": "option",
|
|
998
1177
|
"description": "Name of database to import",
|
|
999
|
-
"
|
|
1178
|
+
"name": "db-database",
|
|
1179
|
+
"hasDynamicHelp": false,
|
|
1180
|
+
"multiple": false,
|
|
1181
|
+
"type": "option"
|
|
1000
1182
|
},
|
|
1001
1183
|
"db-schema": {
|
|
1002
|
-
"name": "db-schema",
|
|
1003
|
-
"type": "option",
|
|
1004
1184
|
"description": "Database schema to import tables from (default: public)",
|
|
1005
|
-
"
|
|
1185
|
+
"name": "db-schema",
|
|
1186
|
+
"hasDynamicHelp": false,
|
|
1187
|
+
"multiple": false,
|
|
1188
|
+
"type": "option"
|
|
1006
1189
|
},
|
|
1007
1190
|
"db-link-types": {
|
|
1008
|
-
"name": "db-link-types",
|
|
1009
|
-
"type": "boolean",
|
|
1010
1191
|
"description": "Automatically link types based on foreign key relationships using @materializer (https://stepzen.com/docs/features/linking-types)",
|
|
1011
|
-
"
|
|
1192
|
+
"name": "db-link-types",
|
|
1193
|
+
"allowNo": false,
|
|
1194
|
+
"type": "boolean"
|
|
1012
1195
|
},
|
|
1013
1196
|
"db-include": {
|
|
1014
|
-
"name": "db-include",
|
|
1015
|
-
"type": "option",
|
|
1016
1197
|
"description": "Should the generated GraphQL schema be based only on database views, only on tables or on both",
|
|
1198
|
+
"name": "db-include",
|
|
1199
|
+
"hasDynamicHelp": false,
|
|
1017
1200
|
"multiple": false,
|
|
1018
1201
|
"options": [
|
|
1019
1202
|
"tables-only",
|
|
1020
1203
|
"views-only",
|
|
1021
1204
|
"tables-and-views"
|
|
1022
|
-
]
|
|
1205
|
+
],
|
|
1206
|
+
"type": "option"
|
|
1023
1207
|
},
|
|
1024
1208
|
"db-use-deprecated-2022-naming": {
|
|
1025
|
-
"name": "db-use-deprecated-2022-naming",
|
|
1026
|
-
"type": "boolean",
|
|
1027
1209
|
"description": "Use the deprecated pre-2023 naming convention in the generated GraphQL schema:\n\t- the generated type and property names are auto-capitalized into PascalCase\n\t- the generated field names use the getCustomer and getCustomerList style.\n\nOn the other hand, when using the default naming convention:\n\t- the generated type and property names match exactly the DB table and column names\n\t- the generated field names use the customer and customerList style.",
|
|
1028
|
-
"
|
|
1210
|
+
"name": "db-use-deprecated-2022-naming",
|
|
1211
|
+
"allowNo": false,
|
|
1212
|
+
"type": "boolean"
|
|
1029
1213
|
},
|
|
1030
1214
|
"ssl-connection": {
|
|
1031
|
-
"name": "ssl-connection",
|
|
1032
|
-
"type": "boolean",
|
|
1033
1215
|
"description": "Is SSL enabled?",
|
|
1034
|
-
"
|
|
1216
|
+
"name": "ssl-connection",
|
|
1217
|
+
"allowNo": false,
|
|
1218
|
+
"type": "boolean"
|
|
1035
1219
|
}
|
|
1036
1220
|
},
|
|
1037
|
-
"
|
|
1038
|
-
|
|
1039
|
-
|
|
1040
|
-
"description": "(optional) Data Source Name (DSN) of a Db2 database.\nExample: 'jdbc:db2://host:port/db:user=username;password=password;schema=schema;sslConnection=true/false;'\n\nFlags, such as --db-host, override the corresponding parts of the DSN (if both are provided)."
|
|
1041
|
-
}
|
|
1042
|
-
}
|
|
1043
|
-
},
|
|
1044
|
-
"import:flow": {
|
|
1045
|
-
"id": "import:flow",
|
|
1046
|
-
"description": "Import StepZen flow expression as a query field into your GraphQL API.\n\nstepzen import flow automatically introspects a GraphQL endpoint and adds a @sequence implementing the given flow expression into your GraphQL schema.",
|
|
1047
|
-
"strict": true,
|
|
1048
|
-
"pluginName": "stepzen",
|
|
1221
|
+
"hasDynamicHelp": false,
|
|
1222
|
+
"hiddenAliases": [],
|
|
1223
|
+
"id": "import:db2",
|
|
1049
1224
|
"pluginAlias": "stepzen",
|
|
1225
|
+
"pluginName": "stepzen",
|
|
1050
1226
|
"pluginType": "core",
|
|
1227
|
+
"strict": true,
|
|
1228
|
+
"enableJsonFlag": false,
|
|
1229
|
+
"isESM": true,
|
|
1230
|
+
"relativePath": [
|
|
1231
|
+
"lib",
|
|
1232
|
+
"commands",
|
|
1233
|
+
"import",
|
|
1234
|
+
"db2.js"
|
|
1235
|
+
]
|
|
1236
|
+
},
|
|
1237
|
+
"import:flow": {
|
|
1051
1238
|
"aliases": [],
|
|
1239
|
+
"args": {
|
|
1240
|
+
"flow": {
|
|
1241
|
+
"name": "flow"
|
|
1242
|
+
}
|
|
1243
|
+
},
|
|
1244
|
+
"description": "Import StepZen flow expression as a query field into your GraphQL API.\n\nstepzen import flow automatically introspects a GraphQL endpoint and adds a @sequence implementing the given flow expression into your GraphQL schema.",
|
|
1052
1245
|
"flags": {
|
|
1053
1246
|
"help": {
|
|
1054
|
-
"name": "help",
|
|
1055
|
-
"type": "boolean",
|
|
1056
1247
|
"char": "h",
|
|
1057
1248
|
"description": "Show CLI help",
|
|
1058
|
-
"
|
|
1249
|
+
"name": "help",
|
|
1250
|
+
"allowNo": false,
|
|
1251
|
+
"type": "boolean"
|
|
1059
1252
|
},
|
|
1060
1253
|
"non-interactive": {
|
|
1061
|
-
"name": "non-interactive",
|
|
1062
|
-
"type": "boolean",
|
|
1063
1254
|
"description": "Disable all interactive prompts",
|
|
1064
|
-
"
|
|
1255
|
+
"name": "non-interactive",
|
|
1256
|
+
"allowNo": false,
|
|
1257
|
+
"type": "boolean"
|
|
1065
1258
|
},
|
|
1066
1259
|
"dir": {
|
|
1067
|
-
"name": "dir",
|
|
1068
|
-
"type": "option",
|
|
1069
1260
|
"description": "Working directory",
|
|
1070
|
-
"
|
|
1261
|
+
"name": "dir",
|
|
1262
|
+
"hasDynamicHelp": false,
|
|
1263
|
+
"multiple": false,
|
|
1264
|
+
"type": "option"
|
|
1071
1265
|
},
|
|
1072
1266
|
"silent": {
|
|
1073
|
-
"name": "silent",
|
|
1074
|
-
"type": "boolean",
|
|
1075
1267
|
"description": "This is an internal flag passed by the (no-arg) Import command when it launches a data-source specific import command. The intent is to avoid showing a welcome message twice (if its already been shown by the (no-arg) Import command).",
|
|
1076
1268
|
"hidden": true,
|
|
1077
|
-
"
|
|
1269
|
+
"name": "silent",
|
|
1270
|
+
"allowNo": false,
|
|
1271
|
+
"type": "boolean"
|
|
1078
1272
|
},
|
|
1079
1273
|
"name": {
|
|
1080
|
-
"name": "name",
|
|
1081
|
-
"type": "option",
|
|
1082
1274
|
"description": "Subfolder inside the workspace folder to save the imported schema files to. Defaults to the name of the imported schema.",
|
|
1083
|
-
"
|
|
1275
|
+
"name": "name",
|
|
1276
|
+
"hasDynamicHelp": false,
|
|
1277
|
+
"multiple": false,
|
|
1278
|
+
"type": "option"
|
|
1084
1279
|
},
|
|
1085
1280
|
"overwrite": {
|
|
1086
|
-
"
|
|
1087
|
-
|
|
1281
|
+
"dependsOn": [
|
|
1282
|
+
"name"
|
|
1283
|
+
],
|
|
1088
1284
|
"description": "Overwrite any existing schema with the same name. Cannot be used without also providing a --name flag.",
|
|
1089
1285
|
"hidden": true,
|
|
1286
|
+
"name": "overwrite",
|
|
1090
1287
|
"allowNo": false,
|
|
1091
|
-
"
|
|
1092
|
-
"name"
|
|
1093
|
-
]
|
|
1288
|
+
"type": "boolean"
|
|
1094
1289
|
},
|
|
1095
1290
|
"header": {
|
|
1096
|
-
"name": "header",
|
|
1097
|
-
"type": "option",
|
|
1098
1291
|
"char": "H",
|
|
1099
|
-
"description": "Specifies a request header to pass\n\nExample:\nstepzen import curl https://example.com/api/customers \\\n\t-H \"Authorization: apikey SecretAPIKeyValue\"",
|
|
1100
|
-
"multiple": true,
|
|
1101
1292
|
"dependsOn": [
|
|
1102
1293
|
"endpoint"
|
|
1103
|
-
]
|
|
1294
|
+
],
|
|
1295
|
+
"description": "Specifies a request header to pass\n\nExample:\nstepzen import curl https://example.com/api/customers \\\n\t-H \"Authorization: apikey SecretAPIKeyValue\"",
|
|
1296
|
+
"name": "header",
|
|
1297
|
+
"hasDynamicHelp": false,
|
|
1298
|
+
"multiple": true,
|
|
1299
|
+
"type": "option"
|
|
1104
1300
|
},
|
|
1105
1301
|
"endpoint": {
|
|
1106
|
-
"name": "endpoint",
|
|
1107
|
-
"type": "option",
|
|
1108
1302
|
"description": "Use a custom GraphQL schema instead of the project's schema as the schema providing the steps in the flow.",
|
|
1109
|
-
"
|
|
1303
|
+
"name": "endpoint",
|
|
1304
|
+
"hasDynamicHelp": false,
|
|
1305
|
+
"multiple": false,
|
|
1306
|
+
"type": "option"
|
|
1110
1307
|
}
|
|
1111
1308
|
},
|
|
1112
|
-
"
|
|
1113
|
-
|
|
1114
|
-
|
|
1115
|
-
}
|
|
1116
|
-
}
|
|
1117
|
-
},
|
|
1118
|
-
"import:graphql": {
|
|
1119
|
-
"id": "import:graphql",
|
|
1120
|
-
"description": "Import a GraphQL API as a subgraph into your GraphQL API.\n\nstepzen import graphql automatically introspects a GraphQL endpoint and merges the types, queries, mutations and subscriptions for accessing this endpoint through a StepZen API into your GraphQL schema.",
|
|
1121
|
-
"strict": true,
|
|
1122
|
-
"pluginName": "stepzen",
|
|
1309
|
+
"hasDynamicHelp": false,
|
|
1310
|
+
"hiddenAliases": [],
|
|
1311
|
+
"id": "import:flow",
|
|
1123
1312
|
"pluginAlias": "stepzen",
|
|
1313
|
+
"pluginName": "stepzen",
|
|
1124
1314
|
"pluginType": "core",
|
|
1315
|
+
"strict": true,
|
|
1316
|
+
"enableJsonFlag": false,
|
|
1317
|
+
"isESM": true,
|
|
1318
|
+
"relativePath": [
|
|
1319
|
+
"lib",
|
|
1320
|
+
"commands",
|
|
1321
|
+
"import",
|
|
1322
|
+
"flow.js"
|
|
1323
|
+
]
|
|
1324
|
+
},
|
|
1325
|
+
"import:graphql": {
|
|
1125
1326
|
"aliases": [],
|
|
1327
|
+
"args": {
|
|
1328
|
+
"url": {
|
|
1329
|
+
"name": "url"
|
|
1330
|
+
}
|
|
1331
|
+
},
|
|
1332
|
+
"description": "Import a GraphQL API as a subgraph into your GraphQL API.\n\nstepzen import graphql automatically introspects a GraphQL endpoint and merges the types, queries, mutations and subscriptions for accessing this endpoint through a StepZen API into your GraphQL schema.",
|
|
1126
1333
|
"flags": {
|
|
1127
1334
|
"help": {
|
|
1128
|
-
"name": "help",
|
|
1129
|
-
"type": "boolean",
|
|
1130
1335
|
"char": "h",
|
|
1131
1336
|
"description": "Show CLI help",
|
|
1132
|
-
"
|
|
1337
|
+
"name": "help",
|
|
1338
|
+
"allowNo": false,
|
|
1339
|
+
"type": "boolean"
|
|
1133
1340
|
},
|
|
1134
1341
|
"non-interactive": {
|
|
1135
|
-
"name": "non-interactive",
|
|
1136
|
-
"type": "boolean",
|
|
1137
1342
|
"description": "Disable all interactive prompts",
|
|
1138
|
-
"
|
|
1343
|
+
"name": "non-interactive",
|
|
1344
|
+
"allowNo": false,
|
|
1345
|
+
"type": "boolean"
|
|
1139
1346
|
},
|
|
1140
1347
|
"dir": {
|
|
1141
|
-
"name": "dir",
|
|
1142
|
-
"type": "option",
|
|
1143
1348
|
"description": "Working directory",
|
|
1144
|
-
"
|
|
1349
|
+
"name": "dir",
|
|
1350
|
+
"hasDynamicHelp": false,
|
|
1351
|
+
"multiple": false,
|
|
1352
|
+
"type": "option"
|
|
1145
1353
|
},
|
|
1146
1354
|
"silent": {
|
|
1147
|
-
"name": "silent",
|
|
1148
|
-
"type": "boolean",
|
|
1149
1355
|
"description": "This is an internal flag passed by the (no-arg) Import command when it launches a data-source specific import command. The intent is to avoid showing a welcome message twice (if its already been shown by the (no-arg) Import command).",
|
|
1150
1356
|
"hidden": true,
|
|
1151
|
-
"
|
|
1357
|
+
"name": "silent",
|
|
1358
|
+
"allowNo": false,
|
|
1359
|
+
"type": "boolean"
|
|
1152
1360
|
},
|
|
1153
1361
|
"name": {
|
|
1154
|
-
"name": "name",
|
|
1155
|
-
"type": "option",
|
|
1156
1362
|
"description": "Subfolder inside the workspace folder to save the imported schema files to. Defaults to the name of the imported schema.",
|
|
1157
|
-
"
|
|
1363
|
+
"name": "name",
|
|
1364
|
+
"hasDynamicHelp": false,
|
|
1365
|
+
"multiple": false,
|
|
1366
|
+
"type": "option"
|
|
1158
1367
|
},
|
|
1159
1368
|
"overwrite": {
|
|
1160
|
-
"
|
|
1161
|
-
|
|
1369
|
+
"dependsOn": [
|
|
1370
|
+
"name"
|
|
1371
|
+
],
|
|
1162
1372
|
"description": "Overwrite any existing schema with the same name. Cannot be used without also providing a --name flag.",
|
|
1163
1373
|
"hidden": true,
|
|
1374
|
+
"name": "overwrite",
|
|
1164
1375
|
"allowNo": false,
|
|
1165
|
-
"
|
|
1166
|
-
"name"
|
|
1167
|
-
]
|
|
1376
|
+
"type": "boolean"
|
|
1168
1377
|
},
|
|
1169
1378
|
"prefix": {
|
|
1170
|
-
"name": "prefix",
|
|
1171
|
-
"type": "option",
|
|
1172
1379
|
"description": "Prefix to add to every type in the generated schema",
|
|
1173
|
-
"
|
|
1380
|
+
"name": "prefix",
|
|
1381
|
+
"hasDynamicHelp": false,
|
|
1382
|
+
"multiple": false,
|
|
1383
|
+
"type": "option"
|
|
1174
1384
|
},
|
|
1175
1385
|
"header": {
|
|
1176
|
-
"name": "header",
|
|
1177
|
-
"type": "option",
|
|
1178
1386
|
"char": "H",
|
|
1179
1387
|
"description": "Specifies a request header to pass\n\nExample:\nstepzen import curl https://example.com/api/customers \\\n\t-H \"Authorization: apikey SecretAPIKeyValue\"",
|
|
1180
|
-
"
|
|
1388
|
+
"name": "header",
|
|
1389
|
+
"hasDynamicHelp": false,
|
|
1390
|
+
"multiple": true,
|
|
1391
|
+
"type": "option"
|
|
1181
1392
|
},
|
|
1182
1393
|
"header-param": {
|
|
1183
|
-
"name": "header-param",
|
|
1184
|
-
"type": "option",
|
|
1185
1394
|
"description": "Specifies a parameter in a header value. Can be formed by taking a -H, --header flag and replacing the variable part of the header value with a $paramName placeholder. Repeat this flag once for each header with a parameter.\n\nExample:\nstepzen import curl https://example.com/api/customers \\\n\t-H \"Authorization: apikey SecretAPIKeyValue\" \\\n\t--header-param 'Authorization: apikey $apikey'",
|
|
1186
|
-
"
|
|
1395
|
+
"name": "header-param",
|
|
1396
|
+
"hasDynamicHelp": false,
|
|
1397
|
+
"multiple": true,
|
|
1398
|
+
"type": "option"
|
|
1187
1399
|
}
|
|
1188
1400
|
},
|
|
1189
|
-
"
|
|
1190
|
-
|
|
1191
|
-
|
|
1192
|
-
}
|
|
1193
|
-
}
|
|
1194
|
-
},
|
|
1195
|
-
"import": {
|
|
1196
|
-
"id": "import",
|
|
1197
|
-
"description": "Import a schema for an external data source or an API endpoint into your GraphQL API.\nSee more details with stepzen import [SOURCE] --help",
|
|
1198
|
-
"strict": true,
|
|
1199
|
-
"pluginName": "stepzen",
|
|
1401
|
+
"hasDynamicHelp": false,
|
|
1402
|
+
"hiddenAliases": [],
|
|
1403
|
+
"id": "import:graphql",
|
|
1200
1404
|
"pluginAlias": "stepzen",
|
|
1405
|
+
"pluginName": "stepzen",
|
|
1201
1406
|
"pluginType": "core",
|
|
1407
|
+
"strict": true,
|
|
1408
|
+
"enableJsonFlag": false,
|
|
1409
|
+
"isESM": true,
|
|
1410
|
+
"relativePath": [
|
|
1411
|
+
"lib",
|
|
1412
|
+
"commands",
|
|
1413
|
+
"import",
|
|
1414
|
+
"graphql.js"
|
|
1415
|
+
]
|
|
1416
|
+
},
|
|
1417
|
+
"import": {
|
|
1202
1418
|
"aliases": [],
|
|
1419
|
+
"args": {
|
|
1420
|
+
"source": {
|
|
1421
|
+
"description": "kind of the data source: curl, graphql, mysql, postgresql, snowflake, db2, oracle (or a full DSN string)",
|
|
1422
|
+
"name": "source"
|
|
1423
|
+
}
|
|
1424
|
+
},
|
|
1425
|
+
"description": "Import a schema for an external data source or an API endpoint into your GraphQL API.\nSee more details with stepzen import [SOURCE] --help",
|
|
1203
1426
|
"flags": {
|
|
1204
1427
|
"help": {
|
|
1205
|
-
"name": "help",
|
|
1206
|
-
"type": "boolean",
|
|
1207
1428
|
"char": "h",
|
|
1208
1429
|
"description": "Show CLI help",
|
|
1209
|
-
"
|
|
1430
|
+
"name": "help",
|
|
1431
|
+
"allowNo": false,
|
|
1432
|
+
"type": "boolean"
|
|
1210
1433
|
},
|
|
1211
1434
|
"non-interactive": {
|
|
1212
|
-
"name": "non-interactive",
|
|
1213
|
-
"type": "boolean",
|
|
1214
1435
|
"description": "Disable all interactive prompts",
|
|
1215
|
-
"
|
|
1436
|
+
"name": "non-interactive",
|
|
1437
|
+
"allowNo": false,
|
|
1438
|
+
"type": "boolean"
|
|
1216
1439
|
},
|
|
1217
1440
|
"dir": {
|
|
1218
|
-
"name": "dir",
|
|
1219
|
-
"type": "option",
|
|
1220
1441
|
"description": "Working directory",
|
|
1221
|
-
"
|
|
1442
|
+
"name": "dir",
|
|
1443
|
+
"hasDynamicHelp": false,
|
|
1444
|
+
"multiple": false,
|
|
1445
|
+
"type": "option"
|
|
1222
1446
|
}
|
|
1223
1447
|
},
|
|
1224
|
-
"
|
|
1225
|
-
|
|
1226
|
-
|
|
1227
|
-
"description": "kind of the data source: curl, graphql, mysql, postgresql, snowflake, db2, oracle (or a full DSN string)"
|
|
1228
|
-
}
|
|
1229
|
-
}
|
|
1230
|
-
},
|
|
1231
|
-
"import:mysql": {
|
|
1232
|
-
"id": "import:mysql",
|
|
1233
|
-
"description": "Import a schema for a MySQL data source into your GraphQL API.\n\nstepzen import mysql automatically introspects a MySQL database, generates a GraphQL schema for accessing this database through a StepZen API, and merges the generated types, queries and mutations into your into your GraphQL schema.",
|
|
1234
|
-
"strict": true,
|
|
1235
|
-
"pluginName": "stepzen",
|
|
1448
|
+
"hasDynamicHelp": false,
|
|
1449
|
+
"hiddenAliases": [],
|
|
1450
|
+
"id": "import",
|
|
1236
1451
|
"pluginAlias": "stepzen",
|
|
1452
|
+
"pluginName": "stepzen",
|
|
1237
1453
|
"pluginType": "core",
|
|
1454
|
+
"strict": false,
|
|
1455
|
+
"enableJsonFlag": false,
|
|
1456
|
+
"isESM": true,
|
|
1457
|
+
"relativePath": [
|
|
1458
|
+
"lib",
|
|
1459
|
+
"commands",
|
|
1460
|
+
"import",
|
|
1461
|
+
"index.js"
|
|
1462
|
+
]
|
|
1463
|
+
},
|
|
1464
|
+
"import:mysql": {
|
|
1238
1465
|
"aliases": [
|
|
1239
1466
|
"import:singlestore"
|
|
1240
1467
|
],
|
|
1468
|
+
"args": {
|
|
1469
|
+
"dsn": {
|
|
1470
|
+
"description": "(optional) Data Source Name (DSN) of a MySQL database.\nExample: mysql://user:password@host:port/database\n\nFlags, such as --db-host, override the corresponding parts of the DSN (if both are provided).",
|
|
1471
|
+
"name": "dsn"
|
|
1472
|
+
}
|
|
1473
|
+
},
|
|
1474
|
+
"description": "Import a schema for a MySQL data source into your GraphQL API.\n\nstepzen import mysql automatically introspects a MySQL database, generates a GraphQL schema for accessing this database through a StepZen API, and merges the generated types, queries and mutations into your into your GraphQL schema.",
|
|
1241
1475
|
"flags": {
|
|
1242
1476
|
"help": {
|
|
1243
|
-
"name": "help",
|
|
1244
|
-
"type": "boolean",
|
|
1245
1477
|
"char": "h",
|
|
1246
1478
|
"description": "Show CLI help",
|
|
1247
|
-
"
|
|
1479
|
+
"name": "help",
|
|
1480
|
+
"allowNo": false,
|
|
1481
|
+
"type": "boolean"
|
|
1248
1482
|
},
|
|
1249
1483
|
"non-interactive": {
|
|
1250
|
-
"name": "non-interactive",
|
|
1251
|
-
"type": "boolean",
|
|
1252
1484
|
"description": "Disable all interactive prompts",
|
|
1253
|
-
"
|
|
1485
|
+
"name": "non-interactive",
|
|
1486
|
+
"allowNo": false,
|
|
1487
|
+
"type": "boolean"
|
|
1254
1488
|
},
|
|
1255
1489
|
"dir": {
|
|
1256
|
-
"name": "dir",
|
|
1257
|
-
"type": "option",
|
|
1258
1490
|
"description": "Working directory",
|
|
1259
|
-
"
|
|
1491
|
+
"name": "dir",
|
|
1492
|
+
"hasDynamicHelp": false,
|
|
1493
|
+
"multiple": false,
|
|
1494
|
+
"type": "option"
|
|
1260
1495
|
},
|
|
1261
1496
|
"silent": {
|
|
1262
|
-
"name": "silent",
|
|
1263
|
-
"type": "boolean",
|
|
1264
1497
|
"description": "This is an internal flag passed by the (no-arg) Import command when it launches a data-source specific import command. The intent is to avoid showing a welcome message twice (if its already been shown by the (no-arg) Import command).",
|
|
1265
1498
|
"hidden": true,
|
|
1266
|
-
"
|
|
1499
|
+
"name": "silent",
|
|
1500
|
+
"allowNo": false,
|
|
1501
|
+
"type": "boolean"
|
|
1267
1502
|
},
|
|
1268
1503
|
"name": {
|
|
1269
|
-
"name": "name",
|
|
1270
|
-
"type": "option",
|
|
1271
1504
|
"description": "Subfolder inside the workspace folder to save the imported schema files to. Defaults to the name of the imported schema.",
|
|
1272
|
-
"
|
|
1505
|
+
"name": "name",
|
|
1506
|
+
"hasDynamicHelp": false,
|
|
1507
|
+
"multiple": false,
|
|
1508
|
+
"type": "option"
|
|
1273
1509
|
},
|
|
1274
1510
|
"overwrite": {
|
|
1275
|
-
"
|
|
1276
|
-
|
|
1511
|
+
"dependsOn": [
|
|
1512
|
+
"name"
|
|
1513
|
+
],
|
|
1277
1514
|
"description": "Overwrite any existing schema with the same name. Cannot be used without also providing a --name flag.",
|
|
1278
1515
|
"hidden": true,
|
|
1516
|
+
"name": "overwrite",
|
|
1279
1517
|
"allowNo": false,
|
|
1280
|
-
"
|
|
1281
|
-
"name"
|
|
1282
|
-
]
|
|
1518
|
+
"type": "boolean"
|
|
1283
1519
|
},
|
|
1284
1520
|
"db-host": {
|
|
1285
|
-
"name": "db-host",
|
|
1286
|
-
"type": "option",
|
|
1287
1521
|
"description": "Database host and optional port (as HOST[:PORT])",
|
|
1288
|
-
"
|
|
1522
|
+
"name": "db-host",
|
|
1523
|
+
"hasDynamicHelp": false,
|
|
1524
|
+
"multiple": false,
|
|
1525
|
+
"type": "option"
|
|
1289
1526
|
},
|
|
1290
1527
|
"db-user": {
|
|
1291
|
-
"name": "db-user",
|
|
1292
|
-
"type": "option",
|
|
1293
1528
|
"description": "Database user name",
|
|
1294
|
-
"
|
|
1529
|
+
"name": "db-user",
|
|
1530
|
+
"hasDynamicHelp": false,
|
|
1531
|
+
"multiple": false,
|
|
1532
|
+
"type": "option"
|
|
1295
1533
|
},
|
|
1296
1534
|
"db-password": {
|
|
1297
|
-
"name": "db-password",
|
|
1298
|
-
"type": "option",
|
|
1299
1535
|
"description": "Database password",
|
|
1300
|
-
"
|
|
1536
|
+
"name": "db-password",
|
|
1537
|
+
"hasDynamicHelp": false,
|
|
1538
|
+
"multiple": false,
|
|
1539
|
+
"type": "option"
|
|
1301
1540
|
},
|
|
1302
1541
|
"db-database": {
|
|
1303
|
-
"name": "db-database",
|
|
1304
|
-
"type": "option",
|
|
1305
1542
|
"description": "Name of database to import",
|
|
1306
|
-
"
|
|
1543
|
+
"name": "db-database",
|
|
1544
|
+
"hasDynamicHelp": false,
|
|
1545
|
+
"multiple": false,
|
|
1546
|
+
"type": "option"
|
|
1307
1547
|
},
|
|
1308
1548
|
"db-link-types": {
|
|
1309
|
-
"name": "db-link-types",
|
|
1310
|
-
"type": "boolean",
|
|
1311
1549
|
"description": "Automatically link types based on foreign key relationships using @materializer (https://stepzen.com/docs/features/linking-types)",
|
|
1312
|
-
"
|
|
1550
|
+
"name": "db-link-types",
|
|
1551
|
+
"allowNo": false,
|
|
1552
|
+
"type": "boolean"
|
|
1313
1553
|
},
|
|
1314
1554
|
"db-include": {
|
|
1315
|
-
"name": "db-include",
|
|
1316
|
-
"type": "option",
|
|
1317
1555
|
"description": "Should the generated GraphQL schema be based only on database views, only on tables or on both",
|
|
1556
|
+
"name": "db-include",
|
|
1557
|
+
"hasDynamicHelp": false,
|
|
1318
1558
|
"multiple": false,
|
|
1319
1559
|
"options": [
|
|
1320
1560
|
"tables-only",
|
|
1321
1561
|
"views-only",
|
|
1322
1562
|
"tables-and-views"
|
|
1323
|
-
]
|
|
1563
|
+
],
|
|
1564
|
+
"type": "option"
|
|
1324
1565
|
},
|
|
1325
1566
|
"db-use-deprecated-2022-naming": {
|
|
1326
|
-
"name": "db-use-deprecated-2022-naming",
|
|
1327
|
-
"type": "boolean",
|
|
1328
1567
|
"description": "Use the deprecated pre-2023 naming convention in the generated GraphQL schema:\n\t- the generated type and property names are auto-capitalized into PascalCase\n\t- the generated field names use the getCustomer and getCustomerList style.\n\nOn the other hand, when using the default naming convention:\n\t- the generated type and property names match exactly the DB table and column names\n\t- the generated field names use the customer and customerList style.",
|
|
1329
|
-
"
|
|
1568
|
+
"name": "db-use-deprecated-2022-naming",
|
|
1569
|
+
"allowNo": false,
|
|
1570
|
+
"type": "boolean"
|
|
1330
1571
|
}
|
|
1331
1572
|
},
|
|
1332
|
-
"
|
|
1333
|
-
|
|
1334
|
-
|
|
1335
|
-
"description": "(optional) Data Source Name (DSN) of a MySQL database.\nExample: mysql://user:password@host:port/database\n\nFlags, such as --db-host, override the corresponding parts of the DSN (if both are provided)."
|
|
1336
|
-
}
|
|
1337
|
-
}
|
|
1338
|
-
},
|
|
1339
|
-
"import:openapi": {
|
|
1340
|
-
"id": "import:openapi",
|
|
1341
|
-
"description": "Import a REST API from an OpenAPI spec as a subgraph into your GraphQL API.\n\nstepzen import openapi automatically introspects an OpenAPI spec file, generates a GraphQL schema for accessing the REST API it describes through a StepZen API, and adds the generated types, queries, mutations and subscriptions for accessing this REST API through a StepZen API into your GraphQL schema.",
|
|
1342
|
-
"strict": true,
|
|
1343
|
-
"pluginName": "stepzen",
|
|
1573
|
+
"hasDynamicHelp": false,
|
|
1574
|
+
"hiddenAliases": [],
|
|
1575
|
+
"id": "import:mysql",
|
|
1344
1576
|
"pluginAlias": "stepzen",
|
|
1577
|
+
"pluginName": "stepzen",
|
|
1345
1578
|
"pluginType": "core",
|
|
1346
|
-
"
|
|
1579
|
+
"strict": true,
|
|
1580
|
+
"enableJsonFlag": false,
|
|
1581
|
+
"isESM": true,
|
|
1582
|
+
"relativePath": [
|
|
1583
|
+
"lib",
|
|
1584
|
+
"commands",
|
|
1585
|
+
"import",
|
|
1586
|
+
"mysql.js"
|
|
1587
|
+
]
|
|
1588
|
+
},
|
|
1589
|
+
"import:openapi": {
|
|
1347
1590
|
"aliases": [],
|
|
1591
|
+
"args": {
|
|
1592
|
+
"openapi": {
|
|
1593
|
+
"name": "openapi"
|
|
1594
|
+
}
|
|
1595
|
+
},
|
|
1596
|
+
"description": "Import a REST API from an OpenAPI spec as a subgraph into your GraphQL API.\n\nstepzen import openapi automatically introspects an OpenAPI spec file, generates a GraphQL schema for accessing the REST API it describes through a StepZen API, and adds the generated types, queries, mutations and subscriptions for accessing this REST API through a StepZen API into your GraphQL schema.",
|
|
1348
1597
|
"flags": {
|
|
1349
1598
|
"help": {
|
|
1350
|
-
"name": "help",
|
|
1351
|
-
"type": "boolean",
|
|
1352
1599
|
"char": "h",
|
|
1353
1600
|
"description": "Show CLI help",
|
|
1354
|
-
"
|
|
1601
|
+
"name": "help",
|
|
1602
|
+
"allowNo": false,
|
|
1603
|
+
"type": "boolean"
|
|
1355
1604
|
},
|
|
1356
1605
|
"non-interactive": {
|
|
1357
|
-
"name": "non-interactive",
|
|
1358
|
-
"type": "boolean",
|
|
1359
1606
|
"description": "Disable all interactive prompts",
|
|
1360
|
-
"
|
|
1607
|
+
"name": "non-interactive",
|
|
1608
|
+
"allowNo": false,
|
|
1609
|
+
"type": "boolean"
|
|
1361
1610
|
},
|
|
1362
1611
|
"dir": {
|
|
1363
|
-
"name": "dir",
|
|
1364
|
-
"type": "option",
|
|
1365
1612
|
"description": "Working directory",
|
|
1366
|
-
"
|
|
1613
|
+
"name": "dir",
|
|
1614
|
+
"hasDynamicHelp": false,
|
|
1615
|
+
"multiple": false,
|
|
1616
|
+
"type": "option"
|
|
1367
1617
|
},
|
|
1368
1618
|
"silent": {
|
|
1369
|
-
"name": "silent",
|
|
1370
|
-
"type": "boolean",
|
|
1371
1619
|
"description": "This is an internal flag passed by the (no-arg) Import command when it launches a data-source specific import command. The intent is to avoid showing a welcome message twice (if its already been shown by the (no-arg) Import command).",
|
|
1372
1620
|
"hidden": true,
|
|
1373
|
-
"
|
|
1621
|
+
"name": "silent",
|
|
1622
|
+
"allowNo": false,
|
|
1623
|
+
"type": "boolean"
|
|
1374
1624
|
},
|
|
1375
1625
|
"name": {
|
|
1376
|
-
"name": "name",
|
|
1377
|
-
"type": "option",
|
|
1378
1626
|
"description": "Subfolder inside the workspace folder to save the imported schema files to. Defaults to the name of the imported schema.",
|
|
1379
|
-
"
|
|
1627
|
+
"name": "name",
|
|
1628
|
+
"hasDynamicHelp": false,
|
|
1629
|
+
"multiple": false,
|
|
1630
|
+
"type": "option"
|
|
1380
1631
|
},
|
|
1381
1632
|
"overwrite": {
|
|
1382
|
-
"
|
|
1383
|
-
|
|
1633
|
+
"dependsOn": [
|
|
1634
|
+
"name"
|
|
1635
|
+
],
|
|
1384
1636
|
"description": "Overwrite any existing schema with the same name. Cannot be used without also providing a --name flag.",
|
|
1385
1637
|
"hidden": true,
|
|
1638
|
+
"name": "overwrite",
|
|
1386
1639
|
"allowNo": false,
|
|
1387
|
-
"
|
|
1388
|
-
"name"
|
|
1389
|
-
]
|
|
1640
|
+
"type": "boolean"
|
|
1390
1641
|
}
|
|
1391
1642
|
},
|
|
1392
|
-
"
|
|
1393
|
-
|
|
1394
|
-
|
|
1395
|
-
|
|
1396
|
-
}
|
|
1397
|
-
},
|
|
1398
|
-
"import:oracle": {
|
|
1399
|
-
"id": "import:oracle",
|
|
1400
|
-
"description": "Import a schema for a oracle data source into your GraphQL API.\n\nstepzen import oracle automatically introspects an Oracle database, generates a GraphQL schema for accessing this database through a StepZen API, and merges the generated types, queries and mutations into your GraphQL schema.",
|
|
1401
|
-
"strict": true,
|
|
1402
|
-
"pluginName": "stepzen",
|
|
1643
|
+
"hasDynamicHelp": false,
|
|
1644
|
+
"hidden": true,
|
|
1645
|
+
"hiddenAliases": [],
|
|
1646
|
+
"id": "import:openapi",
|
|
1403
1647
|
"pluginAlias": "stepzen",
|
|
1648
|
+
"pluginName": "stepzen",
|
|
1404
1649
|
"pluginType": "core",
|
|
1650
|
+
"strict": true,
|
|
1651
|
+
"enableJsonFlag": false,
|
|
1652
|
+
"isESM": true,
|
|
1653
|
+
"relativePath": [
|
|
1654
|
+
"lib",
|
|
1655
|
+
"commands",
|
|
1656
|
+
"import",
|
|
1657
|
+
"openapi.js"
|
|
1658
|
+
]
|
|
1659
|
+
},
|
|
1660
|
+
"import:oracle": {
|
|
1405
1661
|
"aliases": [],
|
|
1662
|
+
"args": {
|
|
1663
|
+
"dsn": {
|
|
1664
|
+
"description": "(optional) Data Source Name (DSN) of an Oracle database.\nExample: 'jdbc:oracle:thin:user/password@//host:port/db?currentschema=schema'\n\nFlags, such as --db-host, override the corresponding parts of the DSN (if both are provided).",
|
|
1665
|
+
"name": "dsn"
|
|
1666
|
+
}
|
|
1667
|
+
},
|
|
1668
|
+
"description": "Import a schema for a oracle data source into your GraphQL API.\n\nstepzen import oracle automatically introspects an Oracle database, generates a GraphQL schema for accessing this database through a StepZen API, and merges the generated types, queries and mutations into your GraphQL schema.",
|
|
1406
1669
|
"flags": {
|
|
1407
1670
|
"help": {
|
|
1408
|
-
"name": "help",
|
|
1409
|
-
"type": "boolean",
|
|
1410
1671
|
"char": "h",
|
|
1411
1672
|
"description": "Show CLI help",
|
|
1412
|
-
"
|
|
1673
|
+
"name": "help",
|
|
1674
|
+
"allowNo": false,
|
|
1675
|
+
"type": "boolean"
|
|
1413
1676
|
},
|
|
1414
1677
|
"non-interactive": {
|
|
1415
|
-
"name": "non-interactive",
|
|
1416
|
-
"type": "boolean",
|
|
1417
1678
|
"description": "Disable all interactive prompts",
|
|
1418
|
-
"
|
|
1679
|
+
"name": "non-interactive",
|
|
1680
|
+
"allowNo": false,
|
|
1681
|
+
"type": "boolean"
|
|
1419
1682
|
},
|
|
1420
1683
|
"dir": {
|
|
1421
|
-
"name": "dir",
|
|
1422
|
-
"type": "option",
|
|
1423
1684
|
"description": "Working directory",
|
|
1424
|
-
"
|
|
1685
|
+
"name": "dir",
|
|
1686
|
+
"hasDynamicHelp": false,
|
|
1687
|
+
"multiple": false,
|
|
1688
|
+
"type": "option"
|
|
1425
1689
|
},
|
|
1426
1690
|
"silent": {
|
|
1427
|
-
"name": "silent",
|
|
1428
|
-
"type": "boolean",
|
|
1429
1691
|
"description": "This is an internal flag passed by the (no-arg) Import command when it launches a data-source specific import command. The intent is to avoid showing a welcome message twice (if its already been shown by the (no-arg) Import command).",
|
|
1430
1692
|
"hidden": true,
|
|
1431
|
-
"
|
|
1693
|
+
"name": "silent",
|
|
1694
|
+
"allowNo": false,
|
|
1695
|
+
"type": "boolean"
|
|
1432
1696
|
},
|
|
1433
1697
|
"name": {
|
|
1434
|
-
"name": "name",
|
|
1435
|
-
"type": "option",
|
|
1436
1698
|
"description": "Subfolder inside the workspace folder to save the imported schema files to. Defaults to the name of the imported schema.",
|
|
1437
|
-
"
|
|
1699
|
+
"name": "name",
|
|
1700
|
+
"hasDynamicHelp": false,
|
|
1701
|
+
"multiple": false,
|
|
1702
|
+
"type": "option"
|
|
1438
1703
|
},
|
|
1439
1704
|
"overwrite": {
|
|
1440
|
-
"
|
|
1441
|
-
|
|
1705
|
+
"dependsOn": [
|
|
1706
|
+
"name"
|
|
1707
|
+
],
|
|
1442
1708
|
"description": "Overwrite any existing schema with the same name. Cannot be used without also providing a --name flag.",
|
|
1443
1709
|
"hidden": true,
|
|
1710
|
+
"name": "overwrite",
|
|
1444
1711
|
"allowNo": false,
|
|
1445
|
-
"
|
|
1446
|
-
"name"
|
|
1447
|
-
]
|
|
1712
|
+
"type": "boolean"
|
|
1448
1713
|
},
|
|
1449
1714
|
"db-host": {
|
|
1450
|
-
"name": "db-host",
|
|
1451
|
-
"type": "option",
|
|
1452
1715
|
"description": "Database host and optional port (as HOST[:PORT])",
|
|
1453
|
-
"
|
|
1716
|
+
"name": "db-host",
|
|
1717
|
+
"hasDynamicHelp": false,
|
|
1718
|
+
"multiple": false,
|
|
1719
|
+
"type": "option"
|
|
1454
1720
|
},
|
|
1455
1721
|
"db-user": {
|
|
1456
|
-
"name": "db-user",
|
|
1457
|
-
"type": "option",
|
|
1458
1722
|
"description": "Database user name",
|
|
1459
|
-
"
|
|
1723
|
+
"name": "db-user",
|
|
1724
|
+
"hasDynamicHelp": false,
|
|
1725
|
+
"multiple": false,
|
|
1726
|
+
"type": "option"
|
|
1460
1727
|
},
|
|
1461
1728
|
"db-password": {
|
|
1462
|
-
"name": "db-password",
|
|
1463
|
-
"type": "option",
|
|
1464
1729
|
"description": "Database password",
|
|
1465
|
-
"
|
|
1730
|
+
"name": "db-password",
|
|
1731
|
+
"hasDynamicHelp": false,
|
|
1732
|
+
"multiple": false,
|
|
1733
|
+
"type": "option"
|
|
1466
1734
|
},
|
|
1467
1735
|
"db-database": {
|
|
1468
|
-
"name": "db-database",
|
|
1469
|
-
"type": "option",
|
|
1470
1736
|
"description": "Name of database to import",
|
|
1471
|
-
"
|
|
1737
|
+
"name": "db-database",
|
|
1738
|
+
"hasDynamicHelp": false,
|
|
1739
|
+
"multiple": false,
|
|
1740
|
+
"type": "option"
|
|
1472
1741
|
},
|
|
1473
1742
|
"db-schema": {
|
|
1474
|
-
"name": "db-schema",
|
|
1475
|
-
"type": "option",
|
|
1476
1743
|
"description": "Database schema to import tables from (default: public)",
|
|
1477
|
-
"
|
|
1744
|
+
"name": "db-schema",
|
|
1745
|
+
"hasDynamicHelp": false,
|
|
1746
|
+
"multiple": false,
|
|
1747
|
+
"type": "option"
|
|
1478
1748
|
},
|
|
1479
1749
|
"db-link-types": {
|
|
1480
|
-
"name": "db-link-types",
|
|
1481
|
-
"type": "boolean",
|
|
1482
1750
|
"description": "Automatically link types based on foreign key relationships using @materializer (https://stepzen.com/docs/features/linking-types)",
|
|
1483
|
-
"
|
|
1751
|
+
"name": "db-link-types",
|
|
1752
|
+
"allowNo": false,
|
|
1753
|
+
"type": "boolean"
|
|
1484
1754
|
},
|
|
1485
1755
|
"db-include": {
|
|
1486
|
-
"name": "db-include",
|
|
1487
|
-
"type": "option",
|
|
1488
1756
|
"description": "Should the generated GraphQL schema be based only on database views, only on tables or on both",
|
|
1757
|
+
"name": "db-include",
|
|
1758
|
+
"hasDynamicHelp": false,
|
|
1489
1759
|
"multiple": false,
|
|
1490
1760
|
"options": [
|
|
1491
1761
|
"tables-only",
|
|
1492
1762
|
"views-only",
|
|
1493
1763
|
"tables-and-views"
|
|
1494
|
-
]
|
|
1764
|
+
],
|
|
1765
|
+
"type": "option"
|
|
1495
1766
|
},
|
|
1496
1767
|
"db-use-deprecated-2022-naming": {
|
|
1497
|
-
"name": "db-use-deprecated-2022-naming",
|
|
1498
|
-
"type": "boolean",
|
|
1499
1768
|
"description": "Use the deprecated pre-2023 naming convention in the generated GraphQL schema:\n\t- the generated type and property names are auto-capitalized into PascalCase\n\t- the generated field names use the getCustomer and getCustomerList style.\n\nOn the other hand, when using the default naming convention:\n\t- the generated type and property names match exactly the DB table and column names\n\t- the generated field names use the customer and customerList style.",
|
|
1500
|
-
"
|
|
1769
|
+
"name": "db-use-deprecated-2022-naming",
|
|
1770
|
+
"allowNo": false,
|
|
1771
|
+
"type": "boolean"
|
|
1501
1772
|
}
|
|
1502
1773
|
},
|
|
1503
|
-
"
|
|
1504
|
-
|
|
1505
|
-
|
|
1506
|
-
"description": "(optional) Data Source Name (DSN) of an Oracle database.\nExample: 'jdbc:oracle:thin:user/password@//host:port/db?currentschema=schema'\n\nFlags, such as --db-host, override the corresponding parts of the DSN (if both are provided)."
|
|
1507
|
-
}
|
|
1508
|
-
}
|
|
1509
|
-
},
|
|
1510
|
-
"import:postgresql": {
|
|
1511
|
-
"id": "import:postgresql",
|
|
1512
|
-
"description": "Import a schema for a PostgreSQL data source into your GraphQL API.\n\nstepzen import postgresql automatically introspects a PostgreSQL database, generates a GraphQL schema for accessing this database through a StepZen API, and merges the generated types, queries and mutations into your GraphQL schema.",
|
|
1513
|
-
"strict": true,
|
|
1514
|
-
"pluginName": "stepzen",
|
|
1774
|
+
"hasDynamicHelp": false,
|
|
1775
|
+
"hiddenAliases": [],
|
|
1776
|
+
"id": "import:oracle",
|
|
1515
1777
|
"pluginAlias": "stepzen",
|
|
1778
|
+
"pluginName": "stepzen",
|
|
1516
1779
|
"pluginType": "core",
|
|
1780
|
+
"strict": true,
|
|
1781
|
+
"enableJsonFlag": false,
|
|
1782
|
+
"isESM": true,
|
|
1783
|
+
"relativePath": [
|
|
1784
|
+
"lib",
|
|
1785
|
+
"commands",
|
|
1786
|
+
"import",
|
|
1787
|
+
"oracle.js"
|
|
1788
|
+
]
|
|
1789
|
+
},
|
|
1790
|
+
"import:postgresql": {
|
|
1517
1791
|
"aliases": [
|
|
1518
1792
|
"import:postgres"
|
|
1519
1793
|
],
|
|
1794
|
+
"args": {
|
|
1795
|
+
"dsn": {
|
|
1796
|
+
"description": "(optional) Data Source Name (DSN) of a PostgreSQL database.\nExample: postgresql://user:password@host:port/database?schema=schema\n\nFlags, such as --db-host, override the corresponding parts of the DSN (if both are provided).",
|
|
1797
|
+
"name": "dsn"
|
|
1798
|
+
}
|
|
1799
|
+
},
|
|
1800
|
+
"description": "Import a schema for a PostgreSQL data source into your GraphQL API.\n\nstepzen import postgresql automatically introspects a PostgreSQL database, generates a GraphQL schema for accessing this database through a StepZen API, and merges the generated types, queries and mutations into your GraphQL schema.",
|
|
1520
1801
|
"flags": {
|
|
1521
1802
|
"help": {
|
|
1522
|
-
"name": "help",
|
|
1523
|
-
"type": "boolean",
|
|
1524
1803
|
"char": "h",
|
|
1525
1804
|
"description": "Show CLI help",
|
|
1526
|
-
"
|
|
1805
|
+
"name": "help",
|
|
1806
|
+
"allowNo": false,
|
|
1807
|
+
"type": "boolean"
|
|
1527
1808
|
},
|
|
1528
1809
|
"non-interactive": {
|
|
1529
|
-
"name": "non-interactive",
|
|
1530
|
-
"type": "boolean",
|
|
1531
1810
|
"description": "Disable all interactive prompts",
|
|
1532
|
-
"
|
|
1811
|
+
"name": "non-interactive",
|
|
1812
|
+
"allowNo": false,
|
|
1813
|
+
"type": "boolean"
|
|
1533
1814
|
},
|
|
1534
1815
|
"dir": {
|
|
1535
|
-
"name": "dir",
|
|
1536
|
-
"type": "option",
|
|
1537
1816
|
"description": "Working directory",
|
|
1538
|
-
"
|
|
1817
|
+
"name": "dir",
|
|
1818
|
+
"hasDynamicHelp": false,
|
|
1819
|
+
"multiple": false,
|
|
1820
|
+
"type": "option"
|
|
1539
1821
|
},
|
|
1540
1822
|
"silent": {
|
|
1541
|
-
"name": "silent",
|
|
1542
|
-
"type": "boolean",
|
|
1543
1823
|
"description": "This is an internal flag passed by the (no-arg) Import command when it launches a data-source specific import command. The intent is to avoid showing a welcome message twice (if its already been shown by the (no-arg) Import command).",
|
|
1544
1824
|
"hidden": true,
|
|
1545
|
-
"
|
|
1825
|
+
"name": "silent",
|
|
1826
|
+
"allowNo": false,
|
|
1827
|
+
"type": "boolean"
|
|
1546
1828
|
},
|
|
1547
1829
|
"name": {
|
|
1548
|
-
"name": "name",
|
|
1549
|
-
"type": "option",
|
|
1550
1830
|
"description": "Subfolder inside the workspace folder to save the imported schema files to. Defaults to the name of the imported schema.",
|
|
1551
|
-
"
|
|
1831
|
+
"name": "name",
|
|
1832
|
+
"hasDynamicHelp": false,
|
|
1833
|
+
"multiple": false,
|
|
1834
|
+
"type": "option"
|
|
1552
1835
|
},
|
|
1553
1836
|
"overwrite": {
|
|
1554
|
-
"
|
|
1555
|
-
|
|
1837
|
+
"dependsOn": [
|
|
1838
|
+
"name"
|
|
1839
|
+
],
|
|
1556
1840
|
"description": "Overwrite any existing schema with the same name. Cannot be used without also providing a --name flag.",
|
|
1557
1841
|
"hidden": true,
|
|
1842
|
+
"name": "overwrite",
|
|
1558
1843
|
"allowNo": false,
|
|
1559
|
-
"
|
|
1560
|
-
"name"
|
|
1561
|
-
]
|
|
1844
|
+
"type": "boolean"
|
|
1562
1845
|
},
|
|
1563
1846
|
"db-host": {
|
|
1564
|
-
"name": "db-host",
|
|
1565
|
-
"type": "option",
|
|
1566
1847
|
"description": "Database host and optional port (as HOST[:PORT])",
|
|
1567
|
-
"
|
|
1848
|
+
"name": "db-host",
|
|
1849
|
+
"hasDynamicHelp": false,
|
|
1850
|
+
"multiple": false,
|
|
1851
|
+
"type": "option"
|
|
1568
1852
|
},
|
|
1569
1853
|
"db-user": {
|
|
1570
|
-
"name": "db-user",
|
|
1571
|
-
"type": "option",
|
|
1572
1854
|
"description": "Database user name",
|
|
1573
|
-
"
|
|
1855
|
+
"name": "db-user",
|
|
1856
|
+
"hasDynamicHelp": false,
|
|
1857
|
+
"multiple": false,
|
|
1858
|
+
"type": "option"
|
|
1574
1859
|
},
|
|
1575
1860
|
"db-password": {
|
|
1576
|
-
"name": "db-password",
|
|
1577
|
-
"type": "option",
|
|
1578
1861
|
"description": "Database password",
|
|
1579
|
-
"
|
|
1862
|
+
"name": "db-password",
|
|
1863
|
+
"hasDynamicHelp": false,
|
|
1864
|
+
"multiple": false,
|
|
1865
|
+
"type": "option"
|
|
1580
1866
|
},
|
|
1581
1867
|
"db-database": {
|
|
1582
|
-
"name": "db-database",
|
|
1583
|
-
"type": "option",
|
|
1584
1868
|
"description": "Name of database to import",
|
|
1585
|
-
"
|
|
1869
|
+
"name": "db-database",
|
|
1870
|
+
"hasDynamicHelp": false,
|
|
1871
|
+
"multiple": false,
|
|
1872
|
+
"type": "option"
|
|
1586
1873
|
},
|
|
1587
1874
|
"db-schema": {
|
|
1588
|
-
"name": "db-schema",
|
|
1589
|
-
"type": "option",
|
|
1590
1875
|
"description": "Database schema to import tables from (default: public)",
|
|
1591
|
-
"
|
|
1876
|
+
"name": "db-schema",
|
|
1877
|
+
"hasDynamicHelp": false,
|
|
1878
|
+
"multiple": false,
|
|
1879
|
+
"type": "option"
|
|
1592
1880
|
},
|
|
1593
1881
|
"db-link-types": {
|
|
1594
|
-
"name": "db-link-types",
|
|
1595
|
-
"type": "boolean",
|
|
1596
1882
|
"description": "Automatically link types based on foreign key relationships using @materializer (https://stepzen.com/docs/features/linking-types)",
|
|
1597
|
-
"
|
|
1883
|
+
"name": "db-link-types",
|
|
1884
|
+
"allowNo": false,
|
|
1885
|
+
"type": "boolean"
|
|
1598
1886
|
},
|
|
1599
1887
|
"db-include": {
|
|
1600
|
-
"name": "db-include",
|
|
1601
|
-
"type": "option",
|
|
1602
1888
|
"description": "Should the generated GraphQL schema be based only on database views, only on tables or on both",
|
|
1889
|
+
"name": "db-include",
|
|
1890
|
+
"hasDynamicHelp": false,
|
|
1603
1891
|
"multiple": false,
|
|
1604
1892
|
"options": [
|
|
1605
1893
|
"tables-only",
|
|
1606
1894
|
"views-only",
|
|
1607
1895
|
"tables-and-views"
|
|
1608
|
-
]
|
|
1896
|
+
],
|
|
1897
|
+
"type": "option"
|
|
1609
1898
|
},
|
|
1610
1899
|
"db-use-deprecated-2022-naming": {
|
|
1611
|
-
"name": "db-use-deprecated-2022-naming",
|
|
1612
|
-
"type": "boolean",
|
|
1613
1900
|
"description": "Use the deprecated pre-2023 naming convention in the generated GraphQL schema:\n\t- the generated type and property names are auto-capitalized into PascalCase\n\t- the generated field names use the getCustomer and getCustomerList style.\n\nOn the other hand, when using the default naming convention:\n\t- the generated type and property names match exactly the DB table and column names\n\t- the generated field names use the customer and customerList style.",
|
|
1614
|
-
"
|
|
1901
|
+
"name": "db-use-deprecated-2022-naming",
|
|
1902
|
+
"allowNo": false,
|
|
1903
|
+
"type": "boolean"
|
|
1615
1904
|
}
|
|
1616
1905
|
},
|
|
1906
|
+
"hasDynamicHelp": false,
|
|
1907
|
+
"hiddenAliases": [],
|
|
1908
|
+
"id": "import:postgresql",
|
|
1909
|
+
"pluginAlias": "stepzen",
|
|
1910
|
+
"pluginName": "stepzen",
|
|
1911
|
+
"pluginType": "core",
|
|
1912
|
+
"strict": true,
|
|
1913
|
+
"enableJsonFlag": false,
|
|
1914
|
+
"isESM": true,
|
|
1915
|
+
"relativePath": [
|
|
1916
|
+
"lib",
|
|
1917
|
+
"commands",
|
|
1918
|
+
"import",
|
|
1919
|
+
"postgresql.js"
|
|
1920
|
+
]
|
|
1921
|
+
},
|
|
1922
|
+
"import:presto": {
|
|
1923
|
+
"aliases": [],
|
|
1617
1924
|
"args": {
|
|
1618
1925
|
"dsn": {
|
|
1619
|
-
"
|
|
1620
|
-
"
|
|
1926
|
+
"description": "(optional) Data Source Name (DSN) of a Presto data source.\nExample: presto://user:password@host:port/catalog\n\nFlags, such as --db-host, override the corresponding parts of the DSN (if both are provided).",
|
|
1927
|
+
"name": "dsn"
|
|
1621
1928
|
}
|
|
1622
|
-
}
|
|
1623
|
-
},
|
|
1624
|
-
"import:presto": {
|
|
1625
|
-
"id": "import:presto",
|
|
1929
|
+
},
|
|
1626
1930
|
"description": "Import a schema for a Presto data source into your GraphQL API.\n\nstepzen import presto automatically introspects a Presto database, generates a GraphQL schema for accessing this database through a StepZen API, and merges the generated types, queries and mutations into your into your GraphQL schema.",
|
|
1627
|
-
"strict": true,
|
|
1628
|
-
"pluginName": "stepzen",
|
|
1629
|
-
"pluginAlias": "stepzen",
|
|
1630
|
-
"pluginType": "core",
|
|
1631
|
-
"hidden": true,
|
|
1632
|
-
"aliases": [],
|
|
1633
1931
|
"flags": {
|
|
1634
1932
|
"help": {
|
|
1635
|
-
"name": "help",
|
|
1636
|
-
"type": "boolean",
|
|
1637
1933
|
"char": "h",
|
|
1638
1934
|
"description": "Show CLI help",
|
|
1639
|
-
"
|
|
1935
|
+
"name": "help",
|
|
1936
|
+
"allowNo": false,
|
|
1937
|
+
"type": "boolean"
|
|
1640
1938
|
},
|
|
1641
1939
|
"non-interactive": {
|
|
1642
|
-
"name": "non-interactive",
|
|
1643
|
-
"type": "boolean",
|
|
1644
1940
|
"description": "Disable all interactive prompts",
|
|
1645
|
-
"
|
|
1941
|
+
"name": "non-interactive",
|
|
1942
|
+
"allowNo": false,
|
|
1943
|
+
"type": "boolean"
|
|
1646
1944
|
},
|
|
1647
1945
|
"dir": {
|
|
1648
|
-
"name": "dir",
|
|
1649
|
-
"type": "option",
|
|
1650
1946
|
"description": "Working directory",
|
|
1651
|
-
"
|
|
1947
|
+
"name": "dir",
|
|
1948
|
+
"hasDynamicHelp": false,
|
|
1949
|
+
"multiple": false,
|
|
1950
|
+
"type": "option"
|
|
1652
1951
|
},
|
|
1653
1952
|
"silent": {
|
|
1654
|
-
"name": "silent",
|
|
1655
|
-
"type": "boolean",
|
|
1656
1953
|
"description": "This is an internal flag passed by the (no-arg) Import command when it launches a data-source specific import command. The intent is to avoid showing a welcome message twice (if its already been shown by the (no-arg) Import command).",
|
|
1657
1954
|
"hidden": true,
|
|
1658
|
-
"
|
|
1955
|
+
"name": "silent",
|
|
1956
|
+
"allowNo": false,
|
|
1957
|
+
"type": "boolean"
|
|
1659
1958
|
},
|
|
1660
1959
|
"name": {
|
|
1661
|
-
"name": "name",
|
|
1662
|
-
"type": "option",
|
|
1663
1960
|
"description": "Subfolder inside the workspace folder to save the imported schema files to. Defaults to the name of the imported schema.",
|
|
1664
|
-
"
|
|
1961
|
+
"name": "name",
|
|
1962
|
+
"hasDynamicHelp": false,
|
|
1963
|
+
"multiple": false,
|
|
1964
|
+
"type": "option"
|
|
1665
1965
|
},
|
|
1666
1966
|
"overwrite": {
|
|
1667
|
-
"
|
|
1668
|
-
|
|
1967
|
+
"dependsOn": [
|
|
1968
|
+
"name"
|
|
1969
|
+
],
|
|
1669
1970
|
"description": "Overwrite any existing schema with the same name. Cannot be used without also providing a --name flag.",
|
|
1670
1971
|
"hidden": true,
|
|
1972
|
+
"name": "overwrite",
|
|
1671
1973
|
"allowNo": false,
|
|
1672
|
-
"
|
|
1673
|
-
"name"
|
|
1674
|
-
]
|
|
1974
|
+
"type": "boolean"
|
|
1675
1975
|
},
|
|
1676
1976
|
"db-host": {
|
|
1677
|
-
"name": "db-host",
|
|
1678
|
-
"type": "option",
|
|
1679
1977
|
"description": "Database host and optional port (as HOST[:PORT])",
|
|
1680
|
-
"
|
|
1978
|
+
"name": "db-host",
|
|
1979
|
+
"hasDynamicHelp": false,
|
|
1980
|
+
"multiple": false,
|
|
1981
|
+
"type": "option"
|
|
1681
1982
|
},
|
|
1682
1983
|
"db-user": {
|
|
1683
|
-
"name": "db-user",
|
|
1684
|
-
"type": "option",
|
|
1685
1984
|
"description": "Database user name",
|
|
1686
|
-
"
|
|
1985
|
+
"name": "db-user",
|
|
1986
|
+
"hasDynamicHelp": false,
|
|
1987
|
+
"multiple": false,
|
|
1988
|
+
"type": "option"
|
|
1687
1989
|
},
|
|
1688
1990
|
"db-password": {
|
|
1689
|
-
"name": "db-password",
|
|
1690
|
-
"type": "option",
|
|
1691
1991
|
"description": "Database password",
|
|
1692
|
-
"
|
|
1992
|
+
"name": "db-password",
|
|
1993
|
+
"hasDynamicHelp": false,
|
|
1994
|
+
"multiple": false,
|
|
1995
|
+
"type": "option"
|
|
1693
1996
|
},
|
|
1694
1997
|
"db-catalog": {
|
|
1695
|
-
"name": "db-catalog",
|
|
1696
|
-
"type": "option",
|
|
1697
1998
|
"description": "Name of the catalog to import",
|
|
1698
|
-
"
|
|
1999
|
+
"name": "db-catalog",
|
|
2000
|
+
"hasDynamicHelp": false,
|
|
2001
|
+
"multiple": false,
|
|
2002
|
+
"type": "option"
|
|
1699
2003
|
},
|
|
1700
2004
|
"db-schema": {
|
|
1701
|
-
"name": "db-schema",
|
|
1702
|
-
"type": "option",
|
|
1703
2005
|
"description": "Database schema to import tables from (default: public)",
|
|
1704
|
-
"
|
|
2006
|
+
"name": "db-schema",
|
|
2007
|
+
"hasDynamicHelp": false,
|
|
2008
|
+
"multiple": false,
|
|
2009
|
+
"type": "option"
|
|
1705
2010
|
},
|
|
1706
2011
|
"db-link-types": {
|
|
1707
|
-
"name": "db-link-types",
|
|
1708
|
-
"type": "boolean",
|
|
1709
2012
|
"description": "Automatically link types based on foreign key relationships using @materializer (https://stepzen.com/docs/features/linking-types)",
|
|
1710
|
-
"
|
|
2013
|
+
"name": "db-link-types",
|
|
2014
|
+
"allowNo": false,
|
|
2015
|
+
"type": "boolean"
|
|
1711
2016
|
},
|
|
1712
2017
|
"db-include": {
|
|
1713
|
-
"name": "db-include",
|
|
1714
|
-
"type": "option",
|
|
1715
2018
|
"description": "Should the generated GraphQL schema be based only on database views, only on tables or on both",
|
|
2019
|
+
"name": "db-include",
|
|
2020
|
+
"hasDynamicHelp": false,
|
|
1716
2021
|
"multiple": false,
|
|
1717
2022
|
"options": [
|
|
1718
2023
|
"tables-only",
|
|
1719
2024
|
"views-only",
|
|
1720
2025
|
"tables-and-views"
|
|
1721
|
-
]
|
|
2026
|
+
],
|
|
2027
|
+
"type": "option"
|
|
1722
2028
|
}
|
|
1723
2029
|
},
|
|
2030
|
+
"hasDynamicHelp": false,
|
|
2031
|
+
"hidden": true,
|
|
2032
|
+
"hiddenAliases": [],
|
|
2033
|
+
"id": "import:presto",
|
|
2034
|
+
"pluginAlias": "stepzen",
|
|
2035
|
+
"pluginName": "stepzen",
|
|
2036
|
+
"pluginType": "core",
|
|
2037
|
+
"strict": true,
|
|
2038
|
+
"enableJsonFlag": false,
|
|
2039
|
+
"isESM": true,
|
|
2040
|
+
"relativePath": [
|
|
2041
|
+
"lib",
|
|
2042
|
+
"commands",
|
|
2043
|
+
"import",
|
|
2044
|
+
"presto.js"
|
|
2045
|
+
]
|
|
2046
|
+
},
|
|
2047
|
+
"import:snowflake": {
|
|
2048
|
+
"aliases": [],
|
|
1724
2049
|
"args": {
|
|
1725
2050
|
"dsn": {
|
|
1726
|
-
"
|
|
1727
|
-
"
|
|
2051
|
+
"description": "(optional) Data Source Name (DSN) of a Snowflake database.\nExample: snowflake://user:password@orgname-accountname/database?warehouse=warehouse&schema=schema\n\nFlags, such as --db-host, override the corresponding parts of the DSN (if both are provided).",
|
|
2052
|
+
"name": "dsn"
|
|
1728
2053
|
}
|
|
1729
|
-
}
|
|
1730
|
-
},
|
|
1731
|
-
"import:snowflake": {
|
|
1732
|
-
"id": "import:snowflake",
|
|
2054
|
+
},
|
|
1733
2055
|
"description": "Import a schema for a Snowflake data source into your GraphQL API.\n\nstepzen import snowflake automatically introspects a Snowflake database, generates a GraphQL schema for accessing this database through a StepZen API, and merges the generated types, queries and mutations into your GraphQL schema.",
|
|
1734
|
-
"strict": true,
|
|
1735
|
-
"pluginName": "stepzen",
|
|
1736
|
-
"pluginAlias": "stepzen",
|
|
1737
|
-
"pluginType": "core",
|
|
1738
|
-
"aliases": [],
|
|
1739
2056
|
"flags": {
|
|
1740
2057
|
"help": {
|
|
1741
|
-
"name": "help",
|
|
1742
|
-
"type": "boolean",
|
|
1743
2058
|
"char": "h",
|
|
1744
2059
|
"description": "Show CLI help",
|
|
1745
|
-
"
|
|
2060
|
+
"name": "help",
|
|
2061
|
+
"allowNo": false,
|
|
2062
|
+
"type": "boolean"
|
|
1746
2063
|
},
|
|
1747
2064
|
"non-interactive": {
|
|
1748
|
-
"name": "non-interactive",
|
|
1749
|
-
"type": "boolean",
|
|
1750
2065
|
"description": "Disable all interactive prompts",
|
|
1751
|
-
"
|
|
2066
|
+
"name": "non-interactive",
|
|
2067
|
+
"allowNo": false,
|
|
2068
|
+
"type": "boolean"
|
|
1752
2069
|
},
|
|
1753
2070
|
"dir": {
|
|
1754
|
-
"name": "dir",
|
|
1755
|
-
"type": "option",
|
|
1756
2071
|
"description": "Working directory",
|
|
1757
|
-
"
|
|
2072
|
+
"name": "dir",
|
|
2073
|
+
"hasDynamicHelp": false,
|
|
2074
|
+
"multiple": false,
|
|
2075
|
+
"type": "option"
|
|
1758
2076
|
},
|
|
1759
2077
|
"silent": {
|
|
1760
|
-
"name": "silent",
|
|
1761
|
-
"type": "boolean",
|
|
1762
2078
|
"description": "This is an internal flag passed by the (no-arg) Import command when it launches a data-source specific import command. The intent is to avoid showing a welcome message twice (if its already been shown by the (no-arg) Import command).",
|
|
1763
2079
|
"hidden": true,
|
|
1764
|
-
"
|
|
2080
|
+
"name": "silent",
|
|
2081
|
+
"allowNo": false,
|
|
2082
|
+
"type": "boolean"
|
|
1765
2083
|
},
|
|
1766
2084
|
"name": {
|
|
1767
|
-
"name": "name",
|
|
1768
|
-
"type": "option",
|
|
1769
2085
|
"description": "Subfolder inside the workspace folder to save the imported schema files to. Defaults to the name of the imported schema.",
|
|
1770
|
-
"
|
|
2086
|
+
"name": "name",
|
|
2087
|
+
"hasDynamicHelp": false,
|
|
2088
|
+
"multiple": false,
|
|
2089
|
+
"type": "option"
|
|
1771
2090
|
},
|
|
1772
2091
|
"overwrite": {
|
|
1773
|
-
"
|
|
1774
|
-
|
|
2092
|
+
"dependsOn": [
|
|
2093
|
+
"name"
|
|
2094
|
+
],
|
|
1775
2095
|
"description": "Overwrite any existing schema with the same name. Cannot be used without also providing a --name flag.",
|
|
1776
2096
|
"hidden": true,
|
|
2097
|
+
"name": "overwrite",
|
|
1777
2098
|
"allowNo": false,
|
|
1778
|
-
"
|
|
1779
|
-
"name"
|
|
1780
|
-
]
|
|
2099
|
+
"type": "boolean"
|
|
1781
2100
|
},
|
|
1782
2101
|
"db-user": {
|
|
1783
|
-
"name": "db-user",
|
|
1784
|
-
"type": "option",
|
|
1785
2102
|
"description": "Database user name",
|
|
1786
|
-
"
|
|
2103
|
+
"name": "db-user",
|
|
2104
|
+
"hasDynamicHelp": false,
|
|
2105
|
+
"multiple": false,
|
|
2106
|
+
"type": "option"
|
|
1787
2107
|
},
|
|
1788
2108
|
"db-password": {
|
|
1789
|
-
"name": "db-password",
|
|
1790
|
-
"type": "option",
|
|
1791
2109
|
"description": "Database password",
|
|
1792
|
-
"
|
|
2110
|
+
"name": "db-password",
|
|
2111
|
+
"hasDynamicHelp": false,
|
|
2112
|
+
"multiple": false,
|
|
2113
|
+
"type": "option"
|
|
1793
2114
|
},
|
|
1794
2115
|
"db-database": {
|
|
1795
|
-
"name": "db-database",
|
|
1796
|
-
"type": "option",
|
|
1797
2116
|
"description": "Name of database to import",
|
|
1798
|
-
"
|
|
2117
|
+
"name": "db-database",
|
|
2118
|
+
"hasDynamicHelp": false,
|
|
2119
|
+
"multiple": false,
|
|
2120
|
+
"type": "option"
|
|
1799
2121
|
},
|
|
1800
2122
|
"db-schema": {
|
|
1801
|
-
"name": "db-schema",
|
|
1802
|
-
"type": "option",
|
|
1803
2123
|
"description": "Database schema to import tables from (default: PUBLIC)",
|
|
1804
|
-
"
|
|
2124
|
+
"name": "db-schema",
|
|
2125
|
+
"hasDynamicHelp": false,
|
|
2126
|
+
"multiple": false,
|
|
2127
|
+
"type": "option"
|
|
1805
2128
|
},
|
|
1806
2129
|
"db-link-types": {
|
|
1807
|
-
"name": "db-link-types",
|
|
1808
|
-
"type": "boolean",
|
|
1809
2130
|
"description": "Automatically link types based on foreign key relationships using @materializer (https://stepzen.com/docs/features/linking-types)",
|
|
1810
|
-
"
|
|
2131
|
+
"name": "db-link-types",
|
|
2132
|
+
"allowNo": false,
|
|
2133
|
+
"type": "boolean"
|
|
1811
2134
|
},
|
|
1812
2135
|
"db-include": {
|
|
1813
|
-
"name": "db-include",
|
|
1814
|
-
"type": "option",
|
|
1815
2136
|
"description": "Should the generated GraphQL schema be based only on database views, only on tables or on both",
|
|
2137
|
+
"name": "db-include",
|
|
2138
|
+
"hasDynamicHelp": false,
|
|
1816
2139
|
"multiple": false,
|
|
1817
2140
|
"options": [
|
|
1818
2141
|
"tables-only",
|
|
1819
2142
|
"views-only",
|
|
1820
2143
|
"tables-and-views"
|
|
1821
|
-
]
|
|
2144
|
+
],
|
|
2145
|
+
"type": "option"
|
|
1822
2146
|
},
|
|
1823
2147
|
"db-use-deprecated-2022-naming": {
|
|
1824
|
-
"name": "db-use-deprecated-2022-naming",
|
|
1825
|
-
"type": "boolean",
|
|
1826
2148
|
"description": "Use the deprecated pre-2023 naming convention in the generated GraphQL schema:\n\t- the generated type and property names are auto-capitalized into PascalCase\n\t- the generated field names use the getCustomer and getCustomerList style.\n\nOn the other hand, when using the default naming convention:\n\t- the generated type and property names match exactly the DB table and column names\n\t- the generated field names use the customer and customerList style.",
|
|
1827
|
-
"
|
|
2149
|
+
"name": "db-use-deprecated-2022-naming",
|
|
2150
|
+
"allowNo": false,
|
|
2151
|
+
"type": "boolean"
|
|
1828
2152
|
},
|
|
1829
2153
|
"snowflake-account-id": {
|
|
1830
|
-
"name": "snowflake-account-id",
|
|
1831
|
-
"type": "option",
|
|
1832
2154
|
"description": "Snowflake account identifier in the orgname-accountname format. For more information, see the Snowflake documentation at https://docs.snowflake.com/en/user-guide/admin-account-identifier.html.",
|
|
1833
|
-
"
|
|
2155
|
+
"name": "snowflake-account-id",
|
|
2156
|
+
"hasDynamicHelp": false,
|
|
2157
|
+
"multiple": false,
|
|
2158
|
+
"type": "option"
|
|
1834
2159
|
},
|
|
1835
2160
|
"snowflake-warehouse": {
|
|
1836
|
-
"name": "snowflake-warehouse",
|
|
1837
|
-
"type": "option",
|
|
1838
2161
|
"description": "Snowflake warehouse",
|
|
1839
|
-
"
|
|
2162
|
+
"name": "snowflake-warehouse",
|
|
2163
|
+
"hasDynamicHelp": false,
|
|
2164
|
+
"multiple": false,
|
|
2165
|
+
"type": "option"
|
|
1840
2166
|
}
|
|
1841
2167
|
},
|
|
1842
|
-
"
|
|
1843
|
-
|
|
1844
|
-
|
|
1845
|
-
|
|
1846
|
-
|
|
1847
|
-
|
|
2168
|
+
"hasDynamicHelp": false,
|
|
2169
|
+
"hiddenAliases": [],
|
|
2170
|
+
"id": "import:snowflake",
|
|
2171
|
+
"pluginAlias": "stepzen",
|
|
2172
|
+
"pluginName": "stepzen",
|
|
2173
|
+
"pluginType": "core",
|
|
2174
|
+
"strict": true,
|
|
2175
|
+
"enableJsonFlag": false,
|
|
2176
|
+
"isESM": true,
|
|
2177
|
+
"relativePath": [
|
|
2178
|
+
"lib",
|
|
2179
|
+
"commands",
|
|
2180
|
+
"import",
|
|
2181
|
+
"snowflake.js"
|
|
2182
|
+
]
|
|
1848
2183
|
}
|
|
1849
|
-
}
|
|
2184
|
+
},
|
|
2185
|
+
"version": "0.45.0-beta.0"
|
|
1850
2186
|
}
|