infrahub-sdk 0.0.1
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/.eslintrc.js +18 -0
- package/.prettierrc +6 -0
- package/LICENSE +201 -0
- package/README.md +47 -0
- package/dist/branch.d.ts +36 -0
- package/dist/branch.js +136 -0
- package/dist/cjs/index.js +65 -0
- package/dist/cjs/index.js.map +7 -0
- package/dist/client.d.ts +6 -0
- package/dist/client.js +35 -0
- package/dist/constants.d.ts +0 -0
- package/dist/constants.js +1 -0
- package/dist/esm/index.js +32 -0
- package/dist/esm/index.js.map +7 -0
- package/dist/graphql.d.ts +31 -0
- package/dist/graphql.js +174 -0
- package/dist/index.d.ts +47 -0
- package/dist/index.js +115 -0
- package/dist/index.test.d.ts +1 -0
- package/dist/index.test.js +62 -0
- package/dist/types/client.d.ts +7 -0
- package/dist/types/client.d.ts.map +1 -0
- package/dist/types/constants.d.ts +1 -0
- package/dist/types/constants.d.ts.map +1 -0
- package/dist/types/index.d.ts +2 -0
- package/dist/types/index.d.ts.map +1 -0
- package/dist/types/utils/auth.d.ts +1 -0
- package/dist/types/utils/auth.d.ts.map +1 -0
- package/dist/types/utils/error-handling.d.ts +1 -0
- package/dist/types/utils/error-handling.d.ts.map +1 -0
- package/dist/types/utils/index.d.ts +1 -0
- package/dist/types/utils/index.d.ts.map +1 -0
- package/dist/types/utils/validation.d.ts +1 -0
- package/dist/types/utils/validation.d.ts.map +1 -0
- package/dist/types.d.ts +3144 -0
- package/dist/types.js +6 -0
- package/dist/utils/auth.d.ts +0 -0
- package/dist/utils/auth.js +1 -0
- package/dist/utils/error-handling.d.ts +0 -0
- package/dist/utils/error-handling.js +1 -0
- package/dist/utils/index.d.ts +0 -0
- package/dist/utils/index.js +1 -0
- package/dist/utils/validation.d.ts +0 -0
- package/dist/utils/validation.js +1 -0
- package/eslint.config.mjs +9 -0
- package/jest.config.js +6 -0
- package/package.json +33 -0
- package/src/branch.ts +161 -0
- package/src/graphql.ts +266 -0
- package/src/index.test.ts +74 -0
- package/src/index.ts +144 -0
- package/src/types.ts +3169 -0
- package/tsconfig.json +14 -0
package/src/types.ts
ADDED
|
@@ -0,0 +1,3169 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* This file was auto-generated by openapi-typescript.
|
|
3
|
+
* Do not make direct changes to the file.
|
|
4
|
+
*/
|
|
5
|
+
|
|
6
|
+
export interface paths {
|
|
7
|
+
'/api/artifact/{artifact_id}': {
|
|
8
|
+
parameters: {
|
|
9
|
+
query?: never;
|
|
10
|
+
header?: never;
|
|
11
|
+
path?: never;
|
|
12
|
+
cookie?: never;
|
|
13
|
+
};
|
|
14
|
+
/** Get Artifact */
|
|
15
|
+
get: operations['get_artifact_api_artifact__artifact_id__get'];
|
|
16
|
+
put?: never;
|
|
17
|
+
post?: never;
|
|
18
|
+
delete?: never;
|
|
19
|
+
options?: never;
|
|
20
|
+
head?: never;
|
|
21
|
+
patch?: never;
|
|
22
|
+
trace?: never;
|
|
23
|
+
};
|
|
24
|
+
'/api/artifact/generate/{artifact_definition_id}': {
|
|
25
|
+
parameters: {
|
|
26
|
+
query?: never;
|
|
27
|
+
header?: never;
|
|
28
|
+
path?: never;
|
|
29
|
+
cookie?: never;
|
|
30
|
+
};
|
|
31
|
+
get?: never;
|
|
32
|
+
put?: never;
|
|
33
|
+
/** Generate Artifact */
|
|
34
|
+
post: operations['generate_artifact_api_artifact_generate__artifact_definition_id__post'];
|
|
35
|
+
delete?: never;
|
|
36
|
+
options?: never;
|
|
37
|
+
head?: never;
|
|
38
|
+
patch?: never;
|
|
39
|
+
trace?: never;
|
|
40
|
+
};
|
|
41
|
+
'/api/auth/login': {
|
|
42
|
+
parameters: {
|
|
43
|
+
query?: never;
|
|
44
|
+
header?: never;
|
|
45
|
+
path?: never;
|
|
46
|
+
cookie?: never;
|
|
47
|
+
};
|
|
48
|
+
get?: never;
|
|
49
|
+
put?: never;
|
|
50
|
+
/** Login User */
|
|
51
|
+
post: operations['login_user_api_auth_login_post'];
|
|
52
|
+
delete?: never;
|
|
53
|
+
options?: never;
|
|
54
|
+
head?: never;
|
|
55
|
+
patch?: never;
|
|
56
|
+
trace?: never;
|
|
57
|
+
};
|
|
58
|
+
'/api/auth/refresh': {
|
|
59
|
+
parameters: {
|
|
60
|
+
query?: never;
|
|
61
|
+
header?: never;
|
|
62
|
+
path?: never;
|
|
63
|
+
cookie?: never;
|
|
64
|
+
};
|
|
65
|
+
get?: never;
|
|
66
|
+
put?: never;
|
|
67
|
+
/** Refresh Jwt Token */
|
|
68
|
+
post: operations['refresh_jwt_token_api_auth_refresh_post'];
|
|
69
|
+
delete?: never;
|
|
70
|
+
options?: never;
|
|
71
|
+
head?: never;
|
|
72
|
+
patch?: never;
|
|
73
|
+
trace?: never;
|
|
74
|
+
};
|
|
75
|
+
'/api/auth/logout': {
|
|
76
|
+
parameters: {
|
|
77
|
+
query?: never;
|
|
78
|
+
header?: never;
|
|
79
|
+
path?: never;
|
|
80
|
+
cookie?: never;
|
|
81
|
+
};
|
|
82
|
+
get?: never;
|
|
83
|
+
put?: never;
|
|
84
|
+
/** Logout */
|
|
85
|
+
post: operations['logout_api_auth_logout_post'];
|
|
86
|
+
delete?: never;
|
|
87
|
+
options?: never;
|
|
88
|
+
head?: never;
|
|
89
|
+
patch?: never;
|
|
90
|
+
trace?: never;
|
|
91
|
+
};
|
|
92
|
+
'/api/diff/files': {
|
|
93
|
+
parameters: {
|
|
94
|
+
query?: never;
|
|
95
|
+
header?: never;
|
|
96
|
+
path?: never;
|
|
97
|
+
cookie?: never;
|
|
98
|
+
};
|
|
99
|
+
/** Get Diff Files */
|
|
100
|
+
get: operations['get_diff_files_api_diff_files_get'];
|
|
101
|
+
put?: never;
|
|
102
|
+
post?: never;
|
|
103
|
+
delete?: never;
|
|
104
|
+
options?: never;
|
|
105
|
+
head?: never;
|
|
106
|
+
patch?: never;
|
|
107
|
+
trace?: never;
|
|
108
|
+
};
|
|
109
|
+
'/api/diff/artifacts': {
|
|
110
|
+
parameters: {
|
|
111
|
+
query?: never;
|
|
112
|
+
header?: never;
|
|
113
|
+
path?: never;
|
|
114
|
+
cookie?: never;
|
|
115
|
+
};
|
|
116
|
+
/** Get Diff Artifacts */
|
|
117
|
+
get: operations['get_diff_artifacts_api_diff_artifacts_get'];
|
|
118
|
+
put?: never;
|
|
119
|
+
post?: never;
|
|
120
|
+
delete?: never;
|
|
121
|
+
options?: never;
|
|
122
|
+
head?: never;
|
|
123
|
+
patch?: never;
|
|
124
|
+
trace?: never;
|
|
125
|
+
};
|
|
126
|
+
'/api/file/{repository_id}/{file_path}': {
|
|
127
|
+
parameters: {
|
|
128
|
+
query?: never;
|
|
129
|
+
header?: never;
|
|
130
|
+
path?: never;
|
|
131
|
+
cookie?: never;
|
|
132
|
+
};
|
|
133
|
+
/**
|
|
134
|
+
* Get File
|
|
135
|
+
* @description Retrieve a file from a git repository.
|
|
136
|
+
*/
|
|
137
|
+
get: operations['get_file_api_file__repository_id___file_path__get'];
|
|
138
|
+
put?: never;
|
|
139
|
+
post?: never;
|
|
140
|
+
delete?: never;
|
|
141
|
+
options?: never;
|
|
142
|
+
head?: never;
|
|
143
|
+
patch?: never;
|
|
144
|
+
trace?: never;
|
|
145
|
+
};
|
|
146
|
+
'/api/config': {
|
|
147
|
+
parameters: {
|
|
148
|
+
query?: never;
|
|
149
|
+
header?: never;
|
|
150
|
+
path?: never;
|
|
151
|
+
cookie?: never;
|
|
152
|
+
};
|
|
153
|
+
/** Get Config */
|
|
154
|
+
get: operations['get_config_api_config_get'];
|
|
155
|
+
put?: never;
|
|
156
|
+
post?: never;
|
|
157
|
+
delete?: never;
|
|
158
|
+
options?: never;
|
|
159
|
+
head?: never;
|
|
160
|
+
patch?: never;
|
|
161
|
+
trace?: never;
|
|
162
|
+
};
|
|
163
|
+
'/api/info': {
|
|
164
|
+
parameters: {
|
|
165
|
+
query?: never;
|
|
166
|
+
header?: never;
|
|
167
|
+
path?: never;
|
|
168
|
+
cookie?: never;
|
|
169
|
+
};
|
|
170
|
+
/** Get Info */
|
|
171
|
+
get: operations['get_info_api_info_get'];
|
|
172
|
+
put?: never;
|
|
173
|
+
post?: never;
|
|
174
|
+
delete?: never;
|
|
175
|
+
options?: never;
|
|
176
|
+
head?: never;
|
|
177
|
+
patch?: never;
|
|
178
|
+
trace?: never;
|
|
179
|
+
};
|
|
180
|
+
'/api/menu': {
|
|
181
|
+
parameters: {
|
|
182
|
+
query?: never;
|
|
183
|
+
header?: never;
|
|
184
|
+
path?: never;
|
|
185
|
+
cookie?: never;
|
|
186
|
+
};
|
|
187
|
+
/** Get Menu */
|
|
188
|
+
get: operations['get_menu_api_menu_get'];
|
|
189
|
+
put?: never;
|
|
190
|
+
post?: never;
|
|
191
|
+
delete?: never;
|
|
192
|
+
options?: never;
|
|
193
|
+
head?: never;
|
|
194
|
+
patch?: never;
|
|
195
|
+
trace?: never;
|
|
196
|
+
};
|
|
197
|
+
'/api/oauth2/{provider_name}/authorize': {
|
|
198
|
+
parameters: {
|
|
199
|
+
query?: never;
|
|
200
|
+
header?: never;
|
|
201
|
+
path?: never;
|
|
202
|
+
cookie?: never;
|
|
203
|
+
};
|
|
204
|
+
/** Authorize */
|
|
205
|
+
get: operations['authorize_api_oauth2__provider_name__authorize_get'];
|
|
206
|
+
put?: never;
|
|
207
|
+
post?: never;
|
|
208
|
+
delete?: never;
|
|
209
|
+
options?: never;
|
|
210
|
+
head?: never;
|
|
211
|
+
patch?: never;
|
|
212
|
+
trace?: never;
|
|
213
|
+
};
|
|
214
|
+
'/api/oauth2/{provider_name}/token': {
|
|
215
|
+
parameters: {
|
|
216
|
+
query?: never;
|
|
217
|
+
header?: never;
|
|
218
|
+
path?: never;
|
|
219
|
+
cookie?: never;
|
|
220
|
+
};
|
|
221
|
+
/** Token */
|
|
222
|
+
get: operations['token_api_oauth2__provider_name__token_get'];
|
|
223
|
+
put?: never;
|
|
224
|
+
post?: never;
|
|
225
|
+
delete?: never;
|
|
226
|
+
options?: never;
|
|
227
|
+
head?: never;
|
|
228
|
+
patch?: never;
|
|
229
|
+
trace?: never;
|
|
230
|
+
};
|
|
231
|
+
'/api/oidc/{provider_name}/authorize': {
|
|
232
|
+
parameters: {
|
|
233
|
+
query?: never;
|
|
234
|
+
header?: never;
|
|
235
|
+
path?: never;
|
|
236
|
+
cookie?: never;
|
|
237
|
+
};
|
|
238
|
+
/** Authorize */
|
|
239
|
+
get: operations['authorize_api_oidc__provider_name__authorize_get'];
|
|
240
|
+
put?: never;
|
|
241
|
+
post?: never;
|
|
242
|
+
delete?: never;
|
|
243
|
+
options?: never;
|
|
244
|
+
head?: never;
|
|
245
|
+
patch?: never;
|
|
246
|
+
trace?: never;
|
|
247
|
+
};
|
|
248
|
+
'/api/oidc/{provider_name}/token': {
|
|
249
|
+
parameters: {
|
|
250
|
+
query?: never;
|
|
251
|
+
header?: never;
|
|
252
|
+
path?: never;
|
|
253
|
+
cookie?: never;
|
|
254
|
+
};
|
|
255
|
+
/** Token */
|
|
256
|
+
get: operations['token_api_oidc__provider_name__token_get'];
|
|
257
|
+
put?: never;
|
|
258
|
+
post?: never;
|
|
259
|
+
delete?: never;
|
|
260
|
+
options?: never;
|
|
261
|
+
head?: never;
|
|
262
|
+
patch?: never;
|
|
263
|
+
trace?: never;
|
|
264
|
+
};
|
|
265
|
+
'/api/query/{query_id}': {
|
|
266
|
+
parameters: {
|
|
267
|
+
query?: never;
|
|
268
|
+
header?: never;
|
|
269
|
+
path?: never;
|
|
270
|
+
cookie?: never;
|
|
271
|
+
};
|
|
272
|
+
/** Graphql Query Get */
|
|
273
|
+
get: operations['graphql_query_get_api_query__query_id__get'];
|
|
274
|
+
put?: never;
|
|
275
|
+
/** Graphql Query Post */
|
|
276
|
+
post: operations['graphql_query_post_api_query__query_id__post'];
|
|
277
|
+
delete?: never;
|
|
278
|
+
options?: never;
|
|
279
|
+
head?: never;
|
|
280
|
+
patch?: never;
|
|
281
|
+
trace?: never;
|
|
282
|
+
};
|
|
283
|
+
'/api/schema': {
|
|
284
|
+
parameters: {
|
|
285
|
+
query?: never;
|
|
286
|
+
header?: never;
|
|
287
|
+
path?: never;
|
|
288
|
+
cookie?: never;
|
|
289
|
+
};
|
|
290
|
+
/** Get Schema */
|
|
291
|
+
get: operations['get_schema_api_schema_get'];
|
|
292
|
+
put?: never;
|
|
293
|
+
post?: never;
|
|
294
|
+
delete?: never;
|
|
295
|
+
options?: never;
|
|
296
|
+
head?: never;
|
|
297
|
+
patch?: never;
|
|
298
|
+
trace?: never;
|
|
299
|
+
};
|
|
300
|
+
'/api/schema/summary': {
|
|
301
|
+
parameters: {
|
|
302
|
+
query?: never;
|
|
303
|
+
header?: never;
|
|
304
|
+
path?: never;
|
|
305
|
+
cookie?: never;
|
|
306
|
+
};
|
|
307
|
+
/** Get Schema Summary */
|
|
308
|
+
get: operations['get_schema_summary_api_schema_summary_get'];
|
|
309
|
+
put?: never;
|
|
310
|
+
post?: never;
|
|
311
|
+
delete?: never;
|
|
312
|
+
options?: never;
|
|
313
|
+
head?: never;
|
|
314
|
+
patch?: never;
|
|
315
|
+
trace?: never;
|
|
316
|
+
};
|
|
317
|
+
'/api/schema/{schema_kind}': {
|
|
318
|
+
parameters: {
|
|
319
|
+
query?: never;
|
|
320
|
+
header?: never;
|
|
321
|
+
path?: never;
|
|
322
|
+
cookie?: never;
|
|
323
|
+
};
|
|
324
|
+
/** Get Schema By Kind */
|
|
325
|
+
get: operations['get_schema_by_kind_api_schema__schema_kind__get'];
|
|
326
|
+
put?: never;
|
|
327
|
+
post?: never;
|
|
328
|
+
delete?: never;
|
|
329
|
+
options?: never;
|
|
330
|
+
head?: never;
|
|
331
|
+
patch?: never;
|
|
332
|
+
trace?: never;
|
|
333
|
+
};
|
|
334
|
+
'/api/schema/json_schema/{schema_kind}': {
|
|
335
|
+
parameters: {
|
|
336
|
+
query?: never;
|
|
337
|
+
header?: never;
|
|
338
|
+
path?: never;
|
|
339
|
+
cookie?: never;
|
|
340
|
+
};
|
|
341
|
+
/** Get Json Schema By Kind */
|
|
342
|
+
get: operations['get_json_schema_by_kind_api_schema_json_schema__schema_kind__get'];
|
|
343
|
+
put?: never;
|
|
344
|
+
post?: never;
|
|
345
|
+
delete?: never;
|
|
346
|
+
options?: never;
|
|
347
|
+
head?: never;
|
|
348
|
+
patch?: never;
|
|
349
|
+
trace?: never;
|
|
350
|
+
};
|
|
351
|
+
'/api/schema/load': {
|
|
352
|
+
parameters: {
|
|
353
|
+
query?: never;
|
|
354
|
+
header?: never;
|
|
355
|
+
path?: never;
|
|
356
|
+
cookie?: never;
|
|
357
|
+
};
|
|
358
|
+
get?: never;
|
|
359
|
+
put?: never;
|
|
360
|
+
/** Load Schema */
|
|
361
|
+
post: operations['load_schema_api_schema_load_post'];
|
|
362
|
+
delete?: never;
|
|
363
|
+
options?: never;
|
|
364
|
+
head?: never;
|
|
365
|
+
patch?: never;
|
|
366
|
+
trace?: never;
|
|
367
|
+
};
|
|
368
|
+
'/api/schema/check': {
|
|
369
|
+
parameters: {
|
|
370
|
+
query?: never;
|
|
371
|
+
header?: never;
|
|
372
|
+
path?: never;
|
|
373
|
+
cookie?: never;
|
|
374
|
+
};
|
|
375
|
+
get?: never;
|
|
376
|
+
put?: never;
|
|
377
|
+
/** Check Schema */
|
|
378
|
+
post: operations['check_schema_api_schema_check_post'];
|
|
379
|
+
delete?: never;
|
|
380
|
+
options?: never;
|
|
381
|
+
head?: never;
|
|
382
|
+
patch?: never;
|
|
383
|
+
trace?: never;
|
|
384
|
+
};
|
|
385
|
+
'/api/storage/object/{identifier}': {
|
|
386
|
+
parameters: {
|
|
387
|
+
query?: never;
|
|
388
|
+
header?: never;
|
|
389
|
+
path?: never;
|
|
390
|
+
cookie?: never;
|
|
391
|
+
};
|
|
392
|
+
/** Get File */
|
|
393
|
+
get: operations['get_file_api_storage_object__identifier__get'];
|
|
394
|
+
put?: never;
|
|
395
|
+
post?: never;
|
|
396
|
+
delete?: never;
|
|
397
|
+
options?: never;
|
|
398
|
+
head?: never;
|
|
399
|
+
patch?: never;
|
|
400
|
+
trace?: never;
|
|
401
|
+
};
|
|
402
|
+
'/api/storage/upload/content': {
|
|
403
|
+
parameters: {
|
|
404
|
+
query?: never;
|
|
405
|
+
header?: never;
|
|
406
|
+
path?: never;
|
|
407
|
+
cookie?: never;
|
|
408
|
+
};
|
|
409
|
+
get?: never;
|
|
410
|
+
put?: never;
|
|
411
|
+
/** Upload Content */
|
|
412
|
+
post: operations['upload_content_api_storage_upload_content_post'];
|
|
413
|
+
delete?: never;
|
|
414
|
+
options?: never;
|
|
415
|
+
head?: never;
|
|
416
|
+
patch?: never;
|
|
417
|
+
trace?: never;
|
|
418
|
+
};
|
|
419
|
+
'/api/storage/upload/file': {
|
|
420
|
+
parameters: {
|
|
421
|
+
query?: never;
|
|
422
|
+
header?: never;
|
|
423
|
+
path?: never;
|
|
424
|
+
cookie?: never;
|
|
425
|
+
};
|
|
426
|
+
get?: never;
|
|
427
|
+
put?: never;
|
|
428
|
+
/** Upload File */
|
|
429
|
+
post: operations['upload_file_api_storage_upload_file_post'];
|
|
430
|
+
delete?: never;
|
|
431
|
+
options?: never;
|
|
432
|
+
head?: never;
|
|
433
|
+
patch?: never;
|
|
434
|
+
trace?: never;
|
|
435
|
+
};
|
|
436
|
+
'/api/transform/python/{transform_id}': {
|
|
437
|
+
parameters: {
|
|
438
|
+
query?: never;
|
|
439
|
+
header?: never;
|
|
440
|
+
path?: never;
|
|
441
|
+
cookie?: never;
|
|
442
|
+
};
|
|
443
|
+
/** Transform Python */
|
|
444
|
+
get: operations['transform_python_api_transform_python__transform_id__get'];
|
|
445
|
+
put?: never;
|
|
446
|
+
post?: never;
|
|
447
|
+
delete?: never;
|
|
448
|
+
options?: never;
|
|
449
|
+
head?: never;
|
|
450
|
+
patch?: never;
|
|
451
|
+
trace?: never;
|
|
452
|
+
};
|
|
453
|
+
'/api/transform/jinja2/{transform_id}': {
|
|
454
|
+
parameters: {
|
|
455
|
+
query?: never;
|
|
456
|
+
header?: never;
|
|
457
|
+
path?: never;
|
|
458
|
+
cookie?: never;
|
|
459
|
+
};
|
|
460
|
+
/** Transform Jinja2 */
|
|
461
|
+
get: operations['transform_jinja2_api_transform_jinja2__transform_id__get'];
|
|
462
|
+
put?: never;
|
|
463
|
+
post?: never;
|
|
464
|
+
delete?: never;
|
|
465
|
+
options?: never;
|
|
466
|
+
head?: never;
|
|
467
|
+
patch?: never;
|
|
468
|
+
trace?: never;
|
|
469
|
+
};
|
|
470
|
+
}
|
|
471
|
+
export type webhooks = Record<string, never>;
|
|
472
|
+
export interface components {
|
|
473
|
+
schemas: {
|
|
474
|
+
/** APIGenericSchema */
|
|
475
|
+
APIGenericSchema: {
|
|
476
|
+
/**
|
|
477
|
+
* Id
|
|
478
|
+
* @description The ID of the node
|
|
479
|
+
*/
|
|
480
|
+
id?: string | null;
|
|
481
|
+
/**
|
|
482
|
+
* @description Expected state of the node/generic after loading the schema
|
|
483
|
+
* @default present
|
|
484
|
+
*/
|
|
485
|
+
state: components['schemas']['HashableModelState'];
|
|
486
|
+
/**
|
|
487
|
+
* Name
|
|
488
|
+
* @description Node name, must be unique within a namespace and must start with an uppercase letter.
|
|
489
|
+
*/
|
|
490
|
+
name: string;
|
|
491
|
+
/**
|
|
492
|
+
* Namespace
|
|
493
|
+
* @description Node Namespace, Namespaces are used to organize models into logical groups and to prevent name collisions.
|
|
494
|
+
*/
|
|
495
|
+
namespace: string;
|
|
496
|
+
/**
|
|
497
|
+
* Description
|
|
498
|
+
* @description Short description of the model, will be visible in the frontend.
|
|
499
|
+
*/
|
|
500
|
+
description?: string | null;
|
|
501
|
+
/**
|
|
502
|
+
* Label
|
|
503
|
+
* @description Human friendly representation of the name/kind
|
|
504
|
+
*/
|
|
505
|
+
label?: string | null;
|
|
506
|
+
/**
|
|
507
|
+
* @description Type of branch support for the model.
|
|
508
|
+
* @default aware
|
|
509
|
+
*/
|
|
510
|
+
branch: components['schemas']['BranchSupportType'];
|
|
511
|
+
/**
|
|
512
|
+
* Default Filter
|
|
513
|
+
* @description Default filter used to search for a node in addition to its ID. (deprecated: please use human_friendly_id instead)
|
|
514
|
+
*/
|
|
515
|
+
default_filter?: string | null;
|
|
516
|
+
/**
|
|
517
|
+
* Human Friendly Id
|
|
518
|
+
* @description Human friendly and unique identifier for the object.
|
|
519
|
+
*/
|
|
520
|
+
human_friendly_id?: string[] | null;
|
|
521
|
+
/**
|
|
522
|
+
* Display Labels
|
|
523
|
+
* @description List of attributes to use to generate the display label
|
|
524
|
+
*/
|
|
525
|
+
display_labels?: string[] | null;
|
|
526
|
+
/**
|
|
527
|
+
* Include In Menu
|
|
528
|
+
* @description Defines if objects of this kind should be included in the menu.
|
|
529
|
+
*/
|
|
530
|
+
include_in_menu?: boolean | null;
|
|
531
|
+
/**
|
|
532
|
+
* Menu Placement
|
|
533
|
+
* @description Defines where in the menu this object should be placed.
|
|
534
|
+
*/
|
|
535
|
+
menu_placement?: string | null;
|
|
536
|
+
/**
|
|
537
|
+
* Icon
|
|
538
|
+
* @description Defines the icon to use in the menu. Must be a valid value from the MDI library https://icon-sets.iconify.design/mdi/
|
|
539
|
+
*/
|
|
540
|
+
icon?: string | null;
|
|
541
|
+
/**
|
|
542
|
+
* Order By
|
|
543
|
+
* @description List of attributes to use to order the results by default
|
|
544
|
+
*/
|
|
545
|
+
order_by?: string[] | null;
|
|
546
|
+
/**
|
|
547
|
+
* Uniqueness Constraints
|
|
548
|
+
* @description List of multi-element uniqueness constraints that can combine relationships and attributes
|
|
549
|
+
*/
|
|
550
|
+
uniqueness_constraints?: string[][] | null;
|
|
551
|
+
/**
|
|
552
|
+
* Documentation
|
|
553
|
+
* @description Link to a documentation associated with this object, can be internal or external.
|
|
554
|
+
*/
|
|
555
|
+
documentation?: string | null;
|
|
556
|
+
/**
|
|
557
|
+
* Attributes
|
|
558
|
+
* @description Node attributes
|
|
559
|
+
*/
|
|
560
|
+
attributes?: components['schemas']['AttributeSchema-Output'][];
|
|
561
|
+
/**
|
|
562
|
+
* Relationships
|
|
563
|
+
* @description Node Relationships
|
|
564
|
+
*/
|
|
565
|
+
relationships?: components['schemas']['RelationshipSchema'][];
|
|
566
|
+
/**
|
|
567
|
+
* Hierarchical
|
|
568
|
+
* @description Defines if the Generic support the hierarchical mode.
|
|
569
|
+
* @default false
|
|
570
|
+
*/
|
|
571
|
+
hierarchical: boolean;
|
|
572
|
+
/**
|
|
573
|
+
* Generate Profile
|
|
574
|
+
* @description Indicate if a profile schema should be generated for this schema
|
|
575
|
+
* @default true
|
|
576
|
+
*/
|
|
577
|
+
generate_profile: boolean;
|
|
578
|
+
/**
|
|
579
|
+
* Generate Template
|
|
580
|
+
* @description Indicate if an object template schema should be generated for this schema
|
|
581
|
+
* @default false
|
|
582
|
+
*/
|
|
583
|
+
generate_template: boolean;
|
|
584
|
+
/**
|
|
585
|
+
* Used By
|
|
586
|
+
* @description List of Nodes that are referencing this Generic
|
|
587
|
+
*/
|
|
588
|
+
used_by?: string[];
|
|
589
|
+
/** Kind */
|
|
590
|
+
kind?: string | null;
|
|
591
|
+
/** Hash */
|
|
592
|
+
hash: string;
|
|
593
|
+
};
|
|
594
|
+
/** APINodeSchema */
|
|
595
|
+
APINodeSchema: {
|
|
596
|
+
/**
|
|
597
|
+
* Id
|
|
598
|
+
* @description The ID of the node
|
|
599
|
+
*/
|
|
600
|
+
id?: string | null;
|
|
601
|
+
/**
|
|
602
|
+
* @description Expected state of the node/generic after loading the schema
|
|
603
|
+
* @default present
|
|
604
|
+
*/
|
|
605
|
+
state: components['schemas']['HashableModelState'];
|
|
606
|
+
/**
|
|
607
|
+
* Name
|
|
608
|
+
* @description Node name, must be unique within a namespace and must start with an uppercase letter.
|
|
609
|
+
*/
|
|
610
|
+
name: string;
|
|
611
|
+
/**
|
|
612
|
+
* Namespace
|
|
613
|
+
* @description Node Namespace, Namespaces are used to organize models into logical groups and to prevent name collisions.
|
|
614
|
+
*/
|
|
615
|
+
namespace: string;
|
|
616
|
+
/**
|
|
617
|
+
* Description
|
|
618
|
+
* @description Short description of the model, will be visible in the frontend.
|
|
619
|
+
*/
|
|
620
|
+
description?: string | null;
|
|
621
|
+
/**
|
|
622
|
+
* Label
|
|
623
|
+
* @description Human friendly representation of the name/kind
|
|
624
|
+
*/
|
|
625
|
+
label?: string | null;
|
|
626
|
+
/**
|
|
627
|
+
* @description Type of branch support for the model.
|
|
628
|
+
* @default aware
|
|
629
|
+
*/
|
|
630
|
+
branch: components['schemas']['BranchSupportType'];
|
|
631
|
+
/**
|
|
632
|
+
* Default Filter
|
|
633
|
+
* @description Default filter used to search for a node in addition to its ID. (deprecated: please use human_friendly_id instead)
|
|
634
|
+
*/
|
|
635
|
+
default_filter?: string | null;
|
|
636
|
+
/**
|
|
637
|
+
* Human Friendly Id
|
|
638
|
+
* @description Human friendly and unique identifier for the object.
|
|
639
|
+
*/
|
|
640
|
+
human_friendly_id?: string[] | null;
|
|
641
|
+
/**
|
|
642
|
+
* Display Labels
|
|
643
|
+
* @description List of attributes to use to generate the display label
|
|
644
|
+
*/
|
|
645
|
+
display_labels?: string[] | null;
|
|
646
|
+
/**
|
|
647
|
+
* Include In Menu
|
|
648
|
+
* @description Defines if objects of this kind should be included in the menu.
|
|
649
|
+
*/
|
|
650
|
+
include_in_menu?: boolean | null;
|
|
651
|
+
/**
|
|
652
|
+
* Menu Placement
|
|
653
|
+
* @description Defines where in the menu this object should be placed.
|
|
654
|
+
*/
|
|
655
|
+
menu_placement?: string | null;
|
|
656
|
+
/**
|
|
657
|
+
* Icon
|
|
658
|
+
* @description Defines the icon to use in the menu. Must be a valid value from the MDI library https://icon-sets.iconify.design/mdi/
|
|
659
|
+
*/
|
|
660
|
+
icon?: string | null;
|
|
661
|
+
/**
|
|
662
|
+
* Order By
|
|
663
|
+
* @description List of attributes to use to order the results by default
|
|
664
|
+
*/
|
|
665
|
+
order_by?: string[] | null;
|
|
666
|
+
/**
|
|
667
|
+
* Uniqueness Constraints
|
|
668
|
+
* @description List of multi-element uniqueness constraints that can combine relationships and attributes
|
|
669
|
+
*/
|
|
670
|
+
uniqueness_constraints?: string[][] | null;
|
|
671
|
+
/**
|
|
672
|
+
* Documentation
|
|
673
|
+
* @description Link to a documentation associated with this object, can be internal or external.
|
|
674
|
+
*/
|
|
675
|
+
documentation?: string | null;
|
|
676
|
+
/**
|
|
677
|
+
* Attributes
|
|
678
|
+
* @description Node attributes
|
|
679
|
+
*/
|
|
680
|
+
attributes?: components['schemas']['AttributeSchema-Output'][];
|
|
681
|
+
/**
|
|
682
|
+
* Relationships
|
|
683
|
+
* @description Node Relationships
|
|
684
|
+
*/
|
|
685
|
+
relationships?: components['schemas']['RelationshipSchema'][];
|
|
686
|
+
/**
|
|
687
|
+
* Inherit From
|
|
688
|
+
* @description List of Generic Kind that this node is inheriting from
|
|
689
|
+
*/
|
|
690
|
+
inherit_from?: string[];
|
|
691
|
+
/**
|
|
692
|
+
* Generate Profile
|
|
693
|
+
* @description Indicate if a profile schema should be generated for this schema
|
|
694
|
+
* @default true
|
|
695
|
+
*/
|
|
696
|
+
generate_profile: boolean;
|
|
697
|
+
/**
|
|
698
|
+
* Generate Template
|
|
699
|
+
* @description Indicate if an object template schema should be generated for this schema
|
|
700
|
+
* @default false
|
|
701
|
+
*/
|
|
702
|
+
generate_template: boolean;
|
|
703
|
+
/**
|
|
704
|
+
* Hierarchy
|
|
705
|
+
* @description Internal value to track the name of the Hierarchy, must match the name of a Generic supporting hierarchical mode
|
|
706
|
+
*/
|
|
707
|
+
hierarchy?: string | null;
|
|
708
|
+
/**
|
|
709
|
+
* Parent
|
|
710
|
+
* @description Expected Kind for the parent node in a Hierarchy, default to the main generic defined if not defined.
|
|
711
|
+
*/
|
|
712
|
+
parent?: string | null;
|
|
713
|
+
/**
|
|
714
|
+
* Children
|
|
715
|
+
* @description Expected Kind for the children nodes in a Hierarchy, default to the main generic defined if not defined.
|
|
716
|
+
*/
|
|
717
|
+
children?: string | null;
|
|
718
|
+
/** Kind */
|
|
719
|
+
kind?: string | null;
|
|
720
|
+
/** Hash */
|
|
721
|
+
hash: string;
|
|
722
|
+
};
|
|
723
|
+
/** APIProfileSchema */
|
|
724
|
+
APIProfileSchema: {
|
|
725
|
+
/**
|
|
726
|
+
* Id
|
|
727
|
+
* @description The ID of the node
|
|
728
|
+
*/
|
|
729
|
+
id?: string | null;
|
|
730
|
+
/**
|
|
731
|
+
* @description Expected state of the node/generic after loading the schema
|
|
732
|
+
* @default present
|
|
733
|
+
*/
|
|
734
|
+
state: components['schemas']['HashableModelState'];
|
|
735
|
+
/**
|
|
736
|
+
* Name
|
|
737
|
+
* @description Node name, must be unique within a namespace and must start with an uppercase letter.
|
|
738
|
+
*/
|
|
739
|
+
name: string;
|
|
740
|
+
/**
|
|
741
|
+
* Namespace
|
|
742
|
+
* @description Node Namespace, Namespaces are used to organize models into logical groups and to prevent name collisions.
|
|
743
|
+
*/
|
|
744
|
+
namespace: string;
|
|
745
|
+
/**
|
|
746
|
+
* Description
|
|
747
|
+
* @description Short description of the model, will be visible in the frontend.
|
|
748
|
+
*/
|
|
749
|
+
description?: string | null;
|
|
750
|
+
/**
|
|
751
|
+
* Label
|
|
752
|
+
* @description Human friendly representation of the name/kind
|
|
753
|
+
*/
|
|
754
|
+
label?: string | null;
|
|
755
|
+
/**
|
|
756
|
+
* @description Type of branch support for the model.
|
|
757
|
+
* @default aware
|
|
758
|
+
*/
|
|
759
|
+
branch: components['schemas']['BranchSupportType'];
|
|
760
|
+
/**
|
|
761
|
+
* Default Filter
|
|
762
|
+
* @description Default filter used to search for a node in addition to its ID. (deprecated: please use human_friendly_id instead)
|
|
763
|
+
*/
|
|
764
|
+
default_filter?: string | null;
|
|
765
|
+
/**
|
|
766
|
+
* Human Friendly Id
|
|
767
|
+
* @description Human friendly and unique identifier for the object.
|
|
768
|
+
*/
|
|
769
|
+
human_friendly_id?: string[] | null;
|
|
770
|
+
/**
|
|
771
|
+
* Display Labels
|
|
772
|
+
* @description List of attributes to use to generate the display label
|
|
773
|
+
*/
|
|
774
|
+
display_labels?: string[] | null;
|
|
775
|
+
/**
|
|
776
|
+
* Include In Menu
|
|
777
|
+
* @description Defines if objects of this kind should be included in the menu.
|
|
778
|
+
*/
|
|
779
|
+
include_in_menu?: boolean | null;
|
|
780
|
+
/**
|
|
781
|
+
* Menu Placement
|
|
782
|
+
* @description Defines where in the menu this object should be placed.
|
|
783
|
+
*/
|
|
784
|
+
menu_placement?: string | null;
|
|
785
|
+
/**
|
|
786
|
+
* Icon
|
|
787
|
+
* @description Defines the icon to use in the menu. Must be a valid value from the MDI library https://icon-sets.iconify.design/mdi/
|
|
788
|
+
*/
|
|
789
|
+
icon?: string | null;
|
|
790
|
+
/**
|
|
791
|
+
* Order By
|
|
792
|
+
* @description List of attributes to use to order the results by default
|
|
793
|
+
*/
|
|
794
|
+
order_by?: string[] | null;
|
|
795
|
+
/**
|
|
796
|
+
* Uniqueness Constraints
|
|
797
|
+
* @description List of multi-element uniqueness constraints that can combine relationships and attributes
|
|
798
|
+
*/
|
|
799
|
+
uniqueness_constraints?: string[][] | null;
|
|
800
|
+
/**
|
|
801
|
+
* Documentation
|
|
802
|
+
* @description Link to a documentation associated with this object, can be internal or external.
|
|
803
|
+
*/
|
|
804
|
+
documentation?: string | null;
|
|
805
|
+
/**
|
|
806
|
+
* Attributes
|
|
807
|
+
* @description Node attributes
|
|
808
|
+
*/
|
|
809
|
+
attributes?: components['schemas']['AttributeSchema-Output'][];
|
|
810
|
+
/**
|
|
811
|
+
* Relationships
|
|
812
|
+
* @description Node Relationships
|
|
813
|
+
*/
|
|
814
|
+
relationships?: components['schemas']['RelationshipSchema'][];
|
|
815
|
+
/**
|
|
816
|
+
* Inherit From
|
|
817
|
+
* @description List of Generic Kind that this profile is inheriting from
|
|
818
|
+
*/
|
|
819
|
+
inherit_from?: string[];
|
|
820
|
+
/** Kind */
|
|
821
|
+
kind?: string | null;
|
|
822
|
+
/** Hash */
|
|
823
|
+
hash: string;
|
|
824
|
+
};
|
|
825
|
+
/** APITemplateSchema */
|
|
826
|
+
APITemplateSchema: {
|
|
827
|
+
/**
|
|
828
|
+
* Id
|
|
829
|
+
* @description The ID of the node
|
|
830
|
+
*/
|
|
831
|
+
id?: string | null;
|
|
832
|
+
/**
|
|
833
|
+
* @description Expected state of the node/generic after loading the schema
|
|
834
|
+
* @default present
|
|
835
|
+
*/
|
|
836
|
+
state: components['schemas']['HashableModelState'];
|
|
837
|
+
/**
|
|
838
|
+
* Name
|
|
839
|
+
* @description Node name, must be unique within a namespace and must start with an uppercase letter.
|
|
840
|
+
*/
|
|
841
|
+
name: string;
|
|
842
|
+
/**
|
|
843
|
+
* Namespace
|
|
844
|
+
* @description Node Namespace, Namespaces are used to organize models into logical groups and to prevent name collisions.
|
|
845
|
+
*/
|
|
846
|
+
namespace: string;
|
|
847
|
+
/**
|
|
848
|
+
* Description
|
|
849
|
+
* @description Short description of the model, will be visible in the frontend.
|
|
850
|
+
*/
|
|
851
|
+
description?: string | null;
|
|
852
|
+
/**
|
|
853
|
+
* Label
|
|
854
|
+
* @description Human friendly representation of the name/kind
|
|
855
|
+
*/
|
|
856
|
+
label?: string | null;
|
|
857
|
+
/**
|
|
858
|
+
* @description Type of branch support for the model.
|
|
859
|
+
* @default aware
|
|
860
|
+
*/
|
|
861
|
+
branch: components['schemas']['BranchSupportType'];
|
|
862
|
+
/**
|
|
863
|
+
* Default Filter
|
|
864
|
+
* @description Default filter used to search for a node in addition to its ID. (deprecated: please use human_friendly_id instead)
|
|
865
|
+
*/
|
|
866
|
+
default_filter?: string | null;
|
|
867
|
+
/**
|
|
868
|
+
* Human Friendly Id
|
|
869
|
+
* @description Human friendly and unique identifier for the object.
|
|
870
|
+
*/
|
|
871
|
+
human_friendly_id?: string[] | null;
|
|
872
|
+
/**
|
|
873
|
+
* Display Labels
|
|
874
|
+
* @description List of attributes to use to generate the display label
|
|
875
|
+
*/
|
|
876
|
+
display_labels?: string[] | null;
|
|
877
|
+
/**
|
|
878
|
+
* Include In Menu
|
|
879
|
+
* @description Defines if objects of this kind should be included in the menu.
|
|
880
|
+
*/
|
|
881
|
+
include_in_menu?: boolean | null;
|
|
882
|
+
/**
|
|
883
|
+
* Menu Placement
|
|
884
|
+
* @description Defines where in the menu this object should be placed.
|
|
885
|
+
*/
|
|
886
|
+
menu_placement?: string | null;
|
|
887
|
+
/**
|
|
888
|
+
* Icon
|
|
889
|
+
* @description Defines the icon to use in the menu. Must be a valid value from the MDI library https://icon-sets.iconify.design/mdi/
|
|
890
|
+
*/
|
|
891
|
+
icon?: string | null;
|
|
892
|
+
/**
|
|
893
|
+
* Order By
|
|
894
|
+
* @description List of attributes to use to order the results by default
|
|
895
|
+
*/
|
|
896
|
+
order_by?: string[] | null;
|
|
897
|
+
/**
|
|
898
|
+
* Uniqueness Constraints
|
|
899
|
+
* @description List of multi-element uniqueness constraints that can combine relationships and attributes
|
|
900
|
+
*/
|
|
901
|
+
uniqueness_constraints?: string[][] | null;
|
|
902
|
+
/**
|
|
903
|
+
* Documentation
|
|
904
|
+
* @description Link to a documentation associated with this object, can be internal or external.
|
|
905
|
+
*/
|
|
906
|
+
documentation?: string | null;
|
|
907
|
+
/**
|
|
908
|
+
* Attributes
|
|
909
|
+
* @description Node attributes
|
|
910
|
+
*/
|
|
911
|
+
attributes?: components['schemas']['AttributeSchema-Output'][];
|
|
912
|
+
/**
|
|
913
|
+
* Relationships
|
|
914
|
+
* @description Node Relationships
|
|
915
|
+
*/
|
|
916
|
+
relationships?: components['schemas']['RelationshipSchema'][];
|
|
917
|
+
/**
|
|
918
|
+
* Inherit From
|
|
919
|
+
* @description List of Generic Kind that this template is inheriting from
|
|
920
|
+
*/
|
|
921
|
+
inherit_from?: string[];
|
|
922
|
+
/** Kind */
|
|
923
|
+
kind?: string | null;
|
|
924
|
+
/** Hash */
|
|
925
|
+
hash: string;
|
|
926
|
+
};
|
|
927
|
+
/** AccessTokenResponse */
|
|
928
|
+
AccessTokenResponse: {
|
|
929
|
+
/**
|
|
930
|
+
* Access Token
|
|
931
|
+
* @description JWT access_token
|
|
932
|
+
*/
|
|
933
|
+
access_token: string;
|
|
934
|
+
};
|
|
935
|
+
/**
|
|
936
|
+
* AllowOverrideType
|
|
937
|
+
* @enum {string}
|
|
938
|
+
*/
|
|
939
|
+
AllowOverrideType: 'none' | 'any';
|
|
940
|
+
/** AnalyticsSettings */
|
|
941
|
+
AnalyticsSettings: {
|
|
942
|
+
/**
|
|
943
|
+
* Enable
|
|
944
|
+
* @default true
|
|
945
|
+
*/
|
|
946
|
+
enable: boolean;
|
|
947
|
+
/** Address */
|
|
948
|
+
address?: string | null;
|
|
949
|
+
/** Api Key */
|
|
950
|
+
api_key?: string | null;
|
|
951
|
+
};
|
|
952
|
+
/** ArtifactGeneratePayload */
|
|
953
|
+
ArtifactGeneratePayload: {
|
|
954
|
+
/** Nodes */
|
|
955
|
+
nodes?: string[];
|
|
956
|
+
};
|
|
957
|
+
/** ArtifactTarget */
|
|
958
|
+
ArtifactTarget: {
|
|
959
|
+
/** Id */
|
|
960
|
+
id: string;
|
|
961
|
+
/** Kind */
|
|
962
|
+
kind: string;
|
|
963
|
+
/** Display Label */
|
|
964
|
+
display_label?: string | null;
|
|
965
|
+
};
|
|
966
|
+
/** AttributeParameters */
|
|
967
|
+
AttributeParameters: {
|
|
968
|
+
/** Id */
|
|
969
|
+
id?: string | null;
|
|
970
|
+
/** @default present */
|
|
971
|
+
state: components['schemas']['HashableModelState'];
|
|
972
|
+
};
|
|
973
|
+
/** AttributeSchema */
|
|
974
|
+
'AttributeSchema-Input': {
|
|
975
|
+
/**
|
|
976
|
+
* Id
|
|
977
|
+
* @description The ID of the attribute
|
|
978
|
+
*/
|
|
979
|
+
id?: string | null;
|
|
980
|
+
/**
|
|
981
|
+
* @description Expected state of the attribute after loading the schema
|
|
982
|
+
* @default present
|
|
983
|
+
*/
|
|
984
|
+
state: components['schemas']['HashableModelState'];
|
|
985
|
+
/**
|
|
986
|
+
* Name
|
|
987
|
+
* @description Attribute name, must be unique within a model and must be all lowercase.
|
|
988
|
+
*/
|
|
989
|
+
name: string;
|
|
990
|
+
/**
|
|
991
|
+
* Kind
|
|
992
|
+
* @description Defines the type of the attribute.
|
|
993
|
+
*/
|
|
994
|
+
kind: string;
|
|
995
|
+
/**
|
|
996
|
+
* Enum
|
|
997
|
+
* @description Define a list of valid values for the attribute.
|
|
998
|
+
*/
|
|
999
|
+
enum?: unknown[] | null;
|
|
1000
|
+
/** @description Defines how the value of this attribute will be populated. */
|
|
1001
|
+
computed_attribute?:
|
|
1002
|
+
| components['schemas']['ComputedAttribute-Input']
|
|
1003
|
+
| null;
|
|
1004
|
+
/**
|
|
1005
|
+
* Choices
|
|
1006
|
+
* @description Define a list of valid choices for a dropdown attribute.
|
|
1007
|
+
*/
|
|
1008
|
+
choices?: components['schemas']['DropdownChoice'][] | null;
|
|
1009
|
+
/**
|
|
1010
|
+
* Regex
|
|
1011
|
+
* @description Regex uses to limit the characters allowed in for the attributes. (deprecated: please use parameters.regex instead)
|
|
1012
|
+
*/
|
|
1013
|
+
regex?: string | null;
|
|
1014
|
+
/**
|
|
1015
|
+
* Max Length
|
|
1016
|
+
* @description Set a maximum number of characters allowed for a given attribute. (deprecated: please use parameters.max_length instead)
|
|
1017
|
+
*/
|
|
1018
|
+
max_length?: number | null;
|
|
1019
|
+
/**
|
|
1020
|
+
* Min Length
|
|
1021
|
+
* @description Set a minimum number of characters allowed for a given attribute. (deprecated: please use parameters.min_length instead)
|
|
1022
|
+
*/
|
|
1023
|
+
min_length?: number | null;
|
|
1024
|
+
/**
|
|
1025
|
+
* Label
|
|
1026
|
+
* @description Human friendly representation of the name. Will be autogenerated if not provided
|
|
1027
|
+
*/
|
|
1028
|
+
label?: string | null;
|
|
1029
|
+
/**
|
|
1030
|
+
* Description
|
|
1031
|
+
* @description Short description of the attribute.
|
|
1032
|
+
*/
|
|
1033
|
+
description?: string | null;
|
|
1034
|
+
/**
|
|
1035
|
+
* Read Only
|
|
1036
|
+
* @description Set the attribute as Read-Only, users won't be able to change its value. Mainly relevant for internal object.
|
|
1037
|
+
* @default false
|
|
1038
|
+
*/
|
|
1039
|
+
read_only: boolean;
|
|
1040
|
+
/**
|
|
1041
|
+
* Unique
|
|
1042
|
+
* @description Indicate if the value of this attribute must be unique in the database for a given model.
|
|
1043
|
+
* @default false
|
|
1044
|
+
*/
|
|
1045
|
+
unique: boolean;
|
|
1046
|
+
/**
|
|
1047
|
+
* Optional
|
|
1048
|
+
* @description Indicate if this attribute is mandatory or optional.
|
|
1049
|
+
* @default false
|
|
1050
|
+
*/
|
|
1051
|
+
optional: boolean;
|
|
1052
|
+
/** @description Type of branch support for the attribute, if not defined it will be inherited from the node. */
|
|
1053
|
+
branch?: components['schemas']['BranchSupportType'] | null;
|
|
1054
|
+
/**
|
|
1055
|
+
* Order Weight
|
|
1056
|
+
* @description Number used to order the attribute in the frontend (table and view). Lowest value will be ordered first.
|
|
1057
|
+
*/
|
|
1058
|
+
order_weight?: number | null;
|
|
1059
|
+
/**
|
|
1060
|
+
* Default Value
|
|
1061
|
+
* @description Default value of the attribute.
|
|
1062
|
+
*/
|
|
1063
|
+
default_value?: unknown | null;
|
|
1064
|
+
/**
|
|
1065
|
+
* Inherited
|
|
1066
|
+
* @description Internal value to indicate if the attribute was inherited from a Generic node.
|
|
1067
|
+
* @default false
|
|
1068
|
+
*/
|
|
1069
|
+
inherited: boolean;
|
|
1070
|
+
/**
|
|
1071
|
+
* @description Type of allowed override for the attribute.
|
|
1072
|
+
* @default any
|
|
1073
|
+
*/
|
|
1074
|
+
allow_override: components['schemas']['AllowOverrideType'];
|
|
1075
|
+
/**
|
|
1076
|
+
* Parameters
|
|
1077
|
+
* @description Extra parameters specific to this kind of attribute
|
|
1078
|
+
*/
|
|
1079
|
+
parameters?:
|
|
1080
|
+
| components['schemas']['AttributeParameters']
|
|
1081
|
+
| components['schemas']['TextAttributeParameters']
|
|
1082
|
+
| components['schemas']['NumberAttributeParameters']
|
|
1083
|
+
| components['schemas']['NumberPoolParameters'];
|
|
1084
|
+
/**
|
|
1085
|
+
* Deprecation
|
|
1086
|
+
* @description Mark attribute as deprecated and provide a user-friendly message to display
|
|
1087
|
+
*/
|
|
1088
|
+
deprecation?: string | null;
|
|
1089
|
+
};
|
|
1090
|
+
/** AttributeSchema */
|
|
1091
|
+
'AttributeSchema-Output': {
|
|
1092
|
+
/**
|
|
1093
|
+
* Id
|
|
1094
|
+
* @description The ID of the attribute
|
|
1095
|
+
*/
|
|
1096
|
+
id?: string | null;
|
|
1097
|
+
/**
|
|
1098
|
+
* @description Expected state of the attribute after loading the schema
|
|
1099
|
+
* @default present
|
|
1100
|
+
*/
|
|
1101
|
+
state: components['schemas']['HashableModelState'];
|
|
1102
|
+
/**
|
|
1103
|
+
* Name
|
|
1104
|
+
* @description Attribute name, must be unique within a model and must be all lowercase.
|
|
1105
|
+
*/
|
|
1106
|
+
name: string;
|
|
1107
|
+
/**
|
|
1108
|
+
* Kind
|
|
1109
|
+
* @description Defines the type of the attribute.
|
|
1110
|
+
*/
|
|
1111
|
+
kind: string;
|
|
1112
|
+
/**
|
|
1113
|
+
* Enum
|
|
1114
|
+
* @description Define a list of valid values for the attribute.
|
|
1115
|
+
*/
|
|
1116
|
+
enum?: unknown[] | null;
|
|
1117
|
+
/** @description Defines how the value of this attribute will be populated. */
|
|
1118
|
+
computed_attribute?:
|
|
1119
|
+
| components['schemas']['ComputedAttribute-Output']
|
|
1120
|
+
| null;
|
|
1121
|
+
/**
|
|
1122
|
+
* Choices
|
|
1123
|
+
* @description Define a list of valid choices for a dropdown attribute.
|
|
1124
|
+
*/
|
|
1125
|
+
choices?: components['schemas']['DropdownChoice'][] | null;
|
|
1126
|
+
/**
|
|
1127
|
+
* Regex
|
|
1128
|
+
* @description Regex uses to limit the characters allowed in for the attributes. (deprecated: please use parameters.regex instead)
|
|
1129
|
+
*/
|
|
1130
|
+
regex?: string | null;
|
|
1131
|
+
/**
|
|
1132
|
+
* Max Length
|
|
1133
|
+
* @description Set a maximum number of characters allowed for a given attribute. (deprecated: please use parameters.max_length instead)
|
|
1134
|
+
*/
|
|
1135
|
+
max_length?: number | null;
|
|
1136
|
+
/**
|
|
1137
|
+
* Min Length
|
|
1138
|
+
* @description Set a minimum number of characters allowed for a given attribute. (deprecated: please use parameters.min_length instead)
|
|
1139
|
+
*/
|
|
1140
|
+
min_length?: number | null;
|
|
1141
|
+
/**
|
|
1142
|
+
* Label
|
|
1143
|
+
* @description Human friendly representation of the name. Will be autogenerated if not provided
|
|
1144
|
+
*/
|
|
1145
|
+
label?: string | null;
|
|
1146
|
+
/**
|
|
1147
|
+
* Description
|
|
1148
|
+
* @description Short description of the attribute.
|
|
1149
|
+
*/
|
|
1150
|
+
description?: string | null;
|
|
1151
|
+
/**
|
|
1152
|
+
* Read Only
|
|
1153
|
+
* @description Set the attribute as Read-Only, users won't be able to change its value. Mainly relevant for internal object.
|
|
1154
|
+
* @default false
|
|
1155
|
+
*/
|
|
1156
|
+
read_only: boolean;
|
|
1157
|
+
/**
|
|
1158
|
+
* Unique
|
|
1159
|
+
* @description Indicate if the value of this attribute must be unique in the database for a given model.
|
|
1160
|
+
* @default false
|
|
1161
|
+
*/
|
|
1162
|
+
unique: boolean;
|
|
1163
|
+
/**
|
|
1164
|
+
* Optional
|
|
1165
|
+
* @description Indicate if this attribute is mandatory or optional.
|
|
1166
|
+
* @default false
|
|
1167
|
+
*/
|
|
1168
|
+
optional: boolean;
|
|
1169
|
+
/** @description Type of branch support for the attribute, if not defined it will be inherited from the node. */
|
|
1170
|
+
branch?: components['schemas']['BranchSupportType'] | null;
|
|
1171
|
+
/**
|
|
1172
|
+
* Order Weight
|
|
1173
|
+
* @description Number used to order the attribute in the frontend (table and view). Lowest value will be ordered first.
|
|
1174
|
+
*/
|
|
1175
|
+
order_weight?: number | null;
|
|
1176
|
+
/**
|
|
1177
|
+
* Default Value
|
|
1178
|
+
* @description Default value of the attribute.
|
|
1179
|
+
*/
|
|
1180
|
+
default_value?: unknown | null;
|
|
1181
|
+
/**
|
|
1182
|
+
* Inherited
|
|
1183
|
+
* @description Internal value to indicate if the attribute was inherited from a Generic node.
|
|
1184
|
+
* @default false
|
|
1185
|
+
*/
|
|
1186
|
+
inherited: boolean;
|
|
1187
|
+
/**
|
|
1188
|
+
* @description Type of allowed override for the attribute.
|
|
1189
|
+
* @default any
|
|
1190
|
+
*/
|
|
1191
|
+
allow_override: components['schemas']['AllowOverrideType'];
|
|
1192
|
+
/**
|
|
1193
|
+
* Parameters
|
|
1194
|
+
* @description Extra parameters specific to this kind of attribute
|
|
1195
|
+
*/
|
|
1196
|
+
parameters?:
|
|
1197
|
+
| components['schemas']['AttributeParameters']
|
|
1198
|
+
| components['schemas']['TextAttributeParameters']
|
|
1199
|
+
| components['schemas']['NumberAttributeParameters']
|
|
1200
|
+
| components['schemas']['NumberPoolParameters'];
|
|
1201
|
+
/**
|
|
1202
|
+
* Deprecation
|
|
1203
|
+
* @description Mark attribute as deprecated and provide a user-friendly message to display
|
|
1204
|
+
*/
|
|
1205
|
+
deprecation?: string | null;
|
|
1206
|
+
};
|
|
1207
|
+
/** Body_upload_file_api_storage_upload_file_post */
|
|
1208
|
+
Body_upload_file_api_storage_upload_file_post: {
|
|
1209
|
+
/**
|
|
1210
|
+
* File
|
|
1211
|
+
* Format: binary
|
|
1212
|
+
*/
|
|
1213
|
+
file: string;
|
|
1214
|
+
};
|
|
1215
|
+
/** BranchDiffArtifact */
|
|
1216
|
+
BranchDiffArtifact: {
|
|
1217
|
+
/** Branch */
|
|
1218
|
+
branch: string;
|
|
1219
|
+
/** Id */
|
|
1220
|
+
id: string;
|
|
1221
|
+
/** Display Label */
|
|
1222
|
+
display_label?: string | null;
|
|
1223
|
+
action: components['schemas']['DiffAction'];
|
|
1224
|
+
target?: components['schemas']['ArtifactTarget'] | null;
|
|
1225
|
+
item_new?: components['schemas']['BranchDiffArtifactStorage'] | null;
|
|
1226
|
+
item_previous?: components['schemas']['BranchDiffArtifactStorage'] | null;
|
|
1227
|
+
};
|
|
1228
|
+
/** BranchDiffArtifactStorage */
|
|
1229
|
+
BranchDiffArtifactStorage: {
|
|
1230
|
+
/** Storage Id */
|
|
1231
|
+
storage_id: string;
|
|
1232
|
+
/** Checksum */
|
|
1233
|
+
checksum: string;
|
|
1234
|
+
};
|
|
1235
|
+
/** BranchDiffFile */
|
|
1236
|
+
BranchDiffFile: {
|
|
1237
|
+
/** Branch */
|
|
1238
|
+
branch: string;
|
|
1239
|
+
/** Location */
|
|
1240
|
+
location: string;
|
|
1241
|
+
action: components['schemas']['DiffAction'];
|
|
1242
|
+
};
|
|
1243
|
+
/** BranchDiffRepository */
|
|
1244
|
+
BranchDiffRepository: {
|
|
1245
|
+
/** Branch */
|
|
1246
|
+
branch: string;
|
|
1247
|
+
/** Id */
|
|
1248
|
+
id: string;
|
|
1249
|
+
/** Display Name */
|
|
1250
|
+
display_name?: string | null;
|
|
1251
|
+
/** Commit From */
|
|
1252
|
+
commit_from: string;
|
|
1253
|
+
/** Commit To */
|
|
1254
|
+
commit_to: string;
|
|
1255
|
+
/** Files */
|
|
1256
|
+
files?: components['schemas']['BranchDiffFile'][];
|
|
1257
|
+
};
|
|
1258
|
+
/**
|
|
1259
|
+
* BranchSupportType
|
|
1260
|
+
* @enum {string}
|
|
1261
|
+
*/
|
|
1262
|
+
BranchSupportType: 'aware' | 'agnostic' | 'local';
|
|
1263
|
+
/** ComputedAttribute */
|
|
1264
|
+
'ComputedAttribute-Input': {
|
|
1265
|
+
/** Id */
|
|
1266
|
+
id?: string | null;
|
|
1267
|
+
/** @default present */
|
|
1268
|
+
state: components['schemas']['HashableModelState'];
|
|
1269
|
+
kind: components['schemas']['ComputedAttributeKind'];
|
|
1270
|
+
/**
|
|
1271
|
+
* Jinja2 Template
|
|
1272
|
+
* @description The Jinja2 template in string format, required when assignment_type=jinja2
|
|
1273
|
+
*/
|
|
1274
|
+
jinja2_template?: string | null;
|
|
1275
|
+
/**
|
|
1276
|
+
* Transform
|
|
1277
|
+
* @description The Python Transform name or ID, required when assignment_type=transform
|
|
1278
|
+
*/
|
|
1279
|
+
transform?: string | null;
|
|
1280
|
+
} & (unknown & unknown);
|
|
1281
|
+
'ComputedAttribute-Output': Record<string, never>;
|
|
1282
|
+
/**
|
|
1283
|
+
* ComputedAttributeKind
|
|
1284
|
+
* @enum {string}
|
|
1285
|
+
*/
|
|
1286
|
+
ComputedAttributeKind: 'User' | 'Jinja2' | 'TransformPython';
|
|
1287
|
+
/** ConfigAPI */
|
|
1288
|
+
ConfigAPI: {
|
|
1289
|
+
main: components['schemas']['MainSettings'];
|
|
1290
|
+
logging: components['schemas']['LoggingSettings'];
|
|
1291
|
+
analytics: components['schemas']['AnalyticsSettings'];
|
|
1292
|
+
experimental_features: components['schemas']['ExperimentalFeaturesSettings'];
|
|
1293
|
+
sso: components['schemas']['SSOInfo'];
|
|
1294
|
+
};
|
|
1295
|
+
/**
|
|
1296
|
+
* DiffAction
|
|
1297
|
+
* @enum {string}
|
|
1298
|
+
*/
|
|
1299
|
+
DiffAction: 'added' | 'removed' | 'updated' | 'unchanged';
|
|
1300
|
+
/** DropdownChoice */
|
|
1301
|
+
DropdownChoice: {
|
|
1302
|
+
/** Id */
|
|
1303
|
+
id?: string | null;
|
|
1304
|
+
/** @default present */
|
|
1305
|
+
state: components['schemas']['HashableModelState'];
|
|
1306
|
+
/** Name */
|
|
1307
|
+
name: string;
|
|
1308
|
+
/** Description */
|
|
1309
|
+
description?: string | null;
|
|
1310
|
+
/** Color */
|
|
1311
|
+
color?: string | null;
|
|
1312
|
+
/** Label */
|
|
1313
|
+
label?: string | null;
|
|
1314
|
+
};
|
|
1315
|
+
/** ExperimentalFeaturesSettings */
|
|
1316
|
+
ExperimentalFeaturesSettings: {
|
|
1317
|
+
/**
|
|
1318
|
+
* Graphql Enums
|
|
1319
|
+
* @default false
|
|
1320
|
+
*/
|
|
1321
|
+
graphql_enums: boolean;
|
|
1322
|
+
/**
|
|
1323
|
+
* Value Db Index
|
|
1324
|
+
* @default false
|
|
1325
|
+
*/
|
|
1326
|
+
value_db_index: boolean;
|
|
1327
|
+
};
|
|
1328
|
+
/**
|
|
1329
|
+
* GenericSchema
|
|
1330
|
+
* @description A Generic can be either an Interface or a Union depending if there are some Attributes or Relationships defined.
|
|
1331
|
+
*/
|
|
1332
|
+
GenericSchema: {
|
|
1333
|
+
/**
|
|
1334
|
+
* Id
|
|
1335
|
+
* @description The ID of the node
|
|
1336
|
+
*/
|
|
1337
|
+
id?: string | null;
|
|
1338
|
+
/**
|
|
1339
|
+
* @description Expected state of the node/generic after loading the schema
|
|
1340
|
+
* @default present
|
|
1341
|
+
*/
|
|
1342
|
+
state: components['schemas']['HashableModelState'];
|
|
1343
|
+
/**
|
|
1344
|
+
* Name
|
|
1345
|
+
* @description Node name, must be unique within a namespace and must start with an uppercase letter.
|
|
1346
|
+
*/
|
|
1347
|
+
name: string;
|
|
1348
|
+
/**
|
|
1349
|
+
* Namespace
|
|
1350
|
+
* @description Node Namespace, Namespaces are used to organize models into logical groups and to prevent name collisions.
|
|
1351
|
+
*/
|
|
1352
|
+
namespace: string;
|
|
1353
|
+
/**
|
|
1354
|
+
* Description
|
|
1355
|
+
* @description Short description of the model, will be visible in the frontend.
|
|
1356
|
+
*/
|
|
1357
|
+
description?: string | null;
|
|
1358
|
+
/**
|
|
1359
|
+
* Label
|
|
1360
|
+
* @description Human friendly representation of the name/kind
|
|
1361
|
+
*/
|
|
1362
|
+
label?: string | null;
|
|
1363
|
+
/**
|
|
1364
|
+
* @description Type of branch support for the model.
|
|
1365
|
+
* @default aware
|
|
1366
|
+
*/
|
|
1367
|
+
branch: components['schemas']['BranchSupportType'];
|
|
1368
|
+
/**
|
|
1369
|
+
* Default Filter
|
|
1370
|
+
* @description Default filter used to search for a node in addition to its ID. (deprecated: please use human_friendly_id instead)
|
|
1371
|
+
*/
|
|
1372
|
+
default_filter?: string | null;
|
|
1373
|
+
/**
|
|
1374
|
+
* Human Friendly Id
|
|
1375
|
+
* @description Human friendly and unique identifier for the object.
|
|
1376
|
+
*/
|
|
1377
|
+
human_friendly_id?: string[] | null;
|
|
1378
|
+
/**
|
|
1379
|
+
* Display Labels
|
|
1380
|
+
* @description List of attributes to use to generate the display label
|
|
1381
|
+
*/
|
|
1382
|
+
display_labels?: string[] | null;
|
|
1383
|
+
/**
|
|
1384
|
+
* Include In Menu
|
|
1385
|
+
* @description Defines if objects of this kind should be included in the menu.
|
|
1386
|
+
*/
|
|
1387
|
+
include_in_menu?: boolean | null;
|
|
1388
|
+
/**
|
|
1389
|
+
* Menu Placement
|
|
1390
|
+
* @description Defines where in the menu this object should be placed.
|
|
1391
|
+
*/
|
|
1392
|
+
menu_placement?: string | null;
|
|
1393
|
+
/**
|
|
1394
|
+
* Icon
|
|
1395
|
+
* @description Defines the icon to use in the menu. Must be a valid value from the MDI library https://icon-sets.iconify.design/mdi/
|
|
1396
|
+
*/
|
|
1397
|
+
icon?: string | null;
|
|
1398
|
+
/**
|
|
1399
|
+
* Order By
|
|
1400
|
+
* @description List of attributes to use to order the results by default
|
|
1401
|
+
*/
|
|
1402
|
+
order_by?: string[] | null;
|
|
1403
|
+
/**
|
|
1404
|
+
* Uniqueness Constraints
|
|
1405
|
+
* @description List of multi-element uniqueness constraints that can combine relationships and attributes
|
|
1406
|
+
*/
|
|
1407
|
+
uniqueness_constraints?: string[][] | null;
|
|
1408
|
+
/**
|
|
1409
|
+
* Documentation
|
|
1410
|
+
* @description Link to a documentation associated with this object, can be internal or external.
|
|
1411
|
+
*/
|
|
1412
|
+
documentation?: string | null;
|
|
1413
|
+
/**
|
|
1414
|
+
* Attributes
|
|
1415
|
+
* @description Node attributes
|
|
1416
|
+
*/
|
|
1417
|
+
attributes?: components['schemas']['AttributeSchema-Input'][];
|
|
1418
|
+
/**
|
|
1419
|
+
* Relationships
|
|
1420
|
+
* @description Node Relationships
|
|
1421
|
+
*/
|
|
1422
|
+
relationships?: components['schemas']['RelationshipSchema'][];
|
|
1423
|
+
/**
|
|
1424
|
+
* Hierarchical
|
|
1425
|
+
* @description Defines if the Generic support the hierarchical mode.
|
|
1426
|
+
* @default false
|
|
1427
|
+
*/
|
|
1428
|
+
hierarchical: boolean;
|
|
1429
|
+
/**
|
|
1430
|
+
* Generate Profile
|
|
1431
|
+
* @description Indicate if a profile schema should be generated for this schema
|
|
1432
|
+
* @default true
|
|
1433
|
+
*/
|
|
1434
|
+
generate_profile: boolean;
|
|
1435
|
+
/**
|
|
1436
|
+
* Generate Template
|
|
1437
|
+
* @description Indicate if an object template schema should be generated for this schema
|
|
1438
|
+
* @default false
|
|
1439
|
+
*/
|
|
1440
|
+
generate_template: boolean;
|
|
1441
|
+
/**
|
|
1442
|
+
* Used By
|
|
1443
|
+
* @description List of Nodes that are referencing this Generic
|
|
1444
|
+
*/
|
|
1445
|
+
used_by?: string[];
|
|
1446
|
+
};
|
|
1447
|
+
/** HTTPValidationError */
|
|
1448
|
+
HTTPValidationError: {
|
|
1449
|
+
/** Detail */
|
|
1450
|
+
detail?: components['schemas']['ValidationError'][];
|
|
1451
|
+
};
|
|
1452
|
+
/** HashableModelDiff */
|
|
1453
|
+
HashableModelDiff: {
|
|
1454
|
+
/** Added */
|
|
1455
|
+
added?: {
|
|
1456
|
+
[key: string]: components['schemas']['HashableModelDiff'] | null;
|
|
1457
|
+
};
|
|
1458
|
+
/** Changed */
|
|
1459
|
+
changed?: {
|
|
1460
|
+
[key: string]: components['schemas']['HashableModelDiff'] | null;
|
|
1461
|
+
};
|
|
1462
|
+
/** Removed */
|
|
1463
|
+
removed?: {
|
|
1464
|
+
[key: string]: components['schemas']['HashableModelDiff'] | null;
|
|
1465
|
+
};
|
|
1466
|
+
};
|
|
1467
|
+
/**
|
|
1468
|
+
* HashableModelState
|
|
1469
|
+
* @enum {string}
|
|
1470
|
+
*/
|
|
1471
|
+
HashableModelState: 'present' | 'absent';
|
|
1472
|
+
/** InfoAPI */
|
|
1473
|
+
InfoAPI: {
|
|
1474
|
+
/** Deployment Id */
|
|
1475
|
+
deployment_id: string;
|
|
1476
|
+
/** Version */
|
|
1477
|
+
version: string;
|
|
1478
|
+
};
|
|
1479
|
+
/** JSONSchema */
|
|
1480
|
+
JSONSchema: {
|
|
1481
|
+
/**
|
|
1482
|
+
* Title
|
|
1483
|
+
* @description Title of the schema
|
|
1484
|
+
*/
|
|
1485
|
+
title?: string | null;
|
|
1486
|
+
/**
|
|
1487
|
+
* Description
|
|
1488
|
+
* @description Description of the schema
|
|
1489
|
+
*/
|
|
1490
|
+
description?: string | null;
|
|
1491
|
+
/**
|
|
1492
|
+
* Type
|
|
1493
|
+
* @description Type of the schema element (e.g., 'object', 'array', 'string')
|
|
1494
|
+
*/
|
|
1495
|
+
type: string;
|
|
1496
|
+
/**
|
|
1497
|
+
* Properties
|
|
1498
|
+
* @description Properties of the object if type is 'object'
|
|
1499
|
+
*/
|
|
1500
|
+
properties?: Record<string, never> | null;
|
|
1501
|
+
/**
|
|
1502
|
+
* Items
|
|
1503
|
+
* @description Items of the array if type is 'array'
|
|
1504
|
+
*/
|
|
1505
|
+
items?: Record<string, never> | Record<string, never>[] | null;
|
|
1506
|
+
/**
|
|
1507
|
+
* Required
|
|
1508
|
+
* @description List of required properties if type is 'object'
|
|
1509
|
+
*/
|
|
1510
|
+
required?: string[] | null;
|
|
1511
|
+
/**
|
|
1512
|
+
* $Schema
|
|
1513
|
+
* @description Schema version identifier
|
|
1514
|
+
*/
|
|
1515
|
+
$schema?: string | null;
|
|
1516
|
+
/**
|
|
1517
|
+
* Additionalproperties
|
|
1518
|
+
* @description Specifies whether additional properties are allowed
|
|
1519
|
+
*/
|
|
1520
|
+
additionalProperties?: boolean | Record<string, never> | null;
|
|
1521
|
+
};
|
|
1522
|
+
/** LoggingSettings */
|
|
1523
|
+
LoggingSettings: {
|
|
1524
|
+
/** @default {
|
|
1525
|
+
* "enable": false
|
|
1526
|
+
* } */
|
|
1527
|
+
remote: components['schemas']['RemoteLoggingSettings'];
|
|
1528
|
+
};
|
|
1529
|
+
/** MainSettings */
|
|
1530
|
+
MainSettings: {
|
|
1531
|
+
/**
|
|
1532
|
+
* Docs Index Path
|
|
1533
|
+
* Format: path
|
|
1534
|
+
* @description Full path of saved json containing pre-indexed documentation
|
|
1535
|
+
* @default /opt/infrahub/docs/build/search-index.json
|
|
1536
|
+
*/
|
|
1537
|
+
docs_index_path: string;
|
|
1538
|
+
/** Internal Address */
|
|
1539
|
+
internal_address?: string | null;
|
|
1540
|
+
/**
|
|
1541
|
+
* Allow Anonymous Access
|
|
1542
|
+
* @description Indicates if the system allows anonymous read access
|
|
1543
|
+
* @default true
|
|
1544
|
+
*/
|
|
1545
|
+
allow_anonymous_access: boolean;
|
|
1546
|
+
/**
|
|
1547
|
+
* Anonymous Access Role
|
|
1548
|
+
* @description Name of the role defining which permissions anonymous users have
|
|
1549
|
+
* @default Anonymous User
|
|
1550
|
+
*/
|
|
1551
|
+
anonymous_access_role: string;
|
|
1552
|
+
/**
|
|
1553
|
+
* Telemetry Optout
|
|
1554
|
+
* @description Disable anonymous usage reporting
|
|
1555
|
+
* @default false
|
|
1556
|
+
*/
|
|
1557
|
+
telemetry_optout: boolean;
|
|
1558
|
+
/**
|
|
1559
|
+
* Telemetry Endpoint
|
|
1560
|
+
* @default https://telemetry.opsmill.cloud/infrahub
|
|
1561
|
+
*/
|
|
1562
|
+
telemetry_endpoint: string;
|
|
1563
|
+
/**
|
|
1564
|
+
* Permission Backends
|
|
1565
|
+
* @description List of modules to handle permissions, they will be run in the given order
|
|
1566
|
+
* @default [
|
|
1567
|
+
* "infrahub.permissions.LocalPermissionBackend"
|
|
1568
|
+
* ]
|
|
1569
|
+
*/
|
|
1570
|
+
permission_backends: string[];
|
|
1571
|
+
/**
|
|
1572
|
+
* Public Url
|
|
1573
|
+
* @description Define the public URL of the Infrahub, might be required for OAuth2 and OIDC depending on your infrastructure.
|
|
1574
|
+
*/
|
|
1575
|
+
public_url?: string | null;
|
|
1576
|
+
/**
|
|
1577
|
+
* Schema Strict Mode
|
|
1578
|
+
* @description Enable strict schema validation. When set to `False`, `human_friendly_id` schema fields should not necessarily target a unique combination of peer attributes.
|
|
1579
|
+
* @default true
|
|
1580
|
+
*/
|
|
1581
|
+
schema_strict_mode: boolean;
|
|
1582
|
+
};
|
|
1583
|
+
/** Menu */
|
|
1584
|
+
Menu: {
|
|
1585
|
+
/** Sections */
|
|
1586
|
+
sections?: {
|
|
1587
|
+
[key: string]: components['schemas']['MenuItemList'][];
|
|
1588
|
+
};
|
|
1589
|
+
};
|
|
1590
|
+
/** MenuItemList */
|
|
1591
|
+
MenuItemList: {
|
|
1592
|
+
/** Id */
|
|
1593
|
+
id?: string | null;
|
|
1594
|
+
/**
|
|
1595
|
+
* Namespace
|
|
1596
|
+
* @description Namespace of the menu item
|
|
1597
|
+
*/
|
|
1598
|
+
namespace: string;
|
|
1599
|
+
/**
|
|
1600
|
+
* Name
|
|
1601
|
+
* @description Name of the menu item
|
|
1602
|
+
*/
|
|
1603
|
+
name: string;
|
|
1604
|
+
/**
|
|
1605
|
+
* Description
|
|
1606
|
+
* @description Description of the menu item
|
|
1607
|
+
* @default
|
|
1608
|
+
*/
|
|
1609
|
+
description: string;
|
|
1610
|
+
/**
|
|
1611
|
+
* Protected
|
|
1612
|
+
* @description Whether the menu item is protected
|
|
1613
|
+
* @default false
|
|
1614
|
+
*/
|
|
1615
|
+
protected: boolean;
|
|
1616
|
+
/**
|
|
1617
|
+
* Label
|
|
1618
|
+
* @description Title of the menu item
|
|
1619
|
+
*/
|
|
1620
|
+
label: string;
|
|
1621
|
+
/**
|
|
1622
|
+
* Path
|
|
1623
|
+
* @description URL endpoint if applicable
|
|
1624
|
+
* @default
|
|
1625
|
+
*/
|
|
1626
|
+
path: string;
|
|
1627
|
+
/**
|
|
1628
|
+
* Icon
|
|
1629
|
+
* @description The icon to show for the current view
|
|
1630
|
+
* @default
|
|
1631
|
+
*/
|
|
1632
|
+
icon: string;
|
|
1633
|
+
/**
|
|
1634
|
+
* Kind
|
|
1635
|
+
* @description Kind of the model associated with this menuitem if applicable
|
|
1636
|
+
* @default
|
|
1637
|
+
*/
|
|
1638
|
+
kind: string;
|
|
1639
|
+
/**
|
|
1640
|
+
* Order Weight
|
|
1641
|
+
* @default 5000
|
|
1642
|
+
*/
|
|
1643
|
+
order_weight: number;
|
|
1644
|
+
/** @default object */
|
|
1645
|
+
section: components['schemas']['MenuSection'];
|
|
1646
|
+
/** Permissions */
|
|
1647
|
+
permissions?: string[];
|
|
1648
|
+
/**
|
|
1649
|
+
* Children
|
|
1650
|
+
* @description Child objects
|
|
1651
|
+
*/
|
|
1652
|
+
children?: components['schemas']['MenuItemList'][];
|
|
1653
|
+
/** Identifier */
|
|
1654
|
+
readonly identifier: string;
|
|
1655
|
+
};
|
|
1656
|
+
/**
|
|
1657
|
+
* MenuSection
|
|
1658
|
+
* @enum {string}
|
|
1659
|
+
*/
|
|
1660
|
+
MenuSection: 'object' | 'internal';
|
|
1661
|
+
/** NodeExtensionSchema */
|
|
1662
|
+
NodeExtensionSchema: {
|
|
1663
|
+
/** Id */
|
|
1664
|
+
id?: string | null;
|
|
1665
|
+
/** @default present */
|
|
1666
|
+
state: components['schemas']['HashableModelState'];
|
|
1667
|
+
/** Kind */
|
|
1668
|
+
kind: string;
|
|
1669
|
+
/** Attributes */
|
|
1670
|
+
attributes?: components['schemas']['AttributeSchema-Input'][];
|
|
1671
|
+
/** Relationships */
|
|
1672
|
+
relationships?: components['schemas']['RelationshipSchema'][];
|
|
1673
|
+
};
|
|
1674
|
+
/** NodeSchema */
|
|
1675
|
+
NodeSchema: {
|
|
1676
|
+
/**
|
|
1677
|
+
* Id
|
|
1678
|
+
* @description The ID of the node
|
|
1679
|
+
*/
|
|
1680
|
+
id?: string | null;
|
|
1681
|
+
/**
|
|
1682
|
+
* @description Expected state of the node/generic after loading the schema
|
|
1683
|
+
* @default present
|
|
1684
|
+
*/
|
|
1685
|
+
state: components['schemas']['HashableModelState'];
|
|
1686
|
+
/**
|
|
1687
|
+
* Name
|
|
1688
|
+
* @description Node name, must be unique within a namespace and must start with an uppercase letter.
|
|
1689
|
+
*/
|
|
1690
|
+
name: string;
|
|
1691
|
+
/**
|
|
1692
|
+
* Namespace
|
|
1693
|
+
* @description Node Namespace, Namespaces are used to organize models into logical groups and to prevent name collisions.
|
|
1694
|
+
*/
|
|
1695
|
+
namespace: string;
|
|
1696
|
+
/**
|
|
1697
|
+
* Description
|
|
1698
|
+
* @description Short description of the model, will be visible in the frontend.
|
|
1699
|
+
*/
|
|
1700
|
+
description?: string | null;
|
|
1701
|
+
/**
|
|
1702
|
+
* Label
|
|
1703
|
+
* @description Human friendly representation of the name/kind
|
|
1704
|
+
*/
|
|
1705
|
+
label?: string | null;
|
|
1706
|
+
/**
|
|
1707
|
+
* @description Type of branch support for the model.
|
|
1708
|
+
* @default aware
|
|
1709
|
+
*/
|
|
1710
|
+
branch: components['schemas']['BranchSupportType'];
|
|
1711
|
+
/**
|
|
1712
|
+
* Default Filter
|
|
1713
|
+
* @description Default filter used to search for a node in addition to its ID. (deprecated: please use human_friendly_id instead)
|
|
1714
|
+
*/
|
|
1715
|
+
default_filter?: string | null;
|
|
1716
|
+
/**
|
|
1717
|
+
* Human Friendly Id
|
|
1718
|
+
* @description Human friendly and unique identifier for the object.
|
|
1719
|
+
*/
|
|
1720
|
+
human_friendly_id?: string[] | null;
|
|
1721
|
+
/**
|
|
1722
|
+
* Display Labels
|
|
1723
|
+
* @description List of attributes to use to generate the display label
|
|
1724
|
+
*/
|
|
1725
|
+
display_labels?: string[] | null;
|
|
1726
|
+
/**
|
|
1727
|
+
* Include In Menu
|
|
1728
|
+
* @description Defines if objects of this kind should be included in the menu.
|
|
1729
|
+
*/
|
|
1730
|
+
include_in_menu?: boolean | null;
|
|
1731
|
+
/**
|
|
1732
|
+
* Menu Placement
|
|
1733
|
+
* @description Defines where in the menu this object should be placed.
|
|
1734
|
+
*/
|
|
1735
|
+
menu_placement?: string | null;
|
|
1736
|
+
/**
|
|
1737
|
+
* Icon
|
|
1738
|
+
* @description Defines the icon to use in the menu. Must be a valid value from the MDI library https://icon-sets.iconify.design/mdi/
|
|
1739
|
+
*/
|
|
1740
|
+
icon?: string | null;
|
|
1741
|
+
/**
|
|
1742
|
+
* Order By
|
|
1743
|
+
* @description List of attributes to use to order the results by default
|
|
1744
|
+
*/
|
|
1745
|
+
order_by?: string[] | null;
|
|
1746
|
+
/**
|
|
1747
|
+
* Uniqueness Constraints
|
|
1748
|
+
* @description List of multi-element uniqueness constraints that can combine relationships and attributes
|
|
1749
|
+
*/
|
|
1750
|
+
uniqueness_constraints?: string[][] | null;
|
|
1751
|
+
/**
|
|
1752
|
+
* Documentation
|
|
1753
|
+
* @description Link to a documentation associated with this object, can be internal or external.
|
|
1754
|
+
*/
|
|
1755
|
+
documentation?: string | null;
|
|
1756
|
+
/**
|
|
1757
|
+
* Attributes
|
|
1758
|
+
* @description Node attributes
|
|
1759
|
+
*/
|
|
1760
|
+
attributes?: components['schemas']['AttributeSchema-Input'][];
|
|
1761
|
+
/**
|
|
1762
|
+
* Relationships
|
|
1763
|
+
* @description Node Relationships
|
|
1764
|
+
*/
|
|
1765
|
+
relationships?: components['schemas']['RelationshipSchema'][];
|
|
1766
|
+
/**
|
|
1767
|
+
* Inherit From
|
|
1768
|
+
* @description List of Generic Kind that this node is inheriting from
|
|
1769
|
+
*/
|
|
1770
|
+
inherit_from?: string[];
|
|
1771
|
+
/**
|
|
1772
|
+
* Generate Profile
|
|
1773
|
+
* @description Indicate if a profile schema should be generated for this schema
|
|
1774
|
+
* @default true
|
|
1775
|
+
*/
|
|
1776
|
+
generate_profile: boolean;
|
|
1777
|
+
/**
|
|
1778
|
+
* Generate Template
|
|
1779
|
+
* @description Indicate if an object template schema should be generated for this schema
|
|
1780
|
+
* @default false
|
|
1781
|
+
*/
|
|
1782
|
+
generate_template: boolean;
|
|
1783
|
+
/**
|
|
1784
|
+
* Hierarchy
|
|
1785
|
+
* @description Internal value to track the name of the Hierarchy, must match the name of a Generic supporting hierarchical mode
|
|
1786
|
+
*/
|
|
1787
|
+
hierarchy?: string | null;
|
|
1788
|
+
/**
|
|
1789
|
+
* Parent
|
|
1790
|
+
* @description Expected Kind for the parent node in a Hierarchy, default to the main generic defined if not defined.
|
|
1791
|
+
*/
|
|
1792
|
+
parent?: string | null;
|
|
1793
|
+
/**
|
|
1794
|
+
* Children
|
|
1795
|
+
* @description Expected Kind for the children nodes in a Hierarchy, default to the main generic defined if not defined.
|
|
1796
|
+
*/
|
|
1797
|
+
children?: string | null;
|
|
1798
|
+
};
|
|
1799
|
+
/** NumberAttributeParameters */
|
|
1800
|
+
NumberAttributeParameters: {
|
|
1801
|
+
/** Id */
|
|
1802
|
+
id?: string | null;
|
|
1803
|
+
/** @default present */
|
|
1804
|
+
state: components['schemas']['HashableModelState'];
|
|
1805
|
+
/**
|
|
1806
|
+
* Min Value
|
|
1807
|
+
* @description Set a minimum value allowed.
|
|
1808
|
+
*/
|
|
1809
|
+
min_value?: number | null;
|
|
1810
|
+
/**
|
|
1811
|
+
* Max Value
|
|
1812
|
+
* @description Set a maximum value allowed.
|
|
1813
|
+
*/
|
|
1814
|
+
max_value?: number | null;
|
|
1815
|
+
/**
|
|
1816
|
+
* Excluded Values
|
|
1817
|
+
* @description List of values or range of values not allowed for the attribute, format is: '100,150-200,280,300-400'
|
|
1818
|
+
*/
|
|
1819
|
+
excluded_values?: string | null;
|
|
1820
|
+
};
|
|
1821
|
+
/** NumberPoolParameters */
|
|
1822
|
+
NumberPoolParameters: {
|
|
1823
|
+
/** Id */
|
|
1824
|
+
id?: string | null;
|
|
1825
|
+
/** @default present */
|
|
1826
|
+
state: components['schemas']['HashableModelState'];
|
|
1827
|
+
/**
|
|
1828
|
+
* End Range
|
|
1829
|
+
* @description End range for numbers for the associated NumberPool
|
|
1830
|
+
* @default 9223372036854776000
|
|
1831
|
+
*/
|
|
1832
|
+
end_range: number;
|
|
1833
|
+
/**
|
|
1834
|
+
* Start Range
|
|
1835
|
+
* @description Start range for numbers for the associated NumberPool
|
|
1836
|
+
* @default 1
|
|
1837
|
+
*/
|
|
1838
|
+
start_range: number;
|
|
1839
|
+
/**
|
|
1840
|
+
* Number Pool Id
|
|
1841
|
+
* @description The ID of the numberpool associated with this attribute
|
|
1842
|
+
*/
|
|
1843
|
+
number_pool_id?: string | null;
|
|
1844
|
+
};
|
|
1845
|
+
/** PasswordCredential */
|
|
1846
|
+
PasswordCredential: {
|
|
1847
|
+
/**
|
|
1848
|
+
* Username
|
|
1849
|
+
* @description Name of the user that is logging in.
|
|
1850
|
+
*/
|
|
1851
|
+
username: string;
|
|
1852
|
+
/**
|
|
1853
|
+
* Password
|
|
1854
|
+
* @description The password of the user.
|
|
1855
|
+
*/
|
|
1856
|
+
password: string;
|
|
1857
|
+
};
|
|
1858
|
+
/** QueryPayload */
|
|
1859
|
+
QueryPayload: {
|
|
1860
|
+
/** Variables */
|
|
1861
|
+
variables?: {
|
|
1862
|
+
[key: string]: string;
|
|
1863
|
+
};
|
|
1864
|
+
};
|
|
1865
|
+
/**
|
|
1866
|
+
* RelationshipCardinality
|
|
1867
|
+
* @enum {string}
|
|
1868
|
+
*/
|
|
1869
|
+
RelationshipCardinality: 'one' | 'many';
|
|
1870
|
+
/**
|
|
1871
|
+
* RelationshipDeleteBehavior
|
|
1872
|
+
* @enum {string}
|
|
1873
|
+
*/
|
|
1874
|
+
RelationshipDeleteBehavior: 'no-action' | 'cascade';
|
|
1875
|
+
/**
|
|
1876
|
+
* RelationshipDirection
|
|
1877
|
+
* @enum {string}
|
|
1878
|
+
*/
|
|
1879
|
+
RelationshipDirection: 'bidirectional' | 'outbound' | 'inbound';
|
|
1880
|
+
/**
|
|
1881
|
+
* RelationshipKind
|
|
1882
|
+
* @enum {string}
|
|
1883
|
+
*/
|
|
1884
|
+
RelationshipKind:
|
|
1885
|
+
| 'Generic'
|
|
1886
|
+
| 'Attribute'
|
|
1887
|
+
| 'Component'
|
|
1888
|
+
| 'Parent'
|
|
1889
|
+
| 'Group'
|
|
1890
|
+
| 'Hierarchy'
|
|
1891
|
+
| 'Profile'
|
|
1892
|
+
| 'Template';
|
|
1893
|
+
/** RelationshipSchema */
|
|
1894
|
+
RelationshipSchema: {
|
|
1895
|
+
/**
|
|
1896
|
+
* Id
|
|
1897
|
+
* @description The ID of the relationship schema
|
|
1898
|
+
*/
|
|
1899
|
+
id?: string | null;
|
|
1900
|
+
/**
|
|
1901
|
+
* @description Expected state of the relationship after loading the schema
|
|
1902
|
+
* @default present
|
|
1903
|
+
*/
|
|
1904
|
+
state: components['schemas']['HashableModelState'];
|
|
1905
|
+
/**
|
|
1906
|
+
* Name
|
|
1907
|
+
* @description Relationship name, must be unique within a model and must be all lowercase.
|
|
1908
|
+
*/
|
|
1909
|
+
name: string;
|
|
1910
|
+
/**
|
|
1911
|
+
* Peer
|
|
1912
|
+
* @description Type (kind) of objects supported on the other end of the relationship.
|
|
1913
|
+
*/
|
|
1914
|
+
peer: string;
|
|
1915
|
+
/**
|
|
1916
|
+
* @description Defines the type of the relationship.
|
|
1917
|
+
* @default Generic
|
|
1918
|
+
*/
|
|
1919
|
+
kind: components['schemas']['RelationshipKind'];
|
|
1920
|
+
/**
|
|
1921
|
+
* Label
|
|
1922
|
+
* @description Human friendly representation of the name. Will be autogenerated if not provided
|
|
1923
|
+
*/
|
|
1924
|
+
label?: string | null;
|
|
1925
|
+
/**
|
|
1926
|
+
* Description
|
|
1927
|
+
* @description Short description of the relationship.
|
|
1928
|
+
*/
|
|
1929
|
+
description?: string | null;
|
|
1930
|
+
/**
|
|
1931
|
+
* Identifier
|
|
1932
|
+
* @description Unique identifier of the relationship within a model, identifiers must match to traverse a relationship on both direction.
|
|
1933
|
+
*/
|
|
1934
|
+
identifier?: string | null;
|
|
1935
|
+
/**
|
|
1936
|
+
* @description Defines how many objects are expected on the other side of the relationship.
|
|
1937
|
+
* @default many
|
|
1938
|
+
*/
|
|
1939
|
+
cardinality: components['schemas']['RelationshipCardinality'];
|
|
1940
|
+
/**
|
|
1941
|
+
* Min Count
|
|
1942
|
+
* @description Defines the minimum objects allowed on the other side of the relationship.
|
|
1943
|
+
* @default 0
|
|
1944
|
+
*/
|
|
1945
|
+
min_count: number;
|
|
1946
|
+
/**
|
|
1947
|
+
* Max Count
|
|
1948
|
+
* @description Defines the maximum objects allowed on the other side of the relationship.
|
|
1949
|
+
* @default 0
|
|
1950
|
+
*/
|
|
1951
|
+
max_count: number;
|
|
1952
|
+
/**
|
|
1953
|
+
* Common Parent
|
|
1954
|
+
* @description Name of a parent relationship on the peer schema that must share the same related object with the object's parent.
|
|
1955
|
+
*/
|
|
1956
|
+
common_parent?: string | null;
|
|
1957
|
+
/**
|
|
1958
|
+
* Common Relatives
|
|
1959
|
+
* @description List of relationship names on the peer schema for which all objects must share the same set of peers.
|
|
1960
|
+
*/
|
|
1961
|
+
common_relatives?: string[] | null;
|
|
1962
|
+
/**
|
|
1963
|
+
* Order Weight
|
|
1964
|
+
* @description Number used to order the relationship in the frontend (table and view). Lowest value will be ordered first.
|
|
1965
|
+
*/
|
|
1966
|
+
order_weight?: number | null;
|
|
1967
|
+
/**
|
|
1968
|
+
* Optional
|
|
1969
|
+
* @description Indicate if this relationship is mandatory or optional.
|
|
1970
|
+
* @default true
|
|
1971
|
+
*/
|
|
1972
|
+
optional: boolean;
|
|
1973
|
+
/** @description Type of branch support for the relatioinship, if not defined it will be determine based both peers. */
|
|
1974
|
+
branch?: components['schemas']['BranchSupportType'] | null;
|
|
1975
|
+
/**
|
|
1976
|
+
* Inherited
|
|
1977
|
+
* @description Internal value to indicate if the relationship was inherited from a Generic node.
|
|
1978
|
+
* @default false
|
|
1979
|
+
*/
|
|
1980
|
+
inherited: boolean;
|
|
1981
|
+
/**
|
|
1982
|
+
* @description Defines the direction of the relationship, Unidirectional relationship are required when the same model is on both side.
|
|
1983
|
+
* @default bidirectional
|
|
1984
|
+
*/
|
|
1985
|
+
direction: components['schemas']['RelationshipDirection'];
|
|
1986
|
+
/**
|
|
1987
|
+
* Hierarchical
|
|
1988
|
+
* @description Internal attribute to track the type of hierarchy this relationship is part of, must match a valid Generic Kind
|
|
1989
|
+
*/
|
|
1990
|
+
hierarchical?: string | null;
|
|
1991
|
+
/** @description Default is no-action. If cascade, related node(s) are deleted when this node is deleted. */
|
|
1992
|
+
on_delete?: components['schemas']['RelationshipDeleteBehavior'] | null;
|
|
1993
|
+
/**
|
|
1994
|
+
* @description Type of allowed override for the relationship.
|
|
1995
|
+
* @default any
|
|
1996
|
+
*/
|
|
1997
|
+
allow_override: components['schemas']['AllowOverrideType'];
|
|
1998
|
+
/**
|
|
1999
|
+
* Read Only
|
|
2000
|
+
* @description Set the relationship as read-only, users won't be able to change its value.
|
|
2001
|
+
* @default false
|
|
2002
|
+
*/
|
|
2003
|
+
read_only: boolean;
|
|
2004
|
+
/**
|
|
2005
|
+
* Deprecation
|
|
2006
|
+
* @description Mark relationship as deprecated and provide a user-friendly message to display
|
|
2007
|
+
*/
|
|
2008
|
+
deprecation?: string | null;
|
|
2009
|
+
};
|
|
2010
|
+
/** RemoteLoggingSettings */
|
|
2011
|
+
RemoteLoggingSettings: {
|
|
2012
|
+
/**
|
|
2013
|
+
* Enable
|
|
2014
|
+
* @default false
|
|
2015
|
+
*/
|
|
2016
|
+
enable: boolean;
|
|
2017
|
+
/** Frontend Dsn */
|
|
2018
|
+
frontend_dsn?: string | null;
|
|
2019
|
+
/** Api Server Dsn */
|
|
2020
|
+
api_server_dsn?: string | null;
|
|
2021
|
+
/** Git Agent Dsn */
|
|
2022
|
+
git_agent_dsn?: string | null;
|
|
2023
|
+
};
|
|
2024
|
+
/** SSOInfo */
|
|
2025
|
+
SSOInfo: {
|
|
2026
|
+
/** Providers */
|
|
2027
|
+
providers?: components['schemas']['SSOProviderInfo'][];
|
|
2028
|
+
/** Enabled */
|
|
2029
|
+
readonly enabled: boolean;
|
|
2030
|
+
};
|
|
2031
|
+
/**
|
|
2032
|
+
* SSOProtocol
|
|
2033
|
+
* @enum {string}
|
|
2034
|
+
*/
|
|
2035
|
+
SSOProtocol: 'oauth2' | 'oidc';
|
|
2036
|
+
/** SSOProviderInfo */
|
|
2037
|
+
SSOProviderInfo: {
|
|
2038
|
+
/** Name */
|
|
2039
|
+
name: string;
|
|
2040
|
+
/** Display Label */
|
|
2041
|
+
display_label: string;
|
|
2042
|
+
/** Icon */
|
|
2043
|
+
icon: string;
|
|
2044
|
+
protocol: components['schemas']['SSOProtocol'];
|
|
2045
|
+
/** Authorize Path */
|
|
2046
|
+
readonly authorize_path: string;
|
|
2047
|
+
/** Token Path */
|
|
2048
|
+
readonly token_path: string;
|
|
2049
|
+
};
|
|
2050
|
+
/** SchemaBranchHash */
|
|
2051
|
+
SchemaBranchHash: {
|
|
2052
|
+
/** Main */
|
|
2053
|
+
main: string;
|
|
2054
|
+
/** Nodes */
|
|
2055
|
+
nodes?: {
|
|
2056
|
+
[key: string]: string;
|
|
2057
|
+
};
|
|
2058
|
+
/** Generics */
|
|
2059
|
+
generics?: {
|
|
2060
|
+
[key: string]: string;
|
|
2061
|
+
};
|
|
2062
|
+
};
|
|
2063
|
+
/** SchemaDiff */
|
|
2064
|
+
SchemaDiff: {
|
|
2065
|
+
/** Added */
|
|
2066
|
+
added?: {
|
|
2067
|
+
[key: string]: components['schemas']['HashableModelDiff'];
|
|
2068
|
+
};
|
|
2069
|
+
/** Changed */
|
|
2070
|
+
changed?: {
|
|
2071
|
+
[key: string]: components['schemas']['HashableModelDiff'];
|
|
2072
|
+
};
|
|
2073
|
+
/** Removed */
|
|
2074
|
+
removed?: {
|
|
2075
|
+
[key: string]: components['schemas']['HashableModelDiff'];
|
|
2076
|
+
};
|
|
2077
|
+
};
|
|
2078
|
+
/** SchemaExtension */
|
|
2079
|
+
SchemaExtension: {
|
|
2080
|
+
/** Id */
|
|
2081
|
+
id?: string | null;
|
|
2082
|
+
/** @default present */
|
|
2083
|
+
state: components['schemas']['HashableModelState'];
|
|
2084
|
+
/** Nodes */
|
|
2085
|
+
nodes?: components['schemas']['NodeExtensionSchema'][];
|
|
2086
|
+
};
|
|
2087
|
+
/** SchemaLoadAPI */
|
|
2088
|
+
SchemaLoadAPI: {
|
|
2089
|
+
/** Version */
|
|
2090
|
+
version: string;
|
|
2091
|
+
/** Generics */
|
|
2092
|
+
generics?: components['schemas']['GenericSchema'][];
|
|
2093
|
+
/** Nodes */
|
|
2094
|
+
nodes?: components['schemas']['NodeSchema'][];
|
|
2095
|
+
/** @default {
|
|
2096
|
+
* "state": "present",
|
|
2097
|
+
* "nodes": []
|
|
2098
|
+
* } */
|
|
2099
|
+
extensions: components['schemas']['SchemaExtension'];
|
|
2100
|
+
};
|
|
2101
|
+
/** SchemaNamespace */
|
|
2102
|
+
SchemaNamespace: {
|
|
2103
|
+
/** Name */
|
|
2104
|
+
name: string;
|
|
2105
|
+
/** User Editable */
|
|
2106
|
+
user_editable: boolean;
|
|
2107
|
+
};
|
|
2108
|
+
/** SchemaReadAPI */
|
|
2109
|
+
SchemaReadAPI: {
|
|
2110
|
+
/**
|
|
2111
|
+
* Main
|
|
2112
|
+
* @description Main hash for the entire schema
|
|
2113
|
+
*/
|
|
2114
|
+
main: string;
|
|
2115
|
+
/** Nodes */
|
|
2116
|
+
nodes?: components['schemas']['APINodeSchema'][];
|
|
2117
|
+
/** Generics */
|
|
2118
|
+
generics?: components['schemas']['APIGenericSchema'][];
|
|
2119
|
+
/** Profiles */
|
|
2120
|
+
profiles?: components['schemas']['APIProfileSchema'][];
|
|
2121
|
+
/** Templates */
|
|
2122
|
+
templates?: components['schemas']['APITemplateSchema'][];
|
|
2123
|
+
/** Namespaces */
|
|
2124
|
+
namespaces?: components['schemas']['SchemaNamespace'][];
|
|
2125
|
+
};
|
|
2126
|
+
/** SchemaUpdate */
|
|
2127
|
+
SchemaUpdate: {
|
|
2128
|
+
/**
|
|
2129
|
+
* Hash
|
|
2130
|
+
* @description The new hash for the entire schema
|
|
2131
|
+
*/
|
|
2132
|
+
hash: string;
|
|
2133
|
+
/**
|
|
2134
|
+
* Previous Hash
|
|
2135
|
+
* @description The previous hash for the entire schema
|
|
2136
|
+
*/
|
|
2137
|
+
previous_hash: string;
|
|
2138
|
+
/** @description The modifications to the schema */
|
|
2139
|
+
diff: components['schemas']['SchemaDiff'];
|
|
2140
|
+
/**
|
|
2141
|
+
* Schema Updated
|
|
2142
|
+
* @description Indicates if the loading of the schema changed the existing schema
|
|
2143
|
+
*/
|
|
2144
|
+
readonly schema_updated: boolean;
|
|
2145
|
+
};
|
|
2146
|
+
/** SchemasLoadAPI */
|
|
2147
|
+
SchemasLoadAPI: {
|
|
2148
|
+
/** Schemas */
|
|
2149
|
+
schemas: components['schemas']['SchemaLoadAPI'][];
|
|
2150
|
+
};
|
|
2151
|
+
/** TextAttributeParameters */
|
|
2152
|
+
TextAttributeParameters: {
|
|
2153
|
+
/** Id */
|
|
2154
|
+
id?: string | null;
|
|
2155
|
+
/** @default present */
|
|
2156
|
+
state: components['schemas']['HashableModelState'];
|
|
2157
|
+
/**
|
|
2158
|
+
* Regex
|
|
2159
|
+
* @description Regular expression that attribute value must match if defined
|
|
2160
|
+
*/
|
|
2161
|
+
regex?: string | null;
|
|
2162
|
+
/**
|
|
2163
|
+
* Min Length
|
|
2164
|
+
* @description Set a minimum number of characters allowed.
|
|
2165
|
+
*/
|
|
2166
|
+
min_length?: number | null;
|
|
2167
|
+
/**
|
|
2168
|
+
* Max Length
|
|
2169
|
+
* @description Set a maximum number of characters allowed.
|
|
2170
|
+
*/
|
|
2171
|
+
max_length?: number | null;
|
|
2172
|
+
};
|
|
2173
|
+
/** UploadContentPayload */
|
|
2174
|
+
UploadContentPayload: {
|
|
2175
|
+
/** Content */
|
|
2176
|
+
content: string;
|
|
2177
|
+
};
|
|
2178
|
+
/** UploadResponse */
|
|
2179
|
+
UploadResponse: {
|
|
2180
|
+
/** Identifier */
|
|
2181
|
+
identifier: string;
|
|
2182
|
+
/** Checksum */
|
|
2183
|
+
checksum: string;
|
|
2184
|
+
};
|
|
2185
|
+
/** UserToken */
|
|
2186
|
+
UserToken: {
|
|
2187
|
+
/**
|
|
2188
|
+
* Access Token
|
|
2189
|
+
* @description JWT access_token
|
|
2190
|
+
*/
|
|
2191
|
+
access_token: string;
|
|
2192
|
+
/**
|
|
2193
|
+
* Refresh Token
|
|
2194
|
+
* @description JWT refresh_token
|
|
2195
|
+
*/
|
|
2196
|
+
refresh_token: string;
|
|
2197
|
+
};
|
|
2198
|
+
/** UserTokenWithUrl */
|
|
2199
|
+
UserTokenWithUrl: {
|
|
2200
|
+
/**
|
|
2201
|
+
* Access Token
|
|
2202
|
+
* @description JWT access_token
|
|
2203
|
+
*/
|
|
2204
|
+
access_token: string;
|
|
2205
|
+
/**
|
|
2206
|
+
* Refresh Token
|
|
2207
|
+
* @description JWT refresh_token
|
|
2208
|
+
*/
|
|
2209
|
+
refresh_token: string;
|
|
2210
|
+
/**
|
|
2211
|
+
* Final Url
|
|
2212
|
+
* @description The final url after logged in
|
|
2213
|
+
*/
|
|
2214
|
+
final_url: string;
|
|
2215
|
+
};
|
|
2216
|
+
/** ValidationError */
|
|
2217
|
+
ValidationError: {
|
|
2218
|
+
/** Location */
|
|
2219
|
+
loc: (string | number)[];
|
|
2220
|
+
/** Message */
|
|
2221
|
+
msg: string;
|
|
2222
|
+
/** Error Type */
|
|
2223
|
+
type: string;
|
|
2224
|
+
};
|
|
2225
|
+
};
|
|
2226
|
+
responses: never;
|
|
2227
|
+
parameters: never;
|
|
2228
|
+
requestBodies: never;
|
|
2229
|
+
headers: never;
|
|
2230
|
+
pathItems: never;
|
|
2231
|
+
}
|
|
2232
|
+
export type $defs = Record<string, never>;
|
|
2233
|
+
export interface operations {
|
|
2234
|
+
get_artifact_api_artifact__artifact_id__get: {
|
|
2235
|
+
parameters: {
|
|
2236
|
+
query?: {
|
|
2237
|
+
/** @description Name of the branch to use for the query */
|
|
2238
|
+
branch?: string | null;
|
|
2239
|
+
/** @description Time to use for the query, in absolute or relative format */
|
|
2240
|
+
at?: string | null;
|
|
2241
|
+
};
|
|
2242
|
+
header?: never;
|
|
2243
|
+
path: {
|
|
2244
|
+
artifact_id: string;
|
|
2245
|
+
};
|
|
2246
|
+
cookie?: never;
|
|
2247
|
+
};
|
|
2248
|
+
requestBody?: never;
|
|
2249
|
+
responses: {
|
|
2250
|
+
/** @description Successful Response */
|
|
2251
|
+
200: {
|
|
2252
|
+
headers: {
|
|
2253
|
+
[name: string]: unknown;
|
|
2254
|
+
};
|
|
2255
|
+
content: {
|
|
2256
|
+
'application/json': unknown;
|
|
2257
|
+
};
|
|
2258
|
+
};
|
|
2259
|
+
/** @description Validation Error */
|
|
2260
|
+
422: {
|
|
2261
|
+
headers: {
|
|
2262
|
+
[name: string]: unknown;
|
|
2263
|
+
};
|
|
2264
|
+
content: {
|
|
2265
|
+
'application/json': components['schemas']['HTTPValidationError'];
|
|
2266
|
+
};
|
|
2267
|
+
};
|
|
2268
|
+
};
|
|
2269
|
+
};
|
|
2270
|
+
generate_artifact_api_artifact_generate__artifact_definition_id__post: {
|
|
2271
|
+
parameters: {
|
|
2272
|
+
query?: {
|
|
2273
|
+
/** @description Name of the branch to use for the query */
|
|
2274
|
+
branch?: string | null;
|
|
2275
|
+
/** @description Time to use for the query, in absolute or relative format */
|
|
2276
|
+
at?: string | null;
|
|
2277
|
+
};
|
|
2278
|
+
header?: never;
|
|
2279
|
+
path: {
|
|
2280
|
+
artifact_definition_id: string;
|
|
2281
|
+
};
|
|
2282
|
+
cookie?: never;
|
|
2283
|
+
};
|
|
2284
|
+
requestBody?: {
|
|
2285
|
+
content: {
|
|
2286
|
+
'application/json': components['schemas']['ArtifactGeneratePayload'];
|
|
2287
|
+
};
|
|
2288
|
+
};
|
|
2289
|
+
responses: {
|
|
2290
|
+
/** @description Successful Response */
|
|
2291
|
+
200: {
|
|
2292
|
+
headers: {
|
|
2293
|
+
[name: string]: unknown;
|
|
2294
|
+
};
|
|
2295
|
+
content: {
|
|
2296
|
+
'application/json': null;
|
|
2297
|
+
};
|
|
2298
|
+
};
|
|
2299
|
+
/** @description Validation Error */
|
|
2300
|
+
422: {
|
|
2301
|
+
headers: {
|
|
2302
|
+
[name: string]: unknown;
|
|
2303
|
+
};
|
|
2304
|
+
content: {
|
|
2305
|
+
'application/json': components['schemas']['HTTPValidationError'];
|
|
2306
|
+
};
|
|
2307
|
+
};
|
|
2308
|
+
};
|
|
2309
|
+
};
|
|
2310
|
+
login_user_api_auth_login_post: {
|
|
2311
|
+
parameters: {
|
|
2312
|
+
query?: never;
|
|
2313
|
+
header?: never;
|
|
2314
|
+
path?: never;
|
|
2315
|
+
cookie?: never;
|
|
2316
|
+
};
|
|
2317
|
+
requestBody: {
|
|
2318
|
+
content: {
|
|
2319
|
+
'application/json': components['schemas']['PasswordCredential'];
|
|
2320
|
+
};
|
|
2321
|
+
};
|
|
2322
|
+
responses: {
|
|
2323
|
+
/** @description Successful Response */
|
|
2324
|
+
200: {
|
|
2325
|
+
headers: {
|
|
2326
|
+
[name: string]: unknown;
|
|
2327
|
+
};
|
|
2328
|
+
content: {
|
|
2329
|
+
'application/json': components['schemas']['UserToken'];
|
|
2330
|
+
};
|
|
2331
|
+
};
|
|
2332
|
+
/** @description Validation Error */
|
|
2333
|
+
422: {
|
|
2334
|
+
headers: {
|
|
2335
|
+
[name: string]: unknown;
|
|
2336
|
+
};
|
|
2337
|
+
content: {
|
|
2338
|
+
'application/json': components['schemas']['HTTPValidationError'];
|
|
2339
|
+
};
|
|
2340
|
+
};
|
|
2341
|
+
};
|
|
2342
|
+
};
|
|
2343
|
+
refresh_jwt_token_api_auth_refresh_post: {
|
|
2344
|
+
parameters: {
|
|
2345
|
+
query?: never;
|
|
2346
|
+
header?: never;
|
|
2347
|
+
path?: never;
|
|
2348
|
+
cookie?: never;
|
|
2349
|
+
};
|
|
2350
|
+
requestBody?: never;
|
|
2351
|
+
responses: {
|
|
2352
|
+
/** @description Successful Response */
|
|
2353
|
+
200: {
|
|
2354
|
+
headers: {
|
|
2355
|
+
[name: string]: unknown;
|
|
2356
|
+
};
|
|
2357
|
+
content: {
|
|
2358
|
+
'application/json': components['schemas']['AccessTokenResponse'];
|
|
2359
|
+
};
|
|
2360
|
+
};
|
|
2361
|
+
};
|
|
2362
|
+
};
|
|
2363
|
+
logout_api_auth_logout_post: {
|
|
2364
|
+
parameters: {
|
|
2365
|
+
query?: never;
|
|
2366
|
+
header?: never;
|
|
2367
|
+
path?: never;
|
|
2368
|
+
cookie?: never;
|
|
2369
|
+
};
|
|
2370
|
+
requestBody?: never;
|
|
2371
|
+
responses: {
|
|
2372
|
+
/** @description Successful Response */
|
|
2373
|
+
200: {
|
|
2374
|
+
headers: {
|
|
2375
|
+
[name: string]: unknown;
|
|
2376
|
+
};
|
|
2377
|
+
content: {
|
|
2378
|
+
'application/json': null;
|
|
2379
|
+
};
|
|
2380
|
+
};
|
|
2381
|
+
};
|
|
2382
|
+
};
|
|
2383
|
+
get_diff_files_api_diff_files_get: {
|
|
2384
|
+
parameters: {
|
|
2385
|
+
query?: {
|
|
2386
|
+
time_from?: string | null;
|
|
2387
|
+
time_to?: string | null;
|
|
2388
|
+
branch_only?: boolean;
|
|
2389
|
+
/** @description Name of the branch to use for the query */
|
|
2390
|
+
branch?: string | null;
|
|
2391
|
+
};
|
|
2392
|
+
header?: never;
|
|
2393
|
+
path?: never;
|
|
2394
|
+
cookie?: never;
|
|
2395
|
+
};
|
|
2396
|
+
requestBody?: never;
|
|
2397
|
+
responses: {
|
|
2398
|
+
/** @description Successful Response */
|
|
2399
|
+
200: {
|
|
2400
|
+
headers: {
|
|
2401
|
+
[name: string]: unknown;
|
|
2402
|
+
};
|
|
2403
|
+
content: {
|
|
2404
|
+
'application/json': {
|
|
2405
|
+
[key: string]: {
|
|
2406
|
+
[key: string]: components['schemas']['BranchDiffRepository'];
|
|
2407
|
+
};
|
|
2408
|
+
};
|
|
2409
|
+
};
|
|
2410
|
+
};
|
|
2411
|
+
/** @description Validation Error */
|
|
2412
|
+
422: {
|
|
2413
|
+
headers: {
|
|
2414
|
+
[name: string]: unknown;
|
|
2415
|
+
};
|
|
2416
|
+
content: {
|
|
2417
|
+
'application/json': components['schemas']['HTTPValidationError'];
|
|
2418
|
+
};
|
|
2419
|
+
};
|
|
2420
|
+
};
|
|
2421
|
+
};
|
|
2422
|
+
get_diff_artifacts_api_diff_artifacts_get: {
|
|
2423
|
+
parameters: {
|
|
2424
|
+
query?: {
|
|
2425
|
+
/** @description Name of the branch to use for the query */
|
|
2426
|
+
branch?: string | null;
|
|
2427
|
+
};
|
|
2428
|
+
header?: never;
|
|
2429
|
+
path?: never;
|
|
2430
|
+
cookie?: never;
|
|
2431
|
+
};
|
|
2432
|
+
requestBody?: never;
|
|
2433
|
+
responses: {
|
|
2434
|
+
/** @description Successful Response */
|
|
2435
|
+
200: {
|
|
2436
|
+
headers: {
|
|
2437
|
+
[name: string]: unknown;
|
|
2438
|
+
};
|
|
2439
|
+
content: {
|
|
2440
|
+
'application/json': {
|
|
2441
|
+
[key: string]: components['schemas']['BranchDiffArtifact'];
|
|
2442
|
+
};
|
|
2443
|
+
};
|
|
2444
|
+
};
|
|
2445
|
+
/** @description Validation Error */
|
|
2446
|
+
422: {
|
|
2447
|
+
headers: {
|
|
2448
|
+
[name: string]: unknown;
|
|
2449
|
+
};
|
|
2450
|
+
content: {
|
|
2451
|
+
'application/json': components['schemas']['HTTPValidationError'];
|
|
2452
|
+
};
|
|
2453
|
+
};
|
|
2454
|
+
};
|
|
2455
|
+
};
|
|
2456
|
+
get_file_api_file__repository_id___file_path__get: {
|
|
2457
|
+
parameters: {
|
|
2458
|
+
query?: {
|
|
2459
|
+
commit?: string | null;
|
|
2460
|
+
/** @description Name of the branch to use for the query */
|
|
2461
|
+
branch?: string | null;
|
|
2462
|
+
/** @description Time to use for the query, in absolute or relative format */
|
|
2463
|
+
at?: string | null;
|
|
2464
|
+
};
|
|
2465
|
+
header?: never;
|
|
2466
|
+
path: {
|
|
2467
|
+
repository_id: string;
|
|
2468
|
+
file_path: string;
|
|
2469
|
+
};
|
|
2470
|
+
cookie?: never;
|
|
2471
|
+
};
|
|
2472
|
+
requestBody?: never;
|
|
2473
|
+
responses: {
|
|
2474
|
+
/** @description Successful Response */
|
|
2475
|
+
200: {
|
|
2476
|
+
headers: {
|
|
2477
|
+
[name: string]: unknown;
|
|
2478
|
+
};
|
|
2479
|
+
content: {
|
|
2480
|
+
'text/plain': string;
|
|
2481
|
+
};
|
|
2482
|
+
};
|
|
2483
|
+
/** @description Validation Error */
|
|
2484
|
+
422: {
|
|
2485
|
+
headers: {
|
|
2486
|
+
[name: string]: unknown;
|
|
2487
|
+
};
|
|
2488
|
+
content: {
|
|
2489
|
+
'application/json': components['schemas']['HTTPValidationError'];
|
|
2490
|
+
};
|
|
2491
|
+
};
|
|
2492
|
+
};
|
|
2493
|
+
};
|
|
2494
|
+
get_config_api_config_get: {
|
|
2495
|
+
parameters: {
|
|
2496
|
+
query?: never;
|
|
2497
|
+
header?: never;
|
|
2498
|
+
path?: never;
|
|
2499
|
+
cookie?: never;
|
|
2500
|
+
};
|
|
2501
|
+
requestBody?: never;
|
|
2502
|
+
responses: {
|
|
2503
|
+
/** @description Successful Response */
|
|
2504
|
+
200: {
|
|
2505
|
+
headers: {
|
|
2506
|
+
[name: string]: unknown;
|
|
2507
|
+
};
|
|
2508
|
+
content: {
|
|
2509
|
+
'application/json': components['schemas']['ConfigAPI'];
|
|
2510
|
+
};
|
|
2511
|
+
};
|
|
2512
|
+
};
|
|
2513
|
+
};
|
|
2514
|
+
get_info_api_info_get: {
|
|
2515
|
+
parameters: {
|
|
2516
|
+
query?: never;
|
|
2517
|
+
header?: never;
|
|
2518
|
+
path?: never;
|
|
2519
|
+
cookie?: never;
|
|
2520
|
+
};
|
|
2521
|
+
requestBody?: never;
|
|
2522
|
+
responses: {
|
|
2523
|
+
/** @description Successful Response */
|
|
2524
|
+
200: {
|
|
2525
|
+
headers: {
|
|
2526
|
+
[name: string]: unknown;
|
|
2527
|
+
};
|
|
2528
|
+
content: {
|
|
2529
|
+
'application/json': components['schemas']['InfoAPI'];
|
|
2530
|
+
};
|
|
2531
|
+
};
|
|
2532
|
+
};
|
|
2533
|
+
};
|
|
2534
|
+
get_menu_api_menu_get: {
|
|
2535
|
+
parameters: {
|
|
2536
|
+
query?: {
|
|
2537
|
+
/** @description Name of the branch to use for the query */
|
|
2538
|
+
branch?: string | null;
|
|
2539
|
+
/** @description Time to use for the query, in absolute or relative format */
|
|
2540
|
+
at?: string | null;
|
|
2541
|
+
};
|
|
2542
|
+
header?: never;
|
|
2543
|
+
path?: never;
|
|
2544
|
+
cookie?: never;
|
|
2545
|
+
};
|
|
2546
|
+
requestBody?: never;
|
|
2547
|
+
responses: {
|
|
2548
|
+
/** @description Successful Response */
|
|
2549
|
+
200: {
|
|
2550
|
+
headers: {
|
|
2551
|
+
[name: string]: unknown;
|
|
2552
|
+
};
|
|
2553
|
+
content: {
|
|
2554
|
+
'application/json': components['schemas']['Menu'];
|
|
2555
|
+
};
|
|
2556
|
+
};
|
|
2557
|
+
/** @description Validation Error */
|
|
2558
|
+
422: {
|
|
2559
|
+
headers: {
|
|
2560
|
+
[name: string]: unknown;
|
|
2561
|
+
};
|
|
2562
|
+
content: {
|
|
2563
|
+
'application/json': components['schemas']['HTTPValidationError'];
|
|
2564
|
+
};
|
|
2565
|
+
};
|
|
2566
|
+
};
|
|
2567
|
+
};
|
|
2568
|
+
authorize_api_oauth2__provider_name__authorize_get: {
|
|
2569
|
+
parameters: {
|
|
2570
|
+
query?: {
|
|
2571
|
+
final_url?: string | null;
|
|
2572
|
+
};
|
|
2573
|
+
header?: never;
|
|
2574
|
+
path: {
|
|
2575
|
+
provider_name: string;
|
|
2576
|
+
};
|
|
2577
|
+
cookie?: never;
|
|
2578
|
+
};
|
|
2579
|
+
requestBody?: never;
|
|
2580
|
+
responses: {
|
|
2581
|
+
/** @description Successful Response */
|
|
2582
|
+
200: {
|
|
2583
|
+
headers: {
|
|
2584
|
+
[name: string]: unknown;
|
|
2585
|
+
};
|
|
2586
|
+
content: {
|
|
2587
|
+
'application/json': unknown;
|
|
2588
|
+
};
|
|
2589
|
+
};
|
|
2590
|
+
/** @description Validation Error */
|
|
2591
|
+
422: {
|
|
2592
|
+
headers: {
|
|
2593
|
+
[name: string]: unknown;
|
|
2594
|
+
};
|
|
2595
|
+
content: {
|
|
2596
|
+
'application/json': components['schemas']['HTTPValidationError'];
|
|
2597
|
+
};
|
|
2598
|
+
};
|
|
2599
|
+
};
|
|
2600
|
+
};
|
|
2601
|
+
token_api_oauth2__provider_name__token_get: {
|
|
2602
|
+
parameters: {
|
|
2603
|
+
query: {
|
|
2604
|
+
state: string;
|
|
2605
|
+
code: string;
|
|
2606
|
+
};
|
|
2607
|
+
header?: never;
|
|
2608
|
+
path: {
|
|
2609
|
+
provider_name: string;
|
|
2610
|
+
};
|
|
2611
|
+
cookie?: never;
|
|
2612
|
+
};
|
|
2613
|
+
requestBody?: never;
|
|
2614
|
+
responses: {
|
|
2615
|
+
/** @description Successful Response */
|
|
2616
|
+
200: {
|
|
2617
|
+
headers: {
|
|
2618
|
+
[name: string]: unknown;
|
|
2619
|
+
};
|
|
2620
|
+
content: {
|
|
2621
|
+
'application/json': components['schemas']['UserTokenWithUrl'];
|
|
2622
|
+
};
|
|
2623
|
+
};
|
|
2624
|
+
/** @description Validation Error */
|
|
2625
|
+
422: {
|
|
2626
|
+
headers: {
|
|
2627
|
+
[name: string]: unknown;
|
|
2628
|
+
};
|
|
2629
|
+
content: {
|
|
2630
|
+
'application/json': components['schemas']['HTTPValidationError'];
|
|
2631
|
+
};
|
|
2632
|
+
};
|
|
2633
|
+
};
|
|
2634
|
+
};
|
|
2635
|
+
authorize_api_oidc__provider_name__authorize_get: {
|
|
2636
|
+
parameters: {
|
|
2637
|
+
query?: {
|
|
2638
|
+
final_url?: string | null;
|
|
2639
|
+
};
|
|
2640
|
+
header?: never;
|
|
2641
|
+
path: {
|
|
2642
|
+
provider_name: string;
|
|
2643
|
+
};
|
|
2644
|
+
cookie?: never;
|
|
2645
|
+
};
|
|
2646
|
+
requestBody?: never;
|
|
2647
|
+
responses: {
|
|
2648
|
+
/** @description Successful Response */
|
|
2649
|
+
200: {
|
|
2650
|
+
headers: {
|
|
2651
|
+
[name: string]: unknown;
|
|
2652
|
+
};
|
|
2653
|
+
content: {
|
|
2654
|
+
'application/json': unknown;
|
|
2655
|
+
};
|
|
2656
|
+
};
|
|
2657
|
+
/** @description Validation Error */
|
|
2658
|
+
422: {
|
|
2659
|
+
headers: {
|
|
2660
|
+
[name: string]: unknown;
|
|
2661
|
+
};
|
|
2662
|
+
content: {
|
|
2663
|
+
'application/json': components['schemas']['HTTPValidationError'];
|
|
2664
|
+
};
|
|
2665
|
+
};
|
|
2666
|
+
};
|
|
2667
|
+
};
|
|
2668
|
+
token_api_oidc__provider_name__token_get: {
|
|
2669
|
+
parameters: {
|
|
2670
|
+
query: {
|
|
2671
|
+
state: string;
|
|
2672
|
+
code: string;
|
|
2673
|
+
};
|
|
2674
|
+
header?: never;
|
|
2675
|
+
path: {
|
|
2676
|
+
provider_name: string;
|
|
2677
|
+
};
|
|
2678
|
+
cookie?: never;
|
|
2679
|
+
};
|
|
2680
|
+
requestBody?: never;
|
|
2681
|
+
responses: {
|
|
2682
|
+
/** @description Successful Response */
|
|
2683
|
+
200: {
|
|
2684
|
+
headers: {
|
|
2685
|
+
[name: string]: unknown;
|
|
2686
|
+
};
|
|
2687
|
+
content: {
|
|
2688
|
+
'application/json': components['schemas']['UserTokenWithUrl'];
|
|
2689
|
+
};
|
|
2690
|
+
};
|
|
2691
|
+
/** @description Validation Error */
|
|
2692
|
+
422: {
|
|
2693
|
+
headers: {
|
|
2694
|
+
[name: string]: unknown;
|
|
2695
|
+
};
|
|
2696
|
+
content: {
|
|
2697
|
+
'application/json': components['schemas']['HTTPValidationError'];
|
|
2698
|
+
};
|
|
2699
|
+
};
|
|
2700
|
+
};
|
|
2701
|
+
};
|
|
2702
|
+
graphql_query_get_api_query__query_id__get: {
|
|
2703
|
+
parameters: {
|
|
2704
|
+
query?: {
|
|
2705
|
+
/** @description List of subscribers to attach to the CoreGraphQLQueryGroup */
|
|
2706
|
+
subscribers?: string[];
|
|
2707
|
+
/** @description When True create or update a CoreGraphQLQueryGroup with all nodes related to this query. */
|
|
2708
|
+
update_group?: boolean;
|
|
2709
|
+
/** @description Name of the branch to use for the query */
|
|
2710
|
+
branch?: string | null;
|
|
2711
|
+
/** @description Time to use for the query, in absolute or relative format */
|
|
2712
|
+
at?: string | null;
|
|
2713
|
+
};
|
|
2714
|
+
header?: never;
|
|
2715
|
+
path: {
|
|
2716
|
+
/** @description ID or Name of the GraphQL query to execute */
|
|
2717
|
+
query_id: string;
|
|
2718
|
+
};
|
|
2719
|
+
cookie?: never;
|
|
2720
|
+
};
|
|
2721
|
+
requestBody?: never;
|
|
2722
|
+
responses: {
|
|
2723
|
+
/** @description Successful Response */
|
|
2724
|
+
200: {
|
|
2725
|
+
headers: {
|
|
2726
|
+
[name: string]: unknown;
|
|
2727
|
+
};
|
|
2728
|
+
content: {
|
|
2729
|
+
'application/json': Record<string, never>;
|
|
2730
|
+
};
|
|
2731
|
+
};
|
|
2732
|
+
/** @description Validation Error */
|
|
2733
|
+
422: {
|
|
2734
|
+
headers: {
|
|
2735
|
+
[name: string]: unknown;
|
|
2736
|
+
};
|
|
2737
|
+
content: {
|
|
2738
|
+
'application/json': components['schemas']['HTTPValidationError'];
|
|
2739
|
+
};
|
|
2740
|
+
};
|
|
2741
|
+
};
|
|
2742
|
+
};
|
|
2743
|
+
graphql_query_post_api_query__query_id__post: {
|
|
2744
|
+
parameters: {
|
|
2745
|
+
query?: {
|
|
2746
|
+
/** @description List of subscribers to attach to the CoreGraphQLQueryGroup */
|
|
2747
|
+
subscribers?: string[];
|
|
2748
|
+
/** @description When True create or update a CoreGraphQLQueryGroup with all nodes related to this query. */
|
|
2749
|
+
update_group?: boolean;
|
|
2750
|
+
/** @description Name of the branch to use for the query */
|
|
2751
|
+
branch?: string | null;
|
|
2752
|
+
/** @description Time to use for the query, in absolute or relative format */
|
|
2753
|
+
at?: string | null;
|
|
2754
|
+
};
|
|
2755
|
+
header?: never;
|
|
2756
|
+
path: {
|
|
2757
|
+
/** @description ID or Name of the GraphQL query to execute */
|
|
2758
|
+
query_id: string;
|
|
2759
|
+
};
|
|
2760
|
+
cookie?: never;
|
|
2761
|
+
};
|
|
2762
|
+
requestBody?: {
|
|
2763
|
+
content: {
|
|
2764
|
+
'application/json': components['schemas']['QueryPayload'];
|
|
2765
|
+
};
|
|
2766
|
+
};
|
|
2767
|
+
responses: {
|
|
2768
|
+
/** @description Successful Response */
|
|
2769
|
+
200: {
|
|
2770
|
+
headers: {
|
|
2771
|
+
[name: string]: unknown;
|
|
2772
|
+
};
|
|
2773
|
+
content: {
|
|
2774
|
+
'application/json': Record<string, never>;
|
|
2775
|
+
};
|
|
2776
|
+
};
|
|
2777
|
+
/** @description Validation Error */
|
|
2778
|
+
422: {
|
|
2779
|
+
headers: {
|
|
2780
|
+
[name: string]: unknown;
|
|
2781
|
+
};
|
|
2782
|
+
content: {
|
|
2783
|
+
'application/json': components['schemas']['HTTPValidationError'];
|
|
2784
|
+
};
|
|
2785
|
+
};
|
|
2786
|
+
};
|
|
2787
|
+
};
|
|
2788
|
+
get_schema_api_schema_get: {
|
|
2789
|
+
parameters: {
|
|
2790
|
+
query?: {
|
|
2791
|
+
namespaces?: string[] | null;
|
|
2792
|
+
/** @description Name of the branch to use for the query */
|
|
2793
|
+
branch?: string | null;
|
|
2794
|
+
};
|
|
2795
|
+
header?: never;
|
|
2796
|
+
path?: never;
|
|
2797
|
+
cookie?: never;
|
|
2798
|
+
};
|
|
2799
|
+
requestBody?: never;
|
|
2800
|
+
responses: {
|
|
2801
|
+
/** @description Successful Response */
|
|
2802
|
+
200: {
|
|
2803
|
+
headers: {
|
|
2804
|
+
[name: string]: unknown;
|
|
2805
|
+
};
|
|
2806
|
+
content: {
|
|
2807
|
+
'application/json': components['schemas']['SchemaReadAPI'];
|
|
2808
|
+
};
|
|
2809
|
+
};
|
|
2810
|
+
/** @description Validation Error */
|
|
2811
|
+
422: {
|
|
2812
|
+
headers: {
|
|
2813
|
+
[name: string]: unknown;
|
|
2814
|
+
};
|
|
2815
|
+
content: {
|
|
2816
|
+
'application/json': components['schemas']['HTTPValidationError'];
|
|
2817
|
+
};
|
|
2818
|
+
};
|
|
2819
|
+
};
|
|
2820
|
+
};
|
|
2821
|
+
get_schema_summary_api_schema_summary_get: {
|
|
2822
|
+
parameters: {
|
|
2823
|
+
query?: {
|
|
2824
|
+
/** @description Name of the branch to use for the query */
|
|
2825
|
+
branch?: string | null;
|
|
2826
|
+
};
|
|
2827
|
+
header?: never;
|
|
2828
|
+
path?: never;
|
|
2829
|
+
cookie?: never;
|
|
2830
|
+
};
|
|
2831
|
+
requestBody?: never;
|
|
2832
|
+
responses: {
|
|
2833
|
+
/** @description Successful Response */
|
|
2834
|
+
200: {
|
|
2835
|
+
headers: {
|
|
2836
|
+
[name: string]: unknown;
|
|
2837
|
+
};
|
|
2838
|
+
content: {
|
|
2839
|
+
'application/json': components['schemas']['SchemaBranchHash'];
|
|
2840
|
+
};
|
|
2841
|
+
};
|
|
2842
|
+
/** @description Validation Error */
|
|
2843
|
+
422: {
|
|
2844
|
+
headers: {
|
|
2845
|
+
[name: string]: unknown;
|
|
2846
|
+
};
|
|
2847
|
+
content: {
|
|
2848
|
+
'application/json': components['schemas']['HTTPValidationError'];
|
|
2849
|
+
};
|
|
2850
|
+
};
|
|
2851
|
+
};
|
|
2852
|
+
};
|
|
2853
|
+
get_schema_by_kind_api_schema__schema_kind__get: {
|
|
2854
|
+
parameters: {
|
|
2855
|
+
query?: {
|
|
2856
|
+
/** @description Name of the branch to use for the query */
|
|
2857
|
+
branch?: string | null;
|
|
2858
|
+
};
|
|
2859
|
+
header?: never;
|
|
2860
|
+
path: {
|
|
2861
|
+
schema_kind: string;
|
|
2862
|
+
};
|
|
2863
|
+
cookie?: never;
|
|
2864
|
+
};
|
|
2865
|
+
requestBody?: never;
|
|
2866
|
+
responses: {
|
|
2867
|
+
/** @description Successful Response */
|
|
2868
|
+
200: {
|
|
2869
|
+
headers: {
|
|
2870
|
+
[name: string]: unknown;
|
|
2871
|
+
};
|
|
2872
|
+
content: {
|
|
2873
|
+
'application/json':
|
|
2874
|
+
| components['schemas']['APIProfileSchema']
|
|
2875
|
+
| components['schemas']['APINodeSchema']
|
|
2876
|
+
| components['schemas']['APIGenericSchema']
|
|
2877
|
+
| components['schemas']['APITemplateSchema'];
|
|
2878
|
+
};
|
|
2879
|
+
};
|
|
2880
|
+
/** @description Validation Error */
|
|
2881
|
+
422: {
|
|
2882
|
+
headers: {
|
|
2883
|
+
[name: string]: unknown;
|
|
2884
|
+
};
|
|
2885
|
+
content: {
|
|
2886
|
+
'application/json': components['schemas']['HTTPValidationError'];
|
|
2887
|
+
};
|
|
2888
|
+
};
|
|
2889
|
+
};
|
|
2890
|
+
};
|
|
2891
|
+
get_json_schema_by_kind_api_schema_json_schema__schema_kind__get: {
|
|
2892
|
+
parameters: {
|
|
2893
|
+
query?: {
|
|
2894
|
+
/** @description Name of the branch to use for the query */
|
|
2895
|
+
branch?: string | null;
|
|
2896
|
+
};
|
|
2897
|
+
header?: never;
|
|
2898
|
+
path: {
|
|
2899
|
+
schema_kind: string;
|
|
2900
|
+
};
|
|
2901
|
+
cookie?: never;
|
|
2902
|
+
};
|
|
2903
|
+
requestBody?: never;
|
|
2904
|
+
responses: {
|
|
2905
|
+
/** @description Successful Response */
|
|
2906
|
+
200: {
|
|
2907
|
+
headers: {
|
|
2908
|
+
[name: string]: unknown;
|
|
2909
|
+
};
|
|
2910
|
+
content: {
|
|
2911
|
+
'application/json': components['schemas']['JSONSchema'];
|
|
2912
|
+
};
|
|
2913
|
+
};
|
|
2914
|
+
/** @description Validation Error */
|
|
2915
|
+
422: {
|
|
2916
|
+
headers: {
|
|
2917
|
+
[name: string]: unknown;
|
|
2918
|
+
};
|
|
2919
|
+
content: {
|
|
2920
|
+
'application/json': components['schemas']['HTTPValidationError'];
|
|
2921
|
+
};
|
|
2922
|
+
};
|
|
2923
|
+
};
|
|
2924
|
+
};
|
|
2925
|
+
load_schema_api_schema_load_post: {
|
|
2926
|
+
parameters: {
|
|
2927
|
+
query?: {
|
|
2928
|
+
/** @description Name of the branch to use for the query */
|
|
2929
|
+
branch?: string | null;
|
|
2930
|
+
/** @description Time to use for the query, in absolute or relative format */
|
|
2931
|
+
at?: string | null;
|
|
2932
|
+
};
|
|
2933
|
+
header?: never;
|
|
2934
|
+
path?: never;
|
|
2935
|
+
cookie?: never;
|
|
2936
|
+
};
|
|
2937
|
+
requestBody: {
|
|
2938
|
+
content: {
|
|
2939
|
+
'application/json': components['schemas']['SchemasLoadAPI'];
|
|
2940
|
+
};
|
|
2941
|
+
};
|
|
2942
|
+
responses: {
|
|
2943
|
+
/** @description Successful Response */
|
|
2944
|
+
200: {
|
|
2945
|
+
headers: {
|
|
2946
|
+
[name: string]: unknown;
|
|
2947
|
+
};
|
|
2948
|
+
content: {
|
|
2949
|
+
'application/json': components['schemas']['SchemaUpdate'];
|
|
2950
|
+
};
|
|
2951
|
+
};
|
|
2952
|
+
/** @description Validation Error */
|
|
2953
|
+
422: {
|
|
2954
|
+
headers: {
|
|
2955
|
+
[name: string]: unknown;
|
|
2956
|
+
};
|
|
2957
|
+
content: {
|
|
2958
|
+
'application/json': components['schemas']['HTTPValidationError'];
|
|
2959
|
+
};
|
|
2960
|
+
};
|
|
2961
|
+
};
|
|
2962
|
+
};
|
|
2963
|
+
check_schema_api_schema_check_post: {
|
|
2964
|
+
parameters: {
|
|
2965
|
+
query?: {
|
|
2966
|
+
/** @description Name of the branch to use for the query */
|
|
2967
|
+
branch?: string | null;
|
|
2968
|
+
};
|
|
2969
|
+
header?: never;
|
|
2970
|
+
path?: never;
|
|
2971
|
+
cookie?: never;
|
|
2972
|
+
};
|
|
2973
|
+
requestBody: {
|
|
2974
|
+
content: {
|
|
2975
|
+
'application/json': components['schemas']['SchemasLoadAPI'];
|
|
2976
|
+
};
|
|
2977
|
+
};
|
|
2978
|
+
responses: {
|
|
2979
|
+
/** @description Successful Response */
|
|
2980
|
+
200: {
|
|
2981
|
+
headers: {
|
|
2982
|
+
[name: string]: unknown;
|
|
2983
|
+
};
|
|
2984
|
+
content: {
|
|
2985
|
+
'application/json': unknown;
|
|
2986
|
+
};
|
|
2987
|
+
};
|
|
2988
|
+
/** @description Validation Error */
|
|
2989
|
+
422: {
|
|
2990
|
+
headers: {
|
|
2991
|
+
[name: string]: unknown;
|
|
2992
|
+
};
|
|
2993
|
+
content: {
|
|
2994
|
+
'application/json': components['schemas']['HTTPValidationError'];
|
|
2995
|
+
};
|
|
2996
|
+
};
|
|
2997
|
+
};
|
|
2998
|
+
};
|
|
2999
|
+
get_file_api_storage_object__identifier__get: {
|
|
3000
|
+
parameters: {
|
|
3001
|
+
query?: never;
|
|
3002
|
+
header?: never;
|
|
3003
|
+
path: {
|
|
3004
|
+
identifier: string;
|
|
3005
|
+
};
|
|
3006
|
+
cookie?: never;
|
|
3007
|
+
};
|
|
3008
|
+
requestBody?: never;
|
|
3009
|
+
responses: {
|
|
3010
|
+
/** @description Successful Response */
|
|
3011
|
+
200: {
|
|
3012
|
+
headers: {
|
|
3013
|
+
[name: string]: unknown;
|
|
3014
|
+
};
|
|
3015
|
+
content: {
|
|
3016
|
+
'application/json': unknown;
|
|
3017
|
+
};
|
|
3018
|
+
};
|
|
3019
|
+
/** @description Validation Error */
|
|
3020
|
+
422: {
|
|
3021
|
+
headers: {
|
|
3022
|
+
[name: string]: unknown;
|
|
3023
|
+
};
|
|
3024
|
+
content: {
|
|
3025
|
+
'application/json': components['schemas']['HTTPValidationError'];
|
|
3026
|
+
};
|
|
3027
|
+
};
|
|
3028
|
+
};
|
|
3029
|
+
};
|
|
3030
|
+
upload_content_api_storage_upload_content_post: {
|
|
3031
|
+
parameters: {
|
|
3032
|
+
query?: never;
|
|
3033
|
+
header?: never;
|
|
3034
|
+
path?: never;
|
|
3035
|
+
cookie?: never;
|
|
3036
|
+
};
|
|
3037
|
+
requestBody: {
|
|
3038
|
+
content: {
|
|
3039
|
+
'application/json': components['schemas']['UploadContentPayload'];
|
|
3040
|
+
};
|
|
3041
|
+
};
|
|
3042
|
+
responses: {
|
|
3043
|
+
/** @description Successful Response */
|
|
3044
|
+
200: {
|
|
3045
|
+
headers: {
|
|
3046
|
+
[name: string]: unknown;
|
|
3047
|
+
};
|
|
3048
|
+
content: {
|
|
3049
|
+
'application/json': components['schemas']['UploadResponse'];
|
|
3050
|
+
};
|
|
3051
|
+
};
|
|
3052
|
+
/** @description Validation Error */
|
|
3053
|
+
422: {
|
|
3054
|
+
headers: {
|
|
3055
|
+
[name: string]: unknown;
|
|
3056
|
+
};
|
|
3057
|
+
content: {
|
|
3058
|
+
'application/json': components['schemas']['HTTPValidationError'];
|
|
3059
|
+
};
|
|
3060
|
+
};
|
|
3061
|
+
};
|
|
3062
|
+
};
|
|
3063
|
+
upload_file_api_storage_upload_file_post: {
|
|
3064
|
+
parameters: {
|
|
3065
|
+
query?: never;
|
|
3066
|
+
header?: never;
|
|
3067
|
+
path?: never;
|
|
3068
|
+
cookie?: never;
|
|
3069
|
+
};
|
|
3070
|
+
requestBody: {
|
|
3071
|
+
content: {
|
|
3072
|
+
'multipart/form-data': components['schemas']['Body_upload_file_api_storage_upload_file_post'];
|
|
3073
|
+
};
|
|
3074
|
+
};
|
|
3075
|
+
responses: {
|
|
3076
|
+
/** @description Successful Response */
|
|
3077
|
+
200: {
|
|
3078
|
+
headers: {
|
|
3079
|
+
[name: string]: unknown;
|
|
3080
|
+
};
|
|
3081
|
+
content: {
|
|
3082
|
+
'application/json': components['schemas']['UploadResponse'];
|
|
3083
|
+
};
|
|
3084
|
+
};
|
|
3085
|
+
/** @description Validation Error */
|
|
3086
|
+
422: {
|
|
3087
|
+
headers: {
|
|
3088
|
+
[name: string]: unknown;
|
|
3089
|
+
};
|
|
3090
|
+
content: {
|
|
3091
|
+
'application/json': components['schemas']['HTTPValidationError'];
|
|
3092
|
+
};
|
|
3093
|
+
};
|
|
3094
|
+
};
|
|
3095
|
+
};
|
|
3096
|
+
transform_python_api_transform_python__transform_id__get: {
|
|
3097
|
+
parameters: {
|
|
3098
|
+
query?: {
|
|
3099
|
+
/** @description Name of the branch to use for the query */
|
|
3100
|
+
branch?: string | null;
|
|
3101
|
+
/** @description Time to use for the query, in absolute or relative format */
|
|
3102
|
+
at?: string | null;
|
|
3103
|
+
};
|
|
3104
|
+
header?: never;
|
|
3105
|
+
path: {
|
|
3106
|
+
transform_id: string;
|
|
3107
|
+
};
|
|
3108
|
+
cookie?: never;
|
|
3109
|
+
};
|
|
3110
|
+
requestBody?: never;
|
|
3111
|
+
responses: {
|
|
3112
|
+
/** @description Successful Response */
|
|
3113
|
+
200: {
|
|
3114
|
+
headers: {
|
|
3115
|
+
[name: string]: unknown;
|
|
3116
|
+
};
|
|
3117
|
+
content: {
|
|
3118
|
+
'application/json': unknown;
|
|
3119
|
+
};
|
|
3120
|
+
};
|
|
3121
|
+
/** @description Validation Error */
|
|
3122
|
+
422: {
|
|
3123
|
+
headers: {
|
|
3124
|
+
[name: string]: unknown;
|
|
3125
|
+
};
|
|
3126
|
+
content: {
|
|
3127
|
+
'application/json': components['schemas']['HTTPValidationError'];
|
|
3128
|
+
};
|
|
3129
|
+
};
|
|
3130
|
+
};
|
|
3131
|
+
};
|
|
3132
|
+
transform_jinja2_api_transform_jinja2__transform_id__get: {
|
|
3133
|
+
parameters: {
|
|
3134
|
+
query?: {
|
|
3135
|
+
/** @description Name of the branch to use for the query */
|
|
3136
|
+
branch?: string | null;
|
|
3137
|
+
/** @description Time to use for the query, in absolute or relative format */
|
|
3138
|
+
at?: string | null;
|
|
3139
|
+
};
|
|
3140
|
+
header?: never;
|
|
3141
|
+
path: {
|
|
3142
|
+
/** @description ID or Name of the Jinja2 Transform to render */
|
|
3143
|
+
transform_id: string;
|
|
3144
|
+
};
|
|
3145
|
+
cookie?: never;
|
|
3146
|
+
};
|
|
3147
|
+
requestBody?: never;
|
|
3148
|
+
responses: {
|
|
3149
|
+
/** @description Successful Response */
|
|
3150
|
+
200: {
|
|
3151
|
+
headers: {
|
|
3152
|
+
[name: string]: unknown;
|
|
3153
|
+
};
|
|
3154
|
+
content: {
|
|
3155
|
+
'text/plain': string;
|
|
3156
|
+
};
|
|
3157
|
+
};
|
|
3158
|
+
/** @description Validation Error */
|
|
3159
|
+
422: {
|
|
3160
|
+
headers: {
|
|
3161
|
+
[name: string]: unknown;
|
|
3162
|
+
};
|
|
3163
|
+
content: {
|
|
3164
|
+
'application/json': components['schemas']['HTTPValidationError'];
|
|
3165
|
+
};
|
|
3166
|
+
};
|
|
3167
|
+
};
|
|
3168
|
+
};
|
|
3169
|
+
}
|