@meshery/schemas 1.2.21 → 1.2.23

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (106) hide show
  1. package/dist/cloudApi.d.mts +1728 -1527
  2. package/dist/cloudApi.d.ts +1728 -1527
  3. package/dist/cloudApi.js +1 -1
  4. package/dist/cloudApi.mjs +1 -1
  5. package/dist/constructs/v1alpha1/capability/Capability.d.ts +111 -106
  6. package/dist/constructs/v1alpha1/core/Core.d.ts +734 -822
  7. package/dist/constructs/v1alpha2/catalog/Catalog.d.ts +40 -45
  8. package/dist/constructs/v1alpha3/relationship/Relationship.d.ts +1716 -1829
  9. package/dist/constructs/v1beta1/academy/Academy.d.ts +6537 -5918
  10. package/dist/constructs/v1beta1/academy/AcademySchema.js +1 -1
  11. package/dist/constructs/v1beta1/academy/AcademySchema.mjs +1 -1
  12. package/dist/constructs/v1beta1/badge/Badge.d.ts +600 -439
  13. package/dist/constructs/v1beta1/capability/Capability.d.ts +111 -106
  14. package/dist/constructs/v1beta1/catalog/Catalog.d.ts +40 -45
  15. package/dist/constructs/v1beta1/category/Category.d.ts +26 -38
  16. package/dist/constructs/v1beta1/component/Component.d.ts +729 -833
  17. package/dist/constructs/v1beta1/connection/Connection.d.ts +1357 -1170
  18. package/dist/constructs/v1beta1/core/Core.d.ts +734 -822
  19. package/dist/constructs/v1beta1/credential/Credential.d.ts +593 -458
  20. package/dist/constructs/v1beta1/environment/Environment.d.ts +835 -666
  21. package/dist/constructs/v1beta1/evaluation/Evaluation.d.ts +5508 -6030
  22. package/dist/constructs/v1beta1/event/Event.d.ts +898 -527
  23. package/dist/constructs/v1beta1/feature/Feature.d.ts +287 -249
  24. package/dist/constructs/v1beta1/invitation/Invitation.d.ts +1244 -877
  25. package/dist/constructs/v1beta1/key/Key.d.ts +589 -444
  26. package/dist/constructs/v1beta1/keychain/Keychain.d.ts +796 -575
  27. package/dist/constructs/v1beta1/model/Model.d.ts +572 -598
  28. package/dist/constructs/v1beta1/organization/Organization.d.ts +1829 -1410
  29. package/dist/constructs/v1beta1/pattern/Pattern.d.ts +17093 -17910
  30. package/dist/constructs/v1beta1/plan/Plan.d.ts +159 -115
  31. package/dist/constructs/v1beta1/role/Role.d.ts +933 -688
  32. package/dist/constructs/v1beta1/role/RoleSchema.js +1 -1
  33. package/dist/constructs/v1beta1/role/RoleSchema.mjs +1 -1
  34. package/dist/constructs/v1beta1/schedule/Schedule.d.ts +425 -315
  35. package/dist/constructs/v1beta1/subcategory/Subcategory.d.ts +18 -61
  36. package/dist/constructs/v1beta1/subscription/Subscription.d.ts +839 -674
  37. package/dist/constructs/v1beta1/support/Support.d.ts +115 -74
  38. package/dist/constructs/v1beta1/system/System.d.ts +434 -0
  39. package/dist/constructs/v1beta1/system/System.js +1 -0
  40. package/dist/constructs/v1beta1/system/System.mjs +0 -0
  41. package/dist/constructs/v1beta1/system/SystemSchema.d.ts +2 -0
  42. package/dist/constructs/v1beta1/system/SystemSchema.js +2 -0
  43. package/dist/constructs/v1beta1/system/SystemSchema.mjs +2 -0
  44. package/dist/constructs/v1beta1/team/Team.d.ts +1028 -762
  45. package/dist/constructs/v1beta1/token/Token.d.ts +612 -475
  46. package/dist/constructs/v1beta1/user/User.d.ts +1723 -1554
  47. package/dist/constructs/v1beta1/user/UserSchema.js +1 -1
  48. package/dist/constructs/v1beta1/user/UserSchema.mjs +1 -1
  49. package/dist/constructs/v1beta1/view/View.d.ts +833 -664
  50. package/dist/constructs/v1beta1/workspace/Workspace.d.ts +4900 -4695
  51. package/dist/constructs/v1beta2/academy/Academy.d.ts +7840 -7222
  52. package/dist/constructs/v1beta2/academy/AcademySchema.js +1 -1
  53. package/dist/constructs/v1beta2/academy/AcademySchema.mjs +1 -1
  54. package/dist/constructs/v1beta2/badge/Badge.d.ts +610 -453
  55. package/dist/constructs/v1beta2/catalog/Catalog.d.ts +40 -45
  56. package/dist/constructs/v1beta2/component/Component.d.ts +747 -851
  57. package/dist/constructs/v1beta2/connection/Connection.d.ts +1376 -1189
  58. package/dist/constructs/v1beta2/core/Core.d.ts +768 -856
  59. package/dist/constructs/v1beta2/credential/Credential.d.ts +572 -437
  60. package/dist/constructs/v1beta2/design/Design.d.ts +17682 -18467
  61. package/dist/constructs/v1beta2/event/Event.d.ts +946 -575
  62. package/dist/constructs/v1beta2/invitation/Invitation.d.ts +1268 -901
  63. package/dist/constructs/v1beta2/key/Key.d.ts +599 -454
  64. package/dist/constructs/v1beta2/keychain/Keychain.d.ts +806 -585
  65. package/dist/constructs/v1beta2/model/Model.d.ts +610 -636
  66. package/dist/constructs/v1beta2/organization/Organization.d.ts +2135 -1724
  67. package/dist/constructs/v1beta2/plan/Plan.d.ts +169 -128
  68. package/dist/constructs/v1beta2/relationship/Relationship.d.ts +1842 -2011
  69. package/dist/constructs/v1beta2/role/Role.d.ts +940 -695
  70. package/dist/constructs/v1beta2/role/RoleSchema.js +1 -1
  71. package/dist/constructs/v1beta2/role/RoleSchema.mjs +1 -1
  72. package/dist/constructs/v1beta2/schedule/Schedule.d.ts +466 -356
  73. package/dist/constructs/v1beta2/subscription/Subscription.d.ts +866 -701
  74. package/dist/constructs/v1beta2/team/Team.d.ts +1118 -852
  75. package/dist/constructs/v1beta2/token/Token.d.ts +616 -479
  76. package/dist/constructs/v1beta2/user/User.d.ts +1723 -1554
  77. package/dist/constructs/v1beta2/user/UserSchema.js +1 -1
  78. package/dist/constructs/v1beta2/user/UserSchema.mjs +1 -1
  79. package/dist/constructs/v1beta2/view/View.d.ts +838 -669
  80. package/dist/constructs/v1beta3/academy/Academy.d.ts +7844 -7226
  81. package/dist/constructs/v1beta3/academy/AcademySchema.js +1 -1
  82. package/dist/constructs/v1beta3/academy/AcademySchema.mjs +1 -1
  83. package/dist/constructs/v1beta3/component/Component.d.ts +753 -857
  84. package/dist/constructs/v1beta3/connection/Connection.d.ts +1447 -1260
  85. package/dist/constructs/v1beta3/design/Design.d.ts +5729 -5307
  86. package/dist/constructs/v1beta3/design/DesignSchema.js +8 -8
  87. package/dist/constructs/v1beta3/design/DesignSchema.mjs +8 -8
  88. package/dist/constructs/v1beta3/environment/Environment.d.ts +858 -689
  89. package/dist/constructs/v1beta3/event/Event.d.ts +1041 -666
  90. package/dist/constructs/v1beta3/filter/Filter.d.ts +1437 -1299
  91. package/dist/constructs/v1beta3/invitation/Invitation.d.ts +1277 -910
  92. package/dist/constructs/v1beta3/performance_profile/PerformanceProfile.d.ts +850 -690
  93. package/dist/constructs/v1beta3/plan/Plan.d.ts +197 -156
  94. package/dist/constructs/v1beta3/relationship/Relationship.d.ts +1842 -2011
  95. package/dist/constructs/v1beta3/subscription/Subscription.d.ts +969 -804
  96. package/dist/constructs/v1beta3/token/Token.d.ts +616 -479
  97. package/dist/constructs/v1beta3/workspace/Workspace.d.ts +5030 -4822
  98. package/dist/index.d.mts +5520 -5062
  99. package/dist/index.d.ts +5520 -5062
  100. package/dist/mesheryApi.d.mts +1318 -526
  101. package/dist/mesheryApi.d.ts +1318 -526
  102. package/dist/mesheryApi.js +1 -1
  103. package/dist/mesheryApi.mjs +1 -1
  104. package/dist/permissions.d.mts +1 -1
  105. package/dist/permissions.d.ts +1 -1
  106. package/package.json +1 -2
@@ -3,112 +3,117 @@
3
3
  * Do not make direct changes to the file.
4
4
  */
5
5
 
6
- export interface paths {}
7
-
6
+ export type paths = Record<string, never>;
7
+ export type webhooks = Record<string, never>;
8
8
  export interface components {
9
- schemas: {
10
- /**
11
- * @description Meshery manages entities in accordance with their specific capabilities. This field explicitly identifies those capabilities largely by what actions a given component supports; e.g. metric-scrape, sub-interface, and so on. This field is extensible. Entities may define a broad array of capabilities, which are in-turn dynamically interpretted by Meshery for full lifecycle management.
12
- * @default [
13
- * {
14
- * "description": "Configure the visual styles for the component",
15
- * "displayName": "Styling",
16
- * "entityState": [
17
- * "declaration"
18
- * ],
19
- * "key": "",
20
- * "kind": "mutate",
21
- * "schemaVersion": "capability.meshery.io/v1beta1",
22
- * "status": "enabled",
23
- * "subType": "",
24
- * "type": "style",
25
- * "version": "0.7.0"
26
- * },
27
- * {
28
- * "description": "Change the shape of the component",
29
- * "displayName": "Change Shape",
30
- * "entityState": [
31
- * "declaration"
32
- * ],
33
- * "key": "",
34
- * "kind": "mutate",
35
- * "schemaVersion": "capability.meshery.io/v1beta1",
36
- * "status": "enabled",
37
- * "subType": "shape",
38
- * "type": "style",
39
- * "version": "0.7.0"
40
- * },
41
- * {
42
- * "description": "Drag and Drop a component into a parent component in graph view",
43
- * "displayName": "Compound Drag And Drop",
44
- * "entityState": [
45
- * "declaration"
46
- * ],
47
- * "key": "",
48
- * "kind": "interaction",
49
- * "schemaVersion": "capability.meshery.io/v1beta1",
50
- * "status": "enabled",
51
- * "subType": "compoundDnd",
52
- * "type": "graph",
53
- * "version": "0.7.0"
54
- * },
55
- * {
56
- * "description": "Add text to nodes body",
57
- * "displayName": "Body Text",
58
- * "entityState": [
59
- * "declaration"
60
- * ],
61
- * "key": "",
62
- * "kind": "mutate",
63
- * "schemaVersion": "capability.meshery.io/v1beta1",
64
- * "status": "enabled",
65
- * "subType": "body-text",
66
- * "type": "style",
67
- * "version": "0.7.0"
68
- * }
69
- * ]
70
- */
71
- Capability: {
72
- /**
73
- * @description Specifies the version of the schema to which the capability definition conforms.
74
- * @example [
75
- * "v1",
76
- * "v1alpha1",
77
- * "v2beta3",
78
- * "v1.custom-suffix",
79
- * "models.meshery.io/v1beta1",
80
- * "capability.meshery.io/v1alpha1"
81
- * ]
82
- */
83
- schemaVersion: string;
84
- /** @description Version of the capability definition. */
85
- version: string;
86
- /** @description Name of the capability in human-readible format. */
87
- displayName: string;
88
- /** @description A written representation of the purpose and characteristics of the capability. */
89
- description: string;
90
- /** @description Top-level categorization of the capability */
91
- kind: string;
92
- /** @description Classification of capabilities. Used to group capabilities similar in nature. */
93
- type: string;
94
- /** @description Most granular unit of capability classification. The combination of Kind, Type and SubType together uniquely identify a Capability. */
95
- subType: string;
96
- /** @description Key that backs the capability. */
97
- key: string;
98
- /** @description State of the entity in which the capability is applicable. */
99
- entityState: ("declaration" | "instance")[];
100
- /**
101
- * @description Status of the capability
102
- * @default enabled
103
- * @enum {string}
104
- */
105
- status: "enabled" | "disabled";
106
- /** @description Metadata contains additional information associated with the capability. Extension point. */
107
- metadata?: { [key: string]: unknown };
9
+ schemas: {
10
+ /**
11
+ * @description Meshery manages entities in accordance with their specific capabilities. This field explicitly identifies those capabilities largely by what actions a given component supports; e.g. metric-scrape, sub-interface, and so on. This field is extensible. Entities may define a broad array of capabilities, which are in-turn dynamically interpretted by Meshery for full lifecycle management.
12
+ * @default [
13
+ * {
14
+ * "description": "Configure the visual styles for the component",
15
+ * "displayName": "Styling",
16
+ * "entityState": [
17
+ * "declaration"
18
+ * ],
19
+ * "key": "",
20
+ * "kind": "mutate",
21
+ * "schemaVersion": "capability.meshery.io/v1beta1",
22
+ * "status": "enabled",
23
+ * "subType": "",
24
+ * "type": "style",
25
+ * "version": "0.7.0"
26
+ * },
27
+ * {
28
+ * "description": "Change the shape of the component",
29
+ * "displayName": "Change Shape",
30
+ * "entityState": [
31
+ * "declaration"
32
+ * ],
33
+ * "key": "",
34
+ * "kind": "mutate",
35
+ * "schemaVersion": "capability.meshery.io/v1beta1",
36
+ * "status": "enabled",
37
+ * "subType": "shape",
38
+ * "type": "style",
39
+ * "version": "0.7.0"
40
+ * },
41
+ * {
42
+ * "description": "Drag and Drop a component into a parent component in graph view",
43
+ * "displayName": "Compound Drag And Drop",
44
+ * "entityState": [
45
+ * "declaration"
46
+ * ],
47
+ * "key": "",
48
+ * "kind": "interaction",
49
+ * "schemaVersion": "capability.meshery.io/v1beta1",
50
+ * "status": "enabled",
51
+ * "subType": "compoundDnd",
52
+ * "type": "graph",
53
+ * "version": "0.7.0"
54
+ * },
55
+ * {
56
+ * "description": "Add text to nodes body",
57
+ * "displayName": "Body Text",
58
+ * "entityState": [
59
+ * "declaration"
60
+ * ],
61
+ * "key": "",
62
+ * "kind": "mutate",
63
+ * "schemaVersion": "capability.meshery.io/v1beta1",
64
+ * "status": "enabled",
65
+ * "subType": "body-text",
66
+ * "type": "style",
67
+ * "version": "0.7.0"
68
+ * }
69
+ * ]
70
+ */
71
+ Capability: {
72
+ /**
73
+ * @description Specifies the version of the schema to which the capability definition conforms.
74
+ * @example [
75
+ * "v1",
76
+ * "v1alpha1",
77
+ * "v2beta3",
78
+ * "v1.custom-suffix",
79
+ * "models.meshery.io/v1beta1",
80
+ * "capability.meshery.io/v1alpha1"
81
+ * ]
82
+ */
83
+ schemaVersion: string;
84
+ /** @description Version of the capability definition. */
85
+ version: string;
86
+ /** @description Name of the capability in human-readible format. */
87
+ displayName: string;
88
+ /** @description A written representation of the purpose and characteristics of the capability. */
89
+ description: string;
90
+ /** @description Top-level categorization of the capability */
91
+ kind: string | "action" | "mutate" | "view" | "interaction";
92
+ /** @description Classification of capabilities. Used to group capabilities similar in nature. */
93
+ type: string;
94
+ /** @description Most granular unit of capability classification. The combination of Kind, Type and SubType together uniquely identify a Capability. */
95
+ subType: string;
96
+ /** @description Key that backs the capability. */
97
+ key: string;
98
+ /** @description State of the entity in which the capability is applicable. */
99
+ entityState: ("declaration" | "instance")[];
100
+ /**
101
+ * @description Status of the capability
102
+ * @default enabled
103
+ * @enum {string}
104
+ */
105
+ status: "enabled" | "disabled";
106
+ /** @description Metadata contains additional information associated with the capability. Extension point. */
107
+ metadata?: {
108
+ [key: string]: unknown;
109
+ };
110
+ };
108
111
  };
109
- };
112
+ responses: never;
113
+ parameters: never;
114
+ requestBodies: never;
115
+ headers: never;
116
+ pathItems: never;
110
117
  }
111
-
112
- export interface operations {}
113
-
114
- export interface external {}
118
+ export type $defs = Record<string, never>;
119
+ export type operations = Record<string, never>;
@@ -3,51 +3,46 @@
3
3
  * Do not make direct changes to the file.
4
4
  */
5
5
 
6
- export interface paths {}
7
-
6
+ export type paths = Record<string, never>;
7
+ export type webhooks = Record<string, never>;
8
8
  export interface components {
9
- schemas: {
10
- CatalogData: {
11
- /** @description Tracks the specific content version that has been made available in the Catalog. */
12
- publishedVersion?: string;
13
- /** @description Published content is classifed by its support level. Content classes help you understand the origin and expected support level for each piece of content. It is important to note that the level of support may vary within each class, and you should exercise discretion when using community-contributed content. Content produced and fully supported by Meshery maintainers. This represents the highest level of support and is considered the most reliable. Content produced by partners and verified by Meshery maintainers. While not directly maintained by Meshery, it has undergone a verification process to ensure quality and compatibility. Content produced and supported by the respective project or organization responsible for the specific technology. This class offers a level of support from the project maintainers themselves. Content produced and shared by Meshery users. This includes a wide range of content, such as performance profiles, test results, filters, patterns, and applications. Community content may have varying levels of support and reliability. */
14
- class?: string;
15
- /**
16
- * Model
17
- * @description One or more models associated with this catalog item. For designs, a list of one or more models implicated by components within the design. For models, this is self-referential.
18
- */
19
- compatibility: "kubernetes"[];
20
- /**
21
- * Caveats and Considerations
22
- * @description Specific stipulations to consider and known behaviors to be aware of when using this design.
23
- */
24
- pattern_caveats: string;
25
- /**
26
- * Description
27
- * @description Purpose of the design along with its intended and unintended uses.
28
- */
29
- pattern_info: string;
30
- /**
31
- * Type
32
- * @description Categorization of the type of design or operational flow depicted in this design.
33
- * @default Deployment
34
- * @enum {string}
35
- */
36
- type:
37
- | "Deployment"
38
- | "Observability"
39
- | "Resiliency"
40
- | "Scaling"
41
- | "Security"
42
- | "Traffic-management"
43
- | "Troubleshooting"
44
- | "Workloads";
45
- /** @description Contains reference to the dark and light mode snapshots of the design. */
46
- snapshotURL?: string[];
9
+ schemas: {
10
+ CatalogData: {
11
+ /** @description Tracks the specific content version that has been made available in the Catalog. */
12
+ publishedVersion?: string;
13
+ /** @description Published content is classifed by its support level. Content classes help you understand the origin and expected support level for each piece of content. It is important to note that the level of support may vary within each class, and you should exercise discretion when using community-contributed content. Content produced and fully supported by Meshery maintainers. This represents the highest level of support and is considered the most reliable. Content produced by partners and verified by Meshery maintainers. While not directly maintained by Meshery, it has undergone a verification process to ensure quality and compatibility. Content produced and supported by the respective project or organization responsible for the specific technology. This class offers a level of support from the project maintainers themselves. Content produced and shared by Meshery users. This includes a wide range of content, such as performance profiles, test results, filters, patterns, and applications. Community content may have varying levels of support and reliability. */
14
+ class?: string & ("official" | "verified" | "reference architecture");
15
+ /**
16
+ * Model
17
+ * @description One or more models associated with this catalog item. For designs, a list of one or more models implicated by components within the design. For models, this is self-referential.
18
+ */
19
+ compatibility: "kubernetes"[];
20
+ /**
21
+ * Caveats and Considerations
22
+ * @description Specific stipulations to consider and known behaviors to be aware of when using this design.
23
+ */
24
+ pattern_caveats: string;
25
+ /**
26
+ * Description
27
+ * @description Purpose of the design along with its intended and unintended uses.
28
+ */
29
+ pattern_info: string;
30
+ /**
31
+ * Type
32
+ * @description Categorization of the type of design or operational flow depicted in this design.
33
+ * @default Deployment
34
+ * @enum {string}
35
+ */
36
+ type: "Deployment" | "Observability" | "Resiliency" | "Scaling" | "Security" | "Traffic-management" | "Troubleshooting" | "Workloads";
37
+ /** @description Contains reference to the dark and light mode snapshots of the design. */
38
+ snapshotURL?: string[];
39
+ };
47
40
  };
48
- };
41
+ responses: never;
42
+ parameters: never;
43
+ requestBodies: never;
44
+ headers: never;
45
+ pathItems: never;
49
46
  }
50
-
51
- export interface operations {}
52
-
53
- export interface external {}
47
+ export type $defs = Record<string, never>;
48
+ export type operations = Record<string, never>;
@@ -3,44 +3,32 @@
3
3
  * Do not make direct changes to the file.
4
4
  */
5
5
 
6
- export interface paths {}
7
-
6
+ export type paths = Record<string, never>;
7
+ export type webhooks = Record<string, never>;
8
8
  export interface components {
9
- schemas: {
10
- /** @description Category of the model. */
11
- CategoryDefinition: {
12
- /**
13
- * Format: uuid
14
- * @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
15
- */
16
- id: string;
17
- /**
18
- * @description The category of the model that determines the main grouping.
19
- * @default Uncategorized
20
- * @enum {string}
21
- */
22
- name:
23
- | "Analytics"
24
- | "App Definition and Development"
25
- | "Cloud Native Network"
26
- | "Cloud Native Storage"
27
- | "Database"
28
- | "Machine Learning"
29
- | "Observability and Analysis"
30
- | "Orchestration & Management"
31
- | "Platform"
32
- | "Provisioning"
33
- | "Runtime"
34
- | "Security & Compliance"
35
- | "Serverless"
36
- | "Tools"
37
- | "Uncategorized";
38
- /** @description Additional metadata associated with the category. */
39
- metadata: { [key: string]: unknown };
9
+ schemas: {
10
+ /** @description Category of the model. */
11
+ CategoryDefinition: {
12
+ /**
13
+ * Format: uuid
14
+ * @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
15
+ */
16
+ id: string;
17
+ /**
18
+ * @description The category of the model that determines the main grouping.
19
+ * @default Uncategorized
20
+ * @enum {string}
21
+ */
22
+ 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";
23
+ /** @description Additional metadata associated with the category. */
24
+ metadata: Record<string, never>;
25
+ };
40
26
  };
41
- };
27
+ responses: never;
28
+ parameters: never;
29
+ requestBodies: never;
30
+ headers: never;
31
+ pathItems: never;
42
32
  }
43
-
44
- export interface operations {}
45
-
46
- export interface external {}
33
+ export type $defs = Record<string, never>;
34
+ export type operations = Record<string, never>;