@meshery/schemas 1.2.14 → 1.2.16

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 (151) hide show
  1. package/dist/cloudApi.d.mts +1516 -1516
  2. package/dist/cloudApi.d.ts +1516 -1516
  3. package/dist/constructs/v1alpha1/capability/Capability.d.ts +114 -0
  4. package/dist/constructs/v1alpha1/capability/CapabilitySchema.d.ts +2 -0
  5. package/dist/constructs/v1alpha1/core/Core.d.ts +832 -0
  6. package/dist/constructs/v1alpha1/core/CoreSchema.d.ts +2 -0
  7. package/dist/constructs/v1alpha2/catalog/Catalog.d.ts +53 -0
  8. package/dist/constructs/v1alpha2/catalog/CatalogSchema.d.ts +2 -0
  9. package/dist/constructs/v1alpha3/relationship/Relationship.d.ts +1937 -0
  10. package/dist/constructs/v1alpha3/relationship/RelationshipSchema.d.ts +2 -0
  11. package/dist/constructs/v1beta1/academy/Academy.d.ts +6417 -0
  12. package/dist/constructs/v1beta1/academy/AcademySchema.d.ts +2 -0
  13. package/dist/constructs/v1beta1/badge/Badge.d.ts +546 -0
  14. package/dist/constructs/v1beta1/badge/BadgeSchema.d.ts +2 -0
  15. package/dist/constructs/v1beta1/capability/Capability.d.ts +114 -0
  16. package/dist/constructs/v1beta1/capability/CapabilitySchema.d.ts +2 -0
  17. package/dist/constructs/v1beta1/catalog/Catalog.d.ts +53 -0
  18. package/dist/constructs/v1beta1/catalog/CatalogSchema.d.ts +2 -0
  19. package/dist/constructs/v1beta1/category/Category.d.ts +46 -0
  20. package/dist/constructs/v1beta1/category/CategorySchema.d.ts +2 -0
  21. package/dist/constructs/v1beta1/component/Component.d.ts +869 -0
  22. package/dist/constructs/v1beta1/component/ComponentSchema.d.ts +2 -0
  23. package/dist/constructs/v1beta1/connection/Connection.d.ts +1300 -0
  24. package/dist/constructs/v1beta1/connection/ConnectionSchema.d.ts +2 -0
  25. package/dist/constructs/v1beta1/core/Core.d.ts +832 -0
  26. package/dist/constructs/v1beta1/core/CoreSchema.d.ts +2 -0
  27. package/dist/constructs/v1beta1/credential/Credential.d.ts +530 -0
  28. package/dist/constructs/v1beta1/credential/CredentialSchema.d.ts +2 -0
  29. package/dist/constructs/v1beta1/environment/Environment.d.ts +759 -0
  30. package/dist/constructs/v1beta1/environment/EnvironmentSchema.d.ts +2 -0
  31. package/dist/constructs/v1beta1/evaluation/Evaluation.d.ts +6338 -0
  32. package/dist/constructs/v1beta1/evaluation/EvaluationSchema.d.ts +2 -0
  33. package/dist/constructs/v1beta1/event/Event.d.ts +570 -0
  34. package/dist/constructs/v1beta1/event/EventSchema.d.ts +2 -0
  35. package/dist/constructs/v1beta1/feature/Feature.d.ts +308 -0
  36. package/dist/constructs/v1beta1/feature/FeatureSchema.d.ts +2 -0
  37. package/dist/constructs/v1beta1/invitation/Invitation.d.ts +983 -0
  38. package/dist/constructs/v1beta1/invitation/InvitationSchema.d.ts +2 -0
  39. package/dist/constructs/v1beta1/key/Key.d.ts +514 -0
  40. package/dist/constructs/v1beta1/key/KeySchema.d.ts +2 -0
  41. package/dist/constructs/v1beta1/keychain/Keychain.d.ts +642 -0
  42. package/dist/constructs/v1beta1/keychain/KeychainSchema.d.ts +2 -0
  43. package/dist/constructs/v1beta1/model/Model.d.ts +659 -0
  44. package/dist/constructs/v1beta1/model/ModelSchema.d.ts +2 -0
  45. package/dist/constructs/v1beta1/organization/Organization.d.ts +1598 -0
  46. package/dist/constructs/v1beta1/organization/OrganizationSchema.d.ts +2 -0
  47. package/dist/constructs/v1beta1/pattern/Pattern.d.ts +18407 -0
  48. package/dist/constructs/v1beta1/pattern/PatternSchema.d.ts +2 -0
  49. package/dist/constructs/v1beta1/plan/Plan.d.ts +149 -0
  50. package/dist/constructs/v1beta1/plan/PlanSchema.d.ts +2 -0
  51. package/dist/constructs/v1beta1/relationship/Relationship.d.ts +1921 -0
  52. package/dist/constructs/v1beta1/relationship/RelationshipSchema.d.ts +2 -0
  53. package/dist/constructs/v1beta1/role/Role.d.ts +745 -0
  54. package/dist/constructs/v1beta1/role/RoleSchema.d.ts +2 -0
  55. package/dist/constructs/v1beta1/schedule/Schedule.d.ts +374 -0
  56. package/dist/constructs/v1beta1/schedule/ScheduleSchema.d.ts +2 -0
  57. package/dist/constructs/v1beta1/subcategory/Subcategory.d.ts +68 -0
  58. package/dist/constructs/v1beta1/subcategory/SubcategorySchema.d.ts +2 -0
  59. package/dist/constructs/v1beta1/subscription/Subscription.d.ts +752 -0
  60. package/dist/constructs/v1beta1/subscription/SubscriptionSchema.d.ts +2 -0
  61. package/dist/constructs/v1beta1/support/Support.d.ts +91 -0
  62. package/dist/constructs/v1beta1/support/SupportSchema.d.ts +2 -0
  63. package/dist/constructs/v1beta1/team/Team.d.ts +846 -0
  64. package/dist/constructs/v1beta1/team/TeamSchema.d.ts +2 -0
  65. package/dist/constructs/v1beta1/token/Token.d.ts +539 -0
  66. package/dist/constructs/v1beta1/token/TokenSchema.d.ts +2 -0
  67. package/dist/constructs/v1beta1/user/User.d.ts +1677 -0
  68. package/dist/constructs/v1beta1/user/UserSchema.d.ts +2 -0
  69. package/dist/constructs/v1beta1/view/View.d.ts +759 -0
  70. package/dist/constructs/v1beta1/view/ViewSchema.d.ts +2 -0
  71. package/dist/constructs/v1beta1/workspace/Workspace.d.ts +4947 -0
  72. package/dist/constructs/v1beta1/workspace/WorkspaceSchema.d.ts +2 -0
  73. package/dist/constructs/v1beta2/academy/Academy.d.ts +7762 -0
  74. package/dist/constructs/v1beta2/academy/AcademySchema.d.ts +2 -0
  75. package/dist/constructs/v1beta2/badge/Badge.d.ts +563 -0
  76. package/dist/constructs/v1beta2/badge/BadgeSchema.d.ts +2 -0
  77. package/dist/constructs/v1beta2/catalog/Catalog.d.ts +53 -0
  78. package/dist/constructs/v1beta2/catalog/CatalogSchema.d.ts +2 -0
  79. package/dist/constructs/v1beta2/component/Component.d.ts +887 -0
  80. package/dist/constructs/v1beta2/component/ComponentSchema.d.ts +2 -0
  81. package/dist/constructs/v1beta2/connection/Connection.d.ts +1330 -0
  82. package/dist/constructs/v1beta2/connection/ConnectionSchema.d.ts +2 -0
  83. package/dist/constructs/v1beta2/core/Core.d.ts +866 -0
  84. package/dist/constructs/v1beta2/core/CoreSchema.d.ts +2 -0
  85. package/dist/constructs/v1beta2/credential/Credential.d.ts +519 -0
  86. package/dist/constructs/v1beta2/credential/CredentialSchema.d.ts +2 -0
  87. package/dist/constructs/v1beta2/design/Design.d.ts +19039 -0
  88. package/dist/constructs/v1beta2/design/DesignSchema.d.ts +2 -0
  89. package/dist/constructs/v1beta2/event/Event.d.ts +626 -0
  90. package/dist/constructs/v1beta2/event/EventSchema.d.ts +2 -0
  91. package/dist/constructs/v1beta2/invitation/Invitation.d.ts +1052 -0
  92. package/dist/constructs/v1beta2/invitation/InvitationSchema.d.ts +2 -0
  93. package/dist/constructs/v1beta2/key/Key.d.ts +524 -0
  94. package/dist/constructs/v1beta2/key/KeySchema.d.ts +2 -0
  95. package/dist/constructs/v1beta2/keychain/Keychain.d.ts +652 -0
  96. package/dist/constructs/v1beta2/keychain/KeychainSchema.d.ts +2 -0
  97. package/dist/constructs/v1beta2/model/Model.d.ts +697 -0
  98. package/dist/constructs/v1beta2/model/ModelSchema.d.ts +2 -0
  99. package/dist/constructs/v1beta2/organization/Organization.d.ts +1915 -0
  100. package/dist/constructs/v1beta2/organization/OrganizationSchema.d.ts +2 -0
  101. package/dist/constructs/v1beta2/plan/Plan.d.ts +162 -0
  102. package/dist/constructs/v1beta2/plan/PlanSchema.d.ts +2 -0
  103. package/dist/constructs/v1beta2/relationship/Relationship.d.ts +2134 -0
  104. package/dist/constructs/v1beta2/relationship/RelationshipSchema.d.ts +2 -0
  105. package/dist/constructs/v1beta2/role/Role.d.ts +752 -0
  106. package/dist/constructs/v1beta2/role/RoleSchema.d.ts +2 -0
  107. package/dist/constructs/v1beta2/schedule/Schedule.d.ts +431 -0
  108. package/dist/constructs/v1beta2/schedule/ScheduleSchema.d.ts +2 -0
  109. package/dist/constructs/v1beta2/subscription/Subscription.d.ts +785 -0
  110. package/dist/constructs/v1beta2/subscription/SubscriptionSchema.d.ts +2 -0
  111. package/dist/constructs/v1beta2/team/Team.d.ts +960 -0
  112. package/dist/constructs/v1beta2/team/TeamSchema.d.ts +2 -0
  113. package/dist/constructs/v1beta2/token/Token.d.ts +544 -0
  114. package/dist/constructs/v1beta2/token/TokenSchema.d.ts +2 -0
  115. package/dist/constructs/v1beta2/user/User.d.ts +1677 -0
  116. package/dist/constructs/v1beta2/user/UserSchema.d.ts +2 -0
  117. package/dist/constructs/v1beta2/view/View.d.ts +767 -0
  118. package/dist/constructs/v1beta2/view/ViewSchema.d.ts +2 -0
  119. package/dist/constructs/v1beta3/academy/Academy.d.ts +7762 -0
  120. package/dist/constructs/v1beta3/academy/AcademySchema.d.ts +2 -0
  121. package/dist/constructs/v1beta3/component/Component.d.ts +892 -0
  122. package/dist/constructs/v1beta3/component/ComponentSchema.d.ts +2 -0
  123. package/dist/constructs/v1beta3/connection/Connection.d.ts +1414 -0
  124. package/dist/constructs/v1beta3/connection/ConnectionSchema.d.ts +2 -0
  125. package/dist/constructs/v1beta3/design/Design.d.ts +5704 -0
  126. package/dist/constructs/v1beta3/design/DesignSchema.d.ts +2 -0
  127. package/dist/constructs/v1beta3/environment/Environment.d.ts +785 -0
  128. package/dist/constructs/v1beta3/environment/EnvironmentSchema.d.ts +2 -0
  129. package/dist/constructs/v1beta3/event/Event.d.ts +720 -0
  130. package/dist/constructs/v1beta3/event/EventSchema.d.ts +2 -0
  131. package/dist/constructs/v1beta3/filter/Filter.d.ts +1452 -0
  132. package/dist/constructs/v1beta3/filter/FilterSchema.d.ts +2 -0
  133. package/dist/constructs/v1beta3/invitation/Invitation.d.ts +1060 -0
  134. package/dist/constructs/v1beta3/invitation/InvitationSchema.d.ts +2 -0
  135. package/dist/constructs/v1beta3/performance_profile/PerformanceProfile.d.ts +813 -0
  136. package/dist/constructs/v1beta3/performance_profile/PerformanceProfileSchema.d.ts +2 -0
  137. package/dist/constructs/v1beta3/plan/Plan.d.ts +199 -0
  138. package/dist/constructs/v1beta3/plan/PlanSchema.d.ts +2 -0
  139. package/dist/constructs/v1beta3/relationship/Relationship.d.ts +2134 -0
  140. package/dist/constructs/v1beta3/relationship/RelationshipSchema.d.ts +2 -0
  141. package/dist/constructs/v1beta3/subscription/Subscription.d.ts +915 -0
  142. package/dist/constructs/v1beta3/subscription/SubscriptionSchema.d.ts +2 -0
  143. package/dist/constructs/v1beta3/token/Token.d.ts +544 -0
  144. package/dist/constructs/v1beta3/token/TokenSchema.d.ts +2 -0
  145. package/dist/constructs/v1beta3/workspace/Workspace.d.ts +5086 -0
  146. package/dist/constructs/v1beta3/workspace/WorkspaceSchema.d.ts +2 -0
  147. package/dist/index.js +1 -1
  148. package/dist/index.mjs +1 -1
  149. package/dist/mesheryApi.d.mts +546 -546
  150. package/dist/mesheryApi.d.ts +546 -546
  151. package/package.json +2 -2
@@ -0,0 +1,659 @@
1
+ /**
2
+ * This file was auto-generated by openapi-typescript.
3
+ * Do not make direct changes to the file.
4
+ */
5
+
6
+ export interface paths {
7
+ "/api/meshmodels/register": {
8
+ post: operations["registerMeshmodels"];
9
+ };
10
+ "/api/integrations/meshmodels/models": {
11
+ get: operations["getMeshModelModels"];
12
+ };
13
+ }
14
+
15
+ export interface components {
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/v1beta1
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 Meshery Connections are managed and unmanaged resources that either through discovery or manual entry are tracked by Meshery. Learn more at https://docs.meshery.io/concepts/logical/connections */
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 of the model. */
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 of the model determines the secondary grouping.
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 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)
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. Properties pertain to the software being managed (e.g. Kubernetes v1.31). */
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 resource was created.
399
+ */
400
+ created_at?: string;
401
+ /**
402
+ * Format: date-time
403
+ * @description Timestamp when the resource was updated.
404
+ */
405
+ updated_at?: 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
+ | {
443
+ /**
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
446
+ */
447
+ url: string;
448
+ }
449
+ | {
450
+ /**
451
+ * Format: binary
452
+ * @description Upload a CSV file containing model definitions
453
+ */
454
+ modelCsv: string;
455
+ /**
456
+ * Format: binary
457
+ * @description Upload a CSV file containing component definitions
458
+ */
459
+ componentCsv: string;
460
+ /**
461
+ * Format: binary
462
+ * @description Upload a CSV file containing relationship definitions
463
+ */
464
+ relationshipCsv: string;
465
+ }
466
+ | ({
467
+ /**
468
+ * Format: uri
469
+ * @description URI to the source code or package of the model.
470
+ */
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
+ MeshModelModelsPage: {
525
+ /** @description Current page number of the result set. */
526
+ page?: number;
527
+ /** @description Number of items per page. */
528
+ page_size?: number;
529
+ /** @description Total number of items available. */
530
+ total_count?: number;
531
+ /** @description The models of the meshmodelmodelspage. */
532
+ models?: { [key: string]: unknown }[];
533
+ };
534
+ };
535
+ responses: {
536
+ /** Expired JWT token used or insufficient privilege */
537
+ 401: {
538
+ content: {
539
+ "text/plain": string;
540
+ };
541
+ };
542
+ };
543
+ }
544
+
545
+ export interface operations {
546
+ registerMeshmodels: {
547
+ responses: {
548
+ /** Successful registration */
549
+ 201: {
550
+ content: {
551
+ "application/json": {
552
+ message?: string;
553
+ };
554
+ };
555
+ };
556
+ /** Invalid request format */
557
+ 400: unknown;
558
+ /** Expired JWT token used or insufficient privilege */
559
+ 401: {
560
+ content: {
561
+ "text/plain": string;
562
+ };
563
+ };
564
+ /** Internal server error */
565
+ 500: unknown;
566
+ };
567
+ requestBody: {
568
+ content: {
569
+ "multipart/form-data": {
570
+ importBody:
571
+ | {
572
+ /** @description Name of the file being uploaded. */
573
+ fileName: string;
574
+ /** @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 */
575
+ modelFile: string;
576
+ }
577
+ | {
578
+ /**
579
+ * Format: uri
580
+ * @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
581
+ */
582
+ url: string;
583
+ }
584
+ | {
585
+ /**
586
+ * Format: binary
587
+ * @description Upload a CSV file containing model definitions
588
+ */
589
+ modelCsv: string;
590
+ /**
591
+ * Format: binary
592
+ * @description Upload a CSV file containing component definitions
593
+ */
594
+ componentCsv: string;
595
+ /**
596
+ * Format: binary
597
+ * @description Upload a CSV file containing relationship definitions
598
+ */
599
+ relationshipCsv: string;
600
+ }
601
+ | ({
602
+ /**
603
+ * Format: uri
604
+ * @description URI to the source code or package of the model.
605
+ */
606
+ url: string;
607
+ } & {
608
+ model: unknown;
609
+ });
610
+ /**
611
+ * Upload method
612
+ * @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.
613
+ * @enum {string}
614
+ */
615
+ uploadType: "file" | "urlImport" | "csv" | "url";
616
+ /** @description The register of the importrequest. */
617
+ register: boolean;
618
+ };
619
+ };
620
+ };
621
+ };
622
+ getMeshModelModels: {
623
+ parameters: {
624
+ query: {
625
+ page?: string;
626
+ pagesize?: string;
627
+ search?: string;
628
+ order?: string;
629
+ };
630
+ };
631
+ responses: {
632
+ /** Model and capabilities registry entries retrieved. */
633
+ 200: {
634
+ content: {
635
+ "application/json": {
636
+ /** @description Current page number of the result set. */
637
+ page?: number;
638
+ /** @description Number of items per page. */
639
+ page_size?: number;
640
+ /** @description Total number of items available. */
641
+ total_count?: number;
642
+ /** @description The models of the meshmodelmodelspage. */
643
+ models?: { [key: string]: unknown }[];
644
+ };
645
+ };
646
+ };
647
+ /** Expired JWT token used or insufficient privilege */
648
+ 401: {
649
+ content: {
650
+ "text/plain": string;
651
+ };
652
+ };
653
+ /** Internal server error */
654
+ 500: unknown;
655
+ };
656
+ };
657
+ }
658
+
659
+ export interface external {}
@@ -0,0 +1,2 @@
1
+ declare const ModelSchema: Record<string, unknown>;
2
+ export default ModelSchema;