@meshery/schemas 1.3.8 → 1.4.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (103) hide show
  1. package/dist/cloudApi.d.mts +4154 -1704
  2. package/dist/cloudApi.d.ts +4154 -1704
  3. package/dist/cloudApi.js +1 -1
  4. package/dist/cloudApi.mjs +1 -1
  5. package/dist/constructs/v1alpha1/capability/Capability.d.ts +106 -111
  6. package/dist/constructs/v1alpha1/core/Core.d.ts +822 -734
  7. package/dist/constructs/v1alpha2/catalog/Catalog.d.ts +45 -40
  8. package/dist/constructs/v1alpha3/relationship/Relationship.d.ts +1829 -1716
  9. package/dist/constructs/v1beta1/academy/Academy.d.ts +6023 -6642
  10. package/dist/constructs/v1beta1/badge/Badge.d.ts +439 -600
  11. package/dist/constructs/v1beta1/capability/Capability.d.ts +106 -111
  12. package/dist/constructs/v1beta1/catalog/Catalog.d.ts +45 -40
  13. package/dist/constructs/v1beta1/category/Category.d.ts +38 -26
  14. package/dist/constructs/v1beta1/component/Component.d.ts +833 -729
  15. package/dist/constructs/v1beta1/connection/Connection.d.ts +1170 -1357
  16. package/dist/constructs/v1beta1/core/Core.d.ts +822 -734
  17. package/dist/constructs/v1beta1/credential/Credential.d.ts +458 -593
  18. package/dist/constructs/v1beta1/environment/Environment.d.ts +666 -835
  19. package/dist/constructs/v1beta1/evaluation/Evaluation.d.ts +6142 -5619
  20. package/dist/constructs/v1beta1/event/Event.d.ts +527 -898
  21. package/dist/constructs/v1beta1/feature/Feature.d.ts +343 -389
  22. package/dist/constructs/v1beta1/invitation/Invitation.d.ts +877 -1244
  23. package/dist/constructs/v1beta1/key/Key.d.ts +444 -589
  24. package/dist/constructs/v1beta1/keychain/Keychain.d.ts +575 -796
  25. package/dist/constructs/v1beta1/model/Model.d.ts +598 -572
  26. package/dist/constructs/v1beta1/organization/Organization.d.ts +1410 -1829
  27. package/dist/constructs/v1beta1/pattern/Pattern.d.ts +17988 -17171
  28. package/dist/constructs/v1beta1/plan/Plan.d.ts +115 -159
  29. package/dist/constructs/v1beta1/role/Role.d.ts +688 -933
  30. package/dist/constructs/v1beta1/schedule/Schedule.d.ts +315 -425
  31. package/dist/constructs/v1beta1/subcategory/Subcategory.d.ts +61 -18
  32. package/dist/constructs/v1beta1/subscription/Subscription.d.ts +674 -839
  33. package/dist/constructs/v1beta1/support/Support.d.ts +74 -115
  34. package/dist/constructs/v1beta1/system/System.d.ts +250 -385
  35. package/dist/constructs/v1beta1/team/Team.d.ts +762 -1028
  36. package/dist/constructs/v1beta1/token/Token.d.ts +475 -612
  37. package/dist/constructs/v1beta1/user/User.d.ts +1553 -1722
  38. package/dist/constructs/v1beta1/view/View.d.ts +664 -833
  39. package/dist/constructs/v1beta1/workspace/Workspace.d.ts +4705 -4910
  40. package/dist/constructs/v1beta2/academy/Academy.d.ts +7246 -7864
  41. package/dist/constructs/v1beta2/badge/Badge.d.ts +453 -610
  42. package/dist/constructs/v1beta2/catalog/Catalog.d.ts +45 -40
  43. package/dist/constructs/v1beta2/component/Component.d.ts +851 -747
  44. package/dist/constructs/v1beta2/connection/Connection.d.ts +1189 -1376
  45. package/dist/constructs/v1beta2/core/Core.d.ts +856 -768
  46. package/dist/constructs/v1beta2/credential/Credential.d.ts +437 -572
  47. package/dist/constructs/v1beta2/design/Design.d.ts +18631 -17846
  48. package/dist/constructs/v1beta2/event/Event.d.ts +575 -946
  49. package/dist/constructs/v1beta2/invitation/Invitation.d.ts +901 -1268
  50. package/dist/constructs/v1beta2/key/Key.d.ts +454 -599
  51. package/dist/constructs/v1beta2/keychain/Keychain.d.ts +585 -806
  52. package/dist/constructs/v1beta2/model/Model.d.ts +636 -610
  53. package/dist/constructs/v1beta2/organization/Organization.d.ts +2017 -2458
  54. package/dist/constructs/v1beta2/plan/Plan.d.ts +128 -169
  55. package/dist/constructs/v1beta2/relationship/Relationship.d.ts +2013 -1844
  56. package/dist/constructs/v1beta2/role/Role.d.ts +695 -940
  57. package/dist/constructs/v1beta2/schedule/Schedule.d.ts +356 -466
  58. package/dist/constructs/v1beta2/subscription/Subscription.d.ts +701 -866
  59. package/dist/constructs/v1beta2/team/Team.d.ts +852 -1118
  60. package/dist/constructs/v1beta2/token/Token.d.ts +479 -616
  61. package/dist/constructs/v1beta2/user/User.d.ts +1553 -1722
  62. package/dist/constructs/v1beta2/view/View.d.ts +669 -838
  63. package/dist/constructs/v1beta3/academy/Academy.d.ts +7246 -7864
  64. package/dist/constructs/v1beta3/academy/AcademySchema.js +1 -1
  65. package/dist/constructs/v1beta3/academy/AcademySchema.mjs +1 -1
  66. package/dist/constructs/v1beta3/component/Component.d.ts +857 -753
  67. package/dist/constructs/v1beta3/connection/Connection.d.ts +5919 -1416
  68. package/dist/constructs/v1beta3/connection/ConnectionSchema.js +25 -1
  69. package/dist/constructs/v1beta3/connection/ConnectionSchema.mjs +25 -1
  70. package/dist/constructs/v1beta3/design/Design.d.ts +5297 -5719
  71. package/dist/constructs/v1beta3/design/DesignSchema.js +2 -2
  72. package/dist/constructs/v1beta3/design/DesignSchema.mjs +2 -2
  73. package/dist/constructs/v1beta3/environment/Environment.d.ts +689 -858
  74. package/dist/constructs/v1beta3/event/Event.d.ts +666 -1041
  75. package/dist/constructs/v1beta3/event/EventSchema.js +1 -1
  76. package/dist/constructs/v1beta3/event/EventSchema.mjs +1 -1
  77. package/dist/constructs/v1beta3/filter/Filter.d.ts +1300 -1438
  78. package/dist/constructs/v1beta3/filter/FilterSchema.js +7 -7
  79. package/dist/constructs/v1beta3/filter/FilterSchema.mjs +7 -7
  80. package/dist/constructs/v1beta3/invitation/Invitation.d.ts +911 -1278
  81. package/dist/constructs/v1beta3/invitation/InvitationSchema.js +1 -1
  82. package/dist/constructs/v1beta3/invitation/InvitationSchema.mjs +1 -1
  83. package/dist/constructs/v1beta3/performance_profile/PerformanceProfile.d.ts +1114 -1412
  84. package/dist/constructs/v1beta3/performance_profile/PerformanceProfileSchema.js +1 -1
  85. package/dist/constructs/v1beta3/performance_profile/PerformanceProfileSchema.mjs +1 -1
  86. package/dist/constructs/v1beta3/plan/Plan.d.ts +156 -197
  87. package/dist/constructs/v1beta3/relationship/Relationship.d.ts +2013 -1844
  88. package/dist/constructs/v1beta3/subscription/Subscription.d.ts +804 -969
  89. package/dist/constructs/v1beta3/token/Token.d.ts +480 -617
  90. package/dist/constructs/v1beta3/token/TokenSchema.js +1 -1
  91. package/dist/constructs/v1beta3/token/TokenSchema.mjs +1 -1
  92. package/dist/constructs/v1beta3/workspace/Workspace.d.ts +4825 -5033
  93. package/dist/index.d.mts +5032 -5501
  94. package/dist/index.d.ts +5032 -5501
  95. package/dist/mesheryApi.d.mts +3334 -884
  96. package/dist/mesheryApi.d.ts +3334 -884
  97. package/dist/mesheryApi.js +1 -1
  98. package/dist/mesheryApi.mjs +1 -1
  99. package/dist/permissions.d.mts +25 -1
  100. package/dist/permissions.d.ts +25 -1
  101. package/dist/permissions.js +1 -1
  102. package/dist/permissions.mjs +1 -1
  103. package/package.json +1 -1
@@ -4,392 +4,618 @@
4
4
  */
5
5
 
6
6
  export interface paths {
7
- "/api/meshmodels/register": {
8
- parameters: {
9
- query?: never;
10
- header?: never;
11
- path?: never;
12
- cookie?: never;
13
- };
14
- get?: never;
15
- put?: never;
16
- /** Register mesh models */
17
- post: operations["registerMeshmodels"];
18
- delete?: never;
19
- options?: never;
20
- head?: never;
21
- patch?: never;
22
- trace?: never;
23
- };
24
- "/api/integrations/meshmodels/models": {
25
- parameters: {
26
- query?: never;
27
- header?: never;
28
- path?: never;
29
- cookie?: never;
30
- };
31
- /** Get mesh model models */
32
- get: operations["getMeshModelModels"];
33
- put?: never;
34
- post?: never;
35
- delete?: never;
36
- options?: never;
37
- head?: never;
38
- patch?: never;
39
- trace?: never;
40
- };
7
+ "/api/meshmodels/register": {
8
+ post: operations["registerMeshmodels"];
9
+ };
10
+ "/api/integrations/meshmodels/models": {
11
+ get: operations["getMeshModelModels"];
12
+ };
41
13
  }
42
- export type webhooks = Record<string, never>;
14
+
43
15
  export interface components {
44
- schemas: {
45
- /** @description Registrant-defined data associated with the model. Properties pertain to the software being managed (e.g. Kubernetes v1.31). */
46
- Model: {
47
- /** @description Version of the model as defined by the registrant. */
48
- version: string;
49
- };
50
- /** @description Meshery Models serve as a portable unit of packaging to define managed entities, their relationships, and capabilities. */
51
- ModelDefinition: {
52
- /**
53
- * Format: uuid
54
- * @description Uniquely identifies the entity (i.e. component) as defined in a declaration (i.e. design).
55
- */
56
- id: string;
57
- /**
58
- * @description Specifies the version of the schema used for the definition.
59
- * @default models.meshery.io/v1beta2
60
- * @example [
61
- * "v1",
62
- * "v1alpha1",
63
- * "v2beta3",
64
- * "v1.custom-suffix",
65
- * "models.meshery.io/v1beta1",
66
- * "capability.meshery.io/v1alpha1"
67
- * ]
68
- */
69
- schemaVersion: string;
70
- /** @description Version of the model definition. */
71
- version: string;
72
- /**
73
- * @description The unique name for the model within the scope of a registrant.
74
- * @default untitled-model
75
- * @example cert-manager
76
- */
77
- name: string;
78
- /**
79
- * @description Human-readable name for the model.
80
- * @default Untitled Model
81
- * @example Cert Manager
82
- */
83
- displayName: string;
84
- /**
85
- * @description Description of the model.
86
- * @default A new Meshery model.
87
- */
88
- description: string;
89
- /**
90
- * @description Status of model, including:
91
- * - duplicate: this component is a duplicate of another. The component that is to be the canonical reference and that is duplicated by other components should not be assigned the 'duplicate' status.
92
- * - maintenance: model is unavailable for a period of time.
93
- * - enabled: model is available for use for all users of this Meshery Server.
94
- * - ignored: model is unavailable for use for all users of this Meshery Server.
95
- * @default enabled
96
- * @enum {string}
97
- */
98
- status: "ignored" | "enabled" | "duplicate";
99
- /** @description Connection identifying the entity that registered this model. */
100
- registrant: {
101
- /**
102
- * Format: uuid
103
- * @description Connection ID
104
- */
105
- id: string;
106
- /** @description Connection Name */
107
- name: string;
108
- /**
109
- * Format: uuid
110
- * @description Associated Credential ID
111
- */
112
- credentialId?: string;
113
- /** @description Connection Type (platform, telemetry, collaboration) */
114
- type: string;
115
- /** @description Connection Subtype (cloud, identity, metrics, chat, git, orchestration) */
116
- subType: string;
117
- /** @description Connection Kind (meshery, kubernetes, prometheus, grafana, gke, aws, azure, slack, github) */
118
- kind: string;
119
- /** @description Additional connection metadata */
120
- metadata?: Record<string, never>;
121
- /**
122
- * @description Connection Status
123
- * @enum {string}
124
- */
125
- status: "discovered" | "registered" | "connected" | "ignored" | "maintenance" | "disconnected" | "deleted" | "not found";
126
- /**
127
- * Format: uuid
128
- * @description User ID who owns this connection
129
- */
130
- user_id?: string;
131
- /** Format: date-time */
132
- created_at?: string;
133
- /** Format: date-time */
134
- updated_at?: string;
135
- /**
136
- * Format: date-time
137
- * @description SQL null Timestamp to handle null values of time.
138
- */
139
- deleted_at?: string;
140
- /** @description Associated environments for this connection */
141
- environments?: {
142
- /**
143
- * Format: uuid
144
- * @description ID
145
- */
146
- id: string;
147
- /**
148
- * @description Specifies the version of the schema to which the environment conforms.
149
- * @default environments.meshery.io/v1beta1
150
- * @example [
151
- * "v1",
152
- * "v1alpha1",
153
- * "v2beta3",
154
- * "v1.custom-suffix",
155
- * "models.meshery.io/v1beta1",
156
- * "capability.meshery.io/v1alpha1"
157
- * ]
158
- */
159
- schemaVersion: string;
160
- /** @description Environment name */
161
- name: string;
162
- /** @description Environment description */
163
- description: string;
164
- /**
165
- * Format: uuid
166
- * @description Environment organization ID
167
- */
168
- organization_id: string;
169
- /**
170
- * Format: uuid
171
- * @description Environment owner
172
- */
173
- owner?: string;
174
- /**
175
- * Format: date-time
176
- * @description Timestamp when the resource was created.
177
- */
178
- created_at?: string;
179
- /** @description Additional metadata associated with the environment. */
180
- metadata?: Record<string, never>;
181
- /**
182
- * Format: date-time
183
- * @description Timestamp when the resource was updated.
184
- */
185
- updated_at?: string;
186
- /**
187
- * Format: date-time
188
- * @description Timestamp when the environment was soft deleted. Null while the environment remains active.
189
- */
190
- deleted_at?: string | null;
191
- }[];
192
- /**
193
- * @description Specifies the version of the schema used for the definition.
194
- * @default connections.meshery.io/v1beta1
195
- * @example [
196
- * "v1",
197
- * "v1alpha1",
198
- * "v2beta3",
199
- * "v1.custom-suffix",
200
- * "models.meshery.io/v1beta1",
201
- * "capability.meshery.io/v1alpha1"
202
- * ]
203
- */
204
- schemaVersion: string;
205
- };
206
- /**
207
- * Format: uuid
208
- * @description ID of the registrant.
209
- */
210
- registrantId: string;
211
- /**
212
- * Format: uuid
213
- * @description ID of the category.
214
- */
215
- categoryId: string;
216
- /** @description Category the model belongs to. */
217
- category: {
218
- /**
219
- * Format: uuid
220
- * @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
221
- */
222
- id: string;
223
- /**
224
- * @description The category of the model that determines the main grouping.
225
- * @default Uncategorized
226
- * @enum {string}
227
- */
228
- name: "Analytics" | "App Definition and Development" | "Cloud Native Network" | "Cloud Native Storage" | "Database" | "Machine Learning" | "Observability and Analysis" | "Orchestration & Management" | "Platform" | "Provisioning" | "Runtime" | "Security & Compliance" | "Serverless" | "Tools" | "Uncategorized";
229
- /** @description Additional metadata associated with the category. */
230
- metadata: Record<string, never>;
231
- };
16
+ schemas: {
17
+ /** @description Registrant-defined data associated with the model. Properties pertain to the software being managed (e.g. Kubernetes v1.31). */
18
+ Model: {
19
+ /** @description Version of the model as defined by the registrant. */
20
+ version: string;
21
+ };
22
+ /** @description Meshery Models serve as a portable unit of packaging to define managed entities, their relationships, and capabilities. */
23
+ ModelDefinition: {
24
+ /**
25
+ * Format: uuid
26
+ * @description Uniquely identifies the entity (i.e. component) as defined in a declaration (i.e. design).
27
+ */
28
+ id: string;
29
+ /**
30
+ * @description Specifies the version of the schema used for the definition.
31
+ * @default models.meshery.io/v1beta2
32
+ * @example [
33
+ * "v1",
34
+ * "v1alpha1",
35
+ * "v2beta3",
36
+ * "v1.custom-suffix",
37
+ * "models.meshery.io/v1beta1",
38
+ * "capability.meshery.io/v1alpha1"
39
+ * ]
40
+ */
41
+ schemaVersion: string;
42
+ /** @description Version of the model definition. */
43
+ version: string;
44
+ /**
45
+ * @description The unique name for the model within the scope of a registrant.
46
+ * @default untitled-model
47
+ */
48
+ name: string;
49
+ /**
50
+ * @description Human-readable name for the model.
51
+ * @default Untitled Model
52
+ */
53
+ displayName: string;
54
+ /**
55
+ * @description Description of the model.
56
+ * @default A new Meshery model.
57
+ */
58
+ description: string;
59
+ /**
60
+ * @description Status of model, including:
61
+ * - duplicate: this component is a duplicate of another. The component that is to be the canonical reference and that is duplicated by other components should not be assigned the 'duplicate' status.
62
+ * - maintenance: model is unavailable for a period of time.
63
+ * - enabled: model is available for use for all users of this Meshery Server.
64
+ * - ignored: model is unavailable for use for all users of this Meshery Server.
65
+ * @default enabled
66
+ * @enum {string}
67
+ */
68
+ status: "ignored" | "enabled" | "duplicate";
69
+ /** @description Connection identifying the entity that registered this model. */
70
+ registrant: {
71
+ /**
72
+ * Format: uuid
73
+ * @description Connection ID
74
+ */
75
+ id: string;
76
+ /** @description Connection Name */
77
+ name: string;
78
+ /**
79
+ * Format: uuid
80
+ * @description Associated Credential ID
81
+ */
82
+ credentialId?: string;
83
+ /** @description Connection Type (platform, telemetry, collaboration) */
84
+ type: string;
85
+ /** @description Connection Subtype (cloud, identity, metrics, chat, git, orchestration) */
86
+ subType: string;
87
+ /** @description Connection Kind (meshery, kubernetes, prometheus, grafana, gke, aws, azure, slack, github) */
88
+ kind: string;
89
+ /** @description Additional connection metadata */
90
+ metadata?: { [key: string]: unknown };
91
+ /**
92
+ * @description Connection Status
93
+ * @enum {string}
94
+ */
95
+ status:
96
+ | "discovered"
97
+ | "registered"
98
+ | "connected"
99
+ | "ignored"
100
+ | "maintenance"
101
+ | "disconnected"
102
+ | "deleted"
103
+ | "not found";
104
+ /**
105
+ * Format: uuid
106
+ * @description User ID who owns this connection
107
+ */
108
+ user_id?: string;
109
+ /** Format: date-time */
110
+ created_at?: string;
111
+ /** Format: date-time */
112
+ updated_at?: string;
113
+ /**
114
+ * Format: date-time
115
+ * @description SQL null Timestamp to handle null values of time.
116
+ */
117
+ deleted_at?: string;
118
+ /** @description Associated environments for this connection */
119
+ environments?: {
120
+ /**
121
+ * Format: uuid
122
+ * @description ID
123
+ */
124
+ id: string;
125
+ /**
126
+ * @description Specifies the version of the schema to which the environment conforms.
127
+ * @default environments.meshery.io/v1beta1
128
+ * @example [
129
+ * "v1",
130
+ * "v1alpha1",
131
+ * "v2beta3",
132
+ * "v1.custom-suffix",
133
+ * "models.meshery.io/v1beta1",
134
+ * "capability.meshery.io/v1alpha1"
135
+ * ]
136
+ */
137
+ schemaVersion: string;
138
+ /** @description Environment name */
139
+ name: string;
140
+ /** @description Environment description */
141
+ description: string;
142
+ /**
143
+ * Format: uuid
144
+ * @description Environment organization ID
145
+ */
146
+ organization_id: string;
147
+ /**
148
+ * Format: uuid
149
+ * @description Environment owner
150
+ */
151
+ owner?: string;
152
+ /**
153
+ * Format: date-time
154
+ * @description Timestamp when the resource was created.
155
+ */
156
+ created_at?: string;
157
+ /** @description Additional metadata associated with the environment. */
158
+ metadata?: { [key: string]: unknown };
159
+ /**
160
+ * Format: date-time
161
+ * @description Timestamp when the resource was updated.
162
+ */
163
+ updated_at?: string;
164
+ /**
165
+ * Format: date-time
166
+ * @description Timestamp when the environment was soft deleted. Null while the environment remains active.
167
+ */
168
+ deleted_at?: string | null;
169
+ }[];
170
+ /**
171
+ * @description Specifies the version of the schema used for the definition.
172
+ * @default connections.meshery.io/v1beta1
173
+ * @example [
174
+ * "v1",
175
+ * "v1alpha1",
176
+ * "v2beta3",
177
+ * "v1.custom-suffix",
178
+ * "models.meshery.io/v1beta1",
179
+ * "capability.meshery.io/v1alpha1"
180
+ * ]
181
+ */
182
+ schemaVersion: string;
183
+ };
184
+ /**
185
+ * Format: uuid
186
+ * @description ID of the registrant.
187
+ */
188
+ registrantId: string;
189
+ /**
190
+ * Format: uuid
191
+ * @description ID of the category.
192
+ */
193
+ categoryId: string;
194
+ /** @description Category the model belongs to. */
195
+ category: {
196
+ /**
197
+ * Format: uuid
198
+ * @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
199
+ */
200
+ id: string;
201
+ /**
202
+ * @description The category of the model that determines the main grouping.
203
+ * @default Uncategorized
204
+ * @enum {string}
205
+ */
206
+ name:
207
+ | "Analytics"
208
+ | "App Definition and Development"
209
+ | "Cloud Native Network"
210
+ | "Cloud Native Storage"
211
+ | "Database"
212
+ | "Machine Learning"
213
+ | "Observability and Analysis"
214
+ | "Orchestration & Management"
215
+ | "Platform"
216
+ | "Provisioning"
217
+ | "Runtime"
218
+ | "Security & Compliance"
219
+ | "Serverless"
220
+ | "Tools"
221
+ | "Uncategorized";
222
+ /** @description Additional metadata associated with the category. */
223
+ metadata: { [key: string]: unknown };
224
+ };
225
+ /**
226
+ * SubCategory
227
+ * @description Sub-category the model belongs to.
228
+ * @default Uncategorized
229
+ * @enum {string}
230
+ */
231
+ subCategory:
232
+ | "API Gateway"
233
+ | "API Integration"
234
+ | "Application Definition & Image Build"
235
+ | "Automation & Configuration"
236
+ | "Certified Kubernetes - Distribution"
237
+ | "Chaos Engineering"
238
+ | "Cloud Native Storage"
239
+ | "Cloud Provider"
240
+ | "CNI"
241
+ | "Compute"
242
+ | "Container Registry"
243
+ | "Container Runtime"
244
+ | "Container Security"
245
+ | "Container"
246
+ | "Content Delivery Network"
247
+ | "Continuous Integration & Delivery"
248
+ | "Coordination & Service Discovery"
249
+ | "Database"
250
+ | "Flowchart"
251
+ | "Framework"
252
+ | "Installable Platform"
253
+ | "Key Management"
254
+ | "Key Management Service"
255
+ | "Kubernetes"
256
+ | "Logging"
257
+ | "Machine Learning"
258
+ | "Management Governance"
259
+ | "Metrics"
260
+ | "Monitoring"
261
+ | "Networking Content Delivery"
262
+ | "Operating System"
263
+ | "Query"
264
+ | "Remote Procedure Call"
265
+ | "Scheduling & Orchestration"
266
+ | "Secrets Management"
267
+ | "Security Identity & Compliance"
268
+ | "Service Mesh"
269
+ | "Service Proxy"
270
+ | "Source Version Control"
271
+ | "Storage"
272
+ | "Specifications"
273
+ | "Streaming & Messaging"
274
+ | "Tools"
275
+ | "Tracing"
276
+ | "Uncategorized"
277
+ | "Video Conferencing";
278
+ /** @description Metadata containing additional information associated with the model. */
279
+ metadata?: {
280
+ /** @description Capabilities associated with the model */
281
+ capabilities?: {
282
+ /**
283
+ * @description Specifies the version of the schema to which the capability definition conforms.
284
+ * @example [
285
+ * "v1",
286
+ * "v1alpha1",
287
+ * "v2beta3",
288
+ * "v1.custom-suffix",
289
+ * "models.meshery.io/v1beta1",
290
+ * "capability.meshery.io/v1alpha1"
291
+ * ]
292
+ */
293
+ schemaVersion: string;
294
+ /** @description Version of the capability definition. */
295
+ version: string;
296
+ /** @description Name of the capability in human-readible format. */
297
+ displayName: string;
298
+ /** @description A written representation of the purpose and characteristics of the capability. */
299
+ description: string;
300
+ /** @description Top-level categorization of the capability */
301
+ kind: string;
302
+ /** @description Classification of capabilities. Used to group capabilities similar in nature. */
303
+ type: string;
304
+ /** @description Most granular unit of capability classification. The combination of Kind, Type and SubType together uniquely identify a Capability. */
305
+ subType: string;
306
+ /** @description Key that backs the capability. */
307
+ key: string;
308
+ /** @description State of the entity in which the capability is applicable. */
309
+ entityState: ("declaration" | "instance")[];
310
+ /**
311
+ * @description Status of the capability
312
+ * @default enabled
313
+ * @enum {string}
314
+ */
315
+ status: "enabled" | "disabled";
316
+ /** @description Metadata contains additional information associated with the capability. Extension point. */
317
+ metadata?: { [key: string]: unknown };
318
+ }[];
319
+ /**
320
+ * @description Indicates whether the model and its entities should be treated as deployable entities or as logical representations.
321
+ * @default false
322
+ */
323
+ isAnnotation?: boolean;
324
+ /**
325
+ * @description Primary color associated with the model.
326
+ * @default #00b39f
327
+ */
328
+ primaryColor?: string;
329
+ /**
330
+ * @description Secondary color associated with the model.
331
+ * @default #00D3A9
332
+ */
333
+ secondaryColor?: string;
334
+ /**
335
+ * @description SVG representation of the model in white color.
336
+ * @default <svg width="32" height="32" viewBox="0 0 32 32" fill="none" xmlns="http://www.w3.org/2000/svg"><path d="M16.405 8.732v6.57l5.694-3.297-5.694-3.273Zm0 7.942v6.602l5.747-3.285-5.747-3.317Z" fill="#fff"/><path d="M15.586 15.256v-6.47l-5.622 3.225 5.622 3.245ZM4.307 23.252a13.809 13.809 0 0 0 4.362 4.39v-6.914l-4.362 2.524Zm11.279-.008v-6.52L9.95 19.985l5.636 3.258Z" fill="#fff" fill-opacity=".8"/><path d="m9.49 27.23 5.707-3.263-5.707-3.3v6.563Z" fill="#fff"/><path d="M22.54 27.265v-6.553l-5.699 3.259 5.7 3.294Zm5.58-4.773a13.697 13.697 0 0 0 1.612-5.895l-5.934 3.397 4.323 2.498Z" fill="#fff" fill-opacity=".8"/><path d="m23.362 19.298 5.728-3.276-5.728-3.291v6.567Z" fill="#fff"/><path d="M22.541 11.315V4.8l-5.673 3.253 5.673 3.262Zm0 7.955v-6.574l-5.685 3.292 5.685 3.281Z" fill="#fff" fill-opacity=".8"/><path d="M9.49 12.684v6.622l5.728-3.316-5.728-3.306Z" fill="#fff"/><path d="M15.586 2.25a13.69 13.69 0 0 0-6.037 1.595l6.037 3.463V2.25Z" fill="#fff" fill-opacity=".8"/><path d="M9.49 4.756v6.583l5.732-3.288L9.49 4.756Z" fill="#fff"/><path d="M8.669 4.356a13.83 13.83 0 0 0-4.362 4.39l4.362 2.518V4.356Z" fill="#fff" fill-opacity=".8"/><path d="M22.504 3.88a13.695 13.695 0 0 0-6.099-1.63v5.123l6.1-3.493ZM2.25 16.483c.071 2.12.634 4.196 1.644 6.062l4.418-2.559-6.062-3.503Zm1.644-7.028a13.68 13.68 0 0 0-1.644 6.036l6.068-3.482-4.424-2.554Z" fill="#fff"/><path d="M9.539 28.147a13.673 13.673 0 0 0 6.047 1.603v-5.062L9.54 28.147Z" fill="#fff" fill-opacity=".8"/><path d="M27.697 8.768a13.83 13.83 0 0 0-4.335-4.383v6.889l4.335-2.506ZM23.362 27.62a13.851 13.851 0 0 0 4.351-4.417l-4.351-2.514v6.93Z" fill="#fff"/><path d="M29.75 15.452a13.659 13.659 0 0 0-1.63-5.979l-4.381 2.53 6.011 3.45Z" fill="#fff" fill-opacity=".8"/><path d="M16.405 29.75a13.673 13.673 0 0 0 6.036-1.595l-6.036-3.498v5.093Z" fill="#fff"/><path d="M8.669 19.247v-6.494L3.03 15.986l5.639 3.261Z" fill="#fff" fill-opacity=".8"/></svg>
337
+ */
338
+ svgWhite: string;
339
+ /**
340
+ * @description SVG representation of the model in colored format.
341
+ * @default <svg xmlns="http://www.w3.org/2000/svg" id="Layer_1" data-name="Layer 1" viewBox="0 0 134.95 135.02"><defs><style>.cls-1{fill:#00d3a9}.cls-2{fill:#00b39f}</style></defs><title>meshery-logo-light</title><polygon points="69.49 31.82 69.49 64.07 97.44 47.89 69.49 31.82" class="cls-1"/><polygon points="69.49 70.81 69.49 103.22 97.7 87.09 69.49 70.81" class="cls-1"/><polygon points="65.47 63.85 65.47 32.09 37.87 47.92 65.47 63.85" class="cls-2"/><path d="M10.1,103.1a67.79,67.79,0,0,0,21.41,21.55V90.71Z" class="cls-2"/><polygon points="65.47 103.06 65.47 71.05 37.8 87.07 65.47 103.06" class="cls-2"/><polygon points="35.54 122.63 63.56 106.61 35.54 90.41 35.54 122.63" class="cls-1"/><polygon points="99.61 122.8 99.61 90.63 71.63 106.63 99.61 122.8" class="cls-2"/><path d="M127,99.37a67.22,67.22,0,0,0,7.91-28.94L105.78,87.11Z" class="cls-2"/><polygon points="103.64 83.69 131.76 67.61 103.64 51.45 103.64 83.69" class="cls-1"/><polygon points="99.61 44.5 99.61 12.52 71.76 28.49 99.61 44.5" class="cls-2"/><polygon points="99.61 83.55 99.61 51.28 71.7 67.44 99.61 83.55" class="cls-2"/><polygon points="67.48 135.02 67.49 135.02 67.48 135.02 67.48 135.02" class="cls-2"/><polygon points="35.54 51.22 35.54 83.73 63.66 67.45 35.54 51.22" class="cls-1"/><path d="M65.47,0A67.2,67.2,0,0,0,35.83,7.83l29.64,17Z" class="cls-2"/><polygon points="35.54 12.3 35.54 44.62 63.68 28.48 35.54 12.3" class="cls-1"/><path d="M31.51,10.34A67.89,67.89,0,0,0,10.1,31.89L31.51,44.25Z" class="cls-2"/><path d="M99.43,8A67.23,67.23,0,0,0,69.49,0V25.15Z" class="cls-1"/><path d="M0,69.87A67.27,67.27,0,0,0,8.07,99.63L29.76,87.07Z" class="cls-1"/><path d="M8.07,35.37A67.16,67.16,0,0,0,0,65L29.79,47.91Z" class="cls-1"/><path d="M35.78,127.13A67.13,67.13,0,0,0,65.47,135V110.15Z" class="cls-2"/><path d="M124.92,32a67.9,67.9,0,0,0-21.28-21.52V44.3Z" class="cls-1"/><path d="M103.64,124.54A68,68,0,0,0,125,102.86L103.64,90.52Z" class="cls-1"/><path d="M135,64.81a67.06,67.06,0,0,0-8-29.35L105.49,47.88Z" class="cls-2"/><path d="M69.49,135a67.12,67.12,0,0,0,29.63-7.83L69.49,110Z" class="cls-1"/><polygon points="31.51 83.44 31.51 51.56 3.83 67.43 31.51 83.44" class="cls-2"/></svg>
342
+ */
343
+ svgColor: string;
344
+ /** @description SVG representation of the complete model. */
345
+ svgComplete?: string;
346
+ /**
347
+ * @description Visual shape used to render the model's entities in design canvases.
348
+ * @enum {string}
349
+ */
350
+ shape?:
351
+ | "ellipse"
352
+ | "triangle"
353
+ | "round-triangle"
354
+ | "rectangle"
355
+ | "round-rectangle"
356
+ | "bottom-round-rectangle"
357
+ | "cut-rectangle"
358
+ | "barrel"
359
+ | "rhomboid"
360
+ | "diamond"
361
+ | "round-diamond"
362
+ | "pentagon"
363
+ | "round-pentagon"
364
+ | "hexagon"
365
+ | "round-hexagon"
366
+ | "concave-hexagon"
367
+ | "heptagon"
368
+ | "round-heptagon"
369
+ | "octagon"
370
+ | "round-octagon"
371
+ | "star"
372
+ | "tag"
373
+ | "round-tag"
374
+ | "vee"
375
+ | "polygon";
376
+ } & { [key: string]: unknown };
377
+ /** @description Registrant-defined data associated with the model. */
378
+ model: {
379
+ /** @description Version of the model as defined by the registrant. */
380
+ version: string;
381
+ };
382
+ /** @description The relationships of the model. */
383
+ relationships: unknown[];
384
+ /** @description The components of the model. */
385
+ components: unknown[];
386
+ /**
387
+ * @description Number of components associated with the model.
388
+ * @default 0
389
+ */
390
+ componentsCount: number;
391
+ /**
392
+ * @description Number of relationships associated with the model.
393
+ * @default 0
394
+ */
395
+ relationshipsCount: number;
396
+ /**
397
+ * Format: date-time
398
+ * @description Timestamp when the model was created.
399
+ */
400
+ createdAt?: string;
401
+ /**
402
+ * Format: date-time
403
+ * @description Timestamp when the model was last updated.
404
+ */
405
+ updatedAt?: string;
406
+ };
407
+ RegistrantReference: {
408
+ /** @description Kind of the registrant. */
409
+ kind: string;
410
+ };
411
+ /** @description Reference to the specific registered model to which the component belongs and from which model version, category, and other properties may be referenced. Learn more at https://docs.meshery.io/concepts/models */
412
+ ModelReference: {
413
+ /**
414
+ * Format: uuid
415
+ * @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
416
+ */
417
+ id: string;
418
+ /** @description The unique name for the model within the scope of a registrant. */
419
+ name: string;
420
+ /** @description Version of the model definition. */
421
+ version: string;
422
+ /** @description Human-readable name for the model. */
423
+ displayName: string;
424
+ /** @description Registrant-defined data associated with the model. Properties pertain to the software being managed (e.g. Kubernetes v1.31). */
425
+ model: {
426
+ /** @description Version of the model as defined by the registrant. */
427
+ version: string;
428
+ };
429
+ registrant: {
430
+ /** @description Kind of the registrant. */
431
+ kind: string;
432
+ };
433
+ };
434
+ ImportRequest: {
435
+ importBody:
436
+ | {
437
+ /** @description Name of the file being uploaded. */
438
+ fileName: string;
439
+ /** @description Supported model file formats are: .tar, .tar.gz, and .tgz. See [Import Models Documentation](https://docs.meshery.io/guides/configuration-management/importing-models#import-models-using-meshery-ui) for details */
440
+ modelFile: string;
441
+ }
442
+ | {
232
443
  /**
233
- * SubCategory
234
- * @description Sub-category the model belongs to.
235
- * @default Uncategorized
236
- * @enum {string}
444
+ * Format: uri
445
+ * @description A direct URL to a single model file, for example: https://raw.github.com/your-model-file.tar. Supported model file formats are: .tar, .tar.gz, and .tgz. \n\nFor bulk import of your model use the GitHub connection or CSV files. See [Import Models Documentation](https://docs.meshery.io/guides/configuration-management/importing-models#import-models-using-meshery-ui) for details
237
446
  */
238
- subCategory: "API Gateway" | "API Integration" | "Application Definition & Image Build" | "Automation & Configuration" | "Certified Kubernetes - Distribution" | "Chaos Engineering" | "Cloud Native Storage" | "Cloud Provider" | "CNI" | "Compute" | "Container Registry" | "Container Runtime" | "Container Security" | "Container" | "Content Delivery Network" | "Continuous Integration & Delivery" | "Coordination & Service Discovery" | "Database" | "Flowchart" | "Framework" | "Installable Platform" | "Key Management" | "Key Management Service" | "Kubernetes" | "Logging" | "Machine Learning" | "Management Governance" | "Metrics" | "Monitoring" | "Networking Content Delivery" | "Operating System" | "Query" | "Remote Procedure Call" | "Scheduling & Orchestration" | "Secrets Management" | "Security Identity & Compliance" | "Service Mesh" | "Service Proxy" | "Source Version Control" | "Storage" | "Specifications" | "Streaming & Messaging" | "Tools" | "Tracing" | "Uncategorized" | "Video Conferencing";
239
- /** @description Metadata containing additional information associated with the model. */
240
- metadata?: {
241
- /** @description Capabilities associated with the model */
242
- capabilities?: {
243
- /**
244
- * @description Specifies the version of the schema to which the capability definition conforms.
245
- * @example [
246
- * "v1",
247
- * "v1alpha1",
248
- * "v2beta3",
249
- * "v1.custom-suffix",
250
- * "models.meshery.io/v1beta1",
251
- * "capability.meshery.io/v1alpha1"
252
- * ]
253
- */
254
- schemaVersion: string;
255
- /** @description Version of the capability definition. */
256
- version: string;
257
- /** @description Name of the capability in human-readible format. */
258
- displayName: string;
259
- /** @description A written representation of the purpose and characteristics of the capability. */
260
- description: string;
261
- /** @description Top-level categorization of the capability */
262
- kind: string | "action" | "mutate" | "view" | "interaction";
263
- /** @description Classification of capabilities. Used to group capabilities similar in nature. */
264
- type: string;
265
- /** @description Most granular unit of capability classification. The combination of Kind, Type and SubType together uniquely identify a Capability. */
266
- subType: string;
267
- /** @description Key that backs the capability. */
268
- key: string;
269
- /** @description State of the entity in which the capability is applicable. */
270
- entityState: ("declaration" | "instance")[];
271
- /**
272
- * @description Status of the capability
273
- * @default enabled
274
- * @enum {string}
275
- */
276
- status: "enabled" | "disabled";
277
- /** @description Metadata contains additional information associated with the capability. Extension point. */
278
- metadata?: {
279
- [key: string]: unknown;
280
- };
281
- }[];
282
- /**
283
- * @description Indicates whether the model and its entities should be treated as deployable entities or as logical representations.
284
- * @default false
285
- */
286
- isAnnotation: boolean;
287
- /**
288
- * @description Primary color associated with the model.
289
- * @default #00b39f
290
- */
291
- primaryColor: string;
292
- /**
293
- * @description Secondary color associated with the model.
294
- * @default #00D3A9
295
- */
296
- secondaryColor: string;
297
- /**
298
- * @description SVG representation of the model in white color.
299
- * @default <svg width="32" height="32" viewBox="0 0 32 32" fill="none" xmlns="http://www.w3.org/2000/svg"><path d="M16.405 8.732v6.57l5.694-3.297-5.694-3.273Zm0 7.942v6.602l5.747-3.285-5.747-3.317Z" fill="#fff"/><path d="M15.586 15.256v-6.47l-5.622 3.225 5.622 3.245ZM4.307 23.252a13.809 13.809 0 0 0 4.362 4.39v-6.914l-4.362 2.524Zm11.279-.008v-6.52L9.95 19.985l5.636 3.258Z" fill="#fff" fill-opacity=".8"/><path d="m9.49 27.23 5.707-3.263-5.707-3.3v6.563Z" fill="#fff"/><path d="M22.54 27.265v-6.553l-5.699 3.259 5.7 3.294Zm5.58-4.773a13.697 13.697 0 0 0 1.612-5.895l-5.934 3.397 4.323 2.498Z" fill="#fff" fill-opacity=".8"/><path d="m23.362 19.298 5.728-3.276-5.728-3.291v6.567Z" fill="#fff"/><path d="M22.541 11.315V4.8l-5.673 3.253 5.673 3.262Zm0 7.955v-6.574l-5.685 3.292 5.685 3.281Z" fill="#fff" fill-opacity=".8"/><path d="M9.49 12.684v6.622l5.728-3.316-5.728-3.306Z" fill="#fff"/><path d="M15.586 2.25a13.69 13.69 0 0 0-6.037 1.595l6.037 3.463V2.25Z" fill="#fff" fill-opacity=".8"/><path d="M9.49 4.756v6.583l5.732-3.288L9.49 4.756Z" fill="#fff"/><path d="M8.669 4.356a13.83 13.83 0 0 0-4.362 4.39l4.362 2.518V4.356Z" fill="#fff" fill-opacity=".8"/><path d="M22.504 3.88a13.695 13.695 0 0 0-6.099-1.63v5.123l6.1-3.493ZM2.25 16.483c.071 2.12.634 4.196 1.644 6.062l4.418-2.559-6.062-3.503Zm1.644-7.028a13.68 13.68 0 0 0-1.644 6.036l6.068-3.482-4.424-2.554Z" fill="#fff"/><path d="M9.539 28.147a13.673 13.673 0 0 0 6.047 1.603v-5.062L9.54 28.147Z" fill="#fff" fill-opacity=".8"/><path d="M27.697 8.768a13.83 13.83 0 0 0-4.335-4.383v6.889l4.335-2.506ZM23.362 27.62a13.851 13.851 0 0 0 4.351-4.417l-4.351-2.514v6.93Z" fill="#fff"/><path d="M29.75 15.452a13.659 13.659 0 0 0-1.63-5.979l-4.381 2.53 6.011 3.45Z" fill="#fff" fill-opacity=".8"/><path d="M16.405 29.75a13.673 13.673 0 0 0 6.036-1.595l-6.036-3.498v5.093Z" fill="#fff"/><path d="M8.669 19.247v-6.494L3.03 15.986l5.639 3.261Z" fill="#fff" fill-opacity=".8"/></svg>
300
- */
301
- svgWhite: string;
302
- /**
303
- * @description SVG representation of the model in colored format.
304
- * @default <svg xmlns="http://www.w3.org/2000/svg" id="Layer_1" data-name="Layer 1" viewBox="0 0 134.95 135.02"><defs><style>.cls-1{fill:#00d3a9}.cls-2{fill:#00b39f}</style></defs><title>meshery-logo-light</title><polygon points="69.49 31.82 69.49 64.07 97.44 47.89 69.49 31.82" class="cls-1"/><polygon points="69.49 70.81 69.49 103.22 97.7 87.09 69.49 70.81" class="cls-1"/><polygon points="65.47 63.85 65.47 32.09 37.87 47.92 65.47 63.85" class="cls-2"/><path d="M10.1,103.1a67.79,67.79,0,0,0,21.41,21.55V90.71Z" class="cls-2"/><polygon points="65.47 103.06 65.47 71.05 37.8 87.07 65.47 103.06" class="cls-2"/><polygon points="35.54 122.63 63.56 106.61 35.54 90.41 35.54 122.63" class="cls-1"/><polygon points="99.61 122.8 99.61 90.63 71.63 106.63 99.61 122.8" class="cls-2"/><path d="M127,99.37a67.22,67.22,0,0,0,7.91-28.94L105.78,87.11Z" class="cls-2"/><polygon points="103.64 83.69 131.76 67.61 103.64 51.45 103.64 83.69" class="cls-1"/><polygon points="99.61 44.5 99.61 12.52 71.76 28.49 99.61 44.5" class="cls-2"/><polygon points="99.61 83.55 99.61 51.28 71.7 67.44 99.61 83.55" class="cls-2"/><polygon points="67.48 135.02 67.49 135.02 67.48 135.02 67.48 135.02" class="cls-2"/><polygon points="35.54 51.22 35.54 83.73 63.66 67.45 35.54 51.22" class="cls-1"/><path d="M65.47,0A67.2,67.2,0,0,0,35.83,7.83l29.64,17Z" class="cls-2"/><polygon points="35.54 12.3 35.54 44.62 63.68 28.48 35.54 12.3" class="cls-1"/><path d="M31.51,10.34A67.89,67.89,0,0,0,10.1,31.89L31.51,44.25Z" class="cls-2"/><path d="M99.43,8A67.23,67.23,0,0,0,69.49,0V25.15Z" class="cls-1"/><path d="M0,69.87A67.27,67.27,0,0,0,8.07,99.63L29.76,87.07Z" class="cls-1"/><path d="M8.07,35.37A67.16,67.16,0,0,0,0,65L29.79,47.91Z" class="cls-1"/><path d="M35.78,127.13A67.13,67.13,0,0,0,65.47,135V110.15Z" class="cls-2"/><path d="M124.92,32a67.9,67.9,0,0,0-21.28-21.52V44.3Z" class="cls-1"/><path d="M103.64,124.54A68,68,0,0,0,125,102.86L103.64,90.52Z" class="cls-1"/><path d="M135,64.81a67.06,67.06,0,0,0-8-29.35L105.49,47.88Z" class="cls-2"/><path d="M69.49,135a67.12,67.12,0,0,0,29.63-7.83L69.49,110Z" class="cls-1"/><polygon points="31.51 83.44 31.51 51.56 3.83 67.43 31.51 83.44" class="cls-2"/></svg>
305
- */
306
- svgColor: string;
307
- /** @description SVG representation of the complete model. */
308
- svgComplete?: string;
309
- /**
310
- * @description Visual shape used to render the model's entities in design canvases.
311
- * @enum {string}
312
- */
313
- 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";
314
- } & {
315
- [key: string]: unknown;
316
- };
317
- /** @description Registrant-defined data associated with the model. */
318
- model: {
319
- /** @description Version of the model as defined by the registrant. */
320
- version: string;
321
- };
322
- /** @description The relationships of the model. */
323
- relationships: unknown[];
324
- /** @description The components of the model. */
325
- components: unknown[];
447
+ url: string;
448
+ }
449
+ | {
326
450
  /**
327
- * @description Number of components associated with the model.
328
- * @default 0
451
+ * Format: binary
452
+ * @description Upload a CSV file containing model definitions
329
453
  */
330
- componentsCount: number;
454
+ modelCsv: string;
331
455
  /**
332
- * @description Number of relationships associated with the model.
333
- * @default 0
456
+ * Format: binary
457
+ * @description Upload a CSV file containing component definitions
334
458
  */
335
- relationshipsCount: number;
459
+ componentCsv: string;
336
460
  /**
337
- * Format: date-time
338
- * @description Timestamp when the model was created.
461
+ * Format: binary
462
+ * @description Upload a CSV file containing relationship definitions
339
463
  */
340
- createdAt?: string;
464
+ relationshipCsv: string;
465
+ }
466
+ | ({
341
467
  /**
342
- * Format: date-time
343
- * @description Timestamp when the model was last updated.
468
+ * Format: uri
469
+ * @description URI to the source code or package of the model.
344
470
  */
345
- updatedAt?: string;
346
- };
347
- RegistrantReference: {
348
- /** @description Kind of the registrant. */
349
- kind: string;
471
+ url: string;
472
+ } & {
473
+ model: unknown;
474
+ });
475
+ /**
476
+ * Upload method
477
+ * @description Choose the method you prefer to upload your model file. Select 'File Import' or 'CSV Import' if you have the file on your local system or 'URL Import' if you have the file hosted online.
478
+ * @enum {string}
479
+ */
480
+ uploadType: "file" | "urlImport" | "csv" | "url";
481
+ /** @description The register of the importrequest. */
482
+ register: boolean;
483
+ };
484
+ ImportBody:
485
+ | {
486
+ /** @description Name of the file being uploaded. */
487
+ fileName: string;
488
+ /** @description Supported model file formats are: .tar, .tar.gz, and .tgz. See [Import Models Documentation](https://docs.meshery.io/guides/configuration-management/importing-models#import-models-using-meshery-ui) for details */
489
+ modelFile: string;
490
+ }
491
+ | {
492
+ /**
493
+ * Format: uri
494
+ * @description A direct URL to a single model file, for example: https://raw.github.com/your-model-file.tar. Supported model file formats are: .tar, .tar.gz, and .tgz. \n\nFor bulk import of your model use the GitHub connection or CSV files. See [Import Models Documentation](https://docs.meshery.io/guides/configuration-management/importing-models#import-models-using-meshery-ui) for details
495
+ */
496
+ url: string;
497
+ }
498
+ | {
499
+ /**
500
+ * Format: binary
501
+ * @description Upload a CSV file containing model definitions
502
+ */
503
+ modelCsv: string;
504
+ /**
505
+ * Format: binary
506
+ * @description Upload a CSV file containing component definitions
507
+ */
508
+ componentCsv: string;
509
+ /**
510
+ * Format: binary
511
+ * @description Upload a CSV file containing relationship definitions
512
+ */
513
+ relationshipCsv: string;
514
+ }
515
+ | ({
516
+ /**
517
+ * Format: uri
518
+ * @description URI to the source code or package of the model.
519
+ */
520
+ url: string;
521
+ } & {
522
+ model: unknown;
523
+ });
524
+ /** @description Page of mesh models matching the list-endpoint query. */
525
+ MeshModelModelsPage: {
526
+ /** @description Current page number of the result set. */
527
+ page?: number;
528
+ /** @description Number of items per page. */
529
+ pageSize?: number;
530
+ /** @description Total number of items available. */
531
+ totalCount?: number;
532
+ /** @description The models of the meshmodelmodelspage. */
533
+ models?: { [key: string]: unknown }[];
534
+ };
535
+ /** @description Flat canonical representation of the model import form that combines the UI-level uploadType discriminator with the union of fields from the ImportBody oneOf variants. This schema is the authoritative source for the canonical RJSF form schema at schemas/constructs/v1beta2/model/forms/import.json. The server receives an ImportRequest; this form schema captures the superset of user-facing fields so the form schema can be validated as a subset of this canonical type. */
536
+ MesheryModelImportFormPayload: {
537
+ /**
538
+ * Upload method
539
+ * @description Choose the method you prefer. Select 'File Import' or 'CSV Import' if you have the file on your local system, or 'URL Import' if you have the file hosted online.
540
+ * @enum {string}
541
+ */
542
+ uploadType: "file" | "urlImport" | "csv";
543
+ /** @description Name of the model file being uploaded. */
544
+ fileName?: string;
545
+ /** @description Model file content. Supported formats: .tar, .tar.gz, .tgz. */
546
+ modelFile?: string;
547
+ /**
548
+ * Format: uri
549
+ * @description A direct URL to a single model file. Supported formats: .tar, .tar.gz, .tgz.
550
+ */
551
+ url?: string;
552
+ /**
553
+ * Format: binary
554
+ * @description CSV file containing model definitions.
555
+ */
556
+ modelCsv?: string;
557
+ /**
558
+ * Format: binary
559
+ * @description CSV file containing component definitions.
560
+ */
561
+ componentCsv?: string;
562
+ /**
563
+ * Format: binary
564
+ * @description CSV file containing relationship definitions.
565
+ */
566
+ relationshipCsv?: string;
567
+ };
568
+ };
569
+ responses: {
570
+ /** Expired JWT token used or insufficient privilege */
571
+ 401: {
572
+ content: {
573
+ "text/plain": string;
574
+ };
575
+ };
576
+ };
577
+ }
578
+
579
+ export interface operations {
580
+ registerMeshmodels: {
581
+ responses: {
582
+ /** Model registered */
583
+ 201: {
584
+ content: {
585
+ "application/json": {
586
+ message?: string;
587
+ };
350
588
  };
351
- /** @description Reference to the specific registered model to which the component belongs and from which model version, category, and other properties may be referenced. Learn more at https://docs.meshery.io/concepts/models */
352
- ModelReference: {
353
- /**
354
- * Format: uuid
355
- * @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
356
- */
357
- id: string;
358
- /**
359
- * @description The unique name for the model within the scope of a registrant.
360
- * @example cert-manager
361
- */
362
- name: string;
363
- /** @description Version of the model definition. */
364
- version: string;
365
- /**
366
- * @description Human-readable name for the model.
367
- * @example Cert Manager
368
- */
369
- displayName: string;
370
- /** @description Registrant-defined data associated with the model. Properties pertain to the software being managed (e.g. Kubernetes v1.31). */
371
- model: {
372
- /** @description Version of the model as defined by the registrant. */
373
- version: string;
374
- };
375
- registrant: {
376
- /** @description Kind of the registrant. */
377
- kind: string;
378
- };
589
+ };
590
+ /** Invalid request format */
591
+ 400: unknown;
592
+ /** Expired JWT token used or insufficient privilege */
593
+ 401: {
594
+ content: {
595
+ "text/plain": string;
379
596
  };
380
- ImportRequest: {
381
- importBody: {
597
+ };
598
+ /** Internal server error */
599
+ 500: unknown;
600
+ };
601
+ requestBody: {
602
+ content: {
603
+ "multipart/form-data": {
604
+ importBody:
605
+ | {
382
606
  /** @description Name of the file being uploaded. */
383
607
  fileName: string;
384
608
  /** @description Supported model file formats are: .tar, .tar.gz, and .tgz. See [Import Models Documentation](https://docs.meshery.io/guides/configuration-management/importing-models#import-models-using-meshery-ui) for details */
385
609
  modelFile: string;
386
- } | {
610
+ }
611
+ | {
387
612
  /**
388
613
  * Format: uri
389
614
  * @description A direct URL to a single model file, for example: https://raw.github.com/your-model-file.tar. Supported model file formats are: .tar, .tar.gz, and .tgz. \n\nFor bulk import of your model use the GitHub connection or CSV files. See [Import Models Documentation](https://docs.meshery.io/guides/configuration-management/importing-models#import-models-using-meshery-ui) for details
390
615
  */
391
616
  url: string;
392
- } | {
617
+ }
618
+ | {
393
619
  /**
394
620
  * Format: binary
395
621
  * @description Upload a CSV file containing model definitions
@@ -405,58 +631,46 @@ export interface components {
405
631
  * @description Upload a CSV file containing relationship definitions
406
632
  */
407
633
  relationshipCsv: string;
408
- } | {
634
+ }
635
+ | ({
409
636
  /**
410
637
  * Format: uri
411
638
  * @description URI to the source code or package of the model.
412
639
  */
413
640
  url: string;
414
- };
415
- /**
416
- * Upload method
417
- * @description Choose the method you prefer to upload your model file. Select 'File Import' or 'CSV Import' if you have the file on your local system or 'URL Import' if you have the file hosted online.
418
- * @enum {string}
419
- */
420
- uploadType: "file" | "urlImport" | "csv" | "url";
421
- /** @description The register of the importrequest. */
422
- register: boolean;
641
+ } & {
642
+ model: unknown;
643
+ });
644
+ /**
645
+ * Upload method
646
+ * @description Choose the method you prefer to upload your model file. Select 'File Import' or 'CSV Import' if you have the file on your local system or 'URL Import' if you have the file hosted online.
647
+ * @enum {string}
648
+ */
649
+ uploadType: "file" | "urlImport" | "csv" | "url";
650
+ /** @description The register of the importrequest. */
651
+ register: boolean;
423
652
  };
424
- ImportBody: {
425
- /** @description Name of the file being uploaded. */
426
- fileName: string;
427
- /** @description Supported model file formats are: .tar, .tar.gz, and .tgz. See [Import Models Documentation](https://docs.meshery.io/guides/configuration-management/importing-models#import-models-using-meshery-ui) for details */
428
- modelFile: string;
429
- } | {
430
- /**
431
- * Format: uri
432
- * @description A direct URL to a single model file, for example: https://raw.github.com/your-model-file.tar. Supported model file formats are: .tar, .tar.gz, and .tgz. \n\nFor bulk import of your model use the GitHub connection or CSV files. See [Import Models Documentation](https://docs.meshery.io/guides/configuration-management/importing-models#import-models-using-meshery-ui) for details
433
- */
434
- url: string;
435
- } | {
436
- /**
437
- * Format: binary
438
- * @description Upload a CSV file containing model definitions
439
- */
440
- modelCsv: string;
441
- /**
442
- * Format: binary
443
- * @description Upload a CSV file containing component definitions
444
- */
445
- componentCsv: string;
446
- /**
447
- * Format: binary
448
- * @description Upload a CSV file containing relationship definitions
449
- */
450
- relationshipCsv: string;
451
- } | {
452
- /**
453
- * Format: uri
454
- * @description URI to the source code or package of the model.
455
- */
456
- url: string;
457
- };
458
- /** @description Page of mesh models matching the list-endpoint query. */
459
- MeshModelModelsPage: {
653
+ };
654
+ };
655
+ };
656
+ getMeshModelModels: {
657
+ parameters: {
658
+ query: {
659
+ /** Current page number of the result set. */
660
+ page?: number;
661
+ /** Number of items per page. */
662
+ pageSize?: number;
663
+ /** Free-text search query applied to model names. */
664
+ search?: string;
665
+ /** Sort order for the result set (e.g. "name asc"). */
666
+ order?: string;
667
+ };
668
+ };
669
+ responses: {
670
+ /** Model and capabilities registry entries retrieved. */
671
+ 200: {
672
+ content: {
673
+ "application/json": {
460
674
  /** @description Current page number of the result set. */
461
675
  page?: number;
462
676
  /** @description Number of items per page. */
@@ -464,208 +678,20 @@ export interface components {
464
678
  /** @description Total number of items available. */
465
679
  totalCount?: number;
466
680
  /** @description The models of the meshmodelmodelspage. */
467
- models?: {
468
- [key: string]: unknown;
469
- }[];
681
+ models?: { [key: string]: unknown }[];
682
+ };
470
683
  };
471
- /** @description Flat canonical representation of the model import form that combines the UI-level uploadType discriminator with the union of fields from the ImportBody oneOf variants. This schema is the authoritative source for the canonical RJSF form schema at schemas/constructs/v1beta2/model/forms/import.json. The server receives an ImportRequest; this form schema captures the superset of user-facing fields so the form schema can be validated as a subset of this canonical type. */
472
- MesheryModelImportFormPayload: {
473
- /**
474
- * Upload method
475
- * @description Choose the method you prefer. Select 'File Import' or 'CSV Import' if you have the file on your local system, or 'URL Import' if you have the file hosted online.
476
- * @enum {string}
477
- */
478
- uploadType: "file" | "urlImport" | "csv";
479
- /** @description Name of the model file being uploaded. */
480
- fileName?: string;
481
- /** @description Model file content. Supported formats: .tar, .tar.gz, .tgz. */
482
- modelFile?: string;
483
- /**
484
- * Format: uri
485
- * @description A direct URL to a single model file. Supported formats: .tar, .tar.gz, .tgz.
486
- */
487
- url?: string;
488
- /**
489
- * Format: binary
490
- * @description CSV file containing model definitions.
491
- */
492
- modelCsv?: string;
493
- /**
494
- * Format: binary
495
- * @description CSV file containing component definitions.
496
- */
497
- componentCsv?: string;
498
- /**
499
- * Format: binary
500
- * @description CSV file containing relationship definitions.
501
- */
502
- relationshipCsv?: string;
503
- };
504
- };
505
- responses: {
506
- /** @description Expired JWT token used or insufficient privilege */
507
- 401: {
508
- headers: {
509
- [name: string]: unknown;
510
- };
511
- content: {
512
- "text/plain": string;
513
- };
514
- };
515
- };
516
- parameters: never;
517
- requestBodies: never;
518
- headers: never;
519
- pathItems: never;
520
- }
521
- export type $defs = Record<string, never>;
522
- export interface operations {
523
- registerMeshmodels: {
524
- parameters: {
525
- query?: never;
526
- header?: never;
527
- path?: never;
528
- cookie?: never;
529
- };
530
- requestBody: {
531
- content: {
532
- "multipart/form-data": {
533
- importBody: {
534
- /** @description Name of the file being uploaded. */
535
- fileName: string;
536
- /** @description Supported model file formats are: .tar, .tar.gz, and .tgz. See [Import Models Documentation](https://docs.meshery.io/guides/configuration-management/importing-models#import-models-using-meshery-ui) for details */
537
- modelFile: string;
538
- } | {
539
- /**
540
- * Format: uri
541
- * @description A direct URL to a single model file, for example: https://raw.github.com/your-model-file.tar. Supported model file formats are: .tar, .tar.gz, and .tgz. \n\nFor bulk import of your model use the GitHub connection or CSV files. See [Import Models Documentation](https://docs.meshery.io/guides/configuration-management/importing-models#import-models-using-meshery-ui) for details
542
- */
543
- url: string;
544
- } | {
545
- /**
546
- * Format: binary
547
- * @description Upload a CSV file containing model definitions
548
- */
549
- modelCsv: string;
550
- /**
551
- * Format: binary
552
- * @description Upload a CSV file containing component definitions
553
- */
554
- componentCsv: string;
555
- /**
556
- * Format: binary
557
- * @description Upload a CSV file containing relationship definitions
558
- */
559
- relationshipCsv: string;
560
- } | {
561
- /**
562
- * Format: uri
563
- * @description URI to the source code or package of the model.
564
- */
565
- url: string;
566
- };
567
- /**
568
- * Upload method
569
- * @description Choose the method you prefer to upload your model file. Select 'File Import' or 'CSV Import' if you have the file on your local system or 'URL Import' if you have the file hosted online.
570
- * @enum {string}
571
- */
572
- uploadType: "file" | "urlImport" | "csv" | "url";
573
- /** @description The register of the importrequest. */
574
- register: boolean;
575
- };
576
- };
577
- };
578
- responses: {
579
- /** @description Model registered */
580
- 201: {
581
- headers: {
582
- [name: string]: unknown;
583
- };
584
- content: {
585
- "application/json": {
586
- message?: string;
587
- };
588
- };
589
- };
590
- /** @description Invalid request format */
591
- 400: {
592
- headers: {
593
- [name: string]: unknown;
594
- };
595
- content?: never;
596
- };
597
- /** @description Expired JWT token used or insufficient privilege */
598
- 401: {
599
- headers: {
600
- [name: string]: unknown;
601
- };
602
- content: {
603
- "text/plain": string;
604
- };
605
- };
606
- /** @description Internal server error */
607
- 500: {
608
- headers: {
609
- [name: string]: unknown;
610
- };
611
- content?: never;
612
- };
613
- };
614
- };
615
- getMeshModelModels: {
616
- parameters: {
617
- query?: {
618
- /** @description Current page number of the result set. */
619
- page?: number;
620
- /** @description Number of items per page. */
621
- pageSize?: number;
622
- /** @description Free-text search query applied to model names. */
623
- search?: string;
624
- /** @description Sort order for the result set (e.g. "name asc"). */
625
- order?: string;
626
- };
627
- header?: never;
628
- path?: never;
629
- cookie?: never;
630
- };
631
- requestBody?: never;
632
- responses: {
633
- /** @description Model and capabilities registry entries retrieved. */
634
- 200: {
635
- headers: {
636
- [name: string]: unknown;
637
- };
638
- content: {
639
- "application/json": {
640
- /** @description Current page number of the result set. */
641
- page?: number;
642
- /** @description Number of items per page. */
643
- pageSize?: number;
644
- /** @description Total number of items available. */
645
- totalCount?: number;
646
- /** @description The models of the meshmodelmodelspage. */
647
- models?: {
648
- [key: string]: unknown;
649
- }[];
650
- };
651
- };
652
- };
653
- /** @description Expired JWT token used or insufficient privilege */
654
- 401: {
655
- headers: {
656
- [name: string]: unknown;
657
- };
658
- content: {
659
- "text/plain": string;
660
- };
661
- };
662
- /** @description Internal server error */
663
- 500: {
664
- headers: {
665
- [name: string]: unknown;
666
- };
667
- content?: never;
668
- };
684
+ };
685
+ /** Expired JWT token used or insufficient privilege */
686
+ 401: {
687
+ content: {
688
+ "text/plain": string;
669
689
  };
690
+ };
691
+ /** Internal server error */
692
+ 500: unknown;
670
693
  };
694
+ };
671
695
  }
696
+
697
+ export interface external {}