@meshery/schemas 1.2.21 → 1.2.23

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (106) hide show
  1. package/dist/cloudApi.d.mts +1728 -1527
  2. package/dist/cloudApi.d.ts +1728 -1527
  3. package/dist/cloudApi.js +1 -1
  4. package/dist/cloudApi.mjs +1 -1
  5. package/dist/constructs/v1alpha1/capability/Capability.d.ts +111 -106
  6. package/dist/constructs/v1alpha1/core/Core.d.ts +734 -822
  7. package/dist/constructs/v1alpha2/catalog/Catalog.d.ts +40 -45
  8. package/dist/constructs/v1alpha3/relationship/Relationship.d.ts +1716 -1829
  9. package/dist/constructs/v1beta1/academy/Academy.d.ts +6537 -5918
  10. package/dist/constructs/v1beta1/academy/AcademySchema.js +1 -1
  11. package/dist/constructs/v1beta1/academy/AcademySchema.mjs +1 -1
  12. package/dist/constructs/v1beta1/badge/Badge.d.ts +600 -439
  13. package/dist/constructs/v1beta1/capability/Capability.d.ts +111 -106
  14. package/dist/constructs/v1beta1/catalog/Catalog.d.ts +40 -45
  15. package/dist/constructs/v1beta1/category/Category.d.ts +26 -38
  16. package/dist/constructs/v1beta1/component/Component.d.ts +729 -833
  17. package/dist/constructs/v1beta1/connection/Connection.d.ts +1357 -1170
  18. package/dist/constructs/v1beta1/core/Core.d.ts +734 -822
  19. package/dist/constructs/v1beta1/credential/Credential.d.ts +593 -458
  20. package/dist/constructs/v1beta1/environment/Environment.d.ts +835 -666
  21. package/dist/constructs/v1beta1/evaluation/Evaluation.d.ts +5508 -6030
  22. package/dist/constructs/v1beta1/event/Event.d.ts +898 -527
  23. package/dist/constructs/v1beta1/feature/Feature.d.ts +287 -249
  24. package/dist/constructs/v1beta1/invitation/Invitation.d.ts +1244 -877
  25. package/dist/constructs/v1beta1/key/Key.d.ts +589 -444
  26. package/dist/constructs/v1beta1/keychain/Keychain.d.ts +796 -575
  27. package/dist/constructs/v1beta1/model/Model.d.ts +572 -598
  28. package/dist/constructs/v1beta1/organization/Organization.d.ts +1829 -1410
  29. package/dist/constructs/v1beta1/pattern/Pattern.d.ts +17093 -17910
  30. package/dist/constructs/v1beta1/plan/Plan.d.ts +159 -115
  31. package/dist/constructs/v1beta1/role/Role.d.ts +933 -688
  32. package/dist/constructs/v1beta1/role/RoleSchema.js +1 -1
  33. package/dist/constructs/v1beta1/role/RoleSchema.mjs +1 -1
  34. package/dist/constructs/v1beta1/schedule/Schedule.d.ts +425 -315
  35. package/dist/constructs/v1beta1/subcategory/Subcategory.d.ts +18 -61
  36. package/dist/constructs/v1beta1/subscription/Subscription.d.ts +839 -674
  37. package/dist/constructs/v1beta1/support/Support.d.ts +115 -74
  38. package/dist/constructs/v1beta1/system/System.d.ts +434 -0
  39. package/dist/constructs/v1beta1/system/System.js +1 -0
  40. package/dist/constructs/v1beta1/system/System.mjs +0 -0
  41. package/dist/constructs/v1beta1/system/SystemSchema.d.ts +2 -0
  42. package/dist/constructs/v1beta1/system/SystemSchema.js +2 -0
  43. package/dist/constructs/v1beta1/system/SystemSchema.mjs +2 -0
  44. package/dist/constructs/v1beta1/team/Team.d.ts +1028 -762
  45. package/dist/constructs/v1beta1/token/Token.d.ts +612 -475
  46. package/dist/constructs/v1beta1/user/User.d.ts +1723 -1554
  47. package/dist/constructs/v1beta1/user/UserSchema.js +1 -1
  48. package/dist/constructs/v1beta1/user/UserSchema.mjs +1 -1
  49. package/dist/constructs/v1beta1/view/View.d.ts +833 -664
  50. package/dist/constructs/v1beta1/workspace/Workspace.d.ts +4900 -4695
  51. package/dist/constructs/v1beta2/academy/Academy.d.ts +7840 -7222
  52. package/dist/constructs/v1beta2/academy/AcademySchema.js +1 -1
  53. package/dist/constructs/v1beta2/academy/AcademySchema.mjs +1 -1
  54. package/dist/constructs/v1beta2/badge/Badge.d.ts +610 -453
  55. package/dist/constructs/v1beta2/catalog/Catalog.d.ts +40 -45
  56. package/dist/constructs/v1beta2/component/Component.d.ts +747 -851
  57. package/dist/constructs/v1beta2/connection/Connection.d.ts +1376 -1189
  58. package/dist/constructs/v1beta2/core/Core.d.ts +768 -856
  59. package/dist/constructs/v1beta2/credential/Credential.d.ts +572 -437
  60. package/dist/constructs/v1beta2/design/Design.d.ts +17682 -18467
  61. package/dist/constructs/v1beta2/event/Event.d.ts +946 -575
  62. package/dist/constructs/v1beta2/invitation/Invitation.d.ts +1268 -901
  63. package/dist/constructs/v1beta2/key/Key.d.ts +599 -454
  64. package/dist/constructs/v1beta2/keychain/Keychain.d.ts +806 -585
  65. package/dist/constructs/v1beta2/model/Model.d.ts +610 -636
  66. package/dist/constructs/v1beta2/organization/Organization.d.ts +2135 -1724
  67. package/dist/constructs/v1beta2/plan/Plan.d.ts +169 -128
  68. package/dist/constructs/v1beta2/relationship/Relationship.d.ts +1842 -2011
  69. package/dist/constructs/v1beta2/role/Role.d.ts +940 -695
  70. package/dist/constructs/v1beta2/role/RoleSchema.js +1 -1
  71. package/dist/constructs/v1beta2/role/RoleSchema.mjs +1 -1
  72. package/dist/constructs/v1beta2/schedule/Schedule.d.ts +466 -356
  73. package/dist/constructs/v1beta2/subscription/Subscription.d.ts +866 -701
  74. package/dist/constructs/v1beta2/team/Team.d.ts +1118 -852
  75. package/dist/constructs/v1beta2/token/Token.d.ts +616 -479
  76. package/dist/constructs/v1beta2/user/User.d.ts +1723 -1554
  77. package/dist/constructs/v1beta2/user/UserSchema.js +1 -1
  78. package/dist/constructs/v1beta2/user/UserSchema.mjs +1 -1
  79. package/dist/constructs/v1beta2/view/View.d.ts +838 -669
  80. package/dist/constructs/v1beta3/academy/Academy.d.ts +7844 -7226
  81. package/dist/constructs/v1beta3/academy/AcademySchema.js +1 -1
  82. package/dist/constructs/v1beta3/academy/AcademySchema.mjs +1 -1
  83. package/dist/constructs/v1beta3/component/Component.d.ts +753 -857
  84. package/dist/constructs/v1beta3/connection/Connection.d.ts +1447 -1260
  85. package/dist/constructs/v1beta3/design/Design.d.ts +5729 -5307
  86. package/dist/constructs/v1beta3/design/DesignSchema.js +8 -8
  87. package/dist/constructs/v1beta3/design/DesignSchema.mjs +8 -8
  88. package/dist/constructs/v1beta3/environment/Environment.d.ts +858 -689
  89. package/dist/constructs/v1beta3/event/Event.d.ts +1041 -666
  90. package/dist/constructs/v1beta3/filter/Filter.d.ts +1437 -1299
  91. package/dist/constructs/v1beta3/invitation/Invitation.d.ts +1277 -910
  92. package/dist/constructs/v1beta3/performance_profile/PerformanceProfile.d.ts +850 -690
  93. package/dist/constructs/v1beta3/plan/Plan.d.ts +197 -156
  94. package/dist/constructs/v1beta3/relationship/Relationship.d.ts +1842 -2011
  95. package/dist/constructs/v1beta3/subscription/Subscription.d.ts +969 -804
  96. package/dist/constructs/v1beta3/token/Token.d.ts +616 -479
  97. package/dist/constructs/v1beta3/workspace/Workspace.d.ts +5030 -4822
  98. package/dist/index.d.mts +5520 -5062
  99. package/dist/index.d.ts +5520 -5062
  100. package/dist/mesheryApi.d.mts +1318 -526
  101. package/dist/mesheryApi.d.ts +1318 -526
  102. package/dist/mesheryApi.js +1 -1
  103. package/dist/mesheryApi.mjs +1 -1
  104. package/dist/permissions.d.mts +1 -1
  105. package/dist/permissions.d.ts +1 -1
  106. package/package.json +1 -2
@@ -3,830 +3,742 @@
3
3
  * Do not make direct changes to the file.
4
4
  */
5
5
 
6
- export interface paths {}
7
-
6
+ export type paths = Record<string, never>;
7
+ export type webhooks = Record<string, never>;
8
8
  export interface components {
9
- schemas: {
10
- /** @description A string starting with an alphanumeric character. Spaces and hyphens allowed. */
11
- inputString: string;
12
- /**
13
- * @description API version of the object, optionally prefixed with an API group (e.g. "group.example.io/v1beta1" or bare "v1beta1").
14
- * @example [
15
- * "v1",
16
- * "v1alpha1",
17
- * "v2beta3",
18
- * "v1.custom-suffix",
19
- * "models.meshery.io/v1beta1",
20
- * "capability.meshery.io/v1alpha1"
21
- * ]
22
- */
23
- versionString: string;
24
- /** @description A valid semantic version string between 5 and 100 characters. The pattern allows for a major.minor.patch version followed by an optional pre-release tag like '-alpha' or '-beta.2' and an optional build metadata tag like '+build.1'. */
25
- semverString: string;
26
- /**
27
- * Format: uuid
28
- * @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
29
- */
30
- uuid: string;
31
- /** Format: uuid */
32
- Id: string;
33
- username: string;
34
- /** @description One of (x-oapi-codegen-extra-tags-cloud, github, google) */
35
- provider: string;
36
- /** Format: date-time */
37
- Time: string;
38
- /** Format: date-time */
39
- SqlNullTime: string;
40
- /**
41
- * Format: email
42
- * @description email
43
- */
44
- email: string;
45
- Text: string;
46
- /**
47
- * @description Visibility level of a resource. Controls who can see and access it.
48
- * - `private`: Only the owner and explicitly shared users can access.
49
- * - `public`: Anyone in the organization (or anonymous, depending on resource) can discover and access.
50
- * - `published`: Promoted to the catalog for broad discovery beyond the owning organization.
51
- *
52
- * @enum {string}
53
- */
54
- Visibility: "private" | "public" | "published";
55
- number: number;
56
- /** @description Link for profile picture */
57
- avatar_url: string;
58
- MapObject: { [key: string]: string };
59
- status: string;
60
- bio: string;
61
- accepted_terms_at: string;
62
- emails: string[];
63
- user_ids: string[];
64
- /** Format: int32 */
65
- price: number;
66
- /** @description endpoint */
67
- Endpoint: string;
68
- roleNames: string[];
69
- recordsPage: {
70
- page?: number;
71
- page_size?: number;
72
- records_total?: number;
73
- recordType?: string;
74
- };
75
- resultsPage: {
76
- page?: number;
77
- page_size?: number;
78
- total_count?: number;
79
- resultType?: string;
80
- };
81
- /** @description Body for empty request */
82
- empty: { [key: string]: unknown };
83
- email_preference: {
84
- welcome_email?: boolean;
85
- notify_role_change?: boolean;
86
- };
87
- /** Format: uuid */
88
- user_uuid: string;
89
- /** Format: uuid */
90
- organization_id: string;
91
- /** Format: uuid */
92
- general_id: string;
93
- /** Format: uuid */
94
- environment_id: string;
95
- /** Format: uuid */
96
- workspace_id: string;
97
- /** Format: uuid */
98
- view_id: string;
99
- /** Format: uuid */
100
- team_id: string;
101
- /** Format: uuid */
102
- design_id: string;
103
- /** Format: uuid */
104
- credential_uuid: string;
105
- /** Format: uuid */
106
- meshery_instance_uuid: string;
107
- /** Format: uuid */
108
- kubernetes_server_uuid: string;
109
- /** Format: uuid */
110
- system_id: string;
111
- /** Format: uuid */
112
- operation_id: string;
113
- /** @description user's email or username */
114
- user_id: string;
115
- /**
116
- * Format: date-time
117
- * @description Timestamp when the resource was created.
118
- */
119
- created_at: string;
120
- /**
121
- * Format: date-time
122
- * @description Timestamp when the resource was updated.
123
- */
124
- updated_at: string;
125
- /**
126
- * Format: date-time
127
- * @description Timestamp when the resource was deleted.
128
- */
129
- deleted_at: string;
130
- /**
131
- * Format: date-time
132
- * @description SQL null Timestamp to handle null values of time.
133
- */
134
- nullTime: string;
135
- /** @description Common styles for all entities */
136
- styles: {
137
- /** @description Primary color of the component used for UI representation. */
138
- primaryColor: string;
139
- /** @description Secondary color of the entity used for UI representation. */
140
- secondaryColor?: string;
141
- /** @description White SVG of the entity used for UI representation on dark background. */
142
- svgWhite: string;
143
- /** @description Colored SVG of the entity used for UI representation on light background. */
144
- svgColor: string;
145
- /** @description Complete SVG of the entity used for UI representation, often inclusive of background. */
146
- svgComplete: string;
147
- /** @description The color of the element's label. Colours may be specified by name (e.g. red), hex (e.g. */
148
- color?: string;
149
- /** @description The opacity of the label text, including its outline. */
150
- "text-opacity"?: number;
151
- /** @description A comma-separated list of font names to use on the label text. */
152
- "font-family"?: string;
153
- /** @description The size of the label text. */
154
- "font-size"?: string;
155
- /** @description A CSS font style to be applied to the label text. */
156
- "font-style"?: string;
157
- /** @description A CSS font weight to be applied to the label text. */
158
- "font-weight"?: string;
159
- /**
160
- * @description A transformation to apply to the label text
161
- * @enum {string}
162
- */
163
- "text-transform"?: "none" | "uppercase" | "lowercase";
164
- /** @description The opacity of the element, ranging from 0 to 1. Note that the opacity of a compound node parent affects the effective opacity of its children. */
165
- opacity?: number;
166
- /** @description An integer value that affects the relative draw order of elements. In general, an element with a higher z-index will be drawn on top of an element with a lower z-index. Note that edges are under nodes despite z-index. */
167
- "z-index"?: number;
168
- /** @description The text to display for an element's label. Can give a path, e.g. data(id) will label with the elements id */
169
- label?: string;
170
- /** @description The animation to apply to the element. example ripple,bounce,etc */
171
- animation?: { [key: string]: unknown };
172
- } & { [key: string]: unknown };
173
- /**
174
- * @description The shape of the node's body. Note that each shape fits within the specified width and height, and so you may have to adjust width and height if you desire an equilateral shape (i.e. width !== height for several equilateral shapes)
175
- * @enum {string}
176
- */
177
- shape:
178
- | "ellipse"
179
- | "triangle"
180
- | "round-triangle"
181
- | "rectangle"
182
- | "round-rectangle"
183
- | "bottom-round-rectangle"
184
- | "cut-rectangle"
185
- | "barrel"
186
- | "rhomboid"
187
- | "diamond"
188
- | "round-diamond"
189
- | "pentagon"
190
- | "round-pentagon"
191
- | "hexagon"
192
- | "round-hexagon"
193
- | "concave-hexagon"
194
- | "heptagon"
195
- | "round-heptagon"
196
- | "octagon"
197
- | "round-octagon"
198
- | "star"
199
- | "tag"
200
- | "round-tag"
201
- | "vee"
202
- | "polygon";
203
- /** @description Visualization styles for a relationship */
204
- edgeStyles: ({
205
- /** @description Primary color of the component used for UI representation. */
206
- primaryColor: string;
207
- /** @description Secondary color of the entity used for UI representation. */
208
- secondaryColor?: string;
209
- /** @description White SVG of the entity used for UI representation on dark background. */
210
- svgWhite: string;
211
- /** @description Colored SVG of the entity used for UI representation on light background. */
212
- svgColor: string;
213
- /** @description Complete SVG of the entity used for UI representation, often inclusive of background. */
214
- svgComplete: string;
215
- /** @description The color of the element's label. Colours may be specified by name (e.g. red), hex (e.g. */
216
- color?: string;
217
- /** @description The opacity of the label text, including its outline. */
218
- "text-opacity"?: number;
219
- /** @description A comma-separated list of font names to use on the label text. */
220
- "font-family"?: string;
221
- /** @description The size of the label text. */
222
- "font-size"?: string;
223
- /** @description A CSS font style to be applied to the label text. */
224
- "font-style"?: string;
225
- /** @description A CSS font weight to be applied to the label text. */
226
- "font-weight"?: string;
227
- /**
228
- * @description A transformation to apply to the label text
229
- * @enum {string}
230
- */
231
- "text-transform"?: "none" | "uppercase" | "lowercase";
232
- /** @description The opacity of the element, ranging from 0 to 1. Note that the opacity of a compound node parent affects the effective opacity of its children. */
233
- opacity?: number;
234
- /** @description An integer value that affects the relative draw order of elements. In general, an element with a higher z-index will be drawn on top of an element with a lower z-index. Note that edges are under nodes despite z-index. */
235
- "z-index"?: number;
236
- /** @description The text to display for an element's label. Can give a path, e.g. data(id) will label with the elements id */
237
- label?: string;
238
- /** @description The animation to apply to the element. example ripple,bounce,etc */
239
- animation?: { [key: string]: unknown };
240
- } & { [key: string]: unknown }) & {
241
- /** @description The animation to use for the edge. Can be like 'marching-ants' , 'blink' , 'moving-gradient',etc . */
242
- "edge-animation"?: string;
243
- /**
244
- * @description The curving method used to separate two or more edges between two nodes; may be haystack (very fast, bundled straight edges for which loops and compounds are unsupported), straight (straight edges with all arrows supported), bezier (bundled curved edges), unbundled-bezier (curved edges for use with manual control points), segments (a series of straight lines), taxi (right-angled lines, hierarchically bundled). Note that haystack edges work best with ellipse, rectangle, or similar nodes. Smaller node shapes, like triangle, will not be as aesthetically pleasing. Also note that edge endpoint arrows are unsupported for haystack edges.
245
- * @default straight
246
- * @enum {string}
247
- */
248
- "curve-style"?:
249
- | "straight"
250
- | "haystack"
251
- | "bezier"
252
- | "unbundled-bezier"
253
- | "segments"
254
- | "taxi";
255
- /** @description The colour of the edge's line. Colours may be specified by name (e.g. red), hex (e.g. */
256
- "line-color"?: string;
257
- /**
258
- * @description The style of the edge's line.
259
- * @enum {string}
260
- */
261
- "line-style"?: "solid" | "dotted" | "dashed";
262
- /**
263
- * @description The cap style of the edge's line; may be butt (default), round, or square. The cap may or may not be visible, depending on the shape of the node and the relative size of the node and edge. Caps other than butt extend beyond the specified endpoint of the edge.
264
- * @default butt
265
- * @enum {string}
266
- */
267
- "line-cap"?: "butt" | "round" | "square";
268
- /**
269
- * @description The opacity of the edge's line and arrow. Useful if you wish to have a separate opacity for the edge label versus the edge line. Note that the opacity value of the edge element affects the effective opacity of its line and label subcomponents.
270
- * @default 1
271
- */
272
- "line-opacity"?: number;
273
- /** @description The colour of the edge's source arrow. Colours may be specified by name (e.g. red), hex (e.g. */
274
- "target-arrow-color"?: string;
275
- /**
276
- * @description The shape of the edge's source arrow
277
- * @enum {string}
278
- */
279
- "target-arrow-shape"?:
280
- | "triangle"
281
- | "triangle-tee"
282
- | "circle-triangle"
283
- | "triangle-cross"
284
- | "triangle-backcurve"
285
- | "vee"
286
- | "tee"
287
- | "square"
288
- | "circle"
289
- | "diamond"
290
- | "chevron"
291
- | "none";
292
- /**
293
- * @description The fill state of the edge's source arrow
294
- * @enum {string}
295
- */
296
- "target-arrow-fill"?: "filled" | "hollow";
297
- /** @description The colour of the edge's source arrow. Colours may be specified by name (e.g. red), hex (e.g. */
298
- "mid-target-arrow-color"?: string;
299
- /**
300
- * @description The shape of the edge's source arrow
301
- * @enum {string}
302
- */
303
- "mid-target-arrow-shape"?:
304
- | "triangle"
305
- | "triangle-tee"
306
- | "circle-triangle"
307
- | "triangle-cross"
308
- | "triangle-backcurve"
309
- | "vee"
310
- | "tee"
311
- | "square"
312
- | "circle"
313
- | "diamond"
314
- | "chevron"
315
- | "none";
316
- /**
317
- * @description The fill state of the edge's source arrow
318
- * @enum {string}
319
- */
320
- "mid-target-arrow-fill"?: "filled" | "hollow";
321
- /** @description Scaling for the arrow size. */
322
- "arrow-scale"?: number;
323
- /** @description The text to display for an edge's source label. Can give a path, e.g. data(id) will label with the elements id */
324
- "source-label"?: string;
325
- /** @description The text to display for an edge's target label. Can give a path, e.g. data(id) will label with the elements id */
326
- "target-label"?: string;
327
- };
328
- /** @description Visualization styles for a component */
329
- componentStyles: ({
330
- /** @description Primary color of the component used for UI representation. */
331
- primaryColor: string;
332
- /** @description Secondary color of the entity used for UI representation. */
333
- secondaryColor?: string;
334
- /** @description White SVG of the entity used for UI representation on dark background. */
335
- svgWhite: string;
336
- /** @description Colored SVG of the entity used for UI representation on light background. */
337
- svgColor: string;
338
- /** @description Complete SVG of the entity used for UI representation, often inclusive of background. */
339
- svgComplete: string;
340
- /** @description The color of the element's label. Colours may be specified by name (e.g. red), hex (e.g. */
341
- color?: string;
342
- /** @description The opacity of the label text, including its outline. */
343
- "text-opacity"?: number;
344
- /** @description A comma-separated list of font names to use on the label text. */
345
- "font-family"?: string;
346
- /** @description The size of the label text. */
347
- "font-size"?: string;
348
- /** @description A CSS font style to be applied to the label text. */
349
- "font-style"?: string;
350
- /** @description A CSS font weight to be applied to the label text. */
351
- "font-weight"?: string;
352
- /**
353
- * @description A transformation to apply to the label text
354
- * @enum {string}
355
- */
356
- "text-transform"?: "none" | "uppercase" | "lowercase";
357
- /** @description The opacity of the element, ranging from 0 to 1. Note that the opacity of a compound node parent affects the effective opacity of its children. */
358
- opacity?: number;
359
- /** @description An integer value that affects the relative draw order of elements. In general, an element with a higher z-index will be drawn on top of an element with a lower z-index. Note that edges are under nodes despite z-index. */
360
- "z-index"?: number;
361
- /** @description The text to display for an element's label. Can give a path, e.g. data(id) will label with the elements id */
362
- label?: string;
363
- /** @description The animation to apply to the element. example ripple,bounce,etc */
364
- animation?: { [key: string]: unknown };
365
- } & { [key: string]: unknown }) & {
366
- /**
367
- * @description The shape of the node's body. Note that each shape fits within the specified width and height, and so you may have to adjust width and height if you desire an equilateral shape (i.e. width !== height for several equilateral shapes)
368
- * @enum {string}
369
- */
370
- shape?:
371
- | "ellipse"
372
- | "triangle"
373
- | "round-triangle"
374
- | "rectangle"
375
- | "round-rectangle"
376
- | "bottom-round-rectangle"
377
- | "cut-rectangle"
378
- | "barrel"
379
- | "rhomboid"
380
- | "diamond"
381
- | "round-diamond"
382
- | "pentagon"
383
- | "round-pentagon"
384
- | "hexagon"
385
- | "round-hexagon"
386
- | "concave-hexagon"
387
- | "heptagon"
388
- | "round-heptagon"
389
- | "octagon"
390
- | "round-octagon"
391
- | "star"
392
- | "tag"
393
- | "round-tag"
394
- | "vee"
395
- | "polygon";
396
- /** @description The position of the node. If the position is set, the node is drawn at that position in the given dimensions. If the position is not set, the node is drawn at a random position. */
397
- position?: {
398
- /** @description The x-coordinate of the node. */
399
- x: number;
400
- /** @description The y-coordinate of the node. */
401
- y: number;
402
- };
403
- /** @description The text to display for an element's body. Can give a path, e.g. data(id) will label with the elements id */
404
- "body-text"?: string;
405
- /** @description How to wrap the text in the node. Can be 'none', 'wrap', or 'ellipsis'. */
406
- "body-text-wrap"?: string;
407
- /** @description The maximum width for wrapping text in the node. */
408
- "body-text-max-width"?: string;
409
- /** @description The opacity of the node's body text, including its outline. */
410
- "body-text-opacity"?: number;
411
- /** @description The colour of the node's body text background. Colours may be specified by name (e.g. red), hex (e.g. */
412
- "body-text-background-color"?: string;
413
- /** @description The size of the node's body text. */
414
- "body-text-font-size"?: number;
415
- /** @description The colour of the node's body text. Colours may be specified by name (e.g. red), hex (e.g. */
416
- "body-text-color"?: string;
417
- /** @description A CSS font weight to be applied to the node's body text. */
418
- "body-text-font-weight"?: string;
419
- /** @description A CSS horizontal alignment to be applied to the node's body text. */
420
- "body-text-horizontal-align"?: string;
421
- /** @description A CSS text decoration to be applied to the node's body text. */
422
- "body-text-decoration"?: string;
423
- /** @description A CSS vertical alignment to be applied to the node's body text. */
424
- "body-text-vertical-align"?: string;
425
- /** @description The width of the node's body or the width of an edge's line. */
426
- width?: number;
427
- /** @description The height of the node's body */
428
- height?: number;
429
- /** @description The URL that points to the image to show in the node. */
430
- "background-image"?: string;
431
- /** @description The colour of the node's body. Colours may be specified by name (e.g. red), hex (e.g. */
432
- "background-color"?: string;
433
- /** @description Blackens the node's body for values from 0 to 1; whitens the node's body for values from 0 to -1. */
434
- "background-blacken"?: number;
435
- /** @description The opacity level of the node's background colour */
436
- "background-opacity"?: number;
437
- /** @description The x position of the background image, measured in percent (e.g. 50%) or pixels (e.g. 10px) */
438
- "background-position-x"?: string;
439
- /** @description The y position of the background image, measured in percent (e.g. 50%) or pixels (e.g. 10px) */
440
- "background-position-y"?: string;
441
- /** @description The x offset of the background image, measured in percent (e.g. 50%) or pixels (e.g. 10px) */
442
- "background-offset-x"?: string;
443
- /** @description The y offset of the background image, measured in percent (e.g. 50%) or pixels (e.g. 10px) */
444
- "background-offset-y"?: string;
445
- /** @description How the background image is fit to the node. Can be 'none', 'contain', or 'cover'. */
446
- "background-fit"?: string;
447
- /** @description How the background image is clipped to the node. Can be 'none', 'node', or 'node-border'. */
448
- "background-clip"?: string;
449
- /** @description How the background image's width is determined. Can be 'none', 'inner', or 'outer'. */
450
- "background-width-relative-to"?: string;
451
- /** @description How the background image's height is determined. Can be 'none', 'inner', or 'outer'. */
452
- "background-height-relative-to"?: string;
453
- /** @description The size of the node's border. */
454
- "border-width"?: number;
455
- /**
456
- * @description The style of the node's border
457
- * @enum {string}
458
- */
459
- "border-style"?: "solid" | "dotted" | "dashed" | "double";
460
- /** @description The colour of the node's border. Colours may be specified by name (e.g. red), hex (e.g. */
461
- "border-color"?: string;
462
- /** @description The opacity of the node's border */
463
- "border-opacity"?: number;
464
- /** @description The amount of padding around all sides of the node. */
465
- padding?: number;
466
- /**
467
- * @description The horizontal alignment of a node's label
468
- * @enum {string}
469
- */
470
- "text-halign"?: "left" | "center" | "right";
471
- /**
472
- * @description The vertical alignment of a node's label
473
- * @enum {string}
474
- */
475
- "text-valign"?: "top" | "center" | "bottom";
476
- /**
477
- * @description Whether to use the ghost effect, a semitransparent duplicate of the element drawn at an offset.
478
- * @default no
479
- * @enum {string}
480
- */
481
- ghost?: "yes" | "no";
482
- /** @description The colour of the indicator shown when the background is grabbed by the user. Selector needs to be *core*. Colours may be specified by name (e.g. red), hex (e.g. */
483
- "active-bg-color"?: string;
484
- /** @description The opacity of the active background indicator. Selector needs to be *core*. */
485
- "active-bg-opacity"?: string;
486
- /** @description The opacity of the active background indicator. Selector needs to be *core*. */
487
- "active-bg-size"?: string;
488
- /** @description The background colour of the selection box used for drag selection. Selector needs to be *core*. Colours may be specified by name (e.g. red), hex (e.g. */
489
- "selection-box-color"?: string;
490
- /** @description The size of the border on the selection box. Selector needs to be *core* */
491
- "selection-box-border-width"?: number;
492
- /** @description The opacity of the selection box. Selector needs to be *core* */
493
- "selection-box-opacity"?: number;
494
- /** @description The colour of the area outside the viewport texture when initOptions.textureOnViewport === true. Selector needs to be *core*. Colours may be specified by name (e.g. red), hex (e.g. */
495
- "outside-texture-bg-color"?: string;
496
- /** @description The opacity of the area outside the viewport texture. Selector needs to be *core* */
497
- "outside-texture-bg-opacity"?: number;
498
- /** @description An array (or a space-separated string) of numbers ranging on [-1, 1], representing alternating x and y values (i.e. x1 y1 x2 y2, x3 y3 ...). This represents the points in the polygon for the node's shape. The bounding box of the node is given by (-1, -1), (1, -1), (1, 1), (-1, 1). The node's position is the origin (0, 0 ) */
499
- "shape-polygon-points"?: string;
500
- /** @description The colour of the background of the component menu. Colours may be specified by name (e.g. red), hex (e.g. */
501
- "menu-background-color"?: string;
502
- /** @description The opacity of the background of the component menu. */
503
- "menu-background-opacity"?: number;
504
- /** @description The colour of the text or icons in the component menu. Colours may be specified by name (e.g. red), hex (e.g. */
505
- "menu-forground-color"?: string;
506
- } & {
507
- shape: unknown;
508
- primaryColor: unknown;
509
- svgColor: unknown;
510
- svgWhite: unknown;
511
- svgComplete: unknown;
512
- };
513
- relationshipStyles:
514
- | (({
515
- /** @description Primary color of the component used for UI representation. */
516
- primaryColor: string;
517
- /** @description Secondary color of the entity used for UI representation. */
518
- secondaryColor?: string;
519
- /** @description White SVG of the entity used for UI representation on dark background. */
520
- svgWhite: string;
521
- /** @description Colored SVG of the entity used for UI representation on light background. */
522
- svgColor: string;
523
- /** @description Complete SVG of the entity used for UI representation, often inclusive of background. */
524
- svgComplete: string;
525
- /** @description The color of the element's label. Colours may be specified by name (e.g. red), hex (e.g. */
526
- color?: string;
527
- /** @description The opacity of the label text, including its outline. */
528
- "text-opacity"?: number;
529
- /** @description A comma-separated list of font names to use on the label text. */
530
- "font-family"?: string;
531
- /** @description The size of the label text. */
532
- "font-size"?: string;
533
- /** @description A CSS font style to be applied to the label text. */
534
- "font-style"?: string;
535
- /** @description A CSS font weight to be applied to the label text. */
536
- "font-weight"?: string;
537
- /**
538
- * @description A transformation to apply to the label text
539
- * @enum {string}
540
- */
541
- "text-transform"?: "none" | "uppercase" | "lowercase";
542
- /** @description The opacity of the element, ranging from 0 to 1. Note that the opacity of a compound node parent affects the effective opacity of its children. */
543
- opacity?: number;
544
- /** @description An integer value that affects the relative draw order of elements. In general, an element with a higher z-index will be drawn on top of an element with a lower z-index. Note that edges are under nodes despite z-index. */
545
- "z-index"?: number;
546
- /** @description The text to display for an element's label. Can give a path, e.g. data(id) will label with the elements id */
547
- label?: string;
548
- /** @description The animation to apply to the element. example ripple,bounce,etc */
549
- animation?: { [key: string]: unknown };
550
- } & { [key: string]: unknown }) & {
551
- /** @description The animation to use for the edge. Can be like 'marching-ants' , 'blink' , 'moving-gradient',etc . */
552
- "edge-animation"?: string;
553
- /**
554
- * @description The curving method used to separate two or more edges between two nodes; may be haystack (very fast, bundled straight edges for which loops and compounds are unsupported), straight (straight edges with all arrows supported), bezier (bundled curved edges), unbundled-bezier (curved edges for use with manual control points), segments (a series of straight lines), taxi (right-angled lines, hierarchically bundled). Note that haystack edges work best with ellipse, rectangle, or similar nodes. Smaller node shapes, like triangle, will not be as aesthetically pleasing. Also note that edge endpoint arrows are unsupported for haystack edges.
555
- * @default straight
556
- * @enum {string}
557
- */
558
- "curve-style"?:
559
- | "straight"
560
- | "haystack"
561
- | "bezier"
562
- | "unbundled-bezier"
563
- | "segments"
564
- | "taxi";
565
- /** @description The colour of the edge's line. Colours may be specified by name (e.g. red), hex (e.g. */
566
- "line-color"?: string;
567
- /**
568
- * @description The style of the edge's line.
569
- * @enum {string}
570
- */
571
- "line-style"?: "solid" | "dotted" | "dashed";
572
- /**
573
- * @description The cap style of the edge's line; may be butt (default), round, or square. The cap may or may not be visible, depending on the shape of the node and the relative size of the node and edge. Caps other than butt extend beyond the specified endpoint of the edge.
574
- * @default butt
575
- * @enum {string}
576
- */
577
- "line-cap"?: "butt" | "round" | "square";
578
- /**
579
- * @description The opacity of the edge's line and arrow. Useful if you wish to have a separate opacity for the edge label versus the edge line. Note that the opacity value of the edge element affects the effective opacity of its line and label subcomponents.
580
- * @default 1
581
- */
582
- "line-opacity"?: number;
583
- /** @description The colour of the edge's source arrow. Colours may be specified by name (e.g. red), hex (e.g. */
584
- "target-arrow-color"?: string;
585
- /**
586
- * @description The shape of the edge's source arrow
587
- * @enum {string}
588
- */
589
- "target-arrow-shape"?:
590
- | "triangle"
591
- | "triangle-tee"
592
- | "circle-triangle"
593
- | "triangle-cross"
594
- | "triangle-backcurve"
595
- | "vee"
596
- | "tee"
597
- | "square"
598
- | "circle"
599
- | "diamond"
600
- | "chevron"
601
- | "none";
602
- /**
603
- * @description The fill state of the edge's source arrow
604
- * @enum {string}
605
- */
606
- "target-arrow-fill"?: "filled" | "hollow";
607
- /** @description The colour of the edge's source arrow. Colours may be specified by name (e.g. red), hex (e.g. */
608
- "mid-target-arrow-color"?: string;
609
- /**
610
- * @description The shape of the edge's source arrow
611
- * @enum {string}
612
- */
613
- "mid-target-arrow-shape"?:
614
- | "triangle"
615
- | "triangle-tee"
616
- | "circle-triangle"
617
- | "triangle-cross"
618
- | "triangle-backcurve"
619
- | "vee"
620
- | "tee"
621
- | "square"
622
- | "circle"
623
- | "diamond"
624
- | "chevron"
625
- | "none";
626
- /**
627
- * @description The fill state of the edge's source arrow
628
- * @enum {string}
629
- */
630
- "mid-target-arrow-fill"?: "filled" | "hollow";
631
- /** @description Scaling for the arrow size. */
632
- "arrow-scale"?: number;
633
- /** @description The text to display for an edge's source label. Can give a path, e.g. data(id) will label with the elements id */
634
- "source-label"?: string;
635
- /** @description The text to display for an edge's target label. Can give a path, e.g. data(id) will label with the elements id */
636
- "target-label"?: string;
637
- })
638
- | (({
639
- /** @description Primary color of the component used for UI representation. */
640
- primaryColor: string;
641
- /** @description Secondary color of the entity used for UI representation. */
642
- secondaryColor?: string;
643
- /** @description White SVG of the entity used for UI representation on dark background. */
644
- svgWhite: string;
645
- /** @description Colored SVG of the entity used for UI representation on light background. */
646
- svgColor: string;
647
- /** @description Complete SVG of the entity used for UI representation, often inclusive of background. */
648
- svgComplete: string;
649
- /** @description The color of the element's label. Colours may be specified by name (e.g. red), hex (e.g. */
650
- color?: string;
651
- /** @description The opacity of the label text, including its outline. */
652
- "text-opacity"?: number;
653
- /** @description A comma-separated list of font names to use on the label text. */
654
- "font-family"?: string;
655
- /** @description The size of the label text. */
656
- "font-size"?: string;
657
- /** @description A CSS font style to be applied to the label text. */
658
- "font-style"?: string;
659
- /** @description A CSS font weight to be applied to the label text. */
660
- "font-weight"?: string;
661
- /**
662
- * @description A transformation to apply to the label text
663
- * @enum {string}
664
- */
665
- "text-transform"?: "none" | "uppercase" | "lowercase";
666
- /** @description The opacity of the element, ranging from 0 to 1. Note that the opacity of a compound node parent affects the effective opacity of its children. */
667
- opacity?: number;
668
- /** @description An integer value that affects the relative draw order of elements. In general, an element with a higher z-index will be drawn on top of an element with a lower z-index. Note that edges are under nodes despite z-index. */
669
- "z-index"?: number;
670
- /** @description The text to display for an element's label. Can give a path, e.g. data(id) will label with the elements id */
671
- label?: string;
672
- /** @description The animation to apply to the element. example ripple,bounce,etc */
673
- animation?: { [key: string]: unknown };
674
- } & { [key: string]: unknown }) & { [key: string]: unknown });
675
- /** @description An alias is an component that acts as an ref/pointer to a field in another component, nonResolvedAlias are not aware of there immediate parents */
676
- NonResolvedAlias: {
677
- /**
678
- * Format: uuid
679
- * @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
680
- */
681
- relationship_id: string;
682
- /**
683
- * Format: uuid
684
- * @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
685
- */
686
- alias_component_id: string;
687
- /**
688
- * Format: uuid
689
- * @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
690
- */
691
- immediate_parent_id: string;
692
- immediate_ref_field_path: string[];
693
- };
694
- /** @description An resolved alias is an component that acts as an ref/pointer to a field in another component, resolvedAlias are aware of there immediate parents and completely resolved parents also */
695
- ResolvedAlias: {
696
- /**
697
- * Format: uuid
698
- * @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
699
- */
700
- relationship_id: string;
701
- /**
702
- * Format: uuid
703
- * @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
704
- */
705
- alias_component_id: string;
706
- /**
707
- * Format: uuid
708
- * @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
709
- */
710
- immediate_parent_id: string;
711
- immediate_ref_field_path: string[];
712
- } & {
713
- /**
714
- * Format: uuid
715
- * @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
716
- */
717
- resolved_parent_id: string;
718
- resolved_ref_field_path: string[];
9
+ schemas: {
10
+ /** @description A string starting with an alphanumeric character. Spaces and hyphens allowed. */
11
+ inputString: string;
12
+ /**
13
+ * @description API version of the object, optionally prefixed with an API group (e.g. "group.example.io/v1beta1" or bare "v1beta1").
14
+ * @example [
15
+ * "v1",
16
+ * "v1alpha1",
17
+ * "v2beta3",
18
+ * "v1.custom-suffix",
19
+ * "models.meshery.io/v1beta1",
20
+ * "capability.meshery.io/v1alpha1"
21
+ * ]
22
+ */
23
+ versionString: string;
24
+ /** @description A valid semantic version string between 5 and 100 characters. The pattern allows for a major.minor.patch version followed by an optional pre-release tag like '-alpha' or '-beta.2' and an optional build metadata tag like '+build.1'. */
25
+ semverString: string;
26
+ /**
27
+ * Format: uuid
28
+ * @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
29
+ */
30
+ uuid: string;
31
+ /** Format: uuid */
32
+ Id: string;
33
+ username: string;
34
+ /** @description One of (x-oapi-codegen-extra-tags-cloud, github, google) */
35
+ provider: string;
36
+ /** Format: date-time */
37
+ Time: string;
38
+ /** Format: date-time */
39
+ SqlNullTime: string;
40
+ /**
41
+ * Format: email
42
+ * @description email
43
+ */
44
+ email: string;
45
+ Text: string;
46
+ /**
47
+ * @description Visibility level of a resource. Controls who can see and access it.
48
+ * - `private`: Only the owner and explicitly shared users can access.
49
+ * - `public`: Anyone in the organization (or anonymous, depending on resource) can discover and access.
50
+ * - `published`: Promoted to the catalog for broad discovery beyond the owning organization.
51
+ * @enum {string}
52
+ */
53
+ Visibility: "private" | "public" | "published";
54
+ number: number;
55
+ /** @description Link for profile picture */
56
+ avatar_url: string;
57
+ MapObject: {
58
+ [key: string]: string;
59
+ };
60
+ status: string;
61
+ bio: string;
62
+ accepted_terms_at: string;
63
+ emails: string[];
64
+ user_ids: string[];
65
+ /** Format: int32 */
66
+ price: number;
67
+ /** @description endpoint */
68
+ Endpoint: string;
69
+ roleNames: string[];
70
+ recordsPage: {
71
+ page?: number;
72
+ page_size?: number;
73
+ records_total?: number;
74
+ recordType?: string;
75
+ };
76
+ resultsPage: {
77
+ page?: number;
78
+ page_size?: number;
79
+ total_count?: number;
80
+ resultType?: string;
81
+ };
82
+ /** @description Body for empty request */
83
+ empty: Record<string, never>;
84
+ email_preference: {
85
+ welcome_email?: boolean;
86
+ notify_role_change?: boolean;
87
+ };
88
+ /** Format: uuid */
89
+ user_uuid: string;
90
+ /** Format: uuid */
91
+ organization_id: string;
92
+ /** Format: uuid */
93
+ general_id: string;
94
+ /** Format: uuid */
95
+ environment_id: string;
96
+ /** Format: uuid */
97
+ workspace_id: string;
98
+ /** Format: uuid */
99
+ view_id: string;
100
+ /** Format: uuid */
101
+ team_id: string;
102
+ /** Format: uuid */
103
+ design_id: string;
104
+ /** Format: uuid */
105
+ credential_uuid: string;
106
+ /** Format: uuid */
107
+ meshery_instance_uuid: string;
108
+ /** Format: uuid */
109
+ kubernetes_server_uuid: string;
110
+ /** Format: uuid */
111
+ system_id: string;
112
+ /** Format: uuid */
113
+ operation_id: string;
114
+ /** @description user's email or username */
115
+ user_id: string;
116
+ /**
117
+ * Format: date-time
118
+ * @description Timestamp when the resource was created.
119
+ */
120
+ created_at: string;
121
+ /**
122
+ * Format: date-time
123
+ * @description Timestamp when the resource was updated.
124
+ */
125
+ updated_at: string;
126
+ /**
127
+ * Format: date-time
128
+ * @description Timestamp when the resource was deleted.
129
+ */
130
+ deleted_at: string;
131
+ /**
132
+ * Format: date-time
133
+ * @description SQL null Timestamp to handle null values of time.
134
+ */
135
+ nullTime: string;
136
+ /** @description Common styles for all entities */
137
+ styles: {
138
+ /** @description Primary color of the component used for UI representation. */
139
+ primaryColor: string;
140
+ /** @description Secondary color of the entity used for UI representation. */
141
+ secondaryColor?: string;
142
+ /** @description White SVG of the entity used for UI representation on dark background. */
143
+ svgWhite: string;
144
+ /** @description Colored SVG of the entity used for UI representation on light background. */
145
+ svgColor: string;
146
+ /** @description Complete SVG of the entity used for UI representation, often inclusive of background. */
147
+ svgComplete: string;
148
+ /** @description The color of the element's label. Colours may be specified by name (e.g. red), hex (e.g. */
149
+ color?: string;
150
+ /** @description The opacity of the label text, including its outline. */
151
+ "text-opacity"?: number;
152
+ /** @description A comma-separated list of font names to use on the label text. */
153
+ "font-family"?: string;
154
+ /** @description The size of the label text. */
155
+ "font-size"?: string;
156
+ /** @description A CSS font style to be applied to the label text. */
157
+ "font-style"?: string;
158
+ /** @description A CSS font weight to be applied to the label text. */
159
+ "font-weight"?: string;
160
+ /**
161
+ * @description A transformation to apply to the label text
162
+ * @enum {string}
163
+ */
164
+ "text-transform"?: "none" | "uppercase" | "lowercase";
165
+ /** @description The opacity of the element, ranging from 0 to 1. Note that the opacity of a compound node parent affects the effective opacity of its children. */
166
+ opacity?: number;
167
+ /** @description An integer value that affects the relative draw order of elements. In general, an element with a higher z-index will be drawn on top of an element with a lower z-index. Note that edges are under nodes despite z-index. */
168
+ "z-index"?: number;
169
+ /** @description The text to display for an element's label. Can give a path, e.g. data(id) will label with the elements id */
170
+ label?: string;
171
+ /** @description The animation to apply to the element. example ripple,bounce,etc */
172
+ animation?: Record<string, never>;
173
+ } & {
174
+ [key: string]: unknown;
175
+ };
176
+ /**
177
+ * @description The shape of the node's body. Note that each shape fits within the specified width and height, and so you may have to adjust width and height if you desire an equilateral shape (i.e. width !== height for several equilateral shapes)
178
+ * @enum {string}
179
+ */
180
+ shape: "ellipse" | "triangle" | "round-triangle" | "rectangle" | "round-rectangle" | "bottom-round-rectangle" | "cut-rectangle" | "barrel" | "rhomboid" | "diamond" | "round-diamond" | "pentagon" | "round-pentagon" | "hexagon" | "round-hexagon" | "concave-hexagon" | "heptagon" | "round-heptagon" | "octagon" | "round-octagon" | "star" | "tag" | "round-tag" | "vee" | "polygon";
181
+ /** @description Visualization styles for a relationship */
182
+ edgeStyles: ({
183
+ /** @description Primary color of the component used for UI representation. */
184
+ primaryColor: string;
185
+ /** @description Secondary color of the entity used for UI representation. */
186
+ secondaryColor?: string;
187
+ /** @description White SVG of the entity used for UI representation on dark background. */
188
+ svgWhite: string;
189
+ /** @description Colored SVG of the entity used for UI representation on light background. */
190
+ svgColor: string;
191
+ /** @description Complete SVG of the entity used for UI representation, often inclusive of background. */
192
+ svgComplete: string;
193
+ /** @description The color of the element's label. Colours may be specified by name (e.g. red), hex (e.g. */
194
+ color?: string;
195
+ /** @description The opacity of the label text, including its outline. */
196
+ "text-opacity"?: number;
197
+ /** @description A comma-separated list of font names to use on the label text. */
198
+ "font-family"?: string;
199
+ /** @description The size of the label text. */
200
+ "font-size"?: string;
201
+ /** @description A CSS font style to be applied to the label text. */
202
+ "font-style"?: string;
203
+ /** @description A CSS font weight to be applied to the label text. */
204
+ "font-weight"?: string;
205
+ /**
206
+ * @description A transformation to apply to the label text
207
+ * @enum {string}
208
+ */
209
+ "text-transform"?: "none" | "uppercase" | "lowercase";
210
+ /** @description The opacity of the element, ranging from 0 to 1. Note that the opacity of a compound node parent affects the effective opacity of its children. */
211
+ opacity?: number;
212
+ /** @description An integer value that affects the relative draw order of elements. In general, an element with a higher z-index will be drawn on top of an element with a lower z-index. Note that edges are under nodes despite z-index. */
213
+ "z-index"?: number;
214
+ /** @description The text to display for an element's label. Can give a path, e.g. data(id) will label with the elements id */
215
+ label?: string;
216
+ /** @description The animation to apply to the element. example ripple,bounce,etc */
217
+ animation?: Record<string, never>;
218
+ } & {
219
+ [key: string]: unknown;
220
+ }) & {
221
+ /** @description The animation to use for the edge. Can be like 'marching-ants' , 'blink' , 'moving-gradient',etc . */
222
+ "edge-animation"?: string;
223
+ /**
224
+ * @description The curving method used to separate two or more edges between two nodes; may be haystack (very fast, bundled straight edges for which loops and compounds are unsupported), straight (straight edges with all arrows supported), bezier (bundled curved edges), unbundled-bezier (curved edges for use with manual control points), segments (a series of straight lines), taxi (right-angled lines, hierarchically bundled). Note that haystack edges work best with ellipse, rectangle, or similar nodes. Smaller node shapes, like triangle, will not be as aesthetically pleasing. Also note that edge endpoint arrows are unsupported for haystack edges.
225
+ * @default straight
226
+ * @enum {string}
227
+ */
228
+ "curve-style": "straight" | "haystack" | "bezier" | "unbundled-bezier" | "segments" | "taxi";
229
+ /** @description The colour of the edge's line. Colours may be specified by name (e.g. red), hex (e.g. */
230
+ "line-color"?: string;
231
+ /**
232
+ * @description The style of the edge's line.
233
+ * @enum {string}
234
+ */
235
+ "line-style"?: "solid" | "dotted" | "dashed";
236
+ /**
237
+ * @description The cap style of the edge's line; may be butt (default), round, or square. The cap may or may not be visible, depending on the shape of the node and the relative size of the node and edge. Caps other than butt extend beyond the specified endpoint of the edge.
238
+ * @default butt
239
+ * @enum {string}
240
+ */
241
+ "line-cap": "butt" | "round" | "square";
242
+ /**
243
+ * @description The opacity of the edge's line and arrow. Useful if you wish to have a separate opacity for the edge label versus the edge line. Note that the opacity value of the edge element affects the effective opacity of its line and label subcomponents.
244
+ * @default 1
245
+ */
246
+ "line-opacity": number;
247
+ /** @description The colour of the edge's source arrow. Colours may be specified by name (e.g. red), hex (e.g. */
248
+ "target-arrow-color"?: string;
249
+ /**
250
+ * @description The shape of the edge's source arrow
251
+ * @enum {string}
252
+ */
253
+ "target-arrow-shape"?: "triangle" | "triangle-tee" | "circle-triangle" | "triangle-cross" | "triangle-backcurve" | "vee" | "tee" | "square" | "circle" | "diamond" | "chevron" | "none";
254
+ /**
255
+ * @description The fill state of the edge's source arrow
256
+ * @enum {string}
257
+ */
258
+ "target-arrow-fill"?: "filled" | "hollow";
259
+ /** @description The colour of the edge's source arrow. Colours may be specified by name (e.g. red), hex (e.g. */
260
+ "mid-target-arrow-color"?: string;
261
+ /**
262
+ * @description The shape of the edge's source arrow
263
+ * @enum {string}
264
+ */
265
+ "mid-target-arrow-shape"?: "triangle" | "triangle-tee" | "circle-triangle" | "triangle-cross" | "triangle-backcurve" | "vee" | "tee" | "square" | "circle" | "diamond" | "chevron" | "none";
266
+ /**
267
+ * @description The fill state of the edge's source arrow
268
+ * @enum {string}
269
+ */
270
+ "mid-target-arrow-fill"?: "filled" | "hollow";
271
+ /** @description Scaling for the arrow size. */
272
+ "arrow-scale"?: number;
273
+ /** @description The text to display for an edge's source label. Can give a path, e.g. data(id) will label with the elements id */
274
+ "source-label"?: string;
275
+ /** @description The text to display for an edge's target label. Can give a path, e.g. data(id) will label with the elements id */
276
+ "target-label"?: string;
277
+ };
278
+ /** @description Visualization styles for a component */
279
+ componentStyles: ({
280
+ /** @description Primary color of the component used for UI representation. */
281
+ primaryColor: string;
282
+ /** @description Secondary color of the entity used for UI representation. */
283
+ secondaryColor?: string;
284
+ /** @description White SVG of the entity used for UI representation on dark background. */
285
+ svgWhite: string;
286
+ /** @description Colored SVG of the entity used for UI representation on light background. */
287
+ svgColor: string;
288
+ /** @description Complete SVG of the entity used for UI representation, often inclusive of background. */
289
+ svgComplete: string;
290
+ /** @description The color of the element's label. Colours may be specified by name (e.g. red), hex (e.g. */
291
+ color?: string;
292
+ /** @description The opacity of the label text, including its outline. */
293
+ "text-opacity"?: number;
294
+ /** @description A comma-separated list of font names to use on the label text. */
295
+ "font-family"?: string;
296
+ /** @description The size of the label text. */
297
+ "font-size"?: string;
298
+ /** @description A CSS font style to be applied to the label text. */
299
+ "font-style"?: string;
300
+ /** @description A CSS font weight to be applied to the label text. */
301
+ "font-weight"?: string;
302
+ /**
303
+ * @description A transformation to apply to the label text
304
+ * @enum {string}
305
+ */
306
+ "text-transform"?: "none" | "uppercase" | "lowercase";
307
+ /** @description The opacity of the element, ranging from 0 to 1. Note that the opacity of a compound node parent affects the effective opacity of its children. */
308
+ opacity?: number;
309
+ /** @description An integer value that affects the relative draw order of elements. In general, an element with a higher z-index will be drawn on top of an element with a lower z-index. Note that edges are under nodes despite z-index. */
310
+ "z-index"?: number;
311
+ /** @description The text to display for an element's label. Can give a path, e.g. data(id) will label with the elements id */
312
+ label?: string;
313
+ /** @description The animation to apply to the element. example ripple,bounce,etc */
314
+ animation?: Record<string, never>;
315
+ } & {
316
+ [key: string]: unknown;
317
+ }) & {
318
+ /**
319
+ * @description The shape of the node's body. Note that each shape fits within the specified width and height, and so you may have to adjust width and height if you desire an equilateral shape (i.e. width !== height for several equilateral shapes)
320
+ * @enum {string}
321
+ */
322
+ shape: "ellipse" | "triangle" | "round-triangle" | "rectangle" | "round-rectangle" | "bottom-round-rectangle" | "cut-rectangle" | "barrel" | "rhomboid" | "diamond" | "round-diamond" | "pentagon" | "round-pentagon" | "hexagon" | "round-hexagon" | "concave-hexagon" | "heptagon" | "round-heptagon" | "octagon" | "round-octagon" | "star" | "tag" | "round-tag" | "vee" | "polygon";
323
+ /** @description The position of the node. If the position is set, the node is drawn at that position in the given dimensions. If the position is not set, the node is drawn at a random position. */
324
+ position?: {
325
+ /** @description The x-coordinate of the node. */
326
+ x: number;
327
+ /** @description The y-coordinate of the node. */
328
+ y: number;
329
+ };
330
+ /** @description The text to display for an element's body. Can give a path, e.g. data(id) will label with the elements id */
331
+ "body-text"?: string;
332
+ /** @description How to wrap the text in the node. Can be 'none', 'wrap', or 'ellipsis'. */
333
+ "body-text-wrap"?: string;
334
+ /** @description The maximum width for wrapping text in the node. */
335
+ "body-text-max-width"?: string;
336
+ /** @description The opacity of the node's body text, including its outline. */
337
+ "body-text-opacity"?: number;
338
+ /** @description The colour of the node's body text background. Colours may be specified by name (e.g. red), hex (e.g. */
339
+ "body-text-background-color"?: string;
340
+ /** @description The size of the node's body text. */
341
+ "body-text-font-size"?: number;
342
+ /** @description The colour of the node's body text. Colours may be specified by name (e.g. red), hex (e.g. */
343
+ "body-text-color"?: string;
344
+ /** @description A CSS font weight to be applied to the node's body text. */
345
+ "body-text-font-weight"?: string;
346
+ /** @description A CSS horizontal alignment to be applied to the node's body text. */
347
+ "body-text-horizontal-align"?: string;
348
+ /** @description A CSS text decoration to be applied to the node's body text. */
349
+ "body-text-decoration"?: string;
350
+ /** @description A CSS vertical alignment to be applied to the node's body text. */
351
+ "body-text-vertical-align"?: string;
352
+ /** @description The width of the node's body or the width of an edge's line. */
353
+ width?: number;
354
+ /** @description The height of the node's body */
355
+ height?: number;
356
+ /** @description The URL that points to the image to show in the node. */
357
+ "background-image"?: string;
358
+ /** @description The colour of the node's body. Colours may be specified by name (e.g. red), hex (e.g. */
359
+ "background-color"?: string;
360
+ /** @description Blackens the node's body for values from 0 to 1; whitens the node's body for values from 0 to -1. */
361
+ "background-blacken"?: number;
362
+ /** @description The opacity level of the node's background colour */
363
+ "background-opacity"?: number;
364
+ /** @description The x position of the background image, measured in percent (e.g. 50%) or pixels (e.g. 10px) */
365
+ "background-position-x"?: string;
366
+ /** @description The y position of the background image, measured in percent (e.g. 50%) or pixels (e.g. 10px) */
367
+ "background-position-y"?: string;
368
+ /** @description The x offset of the background image, measured in percent (e.g. 50%) or pixels (e.g. 10px) */
369
+ "background-offset-x"?: string;
370
+ /** @description The y offset of the background image, measured in percent (e.g. 50%) or pixels (e.g. 10px) */
371
+ "background-offset-y"?: string;
372
+ /** @description How the background image is fit to the node. Can be 'none', 'contain', or 'cover'. */
373
+ "background-fit"?: string;
374
+ /** @description How the background image is clipped to the node. Can be 'none', 'node', or 'node-border'. */
375
+ "background-clip"?: string;
376
+ /** @description How the background image's width is determined. Can be 'none', 'inner', or 'outer'. */
377
+ "background-width-relative-to"?: string;
378
+ /** @description How the background image's height is determined. Can be 'none', 'inner', or 'outer'. */
379
+ "background-height-relative-to"?: string;
380
+ /** @description The size of the node's border. */
381
+ "border-width"?: number;
382
+ /**
383
+ * @description The style of the node's border
384
+ * @enum {string}
385
+ */
386
+ "border-style"?: "solid" | "dotted" | "dashed" | "double";
387
+ /** @description The colour of the node's border. Colours may be specified by name (e.g. red), hex (e.g. */
388
+ "border-color"?: string;
389
+ /** @description The opacity of the node's border */
390
+ "border-opacity"?: number;
391
+ /** @description The amount of padding around all sides of the node. */
392
+ padding?: number;
393
+ /**
394
+ * @description The horizontal alignment of a node's label
395
+ * @enum {string}
396
+ */
397
+ "text-halign"?: "left" | "center" | "right";
398
+ /**
399
+ * @description The vertical alignment of a node's label
400
+ * @enum {string}
401
+ */
402
+ "text-valign"?: "top" | "center" | "bottom";
403
+ /**
404
+ * @description Whether to use the ghost effect, a semitransparent duplicate of the element drawn at an offset.
405
+ * @default no
406
+ * @enum {string}
407
+ */
408
+ ghost: "yes" | "no";
409
+ /** @description The colour of the indicator shown when the background is grabbed by the user. Selector needs to be *core*. Colours may be specified by name (e.g. red), hex (e.g. */
410
+ "active-bg-color"?: string;
411
+ /** @description The opacity of the active background indicator. Selector needs to be *core*. */
412
+ "active-bg-opacity"?: string;
413
+ /** @description The opacity of the active background indicator. Selector needs to be *core*. */
414
+ "active-bg-size"?: string;
415
+ /** @description The background colour of the selection box used for drag selection. Selector needs to be *core*. Colours may be specified by name (e.g. red), hex (e.g. */
416
+ "selection-box-color"?: string;
417
+ /** @description The size of the border on the selection box. Selector needs to be *core* */
418
+ "selection-box-border-width"?: number;
419
+ /** @description The opacity of the selection box. Selector needs to be *core* */
420
+ "selection-box-opacity"?: number;
421
+ /** @description The colour of the area outside the viewport texture when initOptions.textureOnViewport === true. Selector needs to be *core*. Colours may be specified by name (e.g. red), hex (e.g. */
422
+ "outside-texture-bg-color"?: string;
423
+ /** @description The opacity of the area outside the viewport texture. Selector needs to be *core* */
424
+ "outside-texture-bg-opacity"?: number;
425
+ /** @description An array (or a space-separated string) of numbers ranging on [-1, 1], representing alternating x and y values (i.e. x1 y1 x2 y2, x3 y3 ...). This represents the points in the polygon for the node's shape. The bounding box of the node is given by (-1, -1), (1, -1), (1, 1), (-1, 1). The node's position is the origin (0, 0 ) */
426
+ "shape-polygon-points"?: string;
427
+ /** @description The colour of the background of the component menu. Colours may be specified by name (e.g. red), hex (e.g. */
428
+ "menu-background-color"?: string;
429
+ /** @description The opacity of the background of the component menu. */
430
+ "menu-background-opacity"?: number;
431
+ /** @description The colour of the text or icons in the component menu. Colours may be specified by name (e.g. red), hex (e.g. */
432
+ "menu-forground-color"?: string;
433
+ };
434
+ relationshipStyles: (({
435
+ /** @description Primary color of the component used for UI representation. */
436
+ primaryColor: string;
437
+ /** @description Secondary color of the entity used for UI representation. */
438
+ secondaryColor?: string;
439
+ /** @description White SVG of the entity used for UI representation on dark background. */
440
+ svgWhite: string;
441
+ /** @description Colored SVG of the entity used for UI representation on light background. */
442
+ svgColor: string;
443
+ /** @description Complete SVG of the entity used for UI representation, often inclusive of background. */
444
+ svgComplete: string;
445
+ /** @description The color of the element's label. Colours may be specified by name (e.g. red), hex (e.g. */
446
+ color?: string;
447
+ /** @description The opacity of the label text, including its outline. */
448
+ "text-opacity"?: number;
449
+ /** @description A comma-separated list of font names to use on the label text. */
450
+ "font-family"?: string;
451
+ /** @description The size of the label text. */
452
+ "font-size"?: string;
453
+ /** @description A CSS font style to be applied to the label text. */
454
+ "font-style"?: string;
455
+ /** @description A CSS font weight to be applied to the label text. */
456
+ "font-weight"?: string;
457
+ /**
458
+ * @description A transformation to apply to the label text
459
+ * @enum {string}
460
+ */
461
+ "text-transform"?: "none" | "uppercase" | "lowercase";
462
+ /** @description The opacity of the element, ranging from 0 to 1. Note that the opacity of a compound node parent affects the effective opacity of its children. */
463
+ opacity?: number;
464
+ /** @description An integer value that affects the relative draw order of elements. In general, an element with a higher z-index will be drawn on top of an element with a lower z-index. Note that edges are under nodes despite z-index. */
465
+ "z-index"?: number;
466
+ /** @description The text to display for an element's label. Can give a path, e.g. data(id) will label with the elements id */
467
+ label?: string;
468
+ /** @description The animation to apply to the element. example ripple,bounce,etc */
469
+ animation?: Record<string, never>;
470
+ } & {
471
+ [key: string]: unknown;
472
+ }) & {
473
+ /** @description The animation to use for the edge. Can be like 'marching-ants' , 'blink' , 'moving-gradient',etc . */
474
+ "edge-animation"?: string;
475
+ /**
476
+ * @description The curving method used to separate two or more edges between two nodes; may be haystack (very fast, bundled straight edges for which loops and compounds are unsupported), straight (straight edges with all arrows supported), bezier (bundled curved edges), unbundled-bezier (curved edges for use with manual control points), segments (a series of straight lines), taxi (right-angled lines, hierarchically bundled). Note that haystack edges work best with ellipse, rectangle, or similar nodes. Smaller node shapes, like triangle, will not be as aesthetically pleasing. Also note that edge endpoint arrows are unsupported for haystack edges.
477
+ * @default straight
478
+ * @enum {string}
479
+ */
480
+ "curve-style": "straight" | "haystack" | "bezier" | "unbundled-bezier" | "segments" | "taxi";
481
+ /** @description The colour of the edge's line. Colours may be specified by name (e.g. red), hex (e.g. */
482
+ "line-color"?: string;
483
+ /**
484
+ * @description The style of the edge's line.
485
+ * @enum {string}
486
+ */
487
+ "line-style"?: "solid" | "dotted" | "dashed";
488
+ /**
489
+ * @description The cap style of the edge's line; may be butt (default), round, or square. The cap may or may not be visible, depending on the shape of the node and the relative size of the node and edge. Caps other than butt extend beyond the specified endpoint of the edge.
490
+ * @default butt
491
+ * @enum {string}
492
+ */
493
+ "line-cap": "butt" | "round" | "square";
494
+ /**
495
+ * @description The opacity of the edge's line and arrow. Useful if you wish to have a separate opacity for the edge label versus the edge line. Note that the opacity value of the edge element affects the effective opacity of its line and label subcomponents.
496
+ * @default 1
497
+ */
498
+ "line-opacity": number;
499
+ /** @description The colour of the edge's source arrow. Colours may be specified by name (e.g. red), hex (e.g. */
500
+ "target-arrow-color"?: string;
501
+ /**
502
+ * @description The shape of the edge's source arrow
503
+ * @enum {string}
504
+ */
505
+ "target-arrow-shape"?: "triangle" | "triangle-tee" | "circle-triangle" | "triangle-cross" | "triangle-backcurve" | "vee" | "tee" | "square" | "circle" | "diamond" | "chevron" | "none";
506
+ /**
507
+ * @description The fill state of the edge's source arrow
508
+ * @enum {string}
509
+ */
510
+ "target-arrow-fill"?: "filled" | "hollow";
511
+ /** @description The colour of the edge's source arrow. Colours may be specified by name (e.g. red), hex (e.g. */
512
+ "mid-target-arrow-color"?: string;
513
+ /**
514
+ * @description The shape of the edge's source arrow
515
+ * @enum {string}
516
+ */
517
+ "mid-target-arrow-shape"?: "triangle" | "triangle-tee" | "circle-triangle" | "triangle-cross" | "triangle-backcurve" | "vee" | "tee" | "square" | "circle" | "diamond" | "chevron" | "none";
518
+ /**
519
+ * @description The fill state of the edge's source arrow
520
+ * @enum {string}
521
+ */
522
+ "mid-target-arrow-fill"?: "filled" | "hollow";
523
+ /** @description Scaling for the arrow size. */
524
+ "arrow-scale"?: number;
525
+ /** @description The text to display for an edge's source label. Can give a path, e.g. data(id) will label with the elements id */
526
+ "source-label"?: string;
527
+ /** @description The text to display for an edge's target label. Can give a path, e.g. data(id) will label with the elements id */
528
+ "target-label"?: string;
529
+ }) | (({
530
+ /** @description Primary color of the component used for UI representation. */
531
+ primaryColor: string;
532
+ /** @description Secondary color of the entity used for UI representation. */
533
+ secondaryColor?: string;
534
+ /** @description White SVG of the entity used for UI representation on dark background. */
535
+ svgWhite: string;
536
+ /** @description Colored SVG of the entity used for UI representation on light background. */
537
+ svgColor: string;
538
+ /** @description Complete SVG of the entity used for UI representation, often inclusive of background. */
539
+ svgComplete: string;
540
+ /** @description The color of the element's label. Colours may be specified by name (e.g. red), hex (e.g. */
541
+ color?: string;
542
+ /** @description The opacity of the label text, including its outline. */
543
+ "text-opacity"?: number;
544
+ /** @description A comma-separated list of font names to use on the label text. */
545
+ "font-family"?: string;
546
+ /** @description The size of the label text. */
547
+ "font-size"?: string;
548
+ /** @description A CSS font style to be applied to the label text. */
549
+ "font-style"?: string;
550
+ /** @description A CSS font weight to be applied to the label text. */
551
+ "font-weight"?: string;
552
+ /**
553
+ * @description A transformation to apply to the label text
554
+ * @enum {string}
555
+ */
556
+ "text-transform"?: "none" | "uppercase" | "lowercase";
557
+ /** @description The opacity of the element, ranging from 0 to 1. Note that the opacity of a compound node parent affects the effective opacity of its children. */
558
+ opacity?: number;
559
+ /** @description An integer value that affects the relative draw order of elements. In general, an element with a higher z-index will be drawn on top of an element with a lower z-index. Note that edges are under nodes despite z-index. */
560
+ "z-index"?: number;
561
+ /** @description The text to display for an element's label. Can give a path, e.g. data(id) will label with the elements id */
562
+ label?: string;
563
+ /** @description The animation to apply to the element. example ripple,bounce,etc */
564
+ animation?: Record<string, never>;
565
+ } & {
566
+ [key: string]: unknown;
567
+ }) & {
568
+ [key: string]: unknown;
569
+ });
570
+ /** @description An alias is an component that acts as an ref/pointer to a field in another component, nonResolvedAlias are not aware of there immediate parents */
571
+ NonResolvedAlias: {
572
+ /**
573
+ * Format: uuid
574
+ * @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
575
+ */
576
+ relationship_id: string;
577
+ /**
578
+ * Format: uuid
579
+ * @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
580
+ */
581
+ alias_component_id: string;
582
+ /**
583
+ * Format: uuid
584
+ * @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
585
+ */
586
+ immediate_parent_id: string;
587
+ immediate_ref_field_path: string[];
588
+ };
589
+ /** @description An resolved alias is an component that acts as an ref/pointer to a field in another component, resolvedAlias are aware of there immediate parents and completely resolved parents also */
590
+ ResolvedAlias: {
591
+ /**
592
+ * Format: uuid
593
+ * @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
594
+ */
595
+ relationship_id: string;
596
+ /**
597
+ * Format: uuid
598
+ * @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
599
+ */
600
+ alias_component_id: string;
601
+ /**
602
+ * Format: uuid
603
+ * @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
604
+ */
605
+ immediate_parent_id: string;
606
+ immediate_ref_field_path: string[];
607
+ } & {
608
+ /**
609
+ * Format: uuid
610
+ * @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
611
+ */
612
+ resolved_parent_id: string;
613
+ resolved_ref_field_path: string[];
614
+ };
615
+ /**
616
+ * @description The type of the IaC file
617
+ * @enum {string}
618
+ */
619
+ IaCFileTypes: "meshery-design" | "helm-chart" | "k8s-manifest" | "docker-compose" | "k8s-kustomize";
719
620
  };
720
- /**
721
- * @description The type of the IaC file
722
- * @enum {string}
723
- */
724
- IaCFileTypes:
725
- | "meshery-design"
726
- | "helm-chart"
727
- | "k8s-manifest"
728
- | "docker-compose"
729
- | "k8s-kustomize";
730
- };
731
- responses: {
732
- /** ok */
733
- 200: {
734
- content: {
735
- "text/plain": string;
736
- };
621
+ responses: {
622
+ /** @description ok */
623
+ 200: {
624
+ headers: {
625
+ [name: string]: unknown;
626
+ };
627
+ content: {
628
+ "text/plain": string;
629
+ };
630
+ };
631
+ 201: {
632
+ headers: {
633
+ [name: string]: unknown;
634
+ };
635
+ content: {
636
+ "text/plain": string;
637
+ };
638
+ };
639
+ /** @description Invalid request body or request param */
640
+ 400: {
641
+ headers: {
642
+ [name: string]: unknown;
643
+ };
644
+ content: {
645
+ "text/plain": string;
646
+ };
647
+ };
648
+ /** @description Expired JWT token used or insufficient privilege */
649
+ 401: {
650
+ headers: {
651
+ [name: string]: unknown;
652
+ };
653
+ content: {
654
+ "text/plain": string;
655
+ };
656
+ };
657
+ /** @description Result not found */
658
+ 404: {
659
+ headers: {
660
+ [name: string]: unknown;
661
+ };
662
+ content: {
663
+ "text/plain": string;
664
+ };
665
+ };
666
+ /** @description Publish request already exists */
667
+ 409: {
668
+ headers: {
669
+ [name: string]: unknown;
670
+ };
671
+ content: {
672
+ "text/plain": string;
673
+ };
674
+ };
675
+ /** @description Internal server error */
676
+ 500: {
677
+ headers: {
678
+ [name: string]: unknown;
679
+ };
680
+ content: {
681
+ "text/plain": string;
682
+ };
683
+ };
737
684
  };
738
- 201: {
739
- content: {
740
- "text/plain": string;
741
- };
685
+ parameters: {
686
+ /** @description Unique identifier */
687
+ id: string;
688
+ /** @description Get all possible entries */
689
+ all: boolean;
690
+ /** @description Get responses by page */
691
+ page: string;
692
+ /** @description Filter catalog items by user ID. Pass multiple user IDs to fetch content for several users simultaneously. */
693
+ userid: string;
694
+ /** @description Include metrics associated with the designs. */
695
+ metrics: string;
696
+ /** @description Filter catalog items based on their support class. Specify one or more classes per request as needed. Example: 'official' and 'verified' */
697
+ class: string;
698
+ /** @description Get responses by pagesize */
699
+ pagesize: string;
700
+ /** @description Get responses by pagesize (pass all to get all responses) */
701
+ pagesizeWithAll: string;
702
+ /** @description Get ordered responses */
703
+ order: string;
704
+ /** @description Get responses based on visibility - private, public or published */
705
+ visibility: "private" | "public" | "published";
706
+ /** @description Populate the response with additional data like pattern_file */
707
+ populate: string;
708
+ /** @description Get responses that match search param value */
709
+ search: string;
710
+ /** @description Get filtered reponses */
711
+ filter: string;
712
+ /** @description To get OAuth tokens as well */
713
+ isOAuth: string;
714
+ /** @description Name of the resource */
715
+ name: string;
716
+ /** @description Purpose for which token is generated */
717
+ purpose: string;
718
+ /** @description Cumulative events */
719
+ cumulative: string;
720
+ /** @description meshery version */
721
+ mesheryVersion: string;
722
+ /** @description user's os */
723
+ os: string;
724
+ /** @description Is playground mode */
725
+ playground: string;
726
+ /** @description Namespace */
727
+ namespace: string;
728
+ /** @description Type */
729
+ type: string;
730
+ /** @description Type of actor e.g user, team, system, registrant */
731
+ actorType: string;
732
+ /** @description Type of resource e.g design, filter, view, environment, workspace */
733
+ resourceType: string;
734
+ /** @description Filter catalog data based on type of content e.g (deployment, workloads, scaling...) multiple params can be passed */
735
+ contentType: string;
736
+ /** @description Filter catalog data based on technology(compatibility) of content e.g (kubernetes, istio...) multiple params can be passed */
737
+ contentTechnology: string;
742
738
  };
743
- /** Invalid request body or request param */
744
- 400: {
745
- content: {
746
- "text/plain": string;
747
- };
748
- };
749
- /** Expired JWT token used or insufficient privilege */
750
- 401: {
751
- content: {
752
- "text/plain": string;
753
- };
754
- };
755
- /** Result not found */
756
- 404: {
757
- content: {
758
- "text/plain": string;
759
- };
760
- };
761
- /** Publish request already exists */
762
- 409: {
763
- content: {
764
- "text/plain": string;
765
- };
766
- };
767
- /** Internal server error */
768
- 500: {
769
- content: {
770
- "text/plain": string;
771
- };
772
- };
773
- };
774
- parameters: {
775
- /** @description Unique identifier */
776
- id: string;
777
- /** @description Get all possible entries */
778
- all: boolean;
779
- /** @description Get responses by page */
780
- page: string;
781
- /** @description Filter catalog items by user ID. Pass multiple user IDs to fetch content for several users simultaneously. */
782
- userid: string;
783
- /** @description Include metrics associated with the designs. */
784
- metrics: string;
785
- /** @description Filter catalog items based on their support class. Specify one or more classes per request as needed. Example: 'official' and 'verified' */
786
- class: string;
787
- /** @description Get responses by pagesize */
788
- pagesize: string;
789
- /** @description Get responses by pagesize (pass all to get all responses) */
790
- pagesizeWithAll: string;
791
- /** @description Get ordered responses */
792
- order: string;
793
- /** @description Get responses based on visibility - private, public or published */
794
- visibility: "private" | "public" | "published";
795
- /** @description Populate the response with additional data like pattern_file */
796
- populate: string;
797
- /** @description Get responses that match search param value */
798
- search: string;
799
- /** @description Get filtered reponses */
800
- filter: string;
801
- /** @description To get OAuth tokens as well */
802
- isOAuth: string;
803
- /** @description Name of the resource */
804
- name: string;
805
- /** @description Purpose for which token is generated */
806
- purpose: string;
807
- /** @description Cumulative events */
808
- cumulative: string;
809
- /** @description meshery version */
810
- mesheryVersion: string;
811
- /** @description user's os */
812
- os: string;
813
- /** @description Is playground mode */
814
- playground: string;
815
- /** @description Namespace */
816
- namespace: string;
817
- /** @description Type */
818
- type: string;
819
- /** @description Type of actor e.g user, team, system, registrant */
820
- actorType: string;
821
- /** @description Type of resource e.g design, filter, view, environment, workspace */
822
- resourceType: string;
823
- /** @description Filter catalog data based on type of content e.g (deployment, workloads, scaling...) multiple params can be passed */
824
- contentType: string;
825
- /** @description Filter catalog data based on technology(compatibility) of content e.g (kubernetes, istio...) multiple params can be passed */
826
- contentTechnology: string;
827
- };
739
+ requestBodies: never;
740
+ headers: never;
741
+ pathItems: never;
828
742
  }
829
-
830
- export interface operations {}
831
-
832
- export interface external {}
743
+ export type $defs = Record<string, never>;
744
+ export type operations = Record<string, never>;