@meshery/schemas 1.0.9 → 1.1.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 (236) hide show
  1. package/README.md +4 -3
  2. package/dist/cloudApi.d.mts +16689 -16426
  3. package/dist/cloudApi.d.ts +16689 -16426
  4. package/dist/cloudApi.js +1 -1
  5. package/dist/cloudApi.mjs +1 -1
  6. package/dist/constructs/v1beta1/badge/BadgeSchema.js +1 -1
  7. package/dist/constructs/v1beta1/badge/BadgeSchema.mjs +1 -1
  8. package/dist/constructs/v1beta1/connection/ConnectionSchema.js +1 -1
  9. package/dist/constructs/v1beta1/connection/ConnectionSchema.mjs +1 -1
  10. package/dist/constructs/v1beta1/credential/CredentialSchema.js +4 -4
  11. package/dist/constructs/v1beta1/credential/CredentialSchema.mjs +4 -4
  12. package/dist/constructs/v1beta1/environment/EnvironmentSchema.js +1 -1
  13. package/dist/constructs/v1beta1/environment/EnvironmentSchema.mjs +1 -1
  14. package/dist/constructs/v1beta1/event/EventSchema.js +1 -1
  15. package/dist/constructs/v1beta1/event/EventSchema.mjs +1 -1
  16. package/dist/constructs/v1beta1/key/KeySchema.js +1 -1
  17. package/dist/constructs/v1beta1/key/KeySchema.mjs +1 -1
  18. package/dist/constructs/v1beta1/keychain/KeychainSchema.js +1 -1
  19. package/dist/constructs/v1beta1/keychain/KeychainSchema.mjs +1 -1
  20. package/dist/constructs/v1beta1/model/ModelSchema.js +1 -1
  21. package/dist/constructs/v1beta1/model/ModelSchema.mjs +1 -1
  22. package/dist/constructs/v1beta1/organization/OrganizationSchema.js +1 -1
  23. package/dist/constructs/v1beta1/organization/OrganizationSchema.mjs +1 -1
  24. package/dist/constructs/v1beta1/pattern/PatternSchema.js +1 -1
  25. package/dist/constructs/v1beta1/pattern/PatternSchema.mjs +1 -1
  26. package/dist/constructs/v1beta1/role/RoleSchema.js +1 -1
  27. package/dist/constructs/v1beta1/role/RoleSchema.mjs +1 -1
  28. package/dist/constructs/v1beta1/schedule/ScheduleSchema.js +1 -1
  29. package/dist/constructs/v1beta1/schedule/ScheduleSchema.mjs +1 -1
  30. package/dist/constructs/v1beta1/team/TeamSchema.js +1 -1
  31. package/dist/constructs/v1beta1/team/TeamSchema.mjs +1 -1
  32. package/dist/constructs/v1beta1/user/UserSchema.js +1 -1
  33. package/dist/constructs/v1beta1/user/UserSchema.mjs +1 -1
  34. package/dist/constructs/v1beta1/view/ViewSchema.js +1 -1
  35. package/dist/constructs/v1beta1/view/ViewSchema.mjs +1 -1
  36. package/dist/constructs/v1beta1/workspace/WorkspaceSchema.js +2 -2
  37. package/dist/constructs/v1beta1/workspace/WorkspaceSchema.mjs +2 -2
  38. package/dist/constructs/v1beta2/badge/Badge.d.mts +564 -0
  39. package/dist/constructs/v1beta2/badge/Badge.d.ts +564 -0
  40. package/dist/constructs/v1beta2/badge/Badge.js +1 -0
  41. package/dist/constructs/v1beta2/badge/Badge.mjs +0 -0
  42. package/dist/constructs/v1beta2/badge/BadgeSchema.d.mts +7 -0
  43. package/dist/constructs/v1beta2/badge/BadgeSchema.d.ts +7 -0
  44. package/dist/constructs/v1beta2/badge/BadgeSchema.js +2 -0
  45. package/dist/constructs/v1beta2/badge/BadgeSchema.mjs +2 -0
  46. package/dist/constructs/v1beta2/connection/ConnectionSchema.js +1 -1
  47. package/dist/constructs/v1beta2/connection/ConnectionSchema.mjs +1 -1
  48. package/dist/constructs/v1beta2/credential/Credential.d.mts +536 -0
  49. package/dist/constructs/v1beta2/credential/Credential.d.ts +536 -0
  50. package/dist/constructs/v1beta2/credential/Credential.js +1 -0
  51. package/dist/constructs/v1beta2/credential/Credential.mjs +0 -0
  52. package/dist/constructs/v1beta2/credential/CredentialSchema.d.mts +7 -0
  53. package/dist/constructs/v1beta2/credential/CredentialSchema.d.ts +7 -0
  54. package/dist/constructs/v1beta2/credential/CredentialSchema.js +7 -0
  55. package/dist/constructs/v1beta2/credential/CredentialSchema.mjs +7 -0
  56. package/dist/constructs/v1beta2/design/DesignSchema.js +10 -2
  57. package/dist/constructs/v1beta2/design/DesignSchema.mjs +10 -2
  58. package/dist/constructs/v1beta2/event/EventSchema.js +1 -1
  59. package/dist/constructs/v1beta2/event/EventSchema.mjs +1 -1
  60. package/dist/constructs/v1beta2/invitation/InvitationSchema.js +1 -1
  61. package/dist/constructs/v1beta2/invitation/InvitationSchema.mjs +1 -1
  62. package/dist/constructs/v1beta2/key/Key.d.mts +523 -0
  63. package/dist/constructs/v1beta2/key/Key.d.ts +523 -0
  64. package/dist/constructs/v1beta2/key/Key.js +1 -0
  65. package/dist/constructs/v1beta2/key/Key.mjs +0 -0
  66. package/dist/constructs/v1beta2/key/KeySchema.d.mts +7 -0
  67. package/dist/constructs/v1beta2/key/KeySchema.d.ts +7 -0
  68. package/dist/constructs/v1beta2/key/KeySchema.js +2 -0
  69. package/dist/constructs/v1beta2/key/KeySchema.mjs +2 -0
  70. package/dist/constructs/v1beta2/keychain/Keychain.d.mts +651 -0
  71. package/dist/constructs/v1beta2/keychain/Keychain.d.ts +651 -0
  72. package/dist/constructs/v1beta2/keychain/Keychain.js +1 -0
  73. package/dist/constructs/v1beta2/keychain/Keychain.mjs +0 -0
  74. package/dist/constructs/v1beta2/keychain/KeychainSchema.d.mts +7 -0
  75. package/dist/constructs/v1beta2/keychain/KeychainSchema.d.ts +7 -0
  76. package/dist/constructs/v1beta2/keychain/KeychainSchema.js +2 -0
  77. package/dist/constructs/v1beta2/keychain/KeychainSchema.mjs +2 -0
  78. package/dist/constructs/v1beta2/model/Model.d.mts +571 -0
  79. package/dist/constructs/v1beta2/model/Model.d.ts +571 -0
  80. package/dist/constructs/v1beta2/model/Model.js +1 -0
  81. package/dist/constructs/v1beta2/model/Model.mjs +0 -0
  82. package/dist/constructs/v1beta2/model/ModelSchema.d.mts +7 -0
  83. package/dist/constructs/v1beta2/model/ModelSchema.d.ts +7 -0
  84. package/dist/constructs/v1beta2/model/ModelSchema.js +6 -0
  85. package/dist/constructs/v1beta2/model/ModelSchema.mjs +6 -0
  86. package/dist/constructs/v1beta2/organization/Organization.d.mts +1986 -0
  87. package/dist/constructs/v1beta2/organization/Organization.d.ts +1986 -0
  88. package/dist/constructs/v1beta2/organization/Organization.js +1 -0
  89. package/dist/constructs/v1beta2/organization/Organization.mjs +0 -0
  90. package/dist/constructs/v1beta2/organization/OrganizationSchema.d.mts +7 -0
  91. package/dist/constructs/v1beta2/organization/OrganizationSchema.d.ts +7 -0
  92. package/dist/constructs/v1beta2/organization/OrganizationSchema.js +2 -0
  93. package/dist/constructs/v1beta2/organization/OrganizationSchema.mjs +2 -0
  94. package/dist/constructs/v1beta2/plan/PlanSchema.js +1 -1
  95. package/dist/constructs/v1beta2/plan/PlanSchema.mjs +1 -1
  96. package/dist/constructs/v1beta2/role/Role.d.mts +751 -0
  97. package/dist/constructs/v1beta2/role/Role.d.ts +751 -0
  98. package/dist/constructs/v1beta2/role/Role.js +1 -0
  99. package/dist/constructs/v1beta2/role/Role.mjs +0 -0
  100. package/dist/constructs/v1beta2/role/RoleSchema.d.mts +7 -0
  101. package/dist/constructs/v1beta2/role/RoleSchema.d.ts +7 -0
  102. package/dist/constructs/v1beta2/role/RoleSchema.js +2 -0
  103. package/dist/constructs/v1beta2/role/RoleSchema.mjs +2 -0
  104. package/dist/constructs/v1beta2/schedule/Schedule.d.mts +380 -0
  105. package/dist/constructs/v1beta2/schedule/Schedule.d.ts +380 -0
  106. package/dist/constructs/v1beta2/schedule/Schedule.js +1 -0
  107. package/dist/constructs/v1beta2/schedule/Schedule.mjs +0 -0
  108. package/dist/constructs/v1beta2/schedule/ScheduleSchema.d.mts +7 -0
  109. package/dist/constructs/v1beta2/schedule/ScheduleSchema.d.ts +7 -0
  110. package/dist/constructs/v1beta2/schedule/ScheduleSchema.js +13 -0
  111. package/dist/constructs/v1beta2/schedule/ScheduleSchema.mjs +13 -0
  112. package/dist/constructs/v1beta2/subscription/SubscriptionSchema.js +1 -1
  113. package/dist/constructs/v1beta2/subscription/SubscriptionSchema.mjs +1 -1
  114. package/dist/constructs/v1beta2/team/Team.d.mts +939 -0
  115. package/dist/constructs/v1beta2/team/Team.d.ts +939 -0
  116. package/dist/constructs/v1beta2/team/Team.js +1 -0
  117. package/dist/constructs/v1beta2/team/Team.mjs +0 -0
  118. package/dist/constructs/v1beta2/team/TeamSchema.d.mts +7 -0
  119. package/dist/constructs/v1beta2/team/TeamSchema.d.ts +7 -0
  120. package/dist/constructs/v1beta2/team/TeamSchema.js +2 -0
  121. package/dist/constructs/v1beta2/team/TeamSchema.mjs +2 -0
  122. package/dist/constructs/v1beta2/token/TokenSchema.js +1 -1
  123. package/dist/constructs/v1beta2/token/TokenSchema.mjs +1 -1
  124. package/dist/constructs/v1beta2/user/User.d.mts +1831 -0
  125. package/dist/constructs/v1beta2/user/User.d.ts +1831 -0
  126. package/dist/constructs/v1beta2/user/User.js +1 -0
  127. package/dist/constructs/v1beta2/user/User.mjs +0 -0
  128. package/dist/constructs/v1beta2/user/UserSchema.d.mts +7 -0
  129. package/dist/constructs/v1beta2/user/UserSchema.d.ts +7 -0
  130. package/dist/constructs/v1beta2/user/UserSchema.js +2 -0
  131. package/dist/constructs/v1beta2/user/UserSchema.mjs +2 -0
  132. package/dist/constructs/v1beta2/view/View.d.mts +810 -0
  133. package/dist/constructs/v1beta2/view/View.d.ts +810 -0
  134. package/dist/constructs/v1beta2/view/View.js +1 -0
  135. package/dist/constructs/v1beta2/view/View.mjs +0 -0
  136. package/dist/constructs/v1beta2/view/ViewSchema.d.mts +7 -0
  137. package/dist/constructs/v1beta2/view/ViewSchema.d.ts +7 -0
  138. package/dist/constructs/v1beta2/view/ViewSchema.js +13 -0
  139. package/dist/constructs/v1beta2/view/ViewSchema.mjs +13 -0
  140. package/dist/constructs/v1beta3/component/Component.d.mts +796 -0
  141. package/dist/constructs/v1beta3/component/Component.d.ts +796 -0
  142. package/dist/constructs/v1beta3/component/Component.js +1 -0
  143. package/dist/constructs/v1beta3/component/Component.mjs +0 -0
  144. package/dist/constructs/v1beta3/component/ComponentSchema.d.mts +7 -0
  145. package/dist/constructs/v1beta3/component/ComponentSchema.d.ts +7 -0
  146. package/dist/constructs/v1beta3/component/ComponentSchema.js +10 -0
  147. package/dist/constructs/v1beta3/component/ComponentSchema.mjs +10 -0
  148. package/dist/constructs/v1beta3/connection/Connection.d.mts +1348 -0
  149. package/dist/constructs/v1beta3/connection/Connection.d.ts +1348 -0
  150. package/dist/constructs/v1beta3/connection/Connection.js +1 -0
  151. package/dist/constructs/v1beta3/connection/Connection.mjs +0 -0
  152. package/dist/constructs/v1beta3/connection/ConnectionSchema.d.mts +7 -0
  153. package/dist/constructs/v1beta3/connection/ConnectionSchema.d.ts +7 -0
  154. package/dist/constructs/v1beta3/connection/ConnectionSchema.js +2 -0
  155. package/dist/constructs/v1beta3/connection/ConnectionSchema.mjs +2 -0
  156. package/dist/constructs/v1beta3/design/Design.d.mts +17552 -0
  157. package/dist/constructs/v1beta3/design/Design.d.ts +17552 -0
  158. package/dist/constructs/v1beta3/design/Design.js +1 -0
  159. package/dist/constructs/v1beta3/design/Design.mjs +0 -0
  160. package/dist/constructs/v1beta3/design/DesignSchema.d.mts +7 -0
  161. package/dist/constructs/v1beta3/design/DesignSchema.d.ts +7 -0
  162. package/dist/constructs/v1beta3/design/DesignSchema.js +506 -0
  163. package/dist/constructs/v1beta3/design/DesignSchema.mjs +506 -0
  164. package/dist/constructs/v1beta3/environment/Environment.d.mts +800 -0
  165. package/dist/constructs/v1beta3/environment/Environment.d.ts +800 -0
  166. package/dist/constructs/v1beta3/environment/Environment.js +1 -0
  167. package/dist/constructs/v1beta3/environment/Environment.mjs +0 -0
  168. package/dist/constructs/v1beta3/environment/EnvironmentSchema.d.mts +7 -0
  169. package/dist/constructs/v1beta3/environment/EnvironmentSchema.d.ts +7 -0
  170. package/dist/constructs/v1beta3/environment/EnvironmentSchema.js +2 -0
  171. package/dist/constructs/v1beta3/environment/EnvironmentSchema.mjs +2 -0
  172. package/dist/constructs/v1beta3/event/Event.d.mts +733 -0
  173. package/dist/constructs/v1beta3/event/Event.d.ts +733 -0
  174. package/dist/constructs/v1beta3/event/Event.js +1 -0
  175. package/dist/constructs/v1beta3/event/Event.mjs +0 -0
  176. package/dist/constructs/v1beta3/event/EventSchema.d.mts +7 -0
  177. package/dist/constructs/v1beta3/event/EventSchema.d.ts +7 -0
  178. package/dist/constructs/v1beta3/event/EventSchema.js +2 -0
  179. package/dist/constructs/v1beta3/event/EventSchema.mjs +2 -0
  180. package/dist/constructs/v1beta3/invitation/Invitation.d.mts +1079 -0
  181. package/dist/constructs/v1beta3/invitation/Invitation.d.ts +1079 -0
  182. package/dist/constructs/v1beta3/invitation/Invitation.js +1 -0
  183. package/dist/constructs/v1beta3/invitation/Invitation.mjs +0 -0
  184. package/dist/constructs/v1beta3/invitation/InvitationSchema.d.mts +7 -0
  185. package/dist/constructs/v1beta3/invitation/InvitationSchema.d.ts +7 -0
  186. package/dist/constructs/v1beta3/invitation/InvitationSchema.js +2 -0
  187. package/dist/constructs/v1beta3/invitation/InvitationSchema.mjs +2 -0
  188. package/dist/constructs/v1beta3/plan/Plan.d.mts +198 -0
  189. package/dist/constructs/v1beta3/plan/Plan.d.ts +198 -0
  190. package/dist/constructs/v1beta3/plan/Plan.js +1 -0
  191. package/dist/constructs/v1beta3/plan/Plan.mjs +0 -0
  192. package/dist/constructs/v1beta3/plan/PlanSchema.d.mts +7 -0
  193. package/dist/constructs/v1beta3/plan/PlanSchema.d.ts +7 -0
  194. package/dist/constructs/v1beta3/plan/PlanSchema.js +2 -0
  195. package/dist/constructs/v1beta3/plan/PlanSchema.mjs +2 -0
  196. package/dist/constructs/v1beta3/relationship/Relationship.d.mts +1884 -0
  197. package/dist/constructs/v1beta3/relationship/Relationship.d.ts +1884 -0
  198. package/dist/constructs/v1beta3/relationship/Relationship.js +1 -0
  199. package/dist/constructs/v1beta3/relationship/Relationship.mjs +0 -0
  200. package/dist/constructs/v1beta3/relationship/RelationshipSchema.d.mts +7 -0
  201. package/dist/constructs/v1beta3/relationship/RelationshipSchema.d.ts +7 -0
  202. package/dist/constructs/v1beta3/relationship/RelationshipSchema.js +155 -0
  203. package/dist/constructs/v1beta3/relationship/RelationshipSchema.mjs +155 -0
  204. package/dist/constructs/v1beta3/subscription/Subscription.d.mts +876 -0
  205. package/dist/constructs/v1beta3/subscription/Subscription.d.ts +876 -0
  206. package/dist/constructs/v1beta3/subscription/Subscription.js +1 -0
  207. package/dist/constructs/v1beta3/subscription/Subscription.mjs +0 -0
  208. package/dist/constructs/v1beta3/subscription/SubscriptionSchema.d.mts +7 -0
  209. package/dist/constructs/v1beta3/subscription/SubscriptionSchema.d.ts +7 -0
  210. package/dist/constructs/v1beta3/subscription/SubscriptionSchema.js +2 -0
  211. package/dist/constructs/v1beta3/subscription/SubscriptionSchema.mjs +2 -0
  212. package/dist/constructs/v1beta3/token/Token.d.mts +543 -0
  213. package/dist/constructs/v1beta3/token/Token.d.ts +543 -0
  214. package/dist/constructs/v1beta3/token/Token.js +1 -0
  215. package/dist/constructs/v1beta3/token/Token.mjs +0 -0
  216. package/dist/constructs/v1beta3/token/TokenSchema.d.mts +7 -0
  217. package/dist/constructs/v1beta3/token/TokenSchema.d.ts +7 -0
  218. package/dist/constructs/v1beta3/token/TokenSchema.js +2 -0
  219. package/dist/constructs/v1beta3/token/TokenSchema.mjs +2 -0
  220. package/dist/constructs/v1beta3/workspace/Workspace.d.mts +4808 -0
  221. package/dist/constructs/v1beta3/workspace/Workspace.d.ts +4808 -0
  222. package/dist/constructs/v1beta3/workspace/Workspace.js +1 -0
  223. package/dist/constructs/v1beta3/workspace/Workspace.mjs +0 -0
  224. package/dist/constructs/v1beta3/workspace/WorkspaceSchema.d.mts +7 -0
  225. package/dist/constructs/v1beta3/workspace/WorkspaceSchema.d.ts +7 -0
  226. package/dist/constructs/v1beta3/workspace/WorkspaceSchema.js +98 -0
  227. package/dist/constructs/v1beta3/workspace/WorkspaceSchema.mjs +98 -0
  228. package/dist/index.d.mts +10 -8
  229. package/dist/index.d.ts +10 -8
  230. package/dist/index.js +16 -8
  231. package/dist/index.mjs +16 -8
  232. package/dist/mesheryApi.d.mts +5552 -5394
  233. package/dist/mesheryApi.d.ts +5552 -5394
  234. package/dist/mesheryApi.js +1 -1
  235. package/dist/mesheryApi.mjs +1 -1
  236. package/package.json +1 -1
@@ -0,0 +1,571 @@
1
+ /**
2
+ * This file was auto-generated by openapi-typescript.
3
+ * Do not make direct changes to the file.
4
+ */
5
+ interface paths {
6
+ "/api/meshmodels/register": {
7
+ post: operations["registerMeshmodels"];
8
+ };
9
+ "/api/integrations/meshmodels/models": {
10
+ get: operations["getMeshModelModels"];
11
+ };
12
+ }
13
+ interface components {
14
+ schemas: {
15
+ /** @description Registrant-defined data associated with the model. Properties pertain to the software being managed (e.g. Kubernetes v1.31). */
16
+ Model: {
17
+ /** @description Version of the model as defined by the registrant. */
18
+ version: string;
19
+ };
20
+ /** @description Meshery Models serve as a portable unit of packaging to define managed entities, their relationships, and capabilities. */
21
+ ModelDefinition: {
22
+ /**
23
+ * Format: uuid
24
+ * @description Uniquely identifies the entity (i.e. component) as defined in a declaration (i.e. design).
25
+ */
26
+ id: string;
27
+ /**
28
+ * @description Specifies the version of the schema used for the definition.
29
+ * @default models.meshery.io/v1beta2
30
+ * @example [
31
+ * "v1",
32
+ * "v1alpha1",
33
+ * "v2beta3",
34
+ * "v1.custom-suffix",
35
+ * "models.meshery.io/v1beta1",
36
+ * "capability.meshery.io/v1alpha1"
37
+ * ]
38
+ */
39
+ schemaVersion: string;
40
+ /** @description Version of the model definition. */
41
+ version: string;
42
+ /**
43
+ * @description The unique name for the model within the scope of a registrant.
44
+ * @default untitled-model
45
+ */
46
+ name: string;
47
+ /**
48
+ * @description Human-readable name for the model.
49
+ * @default Untitled Model
50
+ */
51
+ displayName: string;
52
+ /**
53
+ * @description Description of the model.
54
+ * @default A new Meshery model.
55
+ */
56
+ description: string;
57
+ /**
58
+ * @description Status of model, including:
59
+ * - 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.
60
+ * - maintenance: model is unavailable for a period of time.
61
+ * - enabled: model is available for use for all users of this Meshery Server.
62
+ * - ignored: model is unavailable for use for all users of this Meshery Server.
63
+ * @default enabled
64
+ * @enum {string}
65
+ */
66
+ status: "ignored" | "enabled" | "duplicate";
67
+ /** @description Connection identifying the entity that registered this model. */
68
+ registrant: {
69
+ /**
70
+ * Format: uuid
71
+ * @description Connection ID
72
+ */
73
+ id: string;
74
+ /** @description Connection Name */
75
+ name: string;
76
+ /**
77
+ * Format: uuid
78
+ * @description Associated Credential ID
79
+ */
80
+ credentialId?: string;
81
+ /** @description Connection Type (platform, telemetry, collaboration) */
82
+ type: string;
83
+ /** @description Connection Subtype (cloud, identity, metrics, chat, git, orchestration) */
84
+ subType: string;
85
+ /** @description Connection Kind (meshery, kubernetes, prometheus, grafana, gke, aws, azure, slack, github) */
86
+ kind: string;
87
+ /** @description Additional connection metadata */
88
+ metadata?: {
89
+ [key: string]: unknown;
90
+ };
91
+ /**
92
+ * @description Connection Status
93
+ * @enum {string}
94
+ */
95
+ status: "discovered" | "registered" | "connected" | "ignored" | "maintenance" | "disconnected" | "deleted" | "not found";
96
+ /**
97
+ * Format: uuid
98
+ * @description User ID who owns this connection
99
+ */
100
+ user_id?: string;
101
+ /** Format: date-time */
102
+ created_at?: string;
103
+ /** Format: date-time */
104
+ updated_at?: string;
105
+ /**
106
+ * Format: date-time
107
+ * @description SQL null Timestamp to handle null values of time.
108
+ */
109
+ deleted_at?: string;
110
+ /** @description Associated environments for this connection */
111
+ environments?: {
112
+ /**
113
+ * Format: uuid
114
+ * @description ID
115
+ */
116
+ id: string;
117
+ /**
118
+ * @description Specifies the version of the schema to which the environment conforms.
119
+ * @default environments.meshery.io/v1beta1
120
+ * @example [
121
+ * "v1",
122
+ * "v1alpha1",
123
+ * "v2beta3",
124
+ * "v1.custom-suffix",
125
+ * "models.meshery.io/v1beta1",
126
+ * "capability.meshery.io/v1alpha1"
127
+ * ]
128
+ */
129
+ schemaVersion: string;
130
+ /** @description Environment name */
131
+ name: string;
132
+ /** @description Environment description */
133
+ description: string;
134
+ /**
135
+ * Format: uuid
136
+ * @description Environment organization ID
137
+ */
138
+ organization_id: string;
139
+ /**
140
+ * Format: uuid
141
+ * @description Environment owner
142
+ */
143
+ owner?: string;
144
+ /**
145
+ * Format: date-time
146
+ * @description Timestamp when the resource was created.
147
+ */
148
+ created_at?: string;
149
+ /** @description Additional metadata associated with the environment. */
150
+ metadata?: {
151
+ [key: string]: unknown;
152
+ };
153
+ /**
154
+ * Format: date-time
155
+ * @description Timestamp when the resource was updated.
156
+ */
157
+ updated_at?: string;
158
+ /**
159
+ * Format: date-time
160
+ * @description Timestamp when the environment was soft deleted. Null while the environment remains active.
161
+ */
162
+ deleted_at?: string | null;
163
+ }[];
164
+ /**
165
+ * @description Specifies the version of the schema used for the definition.
166
+ * @default connections.meshery.io/v1beta1
167
+ * @example [
168
+ * "v1",
169
+ * "v1alpha1",
170
+ * "v2beta3",
171
+ * "v1.custom-suffix",
172
+ * "models.meshery.io/v1beta1",
173
+ * "capability.meshery.io/v1alpha1"
174
+ * ]
175
+ */
176
+ schemaVersion: string;
177
+ };
178
+ /**
179
+ * Format: uuid
180
+ * @description ID of the registrant.
181
+ */
182
+ registrantId: string;
183
+ /**
184
+ * Format: uuid
185
+ * @description ID of the category.
186
+ */
187
+ categoryId: string;
188
+ /** @description Category the model belongs to. */
189
+ category: {
190
+ /**
191
+ * Format: uuid
192
+ * @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
193
+ */
194
+ id: string;
195
+ /**
196
+ * @description The category of the model that determines the main grouping.
197
+ * @default Uncategorized
198
+ * @enum {string}
199
+ */
200
+ 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";
201
+ /** @description Additional metadata associated with the category. */
202
+ metadata: {
203
+ [key: string]: unknown;
204
+ };
205
+ };
206
+ /**
207
+ * SubCategory
208
+ * @description Sub-category the model belongs to.
209
+ * @default Uncategorized
210
+ * @enum {string}
211
+ */
212
+ 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";
213
+ /** @description Metadata containing additional information associated with the model. */
214
+ metadata?: {
215
+ /** @description Capabilities associated with the model */
216
+ capabilities?: {
217
+ /**
218
+ * @description Specifies the version of the schema to which the capability definition conforms.
219
+ * @example [
220
+ * "v1",
221
+ * "v1alpha1",
222
+ * "v2beta3",
223
+ * "v1.custom-suffix",
224
+ * "models.meshery.io/v1beta1",
225
+ * "capability.meshery.io/v1alpha1"
226
+ * ]
227
+ */
228
+ schemaVersion: string;
229
+ /** @description Version of the capability definition. */
230
+ version: string;
231
+ /** @description Name of the capability in human-readible format. */
232
+ displayName: string;
233
+ /** @description A written representation of the purpose and characteristics of the capability. */
234
+ description: string;
235
+ /** @description Top-level categorization of the capability */
236
+ kind: string;
237
+ /** @description Classification of capabilities. Used to group capabilities similar in nature. */
238
+ type: string;
239
+ /** @description Most granular unit of capability classification. The combination of Kind, Type and SubType together uniquely identify a Capability. */
240
+ subType: string;
241
+ /** @description Key that backs the capability. */
242
+ key: string;
243
+ /** @description State of the entity in which the capability is applicable. */
244
+ entityState: ("declaration" | "instance")[];
245
+ /**
246
+ * @description Status of the capability
247
+ * @default enabled
248
+ * @enum {string}
249
+ */
250
+ status: "enabled" | "disabled";
251
+ /** @description Metadata contains additional information associated with the capability. Extension point. */
252
+ metadata?: {
253
+ [key: string]: unknown;
254
+ };
255
+ }[];
256
+ /**
257
+ * @description Indicates whether the model and its entities should be treated as deployable entities or as logical representations.
258
+ * @default false
259
+ */
260
+ isAnnotation?: boolean;
261
+ /**
262
+ * @description Primary color associated with the model.
263
+ * @default #00b39f
264
+ */
265
+ primaryColor?: string;
266
+ /**
267
+ * @description Secondary color associated with the model.
268
+ * @default #00D3A9
269
+ */
270
+ secondaryColor?: string;
271
+ /**
272
+ * @description SVG representation of the model in white color.
273
+ * @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>
274
+ */
275
+ svgWhite: string;
276
+ /**
277
+ * @description SVG representation of the model in colored format.
278
+ * @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>
279
+ */
280
+ svgColor: string;
281
+ /** @description SVG representation of the complete model. */
282
+ svgComplete?: string;
283
+ /**
284
+ * @description Visual shape used to render the model's entities in design canvases.
285
+ * @enum {string}
286
+ */
287
+ 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";
288
+ } & {
289
+ [key: string]: unknown;
290
+ };
291
+ /** @description Registrant-defined data associated with the model. */
292
+ model: {
293
+ /** @description Version of the model as defined by the registrant. */
294
+ version: string;
295
+ };
296
+ /** @description The relationships of the model. */
297
+ relationships: unknown[];
298
+ /** @description The components of the model. */
299
+ components: unknown[];
300
+ /**
301
+ * @description Number of components associated with the model.
302
+ * @default 0
303
+ */
304
+ componentsCount: number;
305
+ /**
306
+ * @description Number of relationships associated with the model.
307
+ * @default 0
308
+ */
309
+ relationshipsCount: number;
310
+ /**
311
+ * Format: date-time
312
+ * @description Timestamp when the model was created.
313
+ */
314
+ createdAt?: string;
315
+ /**
316
+ * Format: date-time
317
+ * @description Timestamp when the model was last updated.
318
+ */
319
+ updatedAt?: string;
320
+ };
321
+ RegistrantReference: {
322
+ /** @description Kind of the registrant. */
323
+ kind: string;
324
+ };
325
+ /** @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 */
326
+ ModelReference: {
327
+ /**
328
+ * Format: uuid
329
+ * @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
330
+ */
331
+ id: string;
332
+ /** @description The unique name for the model within the scope of a registrant. */
333
+ name: string;
334
+ /** @description Version of the model definition. */
335
+ version: string;
336
+ /** @description Human-readable name for the model. */
337
+ displayName: string;
338
+ /** @description Registrant-defined data associated with the model. Properties pertain to the software being managed (e.g. Kubernetes v1.31). */
339
+ model: {
340
+ /** @description Version of the model as defined by the registrant. */
341
+ version: string;
342
+ };
343
+ registrant: {
344
+ /** @description Kind of the registrant. */
345
+ kind: string;
346
+ };
347
+ };
348
+ ImportRequest: {
349
+ importBody: {
350
+ /** @description Name of the file being uploaded. */
351
+ fileName: string;
352
+ /** @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 */
353
+ modelFile: string;
354
+ } | {
355
+ /**
356
+ * Format: uri
357
+ * @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
358
+ */
359
+ url: string;
360
+ } | {
361
+ /**
362
+ * Format: binary
363
+ * @description Upload a CSV file containing model definitions
364
+ */
365
+ modelCsv: string;
366
+ /**
367
+ * Format: binary
368
+ * @description Upload a CSV file containing component definitions
369
+ */
370
+ componentCsv: string;
371
+ /**
372
+ * Format: binary
373
+ * @description Upload a CSV file containing relationship definitions
374
+ */
375
+ relationshipCsv: string;
376
+ } | ({
377
+ /**
378
+ * Format: uri
379
+ * @description URI to the source code or package of the model.
380
+ */
381
+ url: string;
382
+ } & {
383
+ model: unknown;
384
+ });
385
+ /**
386
+ * Upload method
387
+ * @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.
388
+ * @enum {string}
389
+ */
390
+ uploadType: "file" | "urlImport" | "csv" | "url";
391
+ /** @description The register of the importrequest. */
392
+ register: boolean;
393
+ };
394
+ ImportBody: {
395
+ /** @description Name of the file being uploaded. */
396
+ fileName: string;
397
+ /** @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 */
398
+ modelFile: string;
399
+ } | {
400
+ /**
401
+ * Format: uri
402
+ * @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
403
+ */
404
+ url: string;
405
+ } | {
406
+ /**
407
+ * Format: binary
408
+ * @description Upload a CSV file containing model definitions
409
+ */
410
+ modelCsv: string;
411
+ /**
412
+ * Format: binary
413
+ * @description Upload a CSV file containing component definitions
414
+ */
415
+ componentCsv: string;
416
+ /**
417
+ * Format: binary
418
+ * @description Upload a CSV file containing relationship definitions
419
+ */
420
+ relationshipCsv: string;
421
+ } | ({
422
+ /**
423
+ * Format: uri
424
+ * @description URI to the source code or package of the model.
425
+ */
426
+ url: string;
427
+ } & {
428
+ model: unknown;
429
+ });
430
+ /** @description Page of mesh models matching the list-endpoint query. */
431
+ MeshModelModelsPage: {
432
+ /** @description Current page number of the result set. */
433
+ page?: number;
434
+ /** @description Number of items per page. */
435
+ pageSize?: number;
436
+ /** @description Total number of items available. */
437
+ totalCount?: number;
438
+ /** @description The models of the meshmodelmodelspage. */
439
+ models?: {
440
+ [key: string]: unknown;
441
+ }[];
442
+ };
443
+ };
444
+ responses: {
445
+ /** Expired JWT token used or insufficient privilege */
446
+ 401: {
447
+ content: {
448
+ "text/plain": string;
449
+ };
450
+ };
451
+ };
452
+ }
453
+ interface operations {
454
+ registerMeshmodels: {
455
+ responses: {
456
+ /** Model registered */
457
+ 201: {
458
+ content: {
459
+ "application/json": {
460
+ message?: string;
461
+ };
462
+ };
463
+ };
464
+ /** Invalid request format */
465
+ 400: unknown;
466
+ /** Expired JWT token used or insufficient privilege */
467
+ 401: {
468
+ content: {
469
+ "text/plain": string;
470
+ };
471
+ };
472
+ /** Internal server error */
473
+ 500: unknown;
474
+ };
475
+ requestBody: {
476
+ content: {
477
+ "multipart/form-data": {
478
+ importBody: {
479
+ /** @description Name of the file being uploaded. */
480
+ fileName: string;
481
+ /** @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 */
482
+ modelFile: string;
483
+ } | {
484
+ /**
485
+ * Format: uri
486
+ * @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
487
+ */
488
+ url: string;
489
+ } | {
490
+ /**
491
+ * Format: binary
492
+ * @description Upload a CSV file containing model definitions
493
+ */
494
+ modelCsv: string;
495
+ /**
496
+ * Format: binary
497
+ * @description Upload a CSV file containing component definitions
498
+ */
499
+ componentCsv: string;
500
+ /**
501
+ * Format: binary
502
+ * @description Upload a CSV file containing relationship definitions
503
+ */
504
+ relationshipCsv: string;
505
+ } | ({
506
+ /**
507
+ * Format: uri
508
+ * @description URI to the source code or package of the model.
509
+ */
510
+ url: string;
511
+ } & {
512
+ model: unknown;
513
+ });
514
+ /**
515
+ * Upload method
516
+ * @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.
517
+ * @enum {string}
518
+ */
519
+ uploadType: "file" | "urlImport" | "csv" | "url";
520
+ /** @description The register of the importrequest. */
521
+ register: boolean;
522
+ };
523
+ };
524
+ };
525
+ };
526
+ getMeshModelModels: {
527
+ parameters: {
528
+ query: {
529
+ /** Current page number of the result set. */
530
+ page?: number;
531
+ /** Number of items per page. */
532
+ pageSize?: number;
533
+ /** Free-text search query applied to model names. */
534
+ search?: string;
535
+ /** Sort order for the result set (e.g. "name asc"). */
536
+ order?: string;
537
+ };
538
+ };
539
+ responses: {
540
+ /** Model and capabilities registry entries retrieved. */
541
+ 200: {
542
+ content: {
543
+ "application/json": {
544
+ /** @description Current page number of the result set. */
545
+ page?: number;
546
+ /** @description Number of items per page. */
547
+ pageSize?: number;
548
+ /** @description Total number of items available. */
549
+ totalCount?: number;
550
+ /** @description The models of the meshmodelmodelspage. */
551
+ models?: {
552
+ [key: string]: unknown;
553
+ }[];
554
+ };
555
+ };
556
+ };
557
+ /** Expired JWT token used or insufficient privilege */
558
+ 401: {
559
+ content: {
560
+ "text/plain": string;
561
+ };
562
+ };
563
+ /** Internal server error */
564
+ 500: unknown;
565
+ };
566
+ };
567
+ }
568
+ interface external {
569
+ }
570
+
571
+ export type { components, external, operations, paths };
@@ -0,0 +1 @@
1
+ 'use strict';
File without changes
@@ -0,0 +1,7 @@
1
+ /**
2
+ * This file was automatically generated from OpenAPI schema.
3
+ * Do not manually modify this file.
4
+ */
5
+ declare const ModelSchema: Record<string, unknown>;
6
+
7
+ export { ModelSchema as default };
@@ -0,0 +1,7 @@
1
+ /**
2
+ * This file was automatically generated from OpenAPI schema.
3
+ * Do not manually modify this file.
4
+ */
5
+ declare const ModelSchema: Record<string, unknown>;
6
+
7
+ export { ModelSchema as default };