stepzen 0.58.0-experimental.a42e35b → 0.58.0-experimental.a56f2f6

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.
Files changed (243) hide show
  1. package/README.md +1 -1078
  2. package/oclif.manifest.json +2 -2123
  3. package/package.json +6 -6
  4. package/lib/commands/delete.d.ts +0 -14
  5. package/lib/commands/delete.d.ts.map +0 -1
  6. package/lib/commands/delete.js +0 -117
  7. package/lib/commands/delete.js.map +0 -1
  8. package/lib/commands/deploy.d.ts +0 -30
  9. package/lib/commands/deploy.d.ts.map +0 -1
  10. package/lib/commands/deploy.js +0 -182
  11. package/lib/commands/deploy.js.map +0 -1
  12. package/lib/commands/import/curl.d.ts +0 -42
  13. package/lib/commands/import/curl.d.ts.map +0 -1
  14. package/lib/commands/import/curl.js +0 -248
  15. package/lib/commands/import/curl.js.map +0 -1
  16. package/lib/commands/import/db2.d.ts +0 -30
  17. package/lib/commands/import/db2.d.ts.map +0 -1
  18. package/lib/commands/import/db2.js +0 -125
  19. package/lib/commands/import/db2.js.map +0 -1
  20. package/lib/commands/import/flow.d.ts +0 -23
  21. package/lib/commands/import/flow.d.ts.map +0 -1
  22. package/lib/commands/import/flow.js +0 -118
  23. package/lib/commands/import/flow.js.map +0 -1
  24. package/lib/commands/import/graphql.d.ts +0 -27
  25. package/lib/commands/import/graphql.d.ts.map +0 -1
  26. package/lib/commands/import/graphql.js +0 -116
  27. package/lib/commands/import/graphql.js.map +0 -1
  28. package/lib/commands/import/index.d.ts +0 -19
  29. package/lib/commands/import/index.d.ts.map +0 -1
  30. package/lib/commands/import/index.js +0 -198
  31. package/lib/commands/import/index.js.map +0 -1
  32. package/lib/commands/import/mysql.d.ts +0 -40
  33. package/lib/commands/import/mysql.d.ts.map +0 -1
  34. package/lib/commands/import/mysql.js +0 -142
  35. package/lib/commands/import/mysql.js.map +0 -1
  36. package/lib/commands/import/openapi.d.ts +0 -24
  37. package/lib/commands/import/openapi.d.ts.map +0 -1
  38. package/lib/commands/import/openapi.js +0 -120
  39. package/lib/commands/import/openapi.js.map +0 -1
  40. package/lib/commands/import/oracle.d.ts +0 -30
  41. package/lib/commands/import/oracle.d.ts.map +0 -1
  42. package/lib/commands/import/oracle.js +0 -125
  43. package/lib/commands/import/oracle.js.map +0 -1
  44. package/lib/commands/import/postgresql.d.ts +0 -43
  45. package/lib/commands/import/postgresql.d.ts.map +0 -1
  46. package/lib/commands/import/postgresql.js +0 -147
  47. package/lib/commands/import/postgresql.js.map +0 -1
  48. package/lib/commands/import/presto.d.ts +0 -41
  49. package/lib/commands/import/presto.d.ts.map +0 -1
  50. package/lib/commands/import/presto.js +0 -149
  51. package/lib/commands/import/presto.js.map +0 -1
  52. package/lib/commands/import/snowflake.d.ts +0 -45
  53. package/lib/commands/import/snowflake.d.ts.map +0 -1
  54. package/lib/commands/import/snowflake.js +0 -178
  55. package/lib/commands/import/snowflake.js.map +0 -1
  56. package/lib/commands/init.d.ts +0 -13
  57. package/lib/commands/init.d.ts.map +0 -1
  58. package/lib/commands/init.js +0 -35
  59. package/lib/commands/init.js.map +0 -1
  60. package/lib/commands/lint.d.ts +0 -10
  61. package/lib/commands/lint.d.ts.map +0 -1
  62. package/lib/commands/lint.js +0 -30
  63. package/lib/commands/lint.js.map +0 -1
  64. package/lib/commands/list.d.ts +0 -13
  65. package/lib/commands/list.d.ts.map +0 -1
  66. package/lib/commands/list.js +0 -114
  67. package/lib/commands/list.js.map +0 -1
  68. package/lib/commands/login.d.ts +0 -18
  69. package/lib/commands/login.d.ts.map +0 -1
  70. package/lib/commands/login.js +0 -233
  71. package/lib/commands/login.js.map +0 -1
  72. package/lib/commands/logout.d.ts +0 -9
  73. package/lib/commands/logout.d.ts.map +0 -1
  74. package/lib/commands/logout.js +0 -20
  75. package/lib/commands/logout.js.map +0 -1
  76. package/lib/commands/request.d.ts +0 -26
  77. package/lib/commands/request.d.ts.map +0 -1
  78. package/lib/commands/request.js +0 -335
  79. package/lib/commands/request.js.map +0 -1
  80. package/lib/commands/service.d.ts +0 -84
  81. package/lib/commands/service.d.ts.map +0 -1
  82. package/lib/commands/service.js +0 -801
  83. package/lib/commands/service.js.map +0 -1
  84. package/lib/commands/start.d.ts +0 -24
  85. package/lib/commands/start.d.ts.map +0 -1
  86. package/lib/commands/start.js +0 -221
  87. package/lib/commands/start.js.map +0 -1
  88. package/lib/commands/transpile.d.ts +0 -18
  89. package/lib/commands/transpile.d.ts.map +0 -1
  90. package/lib/commands/transpile.js +0 -58
  91. package/lib/commands/transpile.js.map +0 -1
  92. package/lib/commands/validate.d.ts +0 -13
  93. package/lib/commands/validate.d.ts.map +0 -1
  94. package/lib/commands/validate.js +0 -38
  95. package/lib/commands/validate.js.map +0 -1
  96. package/lib/commands/whoami.d.ts +0 -19
  97. package/lib/commands/whoami.d.ts.map +0 -1
  98. package/lib/commands/whoami.js +0 -236
  99. package/lib/commands/whoami.js.map +0 -1
  100. package/lib/generate/curl2sdl.d.ts +0 -44
  101. package/lib/generate/curl2sdl.d.ts.map +0 -1
  102. package/lib/generate/curl2sdl.js +0 -139
  103. package/lib/generate/curl2sdl.js.map +0 -1
  104. package/lib/generate/flags.d.ts +0 -21
  105. package/lib/generate/flags.d.ts.map +0 -1
  106. package/lib/generate/flags.js +0 -96
  107. package/lib/generate/flags.js.map +0 -1
  108. package/lib/generate/flow2sdl.d.ts +0 -11
  109. package/lib/generate/flow2sdl.d.ts.map +0 -1
  110. package/lib/generate/flow2sdl.js +0 -17
  111. package/lib/generate/flow2sdl.js.map +0 -1
  112. package/lib/generate/graphql2sdl.d.ts +0 -13
  113. package/lib/generate/graphql2sdl.d.ts.map +0 -1
  114. package/lib/generate/graphql2sdl.js +0 -29
  115. package/lib/generate/graphql2sdl.js.map +0 -1
  116. package/lib/generate/helpers.d.ts +0 -27
  117. package/lib/generate/helpers.d.ts.map +0 -1
  118. package/lib/generate/helpers.js +0 -158
  119. package/lib/generate/helpers.js.map +0 -1
  120. package/lib/generate/import-command.d.ts +0 -19
  121. package/lib/generate/import-command.d.ts.map +0 -1
  122. package/lib/generate/import-command.js +0 -184
  123. package/lib/generate/import-command.js.map +0 -1
  124. package/lib/generate/openapi2sdl.d.ts +0 -8
  125. package/lib/generate/openapi2sdl.d.ts.map +0 -1
  126. package/lib/generate/openapi2sdl.js +0 -13
  127. package/lib/generate/openapi2sdl.js.map +0 -1
  128. package/lib/generate/questions.d.ts +0 -37
  129. package/lib/generate/questions.d.ts.map +0 -1
  130. package/lib/generate/questions.js +0 -72
  131. package/lib/generate/questions.js.map +0 -1
  132. package/lib/generate/sql2sdl.d.ts +0 -53
  133. package/lib/generate/sql2sdl.d.ts.map +0 -1
  134. package/lib/generate/sql2sdl.js +0 -163
  135. package/lib/generate/sql2sdl.js.map +0 -1
  136. package/lib/hooks/init/version.d.ts +0 -4
  137. package/lib/hooks/init/version.d.ts.map +0 -1
  138. package/lib/hooks/init/version.js +0 -41
  139. package/lib/hooks/init/version.js.map +0 -1
  140. package/lib/hooks/prerun/check-upgrade.d.ts +0 -28
  141. package/lib/hooks/prerun/check-upgrade.d.ts.map +0 -1
  142. package/lib/hooks/prerun/check-upgrade.js +0 -161
  143. package/lib/hooks/prerun/check-upgrade.js.map +0 -1
  144. package/lib/hooks/prerun/ensure-config-file.d.ts +0 -4
  145. package/lib/hooks/prerun/ensure-config-file.d.ts.map +0 -1
  146. package/lib/hooks/prerun/ensure-config-file.js +0 -27
  147. package/lib/hooks/prerun/ensure-config-file.js.map +0 -1
  148. package/lib/hooks/prerun/ensure-permissions.d.ts +0 -4
  149. package/lib/hooks/prerun/ensure-permissions.d.ts.map +0 -1
  150. package/lib/hooks/prerun/ensure-permissions.js +0 -24
  151. package/lib/hooks/prerun/ensure-permissions.js.map +0 -1
  152. package/lib/index.d.ts +0 -2
  153. package/lib/index.d.ts.map +0 -1
  154. package/lib/index.js +0 -3
  155. package/lib/index.js.map +0 -1
  156. package/lib/shared/client-wrapper.d.ts +0 -16
  157. package/lib/shared/client-wrapper.d.ts.map +0 -1
  158. package/lib/shared/client-wrapper.js +0 -21
  159. package/lib/shared/client-wrapper.js.map +0 -1
  160. package/lib/shared/configuration.d.ts +0 -33
  161. package/lib/shared/configuration.d.ts.map +0 -1
  162. package/lib/shared/configuration.js +0 -229
  163. package/lib/shared/configuration.js.map +0 -1
  164. package/lib/shared/constants.d.ts +0 -105
  165. package/lib/shared/constants.d.ts.map +0 -1
  166. package/lib/shared/constants.js +0 -175
  167. package/lib/shared/constants.js.map +0 -1
  168. package/lib/shared/curl-parser.d.ts +0 -25
  169. package/lib/shared/curl-parser.d.ts.map +0 -1
  170. package/lib/shared/curl-parser.js +0 -210
  171. package/lib/shared/curl-parser.js.map +0 -1
  172. package/lib/shared/docker.d.ts +0 -35
  173. package/lib/shared/docker.d.ts.map +0 -1
  174. package/lib/shared/docker.js +0 -168
  175. package/lib/shared/docker.js.map +0 -1
  176. package/lib/shared/errors.d.ts +0 -6
  177. package/lib/shared/errors.d.ts.map +0 -1
  178. package/lib/shared/errors.js +0 -15
  179. package/lib/shared/errors.js.map +0 -1
  180. package/lib/shared/header-params-parser.d.ts +0 -8
  181. package/lib/shared/header-params-parser.d.ts.map +0 -1
  182. package/lib/shared/header-params-parser.js +0 -117
  183. package/lib/shared/header-params-parser.js.map +0 -1
  184. package/lib/shared/header.d.ts +0 -33
  185. package/lib/shared/header.d.ts.map +0 -1
  186. package/lib/shared/header.js +0 -46
  187. package/lib/shared/header.js.map +0 -1
  188. package/lib/shared/inquirer.d.ts +0 -14
  189. package/lib/shared/inquirer.d.ts.map +0 -1
  190. package/lib/shared/inquirer.js +0 -123
  191. package/lib/shared/inquirer.js.map +0 -1
  192. package/lib/shared/moniker.d.ts +0 -5
  193. package/lib/shared/moniker.d.ts.map +0 -1
  194. package/lib/shared/moniker.js +0 -641
  195. package/lib/shared/moniker.js.map +0 -1
  196. package/lib/shared/path-params-parser.d.ts +0 -8
  197. package/lib/shared/path-params-parser.d.ts.map +0 -1
  198. package/lib/shared/path-params-parser.js +0 -82
  199. package/lib/shared/path-params-parser.js.map +0 -1
  200. package/lib/shared/request-variables-parser.d.ts +0 -8
  201. package/lib/shared/request-variables-parser.d.ts.map +0 -1
  202. package/lib/shared/request-variables-parser.js +0 -114
  203. package/lib/shared/request-variables-parser.js.map +0 -1
  204. package/lib/shared/rmtemp.d.ts +0 -12
  205. package/lib/shared/rmtemp.d.ts.map +0 -1
  206. package/lib/shared/rmtemp.js +0 -36
  207. package/lib/shared/rmtemp.js.map +0 -1
  208. package/lib/shared/segment.d.ts +0 -23
  209. package/lib/shared/segment.d.ts.map +0 -1
  210. package/lib/shared/segment.js +0 -134
  211. package/lib/shared/segment.js.map +0 -1
  212. package/lib/shared/shell.d.ts +0 -4
  213. package/lib/shared/shell.d.ts.map +0 -1
  214. package/lib/shared/shell.js +0 -6
  215. package/lib/shared/shell.js.map +0 -1
  216. package/lib/shared/stepzen-sdk.d.ts +0 -83
  217. package/lib/shared/stepzen-sdk.d.ts.map +0 -1
  218. package/lib/shared/stepzen-sdk.js +0 -284
  219. package/lib/shared/stepzen-sdk.js.map +0 -1
  220. package/lib/shared/types.d.ts +0 -92
  221. package/lib/shared/types.d.ts.map +0 -1
  222. package/lib/shared/types.js +0 -2
  223. package/lib/shared/types.js.map +0 -1
  224. package/lib/shared/url-helpers.d.ts +0 -39
  225. package/lib/shared/url-helpers.d.ts.map +0 -1
  226. package/lib/shared/url-helpers.js +0 -117
  227. package/lib/shared/url-helpers.js.map +0 -1
  228. package/lib/shared/utils.d.ts +0 -65
  229. package/lib/shared/utils.d.ts.map +0 -1
  230. package/lib/shared/utils.js +0 -292
  231. package/lib/shared/utils.js.map +0 -1
  232. package/lib/shared/validation.d.ts +0 -9
  233. package/lib/shared/validation.d.ts.map +0 -1
  234. package/lib/shared/validation.js +0 -76
  235. package/lib/shared/validation.js.map +0 -1
  236. package/lib/shared/workspace.d.ts +0 -12
  237. package/lib/shared/workspace.d.ts.map +0 -1
  238. package/lib/shared/workspace.js +0 -164
  239. package/lib/shared/workspace.js.map +0 -1
  240. package/lib/shared/zen-command.d.ts +0 -28
  241. package/lib/shared/zen-command.d.ts.map +0 -1
  242. package/lib/shared/zen-command.js +0 -333
  243. package/lib/shared/zen-command.js.map +0 -1
package/README.md CHANGED
@@ -36,7 +36,7 @@ $ npm install -g stepzen
36
36
  $ stepzen COMMAND
37
37
  running command...
38
38
  $ stepzen (--version|-v)
39
- stepzen/0.58.0-experimental.a42e35b linux-x64 node-v22.22.2
39
+ stepzen/0.58.0-experimental.a56f2f6 linux-x64 node-v22.22.2
40
40
  $ stepzen --help [COMMAND]
41
41
  USAGE
42
42
  $ stepzen COMMAND
@@ -51,112 +51,8 @@ To run from code: `path-to-repo/bin/run start` (start or whatever command you're
51
51
 
52
52
  # Commands
53
53
  <!-- commands -->
54
- * [`stepzen delete ENDPOINT`](#stepzen-delete-endpoint)
55
- * [`stepzen deploy [ENDPOINT] [--config=path/to/config.yaml] [--dir=path/to/workspace]
56
-
57
- -- OR (deprecated) --
58
-
59
- $ stepzen deploy ENDPOINT --schema=schema [--configurationsets=cs1[,cs2[,..]]]`](#stepzen-deploy-endpoint---configpathtoconfigyaml---dirpathtoworkspace---or-deprecated----stepzen-deploy-endpoint---schemaschema---configurationsetscs1cs2)
60
54
  * [`stepzen help [COMMAND]`](#stepzen-help-command)
61
- * [`stepzen import [SOURCE]`](#stepzen-import-source)
62
- * [`stepzen import curl`](#stepzen-import-curl)
63
- * [`stepzen import db2 [JDBCURL]`](#stepzen-import-db2-jdbcurl)
64
- * [`stepzen import flow [FLOW]`](#stepzen-import-flow-flow)
65
- * [`stepzen import graphql [URL]`](#stepzen-import-graphql-url)
66
- * [`stepzen import mysql [DSN]`](#stepzen-import-mysql-dsn)
67
- * [`stepzen import oracle [JDBCURL]`](#stepzen-import-oracle-jdbcurl)
68
- * [`stepzen import postgres [DSN]`](#stepzen-import-postgres-dsn)
69
- * [`stepzen import postgresql [DSN]`](#stepzen-import-postgresql-dsn)
70
- * [`stepzen import singlestore [DSN]`](#stepzen-import-singlestore-dsn)
71
- * [`stepzen import snowflake [DSN]`](#stepzen-import-snowflake-dsn)
72
- * [`stepzen init`](#stepzen-init)
73
- * [`stepzen list [TYPE]`](#stepzen-list-type)
74
- * [`stepzen login [DOMAIN]`](#stepzen-login-domain)
75
- * [`stepzen logout`](#stepzen-logout)
76
- * [`stepzen request [QUERY]`](#stepzen-request-query)
77
- * [`stepzen service [ACTION]`](#stepzen-service-action)
78
- * [`stepzen start`](#stepzen-start)
79
55
  * [`stepzen version`](#stepzen-version)
80
- * [`stepzen whoami`](#stepzen-whoami)
81
-
82
- ## `stepzen delete ENDPOINT`
83
-
84
- Delete an endpoint from your StepZen account.
85
-
86
- ```
87
- USAGE
88
- $ stepzen delete ENDPOINT [-h] [--non-interactive]
89
-
90
- ARGUMENTS
91
- ENDPOINT name of the endpoint (e.g. api/customers)
92
-
93
- FLAGS
94
- -h, --help Show CLI help
95
- --non-interactive Disable all interactive prompts
96
-
97
- DESCRIPTION
98
- Delete an endpoint from your StepZen account.
99
- ```
100
-
101
- ## `stepzen deploy [ENDPOINT] [--config=path/to/config.yaml] [--dir=path/to/workspace]
102
-
103
- -- OR (deprecated) --
104
-
105
- $ stepzen deploy ENDPOINT --schema=schema [--configurationsets=cs1[,cs2[,..]]]`
106
-
107
- Deploy to StepZen.
108
-
109
- ```
110
- USAGE
111
- $ stepzen deploy [ENDPOINT] [--config=path/to/config.yaml] [--dir=path/to/workspace]
112
-
113
- -- OR (deprecated)
114
- --
115
-
116
- $ stepzen deploy ENDPOINT --schema=schema [--configurationsets=cs1[,cs2[,..]]]
117
-
118
- ARGUMENTS
119
- [ENDPOINT] name of the endpoint (e.g. api/customers)
120
- [default: use the endpoint property from stepzen.config.json]
121
-
122
- FLAGS
123
- -h, --help
124
- Show CLI help
125
-
126
- --config=path/to/config.yaml
127
- [default: config.yaml] Configuration file to use (relative to the current directory)
128
-
129
- --configurationsets=<value>
130
- Name(s) of configuration sets uploaded earlier with stepzen upload
131
- [DEPRECATED: this flag will be removed in future versions]
132
-
133
- Instead, please use one of these options:
134
- - stepzen deploy (without the --configurationsets flag)
135
- to use the configuration from the config.yaml file in the current directory (if exists)
136
- - stepzen deploy --config path/to/config.yaml
137
- to explicitly specify the configuration file
138
-
139
- --dir=<value>
140
- Working directory
141
-
142
- --non-interactive
143
- Disable all interactive prompts
144
-
145
- --schema=<value>
146
- Name of a schema uploaded earlier with stepzen upload
147
- [DEPRECATED: this flag will be removed in future versions]
148
-
149
- Instead, please use one of these options:
150
- - stepzen deploy (without the --schema flag)
151
- to deploy the schema from a StepZen workspace in your current directory
152
- - stepzen deploy --dir path/to/workspace
153
- to deploy from a StepZen workspace in another folder
154
-
155
- --silent
156
-
157
- DESCRIPTION
158
- Deploy to StepZen.
159
- ```
160
56
 
161
57
  ## `stepzen help [COMMAND]`
162
58
 
@@ -178,954 +74,6 @@ DESCRIPTION
178
74
 
179
75
  _See code: [@oclif/plugin-help](https://github.com/oclif/plugin-help/blob/6.2.43/src/commands/help.ts)_
180
76
 
181
- ## `stepzen import [SOURCE]`
182
-
183
- Import a schema for an external data source or an API endpoint into your GraphQL API.
184
-
185
- ```
186
- USAGE
187
- $ stepzen import [SOURCE...] [-h] [--non-interactive] [--dir <value>]
188
-
189
- ARGUMENTS
190
- [SOURCE...] kind of the data source: curl, graphql, mysql, postgresql, snowflake, db2, oracle (or a full DSN string)
191
-
192
- FLAGS
193
- -h, --help Show CLI help
194
- --dir=<value> Working directory
195
- --non-interactive Disable all interactive prompts
196
-
197
- DESCRIPTION
198
- Import a schema for an external data source or an API endpoint into your GraphQL API.
199
- See more details with stepzen import [SOURCE] --help
200
- ```
201
-
202
- ## `stepzen import curl`
203
-
204
- Import a schema for a REST endpoint into your GraphQL API (uses the curl syntax).
205
-
206
- ```
207
- USAGE
208
- $ stepzen import curl [-h] [--non-interactive] [--dir <value>] [--name <value>] [--prefix <value>] [-H
209
- <value>...] [--header-param <value>...] [--query-name <value>] [--query-type <value>] [--path-params <value>]
210
- [--secrets <value>...]
211
-
212
- FLAGS
213
- -H, --header=<value>...
214
- Specifies a request header to pass
215
-
216
- Example:
217
- stepzen import curl https://example.com/api/customers \
218
- -H "Authorization: apikey SecretAPIKeyValue"
219
-
220
- -h, --help
221
- Show CLI help
222
-
223
- --dir=<value>
224
- Working directory
225
-
226
- --header-param=<value>...
227
- Specifies a parameter in a header value. Can be formed by taking a -H, --header flag and replacing the variable part
228
- of the header value with a $paramName placeholder. Repeat this flag once for each header with a parameter.
229
-
230
- Example:
231
- stepzen import curl https://example.com/api/customers \
232
- -H "Authorization: apikey SecretAPIKeyValue" \
233
- --header-param 'Authorization: apikey $apikey'
234
-
235
- --name=<value>
236
- Subfolder inside the workspace folder to save the imported schema files to. Defaults to the name of the imported
237
- schema.
238
-
239
- --non-interactive
240
- Disable all interactive prompts
241
-
242
- --path-params=<value>
243
- Specifies path parameters in the URL path. Can be formed by taking the original path and replacing the variable
244
- segments with $paramName placeholders.
245
-
246
- Example:
247
- stepzen import curl https://example.com/users/jane/posts/12 --path-params '/users/$userId/posts/$postId'
248
-
249
- --prefix=<value>
250
- Prefix to add to every type in the generated schema
251
-
252
- --query-name=<value>
253
- Property name to add to the Query type as a way to access the imported endpoint
254
-
255
- --query-type=<value>
256
- Name for the type returned by the curl request in the generated schema. The name specified by --query-type is not
257
- prefixed by --prefix if both flags are present.
258
-
259
- --secrets=<value>...
260
- Specifies the names of HTTP headers whose values are considered secrets.
261
- A header's value is replaced with an expansion variable which is set in config.yaml
262
-
263
- Example:
264
- stepzen import curl https://stepzen.us-east-a.ibm.stepzen.net/version \
265
- --header 'Authorization: <sensitive value>' \
266
- --secrets 'Authorization'
267
-
268
- This ensures that sensitive values are securely stored in generated config.yaml
269
-
270
- ### Example config.yaml outputs:
271
- ```yaml
272
- configurationset:
273
- - configuration:
274
- authorization_416efbc0dc: Apikey <sensitive value>
275
- name: curl_import_config
276
- ```
277
-
278
- In this case, index.graphql must reference "$authorization_416efbc0dc;".
279
-
280
- **headers: [{ name: "authorization", value: "$authorization_416efbc0dc;" }]
281
-
282
- DESCRIPTION
283
- Import a schema for a REST endpoint into your GraphQL API (uses the curl syntax).
284
-
285
- stepzen import curl automatically introspects a REST endpoint, generates a GraphQL schema for accessing this endpoint
286
- through a StepZen API, and adds the generated types and a query field into your GraphQL schema.
287
- ```
288
-
289
- ## `stepzen import db2 [JDBCURL]`
290
-
291
- Import a schema for a Db2 data source into your GraphQL API.
292
-
293
- ```
294
- USAGE
295
- $ stepzen import db2 [JDBCURL] [-h] [--non-interactive] [--dir <value>] [--name <value>] [--db-schema <value>]
296
- [--db-link-types] [--db-include tables-only|views-only|tables-and-views] [--db-use-deprecated-2022-naming]
297
-
298
- ARGUMENTS
299
- [JDBCURL] (optional) JDBC URL of a Db2 database.
300
- Example: 'jdbc:db2://host:port/db:user=username;password=password;schema=schema;sslConnection=true/false;'
301
-
302
- The --db-schema flag overrides the schema part of the JDBC URL (if both are provided).
303
-
304
- FLAGS
305
- -h, --help
306
- Show CLI help
307
-
308
- --db-include=<option>
309
- Should the generated GraphQL schema be based only on database views, only on tables or on both
310
- <options: tables-only|views-only|tables-and-views>
311
-
312
- --db-link-types
313
- Automatically link types based on foreign key relationships using @materializer
314
- (https://stepzen.com/docs/features/linking-types)
315
-
316
- --db-schema=<value>
317
- Database schema to import tables from (default: public)
318
-
319
- --db-use-deprecated-2022-naming
320
- Use the deprecated pre-2023 naming convention in the generated GraphQL schema:
321
- - the generated type and property names are auto-capitalized into PascalCase
322
- - the generated field names use the getCustomer and getCustomerList style.
323
-
324
- On the other hand, when using the default naming convention:
325
- - the generated type and property names match exactly the DB table and column names
326
- - the generated field names use the customer and customerList style.
327
-
328
- --dir=<value>
329
- Working directory
330
-
331
- --name=<value>
332
- Subfolder inside the workspace folder to save the imported schema files to. Defaults to the name of the imported
333
- schema.
334
-
335
- --non-interactive
336
- Disable all interactive prompts
337
-
338
- DESCRIPTION
339
- Import a schema for a Db2 data source into your GraphQL API.
340
-
341
- stepzen import db2 automatically introspects a Db2 database, generates a GraphQL schema for accessing this database
342
- through a StepZen API, and merges the generated types, queries and mutations into your GraphQL schema.
343
- ```
344
-
345
- ## `stepzen import flow [FLOW]`
346
-
347
- Import StepZen flow expression as a query field into your GraphQL API.
348
-
349
- ```
350
- USAGE
351
- $ stepzen import flow [FLOW] [-h] [--non-interactive] [--dir <value>] [--name <value>] [-H <value>...
352
- --endpoint <value>]
353
-
354
- FLAGS
355
- -H, --header=<value>... Specifies a request header to pass
356
-
357
- Example:
358
- stepzen import curl https://example.com/api/customers \
359
- -H "Authorization: apikey SecretAPIKeyValue"
360
- -h, --help Show CLI help
361
- --dir=<value> Working directory
362
- --endpoint=<value> Use a custom GraphQL schema instead of the project's schema as the schema providing the steps
363
- in the flow.
364
- --name=<value> Subfolder inside the workspace folder to save the imported schema files to. Defaults to the
365
- name of the imported schema.
366
- --non-interactive Disable all interactive prompts
367
-
368
- DESCRIPTION
369
- Import StepZen flow expression as a query field into your GraphQL API.
370
-
371
- stepzen import flow automatically introspects a GraphQL endpoint and adds a @sequence implementing the given flow
372
- expression into your GraphQL schema.
373
- ```
374
-
375
- ## `stepzen import graphql [URL]`
376
-
377
- Import a GraphQL API as a subgraph into your GraphQL API.
378
-
379
- ```
380
- USAGE
381
- $ stepzen import graphql [URL] [-h] [--non-interactive] [--dir <value>] [--name <value>] [--prefix <value>] [-H
382
- <value>...] [--header-param <value>...] [--secrets <value>...]
383
-
384
- FLAGS
385
- -H, --header=<value>...
386
- Specifies a request header to pass
387
-
388
- Example:
389
- stepzen import curl https://example.com/api/customers \
390
- -H "Authorization: apikey SecretAPIKeyValue"
391
-
392
- -h, --help
393
- Show CLI help
394
-
395
- --dir=<value>
396
- Working directory
397
-
398
- --header-param=<value>...
399
- Specifies a parameter in a header value. Can be formed by taking a -H, --header flag and replacing the variable part
400
- of the header value with a $paramName placeholder. Repeat this flag once for each header with a parameter.
401
-
402
- Example:
403
- stepzen import curl https://example.com/api/customers \
404
- -H "Authorization: apikey SecretAPIKeyValue" \
405
- --header-param 'Authorization: apikey $apikey'
406
-
407
- --name=<value>
408
- Subfolder inside the workspace folder to save the imported schema files to. Defaults to the name of the imported
409
- schema.
410
-
411
- --non-interactive
412
- Disable all interactive prompts
413
-
414
- --prefix=<value>
415
- Prefix to add to every type in the generated schema
416
-
417
- --secrets=<value>...
418
- Specifies the names of HTTP headers whose values are considered secrets.
419
- A header's value is replaced with an expansion variable which is set in config.yaml
420
-
421
- Example:
422
- stepzen import curl https://stepzen.us-east-a.ibm.stepzen.net/version \
423
- --header 'Authorization: <sensitive value>' \
424
- --secrets 'Authorization'
425
-
426
- This ensures that sensitive values are securely stored in generated config.yaml
427
-
428
- ### Example config.yaml outputs:
429
- ```yaml
430
- configurationset:
431
- - configuration:
432
- authorization_416efbc0dc: Apikey <sensitive value>
433
- name: curl_import_config
434
- ```
435
-
436
- In this case, index.graphql must reference "$authorization_416efbc0dc;".
437
-
438
- **headers: [{ name: "authorization", value: "$authorization_416efbc0dc;" }]
439
-
440
- DESCRIPTION
441
- Import a GraphQL API as a subgraph into your GraphQL API.
442
-
443
- stepzen import graphql automatically introspects a GraphQL endpoint and merges the types, queries, mutations and
444
- subscriptions for accessing this endpoint through a StepZen API into your GraphQL schema.
445
- ```
446
-
447
- ## `stepzen import mysql [DSN]`
448
-
449
- Import a schema for a MySQL data source into your GraphQL API.
450
-
451
- ```
452
- USAGE
453
- $ stepzen import mysql [DSN] [-h] [--non-interactive] [--dir <value>] [--name <value>] [--db-host <value>]
454
- [--db-user <value>] [--db-password <value>] [--db-database <value>] [--db-link-types] [--db-include
455
- tables-only|views-only|tables-and-views] [--db-use-deprecated-2022-naming]
456
-
457
- ARGUMENTS
458
- [DSN] (optional) Data Source Name (DSN) of a MySQL database.
459
- Example: mysql://user:password@host:port/database
460
-
461
- Flags, such as --db-host, override the corresponding parts of the DSN (if both are provided).
462
-
463
- FLAGS
464
- -h, --help
465
- Show CLI help
466
-
467
- --db-database=<value>
468
- Name of database to import
469
-
470
- --db-host=<value>
471
- Database host and optional port (as HOST[:PORT])
472
-
473
- --db-include=<option>
474
- Should the generated GraphQL schema be based only on database views, only on tables or on both
475
- <options: tables-only|views-only|tables-and-views>
476
-
477
- --db-link-types
478
- Automatically link types based on foreign key relationships using @materializer
479
- (https://stepzen.com/docs/features/linking-types)
480
-
481
- --db-password=<value>
482
- Database password
483
-
484
- --db-use-deprecated-2022-naming
485
- Use the deprecated pre-2023 naming convention in the generated GraphQL schema:
486
- - the generated type and property names are auto-capitalized into PascalCase
487
- - the generated field names use the getCustomer and getCustomerList style.
488
-
489
- On the other hand, when using the default naming convention:
490
- - the generated type and property names match exactly the DB table and column names
491
- - the generated field names use the customer and customerList style.
492
-
493
- --db-user=<value>
494
- Database user name
495
-
496
- --dir=<value>
497
- Working directory
498
-
499
- --name=<value>
500
- Subfolder inside the workspace folder to save the imported schema files to. Defaults to the name of the imported
501
- schema.
502
-
503
- --non-interactive
504
- Disable all interactive prompts
505
-
506
- DESCRIPTION
507
- Import a schema for a MySQL data source into your GraphQL API.
508
-
509
- stepzen import mysql automatically introspects a MySQL database, generates a GraphQL schema for accessing this
510
- database through a StepZen API, and merges the generated types, queries and mutations into your into your GraphQL
511
- schema.
512
-
513
- ALIASES
514
- $ stepzen import singlestore
515
- ```
516
-
517
- ## `stepzen import oracle [JDBCURL]`
518
-
519
- Import a schema for a oracle data source into your GraphQL API.
520
-
521
- ```
522
- USAGE
523
- $ stepzen import oracle [JDBCURL] [-h] [--non-interactive] [--dir <value>] [--name <value>] [--db-schema <value>]
524
- [--db-link-types] [--db-include tables-only|views-only|tables-and-views] [--db-use-deprecated-2022-naming]
525
-
526
- ARGUMENTS
527
- [JDBCURL] (optional) JDBC URL of an Oracle database.
528
- Example: 'jdbc:oracle:thin:user/password@//host:port/db?currentschema=schema'
529
-
530
- The --db-schema flag overrides the schema part of the JDBC URL (if both are provided).
531
-
532
- FLAGS
533
- -h, --help
534
- Show CLI help
535
-
536
- --db-include=<option>
537
- Should the generated GraphQL schema be based only on database views, only on tables or on both
538
- <options: tables-only|views-only|tables-and-views>
539
-
540
- --db-link-types
541
- Automatically link types based on foreign key relationships using @materializer
542
- (https://stepzen.com/docs/features/linking-types)
543
-
544
- --db-schema=<value>
545
- Database schema to import tables from (default: public)
546
-
547
- --db-use-deprecated-2022-naming
548
- Use the deprecated pre-2023 naming convention in the generated GraphQL schema:
549
- - the generated type and property names are auto-capitalized into PascalCase
550
- - the generated field names use the getCustomer and getCustomerList style.
551
-
552
- On the other hand, when using the default naming convention:
553
- - the generated type and property names match exactly the DB table and column names
554
- - the generated field names use the customer and customerList style.
555
-
556
- --dir=<value>
557
- Working directory
558
-
559
- --name=<value>
560
- Subfolder inside the workspace folder to save the imported schema files to. Defaults to the name of the imported
561
- schema.
562
-
563
- --non-interactive
564
- Disable all interactive prompts
565
-
566
- DESCRIPTION
567
- Import a schema for a oracle data source into your GraphQL API.
568
-
569
- stepzen import oracle automatically introspects an Oracle database, generates a GraphQL schema for accessing this
570
- database through a StepZen API, and merges the generated types, queries and mutations into your GraphQL schema.
571
- ```
572
-
573
- ## `stepzen import postgres [DSN]`
574
-
575
- Import a schema for a PostgreSQL data source into your GraphQL API.
576
-
577
- ```
578
- USAGE
579
- $ stepzen import postgres [DSN] [-h] [--non-interactive] [--dir <value>] [--name <value>] [--db-host <value>]
580
- [--db-user <value>] [--db-password <value>] [--db-database <value>] [--db-schema <value>] [--db-link-types]
581
- [--db-include tables-only|views-only|tables-and-views] [--db-use-deprecated-2022-naming]
582
-
583
- ARGUMENTS
584
- [DSN] (optional) Data Source Name (DSN) of a PostgreSQL database.
585
- Example: postgresql://user:password@host:port/database?schema=schema
586
-
587
- Flags, such as --db-host, override the corresponding parts of the DSN (if both are provided).
588
-
589
- FLAGS
590
- -h, --help
591
- Show CLI help
592
-
593
- --db-database=<value>
594
- Name of database to import
595
-
596
- --db-host=<value>
597
- Database host and optional port (as HOST[:PORT])
598
-
599
- --db-include=<option>
600
- Should the generated GraphQL schema be based only on database views, only on tables or on both
601
- <options: tables-only|views-only|tables-and-views>
602
-
603
- --db-link-types
604
- Automatically link types based on foreign key relationships using @materializer
605
- (https://stepzen.com/docs/features/linking-types)
606
-
607
- --db-password=<value>
608
- Database password
609
-
610
- --db-schema=<value>
611
- Database schema to import tables from (default: public)
612
-
613
- --db-use-deprecated-2022-naming
614
- Use the deprecated pre-2023 naming convention in the generated GraphQL schema:
615
- - the generated type and property names are auto-capitalized into PascalCase
616
- - the generated field names use the getCustomer and getCustomerList style.
617
-
618
- On the other hand, when using the default naming convention:
619
- - the generated type and property names match exactly the DB table and column names
620
- - the generated field names use the customer and customerList style.
621
-
622
- --db-user=<value>
623
- Database user name
624
-
625
- --dir=<value>
626
- Working directory
627
-
628
- --name=<value>
629
- Subfolder inside the workspace folder to save the imported schema files to. Defaults to the name of the imported
630
- schema.
631
-
632
- --non-interactive
633
- Disable all interactive prompts
634
-
635
- DESCRIPTION
636
- Import a schema for a PostgreSQL data source into your GraphQL API.
637
-
638
- stepzen import postgresql automatically introspects a PostgreSQL database, generates a GraphQL schema for accessing
639
- this database through a StepZen API, and merges the generated types, queries and mutations into your GraphQL schema.
640
-
641
- ALIASES
642
- $ stepzen import postgres
643
- ```
644
-
645
- ## `stepzen import postgresql [DSN]`
646
-
647
- Import a schema for a PostgreSQL data source into your GraphQL API.
648
-
649
- ```
650
- USAGE
651
- $ stepzen import postgresql [DSN] [-h] [--non-interactive] [--dir <value>] [--name <value>] [--db-host <value>]
652
- [--db-user <value>] [--db-password <value>] [--db-database <value>] [--db-schema <value>] [--db-link-types]
653
- [--db-include tables-only|views-only|tables-and-views] [--db-use-deprecated-2022-naming]
654
-
655
- ARGUMENTS
656
- [DSN] (optional) Data Source Name (DSN) of a PostgreSQL database.
657
- Example: postgresql://user:password@host:port/database?schema=schema
658
-
659
- Flags, such as --db-host, override the corresponding parts of the DSN (if both are provided).
660
-
661
- FLAGS
662
- -h, --help
663
- Show CLI help
664
-
665
- --db-database=<value>
666
- Name of database to import
667
-
668
- --db-host=<value>
669
- Database host and optional port (as HOST[:PORT])
670
-
671
- --db-include=<option>
672
- Should the generated GraphQL schema be based only on database views, only on tables or on both
673
- <options: tables-only|views-only|tables-and-views>
674
-
675
- --db-link-types
676
- Automatically link types based on foreign key relationships using @materializer
677
- (https://stepzen.com/docs/features/linking-types)
678
-
679
- --db-password=<value>
680
- Database password
681
-
682
- --db-schema=<value>
683
- Database schema to import tables from (default: public)
684
-
685
- --db-use-deprecated-2022-naming
686
- Use the deprecated pre-2023 naming convention in the generated GraphQL schema:
687
- - the generated type and property names are auto-capitalized into PascalCase
688
- - the generated field names use the getCustomer and getCustomerList style.
689
-
690
- On the other hand, when using the default naming convention:
691
- - the generated type and property names match exactly the DB table and column names
692
- - the generated field names use the customer and customerList style.
693
-
694
- --db-user=<value>
695
- Database user name
696
-
697
- --dir=<value>
698
- Working directory
699
-
700
- --name=<value>
701
- Subfolder inside the workspace folder to save the imported schema files to. Defaults to the name of the imported
702
- schema.
703
-
704
- --non-interactive
705
- Disable all interactive prompts
706
-
707
- DESCRIPTION
708
- Import a schema for a PostgreSQL data source into your GraphQL API.
709
-
710
- stepzen import postgresql automatically introspects a PostgreSQL database, generates a GraphQL schema for accessing
711
- this database through a StepZen API, and merges the generated types, queries and mutations into your GraphQL schema.
712
-
713
- ALIASES
714
- $ stepzen import postgres
715
- ```
716
-
717
- ## `stepzen import singlestore [DSN]`
718
-
719
- Import a schema for a MySQL data source into your GraphQL API.
720
-
721
- ```
722
- USAGE
723
- $ stepzen import singlestore [DSN] [-h] [--non-interactive] [--dir <value>] [--name <value>] [--db-host <value>]
724
- [--db-user <value>] [--db-password <value>] [--db-database <value>] [--db-link-types] [--db-include
725
- tables-only|views-only|tables-and-views] [--db-use-deprecated-2022-naming]
726
-
727
- ARGUMENTS
728
- [DSN] (optional) Data Source Name (DSN) of a MySQL database.
729
- Example: mysql://user:password@host:port/database
730
-
731
- Flags, such as --db-host, override the corresponding parts of the DSN (if both are provided).
732
-
733
- FLAGS
734
- -h, --help
735
- Show CLI help
736
-
737
- --db-database=<value>
738
- Name of database to import
739
-
740
- --db-host=<value>
741
- Database host and optional port (as HOST[:PORT])
742
-
743
- --db-include=<option>
744
- Should the generated GraphQL schema be based only on database views, only on tables or on both
745
- <options: tables-only|views-only|tables-and-views>
746
-
747
- --db-link-types
748
- Automatically link types based on foreign key relationships using @materializer
749
- (https://stepzen.com/docs/features/linking-types)
750
-
751
- --db-password=<value>
752
- Database password
753
-
754
- --db-use-deprecated-2022-naming
755
- Use the deprecated pre-2023 naming convention in the generated GraphQL schema:
756
- - the generated type and property names are auto-capitalized into PascalCase
757
- - the generated field names use the getCustomer and getCustomerList style.
758
-
759
- On the other hand, when using the default naming convention:
760
- - the generated type and property names match exactly the DB table and column names
761
- - the generated field names use the customer and customerList style.
762
-
763
- --db-user=<value>
764
- Database user name
765
-
766
- --dir=<value>
767
- Working directory
768
-
769
- --name=<value>
770
- Subfolder inside the workspace folder to save the imported schema files to. Defaults to the name of the imported
771
- schema.
772
-
773
- --non-interactive
774
- Disable all interactive prompts
775
-
776
- DESCRIPTION
777
- Import a schema for a MySQL data source into your GraphQL API.
778
-
779
- stepzen import mysql automatically introspects a MySQL database, generates a GraphQL schema for accessing this
780
- database through a StepZen API, and merges the generated types, queries and mutations into your into your GraphQL
781
- schema.
782
-
783
- ALIASES
784
- $ stepzen import singlestore
785
- ```
786
-
787
- ## `stepzen import snowflake [DSN]`
788
-
789
- Import a schema for a Snowflake data source into your GraphQL API.
790
-
791
- ```
792
- USAGE
793
- $ stepzen import snowflake [DSN] [-h] [--non-interactive] [--dir <value>] [--name <value>] [--db-user <value>]
794
- [--db-password <value>] [--db-database <value>] [--db-schema <value>] [--db-link-types] [--db-include
795
- tables-only|views-only|tables-and-views] [--db-use-deprecated-2022-naming] [--snowflake-account-id <value>]
796
- [--snowflake-warehouse <value>]
797
-
798
- ARGUMENTS
799
- [DSN] (optional) Data Source Name (DSN) of a Snowflake database.
800
- Example: snowflake://user:password@orgname-accountname/database?warehouse=warehouse&schema=schema
801
-
802
- Flags, such as --db-host, override the corresponding parts of the DSN (if both are provided).
803
-
804
- FLAGS
805
- -h, --help
806
- Show CLI help
807
-
808
- --db-database=<value>
809
- Name of database to import
810
-
811
- --db-include=<option>
812
- Should the generated GraphQL schema be based only on database views, only on tables or on both
813
- <options: tables-only|views-only|tables-and-views>
814
-
815
- --db-link-types
816
- Automatically link types based on foreign key relationships using @materializer
817
- (https://stepzen.com/docs/features/linking-types)
818
-
819
- --db-password=<value>
820
- Database password
821
-
822
- --db-schema=<value>
823
- Database schema to import tables from (default: PUBLIC)
824
-
825
- --db-use-deprecated-2022-naming
826
- Use the deprecated pre-2023 naming convention in the generated GraphQL schema:
827
- - the generated type and property names are auto-capitalized into PascalCase
828
- - the generated field names use the getCustomer and getCustomerList style.
829
-
830
- On the other hand, when using the default naming convention:
831
- - the generated type and property names match exactly the DB table and column names
832
- - the generated field names use the customer and customerList style.
833
-
834
- --db-user=<value>
835
- Database user name
836
-
837
- --dir=<value>
838
- Working directory
839
-
840
- --name=<value>
841
- Subfolder inside the workspace folder to save the imported schema files to. Defaults to the name of the imported
842
- schema.
843
-
844
- --non-interactive
845
- Disable all interactive prompts
846
-
847
- --snowflake-account-id=<value>
848
- Snowflake account identifier in the orgname-accountname format. For more information, see the Snowflake
849
- documentation at https://docs.snowflake.com/en/user-guide/admin-account-identifier.html.
850
-
851
- --snowflake-warehouse=<value>
852
- Snowflake warehouse
853
-
854
- DESCRIPTION
855
- Import a schema for a Snowflake data source into your GraphQL API.
856
-
857
- stepzen import snowflake automatically introspects a Snowflake database, generates a GraphQL schema for accessing this
858
- database through a StepZen API, and merges the generated types, queries and mutations into your GraphQL schema.
859
- ```
860
-
861
- ## `stepzen init`
862
-
863
- Initialize a StepZen workspace in the current directory.
864
-
865
- ```
866
- USAGE
867
- $ stepzen init [-h] [--non-interactive] [--endpoint <value>] [--yes]
868
-
869
- FLAGS
870
- -h, --help Show CLI help
871
- --endpoint=<value> Endpoint name (e.g. api/myapp)
872
- --non-interactive Disable all interactive prompts
873
- --yes Accept default answers to interactive prompts
874
-
875
- DESCRIPTION
876
- Initialize a StepZen workspace in the current directory.
877
- ```
878
-
879
- ## `stepzen list [TYPE]`
880
-
881
- List endpoints, schemas and configuration sets in your StepZen account.
882
-
883
- ```
884
- USAGE
885
- $ stepzen list [TYPE] [-h] [--non-interactive] [--folder <value>] [--name <value>]
886
-
887
- ARGUMENTS
888
- [TYPE] [default: endpoints]
889
-
890
- The type of entities to list:
891
- endpoints - GraphQL API endpoints deployed with stepzen deploy (or stepzen start)
892
-
893
- FLAGS
894
- -h, --help Show CLI help
895
- --folder=<value> Filter the list to only show endpoints within a specific folder. example usage --folder
896
- folder_name or --folder !folder_name
897
- --name=<value> Filter the list to only show endpoints with a specific name. example usage --name endpoint_name
898
- or --name '!endpoint_name'
899
- --non-interactive Disable all interactive prompts
900
-
901
- DESCRIPTION
902
- List endpoints, schemas and configuration sets in your StepZen account.
903
- All timestamps displayed by stepzen list endpoints are in your local time zone.
904
- ```
905
-
906
- ## `stepzen login [DOMAIN]`
907
-
908
- Log in to StepZen.
909
-
910
- ```
911
- USAGE
912
- $ stepzen login [DOMAIN] [-h] [--non-interactive] [-a <value> | ] [-k <value> | ] [--introspection
913
- <value>] [-i <value>]
914
-
915
- ARGUMENTS
916
- [DOMAIN] Domain of the StepZen service to login to (e.g. us-east-a.ibm.stepzen.net or eu-central-a.ibm.stepzen.net).
917
- If no domain is provided, stepzen.net is used by default. Check you domain from the StepZen Dashboard.
918
-
919
- FLAGS
920
- -a, --account=<value> StepZen account name (copy from https://stepzen.com/account). If not provided, the CLI
921
- prompts the users to enter one.
922
- -h, --help Show CLI help
923
- -i, --instanceId=<value> Instance ID of your subscribed StepZen instance. You can find this in the SaaS console
924
- under Subscriptions → APIConnect for GraphQL → Instances.
925
- -k, --adminkey=<value> Key used for authentication. If used with `-i <instance_id>`, it is treated as the API
926
- key for the instance (get it from https://aws.console.saas.ibm.com/ under "API Keys"). If
927
- used with `-a <account>`, it is treated as the Admin key (get it from the dashbaord
928
- https://dashboard.ibm.stepzen.com/) ). If not provided, the CLI will prompt for it.
929
- --introspection=<value> Override the default StepZen introspection service URL for all stepzen import commands.
930
- If not provided, use the default introspection URL.
931
-
932
- Example:
933
- stepzen login --introspection stepzen-introspection.mydomain.com
934
- --non-interactive Disable all interactive prompts
935
-
936
- DESCRIPTION
937
- Log in to StepZen.
938
- ```
939
-
940
- ## `stepzen logout`
941
-
942
- Log out of StepZen.
943
-
944
- ```
945
- USAGE
946
- $ stepzen logout [-h] [--non-interactive]
947
-
948
- FLAGS
949
- -h, --help Show CLI help
950
- --non-interactive Disable all interactive prompts
951
-
952
- DESCRIPTION
953
- Log out of StepZen.
954
- ```
955
-
956
- ## `stepzen request [QUERY]`
957
-
958
- 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.
959
-
960
- ```
961
- USAGE
962
- $ stepzen request [QUERY] [-h] [--non-interactive] [--dir <value> | --endpoint <value>] [-H <value>...]
963
- [--operation-name <value>] [--var <value>...] [--var-file <value>] [-f <value>]
964
-
965
- ARGUMENTS
966
- [QUERY] GraphQL query (could include a query, a mutation or a subscription).
967
- This argument is required unless you provide the query as a file with --file=file.
968
-
969
- FLAGS
970
- -H, --header=<value>...
971
- Add an additional HTTP header to the request. This is useful for schemas where @rest or @graphql directives enable
972
- header forwarding with forwardheaders.
973
-
974
- Example:
975
- stepzen request '{ user(id: "u123") { email } }' \
976
- -H "X-API-Token: SecretAPIToken"
977
-
978
- Use the -H "Header-Name:" syntax to drop a default header, and the -H "Header-Name;" syntax to send a header with an
979
- empty value.
980
-
981
- -f, --file=<value>
982
- Read the query text from a file instead of the command line.
983
-
984
- Example:
985
- stepzen request -f query.graphql
986
-
987
- -h, --help
988
- Show CLI help
989
-
990
- --dir=<value>
991
- StepZen workspace directory (defaults to the current directory)
992
-
993
- --endpoint=<value>
994
- StepZen endpoint to call (defaults to the endpoint in current StepZen workspace)
995
-
996
- --non-interactive
997
- Disable all interactive prompts
998
-
999
- --operation-name=<value>
1000
- Specify the operation name (in case if the provided query includes multiple operations)
1001
-
1002
- --var=<value>...
1003
- Add a request variable, in the name=value format.
1004
-
1005
- Example:
1006
- stepzen request 'query OrdersQuery($search: String!, $limit: Int) {
1007
- orders(search: $search, limit: $limit) { id createdAt }
1008
- }' \
1009
- --var 'search=space ninja' \
1010
- --var limit=5
1011
-
1012
- --var-file=<value>
1013
- Read request variables from a JSON file. In case when the same variable value is provided both via --var-file and
1014
- --var, the priority is given to the latter.
1015
-
1016
- Example:
1017
- stepzen request 'query OrdersQuery($search: String!, $limit: Int) {
1018
- orders(search: $search, limit: $limit) { id createdAt }
1019
- }' \
1020
- --var-file ./vars.json
1021
-
1022
- DESCRIPTION
1023
- Send a GraphQL request to a StepZen endpoint and print the response, using the API key and the target endpoint from
1024
- the current StepZen workspace.
1025
- ```
1026
-
1027
- ## `stepzen service [ACTION]`
1028
-
1029
- Manage the local StepZen service instance (requires Docker).
1030
-
1031
- ```
1032
- USAGE
1033
- $ stepzen service [ACTION] [-h] [--non-interactive] [--dsn <value> | --reset-auto | --prompt] [--port
1034
- <value>] [--driver-path <value>...]
1035
-
1036
- ARGUMENTS
1037
- [ACTION]
1038
- (start|stop|upgrade)
1039
- start start a local StepZen service instance in a Docker container
1040
- This command pulls the latest StepZen service instance Docker image so that the
1041
- version of StepZen you run locally is the same as the one running on
1042
- stepzen.net.
1043
-
1044
- stop stop the local StepZen service instance (if running)
1045
- This command deletes the Docker container with the StepZen service instance,
1046
- but all your endpoints are persistently stored in the metadata database. They
1047
- remain available when running stepzen service start next time.
1048
-
1049
- upgrade upgrade the local StepZen service instance if it is running
1050
- This command checks if a newer version of the StepZen service instance Docker
1051
- image is available, and if it is then stops and deletes the currently running
1052
- container, pulls the latest image, and starts it. All endpoints are preserved.
1053
-
1054
- If no action is provided, print the service status and exit.
1055
-
1056
- FLAGS
1057
- -h, --help
1058
- Show CLI help
1059
-
1060
- --driver-path=<value>...
1061
- (Optional) Mount a local directory containing additional JDBC drivers to the API Connect Essentials Docker container
1062
- for the introspection service. This setup is required when JDBC driver licenses restrict the distribution of certain
1063
- drivers (such as those for Db2 and Oracle) along with the API Connect Essentials Docker image.
1064
-
1065
- Example: stepzen service start --driver-path "path1" --driver-path "path2"
1066
-
1067
- --dsn=<value>
1068
- DSN of a StepZen metadata database, e.g. postgres://user:password@172.17.0.1:5432/zenctl
1069
-
1070
- --non-interactive
1071
- Disable all interactive prompts
1072
-
1073
- --port=<value>
1074
- Override the TCP port on which the local StepZen service instance will listen for connections (port 9000 by
1075
- default).
1076
-
1077
- --prompt
1078
- Opens an interactive prompt to ask for database details (or fails, if running in a non-interactive mode).
1079
-
1080
- --reset-auto
1081
- Create fresh empty metadata database. Note: all existing endpoints will be deleted and you will be logged out.
1082
-
1083
- DESCRIPTION
1084
- Manage the local StepZen service instance (requires Docker).
1085
- You can use a local StepZen service instance instead of the StepZen cloud to develop and test GraphQL endpoints
1086
- locally. This way you can try StepZen out without giving the StepZen cloud access to your data sources and API
1087
- endpoints.
1088
-
1089
- Local StepZen service instances are not suitable for production use. Please refer to the documentation at
1090
- https://stepzen.com/docs/deployment/local-docker for more information and examples.
1091
- ```
1092
-
1093
- ## `stepzen start`
1094
-
1095
- Deploy your schema to StepZen, and then redeploy on every change.
1096
-
1097
- ```
1098
- USAGE
1099
- $ stepzen start [-h] [--non-interactive] [--dir <value>] [--endpoint <value>] [--dashboard
1100
- web|local|none] [--port <value>]
1101
-
1102
- FLAGS
1103
- -h, --help
1104
- Show CLI help
1105
-
1106
- --dashboard=<option>
1107
- Which GraphiQL dashboard to use to explore the deployed endpoint.
1108
- - web [default]: use GraphiQL at dashboard.stepzen.com
1109
- - local: start a local GraphiQL dashboard on localhost:5001 (change the port with the --port flag)
1110
- - none: do not use GraphiQL at all
1111
- <options: web|local|none>
1112
-
1113
- --dir=<value>
1114
- Working directory
1115
-
1116
- --endpoint=<value>
1117
- Override workspace endpoint
1118
-
1119
- --non-interactive
1120
- Disable all interactive prompts
1121
-
1122
- --port=<value>
1123
- [default: 5001, env: PORT] Port for the local GraphiQL dashboard (when using --dashboard=local)
1124
-
1125
- DESCRIPTION
1126
- Deploy your schema to StepZen, and then redeploy on every change.
1127
- ```
1128
-
1129
77
  ## `stepzen version`
1130
78
 
1131
79
  ```
@@ -1145,29 +93,4 @@ FLAG DESCRIPTIONS
1145
93
  ```
1146
94
 
1147
95
  _See code: [@oclif/plugin-version](https://github.com/oclif/plugin-version/blob/2.2.41/src/commands/version.ts)_
1148
-
1149
- ## `stepzen whoami`
1150
-
1151
- View your StepZen credentials.
1152
-
1153
- ```
1154
- USAGE
1155
- $ stepzen whoami [-h] [--non-interactive] [--showkeys | --account | --adminkey | --apikey | --domain |
1156
- --instanceid | --email | --accesstoken]
1157
-
1158
- FLAGS
1159
- -h, --help Show CLI help
1160
- --accesstoken
1161
- --account
1162
- --adminkey
1163
- --apikey
1164
- --domain
1165
- --email
1166
- --instanceid
1167
- --non-interactive Disable all interactive prompts
1168
- --showkeys
1169
-
1170
- DESCRIPTION
1171
- View your StepZen credentials.
1172
- ```
1173
96
  <!-- commandsstop -->