@meshery/schemas 1.2.15 → 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.
- package/dist/constructs/v1alpha1/capability/Capability.d.ts +114 -0
- package/dist/constructs/v1alpha1/capability/CapabilitySchema.d.ts +2 -0
- package/dist/constructs/v1alpha1/core/Core.d.ts +832 -0
- package/dist/constructs/v1alpha1/core/CoreSchema.d.ts +2 -0
- package/dist/constructs/v1alpha2/catalog/Catalog.d.ts +53 -0
- package/dist/constructs/v1alpha2/catalog/CatalogSchema.d.ts +2 -0
- package/dist/constructs/v1alpha3/relationship/Relationship.d.ts +1937 -0
- package/dist/constructs/v1alpha3/relationship/RelationshipSchema.d.ts +2 -0
- package/dist/constructs/v1beta1/academy/Academy.d.ts +6417 -0
- package/dist/constructs/v1beta1/academy/AcademySchema.d.ts +2 -0
- package/dist/constructs/v1beta1/badge/Badge.d.ts +546 -0
- package/dist/constructs/v1beta1/badge/BadgeSchema.d.ts +2 -0
- package/dist/constructs/v1beta1/capability/Capability.d.ts +114 -0
- package/dist/constructs/v1beta1/capability/CapabilitySchema.d.ts +2 -0
- package/dist/constructs/v1beta1/catalog/Catalog.d.ts +53 -0
- package/dist/constructs/v1beta1/catalog/CatalogSchema.d.ts +2 -0
- package/dist/constructs/v1beta1/category/Category.d.ts +46 -0
- package/dist/constructs/v1beta1/category/CategorySchema.d.ts +2 -0
- package/dist/constructs/v1beta1/component/Component.d.ts +869 -0
- package/dist/constructs/v1beta1/component/ComponentSchema.d.ts +2 -0
- package/dist/constructs/v1beta1/connection/Connection.d.ts +1300 -0
- package/dist/constructs/v1beta1/connection/ConnectionSchema.d.ts +2 -0
- package/dist/constructs/v1beta1/core/Core.d.ts +832 -0
- package/dist/constructs/v1beta1/core/CoreSchema.d.ts +2 -0
- package/dist/constructs/v1beta1/credential/Credential.d.ts +530 -0
- package/dist/constructs/v1beta1/credential/CredentialSchema.d.ts +2 -0
- package/dist/constructs/v1beta1/environment/Environment.d.ts +759 -0
- package/dist/constructs/v1beta1/environment/EnvironmentSchema.d.ts +2 -0
- package/dist/constructs/v1beta1/evaluation/Evaluation.d.ts +6338 -0
- package/dist/constructs/v1beta1/evaluation/EvaluationSchema.d.ts +2 -0
- package/dist/constructs/v1beta1/event/Event.d.ts +570 -0
- package/dist/constructs/v1beta1/event/EventSchema.d.ts +2 -0
- package/dist/constructs/v1beta1/feature/Feature.d.ts +308 -0
- package/dist/constructs/v1beta1/feature/FeatureSchema.d.ts +2 -0
- package/dist/constructs/v1beta1/invitation/Invitation.d.ts +983 -0
- package/dist/constructs/v1beta1/invitation/InvitationSchema.d.ts +2 -0
- package/dist/constructs/v1beta1/key/Key.d.ts +514 -0
- package/dist/constructs/v1beta1/key/KeySchema.d.ts +2 -0
- package/dist/constructs/v1beta1/keychain/Keychain.d.ts +642 -0
- package/dist/constructs/v1beta1/keychain/KeychainSchema.d.ts +2 -0
- package/dist/constructs/v1beta1/model/Model.d.ts +659 -0
- package/dist/constructs/v1beta1/model/ModelSchema.d.ts +2 -0
- package/dist/constructs/v1beta1/organization/Organization.d.ts +1598 -0
- package/dist/constructs/v1beta1/organization/OrganizationSchema.d.ts +2 -0
- package/dist/constructs/v1beta1/pattern/Pattern.d.ts +18407 -0
- package/dist/constructs/v1beta1/pattern/PatternSchema.d.ts +2 -0
- package/dist/constructs/v1beta1/plan/Plan.d.ts +149 -0
- package/dist/constructs/v1beta1/plan/PlanSchema.d.ts +2 -0
- package/dist/constructs/v1beta1/relationship/Relationship.d.ts +1921 -0
- package/dist/constructs/v1beta1/relationship/RelationshipSchema.d.ts +2 -0
- package/dist/constructs/v1beta1/role/Role.d.ts +745 -0
- package/dist/constructs/v1beta1/role/RoleSchema.d.ts +2 -0
- package/dist/constructs/v1beta1/schedule/Schedule.d.ts +374 -0
- package/dist/constructs/v1beta1/schedule/ScheduleSchema.d.ts +2 -0
- package/dist/constructs/v1beta1/subcategory/Subcategory.d.ts +68 -0
- package/dist/constructs/v1beta1/subcategory/SubcategorySchema.d.ts +2 -0
- package/dist/constructs/v1beta1/subscription/Subscription.d.ts +752 -0
- package/dist/constructs/v1beta1/subscription/SubscriptionSchema.d.ts +2 -0
- package/dist/constructs/v1beta1/support/Support.d.ts +91 -0
- package/dist/constructs/v1beta1/support/SupportSchema.d.ts +2 -0
- package/dist/constructs/v1beta1/team/Team.d.ts +846 -0
- package/dist/constructs/v1beta1/team/TeamSchema.d.ts +2 -0
- package/dist/constructs/v1beta1/token/Token.d.ts +539 -0
- package/dist/constructs/v1beta1/token/TokenSchema.d.ts +2 -0
- package/dist/constructs/v1beta1/user/User.d.ts +1677 -0
- package/dist/constructs/v1beta1/user/UserSchema.d.ts +2 -0
- package/dist/constructs/v1beta1/view/View.d.ts +759 -0
- package/dist/constructs/v1beta1/view/ViewSchema.d.ts +2 -0
- package/dist/constructs/v1beta1/workspace/Workspace.d.ts +4947 -0
- package/dist/constructs/v1beta1/workspace/WorkspaceSchema.d.ts +2 -0
- package/dist/constructs/v1beta2/academy/Academy.d.ts +7762 -0
- package/dist/constructs/v1beta2/academy/AcademySchema.d.ts +2 -0
- package/dist/constructs/v1beta2/badge/Badge.d.ts +563 -0
- package/dist/constructs/v1beta2/badge/BadgeSchema.d.ts +2 -0
- package/dist/constructs/v1beta2/catalog/Catalog.d.ts +53 -0
- package/dist/constructs/v1beta2/catalog/CatalogSchema.d.ts +2 -0
- package/dist/constructs/v1beta2/component/Component.d.ts +887 -0
- package/dist/constructs/v1beta2/component/ComponentSchema.d.ts +2 -0
- package/dist/constructs/v1beta2/connection/Connection.d.ts +1330 -0
- package/dist/constructs/v1beta2/connection/ConnectionSchema.d.ts +2 -0
- package/dist/constructs/v1beta2/core/Core.d.ts +866 -0
- package/dist/constructs/v1beta2/core/CoreSchema.d.ts +2 -0
- package/dist/constructs/v1beta2/credential/Credential.d.ts +519 -0
- package/dist/constructs/v1beta2/credential/CredentialSchema.d.ts +2 -0
- package/dist/constructs/v1beta2/design/Design.d.ts +19039 -0
- package/dist/constructs/v1beta2/design/DesignSchema.d.ts +2 -0
- package/dist/constructs/v1beta2/event/Event.d.ts +626 -0
- package/dist/constructs/v1beta2/event/EventSchema.d.ts +2 -0
- package/dist/constructs/v1beta2/invitation/Invitation.d.ts +1052 -0
- package/dist/constructs/v1beta2/invitation/InvitationSchema.d.ts +2 -0
- package/dist/constructs/v1beta2/key/Key.d.ts +524 -0
- package/dist/constructs/v1beta2/key/KeySchema.d.ts +2 -0
- package/dist/constructs/v1beta2/keychain/Keychain.d.ts +652 -0
- package/dist/constructs/v1beta2/keychain/KeychainSchema.d.ts +2 -0
- package/dist/constructs/v1beta2/model/Model.d.ts +697 -0
- package/dist/constructs/v1beta2/model/ModelSchema.d.ts +2 -0
- package/dist/constructs/v1beta2/organization/Organization.d.ts +1915 -0
- package/dist/constructs/v1beta2/organization/OrganizationSchema.d.ts +2 -0
- package/dist/constructs/v1beta2/plan/Plan.d.ts +162 -0
- package/dist/constructs/v1beta2/plan/PlanSchema.d.ts +2 -0
- package/dist/constructs/v1beta2/relationship/Relationship.d.ts +2134 -0
- package/dist/constructs/v1beta2/relationship/RelationshipSchema.d.ts +2 -0
- package/dist/constructs/v1beta2/role/Role.d.ts +752 -0
- package/dist/constructs/v1beta2/role/RoleSchema.d.ts +2 -0
- package/dist/constructs/v1beta2/schedule/Schedule.d.ts +431 -0
- package/dist/constructs/v1beta2/schedule/ScheduleSchema.d.ts +2 -0
- package/dist/constructs/v1beta2/subscription/Subscription.d.ts +785 -0
- package/dist/constructs/v1beta2/subscription/SubscriptionSchema.d.ts +2 -0
- package/dist/constructs/v1beta2/team/Team.d.ts +960 -0
- package/dist/constructs/v1beta2/team/TeamSchema.d.ts +2 -0
- package/dist/constructs/v1beta2/token/Token.d.ts +544 -0
- package/dist/constructs/v1beta2/token/TokenSchema.d.ts +2 -0
- package/dist/constructs/v1beta2/user/User.d.ts +1677 -0
- package/dist/constructs/v1beta2/user/UserSchema.d.ts +2 -0
- package/dist/constructs/v1beta2/view/View.d.ts +767 -0
- package/dist/constructs/v1beta2/view/ViewSchema.d.ts +2 -0
- package/dist/constructs/v1beta3/academy/Academy.d.ts +7762 -0
- package/dist/constructs/v1beta3/academy/AcademySchema.d.ts +2 -0
- package/dist/constructs/v1beta3/component/Component.d.ts +892 -0
- package/dist/constructs/v1beta3/component/ComponentSchema.d.ts +2 -0
- package/dist/constructs/v1beta3/connection/Connection.d.ts +1414 -0
- package/dist/constructs/v1beta3/connection/ConnectionSchema.d.ts +2 -0
- package/dist/constructs/v1beta3/design/Design.d.ts +5704 -0
- package/dist/constructs/v1beta3/design/DesignSchema.d.ts +2 -0
- package/dist/constructs/v1beta3/environment/Environment.d.ts +785 -0
- package/dist/constructs/v1beta3/environment/EnvironmentSchema.d.ts +2 -0
- package/dist/constructs/v1beta3/event/Event.d.ts +720 -0
- package/dist/constructs/v1beta3/event/EventSchema.d.ts +2 -0
- package/dist/constructs/v1beta3/filter/Filter.d.ts +1452 -0
- package/dist/constructs/v1beta3/filter/FilterSchema.d.ts +2 -0
- package/dist/constructs/v1beta3/invitation/Invitation.d.ts +1060 -0
- package/dist/constructs/v1beta3/invitation/InvitationSchema.d.ts +2 -0
- package/dist/constructs/v1beta3/performance_profile/PerformanceProfile.d.ts +813 -0
- package/dist/constructs/v1beta3/performance_profile/PerformanceProfileSchema.d.ts +2 -0
- package/dist/constructs/v1beta3/plan/Plan.d.ts +199 -0
- package/dist/constructs/v1beta3/plan/PlanSchema.d.ts +2 -0
- package/dist/constructs/v1beta3/relationship/Relationship.d.ts +2134 -0
- package/dist/constructs/v1beta3/relationship/RelationshipSchema.d.ts +2 -0
- package/dist/constructs/v1beta3/subscription/Subscription.d.ts +915 -0
- package/dist/constructs/v1beta3/subscription/SubscriptionSchema.d.ts +2 -0
- package/dist/constructs/v1beta3/token/Token.d.ts +544 -0
- package/dist/constructs/v1beta3/token/TokenSchema.d.ts +2 -0
- package/dist/constructs/v1beta3/workspace/Workspace.d.ts +5086 -0
- package/dist/constructs/v1beta3/workspace/WorkspaceSchema.d.ts +2 -0
- package/dist/index.js +1 -1
- package/dist/index.mjs +1 -1
- package/package.json +2 -2
|
@@ -0,0 +1,1414 @@
|
|
|
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/integrations/connections": {
|
|
8
|
+
/** Returns a paginated list of connections for the authenticated user with filtering, sorting and pagination support */
|
|
9
|
+
get: operations["getConnections"];
|
|
10
|
+
/** Register a new connection with credentials */
|
|
11
|
+
post: operations["registerConnection"];
|
|
12
|
+
};
|
|
13
|
+
"/api/integrations/connections/{connectionId}": {
|
|
14
|
+
/** Returns a specific connection by its ID */
|
|
15
|
+
get: operations["getConnectionById"];
|
|
16
|
+
/** Update an existing connection */
|
|
17
|
+
put: operations["updateConnection"];
|
|
18
|
+
/** Delete a specific connection */
|
|
19
|
+
delete: operations["deleteConnection"];
|
|
20
|
+
};
|
|
21
|
+
"/api/integrations/connections/meshery/{mesheryServerId}": {
|
|
22
|
+
/** Delete a Meshery server connection by server ID */
|
|
23
|
+
delete: operations["deleteMesheryConnection"];
|
|
24
|
+
};
|
|
25
|
+
"/api/integrations/connections/kubernetes/{connectionId}/context": {
|
|
26
|
+
/** Get Kubernetes context for a specific connection */
|
|
27
|
+
get: operations["getKubernetesContext"];
|
|
28
|
+
};
|
|
29
|
+
"/api/environments/{environmentId}/connections/{connectionId}": {
|
|
30
|
+
/** Associate a connection with an environment */
|
|
31
|
+
post: operations["addConnectionToEnvironment"];
|
|
32
|
+
/** Disassociate a connection from an environment */
|
|
33
|
+
delete: operations["removeConnectionFromEnvironment"];
|
|
34
|
+
};
|
|
35
|
+
}
|
|
36
|
+
|
|
37
|
+
export interface components {
|
|
38
|
+
schemas: {
|
|
39
|
+
/** @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 */
|
|
40
|
+
Connection: {
|
|
41
|
+
/**
|
|
42
|
+
* Format: uuid
|
|
43
|
+
* @description Connection ID
|
|
44
|
+
*/
|
|
45
|
+
id: string;
|
|
46
|
+
/** @description Connection Name */
|
|
47
|
+
name: string;
|
|
48
|
+
/** @description Human-readable description of the connection and its purpose. */
|
|
49
|
+
description?: string;
|
|
50
|
+
/**
|
|
51
|
+
* Format: uri
|
|
52
|
+
* @description URL of the remote resource this connection points to (e.g. the Helm repository URL, the Kubernetes API server endpoint, the Grafana instance URL).
|
|
53
|
+
*/
|
|
54
|
+
url?: string;
|
|
55
|
+
/**
|
|
56
|
+
* Format: uuid
|
|
57
|
+
* @description Associated Credential ID
|
|
58
|
+
*/
|
|
59
|
+
credentialId?: string;
|
|
60
|
+
/** @description Connection Type (platform, telemetry, collaboration) */
|
|
61
|
+
type: string;
|
|
62
|
+
/** @description Connection Subtype (cloud, identity, metrics, chat, git, orchestration) */
|
|
63
|
+
subType: string;
|
|
64
|
+
/** @description Connection Kind (meshery, kubernetes, prometheus, grafana, gke, aws, azure, slack, github) */
|
|
65
|
+
kind: string;
|
|
66
|
+
/** @description Additional connection metadata */
|
|
67
|
+
metadata?: { [key: string]: unknown };
|
|
68
|
+
/**
|
|
69
|
+
* @description Connection Status
|
|
70
|
+
* @enum {string}
|
|
71
|
+
*/
|
|
72
|
+
status:
|
|
73
|
+
| "discovered"
|
|
74
|
+
| "registered"
|
|
75
|
+
| "connected"
|
|
76
|
+
| "ignored"
|
|
77
|
+
| "maintenance"
|
|
78
|
+
| "disconnected"
|
|
79
|
+
| "deleted"
|
|
80
|
+
| "not found";
|
|
81
|
+
/**
|
|
82
|
+
* Format: uuid
|
|
83
|
+
* @description User ID who owns this connection
|
|
84
|
+
*/
|
|
85
|
+
userId?: string;
|
|
86
|
+
/**
|
|
87
|
+
* Format: date-time
|
|
88
|
+
* @description Timestamp when the connection was created.
|
|
89
|
+
*/
|
|
90
|
+
createdAt?: string;
|
|
91
|
+
/**
|
|
92
|
+
* Format: date-time
|
|
93
|
+
* @description Timestamp when the connection was last updated.
|
|
94
|
+
*/
|
|
95
|
+
updatedAt?: string;
|
|
96
|
+
/**
|
|
97
|
+
* Format: date-time
|
|
98
|
+
* @description Timestamp when the connection was soft-deleted, if applicable.
|
|
99
|
+
*/
|
|
100
|
+
deletedAt?: string;
|
|
101
|
+
/** @description Associated environments for this connection */
|
|
102
|
+
environments?: {
|
|
103
|
+
/**
|
|
104
|
+
* Format: uuid
|
|
105
|
+
* @description ID
|
|
106
|
+
*/
|
|
107
|
+
id: string;
|
|
108
|
+
/**
|
|
109
|
+
* @description Specifies the version of the schema to which the environment conforms.
|
|
110
|
+
* @default environments.meshery.io/v1beta3
|
|
111
|
+
* @example [
|
|
112
|
+
* "v1",
|
|
113
|
+
* "v1alpha1",
|
|
114
|
+
* "v2beta3",
|
|
115
|
+
* "v1.custom-suffix",
|
|
116
|
+
* "models.meshery.io/v1beta1",
|
|
117
|
+
* "capability.meshery.io/v1alpha1"
|
|
118
|
+
* ]
|
|
119
|
+
*/
|
|
120
|
+
schemaVersion: string;
|
|
121
|
+
/** @description Environment name */
|
|
122
|
+
name: string;
|
|
123
|
+
/** @description Environment description */
|
|
124
|
+
description: string;
|
|
125
|
+
/**
|
|
126
|
+
* Format: uuid
|
|
127
|
+
* @description Environment organization ID
|
|
128
|
+
*/
|
|
129
|
+
organizationId: string;
|
|
130
|
+
/**
|
|
131
|
+
* Format: uuid
|
|
132
|
+
* @description Environment owner
|
|
133
|
+
*/
|
|
134
|
+
owner?: string;
|
|
135
|
+
/**
|
|
136
|
+
* Format: date-time
|
|
137
|
+
* @description Timestamp when the environment was created.
|
|
138
|
+
*/
|
|
139
|
+
createdAt?: string;
|
|
140
|
+
/** @description Additional metadata associated with the environment. */
|
|
141
|
+
metadata?: { [key: string]: unknown };
|
|
142
|
+
/**
|
|
143
|
+
* Format: date-time
|
|
144
|
+
* @description Timestamp when the environment was last updated.
|
|
145
|
+
*/
|
|
146
|
+
updatedAt?: string;
|
|
147
|
+
/**
|
|
148
|
+
* Format: date-time
|
|
149
|
+
* @description Timestamp when the environment was soft deleted. Null while the environment remains active.
|
|
150
|
+
*/
|
|
151
|
+
deletedAt?: string | null;
|
|
152
|
+
}[];
|
|
153
|
+
/**
|
|
154
|
+
* @description Specifies the version of the schema used for the definition.
|
|
155
|
+
* @default connections.meshery.io/v1beta3
|
|
156
|
+
* @example [
|
|
157
|
+
* "v1",
|
|
158
|
+
* "v1alpha1",
|
|
159
|
+
* "v2beta3",
|
|
160
|
+
* "v1.custom-suffix",
|
|
161
|
+
* "models.meshery.io/v1beta1",
|
|
162
|
+
* "capability.meshery.io/v1alpha1"
|
|
163
|
+
* ]
|
|
164
|
+
*/
|
|
165
|
+
schemaVersion: string;
|
|
166
|
+
};
|
|
167
|
+
/** @description Represents a page of connections with meta information about connections count */
|
|
168
|
+
ConnectionPage: {
|
|
169
|
+
/** @description List of connections on this page */
|
|
170
|
+
connections: {
|
|
171
|
+
/**
|
|
172
|
+
* Format: uuid
|
|
173
|
+
* @description Connection ID
|
|
174
|
+
*/
|
|
175
|
+
id: string;
|
|
176
|
+
/** @description Connection Name */
|
|
177
|
+
name: string;
|
|
178
|
+
/** @description Human-readable description of the connection and its purpose. */
|
|
179
|
+
description?: string;
|
|
180
|
+
/**
|
|
181
|
+
* Format: uri
|
|
182
|
+
* @description URL of the remote resource this connection points to (e.g. the Helm repository URL, the Kubernetes API server endpoint, the Grafana instance URL).
|
|
183
|
+
*/
|
|
184
|
+
url?: string;
|
|
185
|
+
/**
|
|
186
|
+
* Format: uuid
|
|
187
|
+
* @description Associated Credential ID
|
|
188
|
+
*/
|
|
189
|
+
credentialId?: string;
|
|
190
|
+
/** @description Connection Type (platform, telemetry, collaboration) */
|
|
191
|
+
type: string;
|
|
192
|
+
/** @description Connection Subtype (cloud, identity, metrics, chat, git, orchestration) */
|
|
193
|
+
subType: string;
|
|
194
|
+
/** @description Connection Kind (meshery, kubernetes, prometheus, grafana, gke, aws, azure, slack, github) */
|
|
195
|
+
kind: string;
|
|
196
|
+
/** @description Additional connection metadata */
|
|
197
|
+
metadata?: { [key: string]: unknown };
|
|
198
|
+
/**
|
|
199
|
+
* @description Connection Status
|
|
200
|
+
* @enum {string}
|
|
201
|
+
*/
|
|
202
|
+
status:
|
|
203
|
+
| "discovered"
|
|
204
|
+
| "registered"
|
|
205
|
+
| "connected"
|
|
206
|
+
| "ignored"
|
|
207
|
+
| "maintenance"
|
|
208
|
+
| "disconnected"
|
|
209
|
+
| "deleted"
|
|
210
|
+
| "not found";
|
|
211
|
+
/**
|
|
212
|
+
* Format: uuid
|
|
213
|
+
* @description User ID who owns this connection
|
|
214
|
+
*/
|
|
215
|
+
userId?: string;
|
|
216
|
+
/**
|
|
217
|
+
* Format: date-time
|
|
218
|
+
* @description Timestamp when the connection was created.
|
|
219
|
+
*/
|
|
220
|
+
createdAt?: string;
|
|
221
|
+
/**
|
|
222
|
+
* Format: date-time
|
|
223
|
+
* @description Timestamp when the connection was last updated.
|
|
224
|
+
*/
|
|
225
|
+
updatedAt?: string;
|
|
226
|
+
/**
|
|
227
|
+
* Format: date-time
|
|
228
|
+
* @description Timestamp when the connection was soft-deleted, if applicable.
|
|
229
|
+
*/
|
|
230
|
+
deletedAt?: string;
|
|
231
|
+
/** @description Associated environments for this connection */
|
|
232
|
+
environments?: {
|
|
233
|
+
/**
|
|
234
|
+
* Format: uuid
|
|
235
|
+
* @description ID
|
|
236
|
+
*/
|
|
237
|
+
id: string;
|
|
238
|
+
/**
|
|
239
|
+
* @description Specifies the version of the schema to which the environment conforms.
|
|
240
|
+
* @default environments.meshery.io/v1beta3
|
|
241
|
+
* @example [
|
|
242
|
+
* "v1",
|
|
243
|
+
* "v1alpha1",
|
|
244
|
+
* "v2beta3",
|
|
245
|
+
* "v1.custom-suffix",
|
|
246
|
+
* "models.meshery.io/v1beta1",
|
|
247
|
+
* "capability.meshery.io/v1alpha1"
|
|
248
|
+
* ]
|
|
249
|
+
*/
|
|
250
|
+
schemaVersion: string;
|
|
251
|
+
/** @description Environment name */
|
|
252
|
+
name: string;
|
|
253
|
+
/** @description Environment description */
|
|
254
|
+
description: string;
|
|
255
|
+
/**
|
|
256
|
+
* Format: uuid
|
|
257
|
+
* @description Environment organization ID
|
|
258
|
+
*/
|
|
259
|
+
organizationId: string;
|
|
260
|
+
/**
|
|
261
|
+
* Format: uuid
|
|
262
|
+
* @description Environment owner
|
|
263
|
+
*/
|
|
264
|
+
owner?: string;
|
|
265
|
+
/**
|
|
266
|
+
* Format: date-time
|
|
267
|
+
* @description Timestamp when the environment was created.
|
|
268
|
+
*/
|
|
269
|
+
createdAt?: string;
|
|
270
|
+
/** @description Additional metadata associated with the environment. */
|
|
271
|
+
metadata?: { [key: string]: unknown };
|
|
272
|
+
/**
|
|
273
|
+
* Format: date-time
|
|
274
|
+
* @description Timestamp when the environment was last updated.
|
|
275
|
+
*/
|
|
276
|
+
updatedAt?: string;
|
|
277
|
+
/**
|
|
278
|
+
* Format: date-time
|
|
279
|
+
* @description Timestamp when the environment was soft deleted. Null while the environment remains active.
|
|
280
|
+
*/
|
|
281
|
+
deletedAt?: string | null;
|
|
282
|
+
}[];
|
|
283
|
+
/**
|
|
284
|
+
* @description Specifies the version of the schema used for the definition.
|
|
285
|
+
* @default connections.meshery.io/v1beta3
|
|
286
|
+
* @example [
|
|
287
|
+
* "v1",
|
|
288
|
+
* "v1alpha1",
|
|
289
|
+
* "v2beta3",
|
|
290
|
+
* "v1.custom-suffix",
|
|
291
|
+
* "models.meshery.io/v1beta1",
|
|
292
|
+
* "capability.meshery.io/v1alpha1"
|
|
293
|
+
* ]
|
|
294
|
+
*/
|
|
295
|
+
schemaVersion: string;
|
|
296
|
+
}[];
|
|
297
|
+
/** @description Total number of connections on all pages */
|
|
298
|
+
totalCount: number;
|
|
299
|
+
/** @description Current page number */
|
|
300
|
+
page: number;
|
|
301
|
+
/** @description Number of elements per page */
|
|
302
|
+
pageSize: number;
|
|
303
|
+
/** @description Aggregate count of connections grouped by status */
|
|
304
|
+
statusSummary?: { [key: string]: number };
|
|
305
|
+
};
|
|
306
|
+
/**
|
|
307
|
+
* @description Connection Status Value
|
|
308
|
+
* @enum {string}
|
|
309
|
+
*/
|
|
310
|
+
ConnectionStatusValue:
|
|
311
|
+
| "discovered"
|
|
312
|
+
| "registered"
|
|
313
|
+
| "connected"
|
|
314
|
+
| "ignored"
|
|
315
|
+
| "maintenance"
|
|
316
|
+
| "disconnected"
|
|
317
|
+
| "deleted"
|
|
318
|
+
| "not found";
|
|
319
|
+
/** @description Payload for creating or updating a connection */
|
|
320
|
+
ConnectionPayload: {
|
|
321
|
+
/**
|
|
322
|
+
* Format: uuid
|
|
323
|
+
* @description Connection ID
|
|
324
|
+
*/
|
|
325
|
+
id?: string;
|
|
326
|
+
/** @description Connection name */
|
|
327
|
+
name: string;
|
|
328
|
+
/** @description Connection kind */
|
|
329
|
+
kind: string;
|
|
330
|
+
/** @description Connection type */
|
|
331
|
+
type: string;
|
|
332
|
+
/** @description Connection sub-type */
|
|
333
|
+
subType: string;
|
|
334
|
+
/** @description Credential secret data */
|
|
335
|
+
credentialSecret?: { [key: string]: unknown };
|
|
336
|
+
/** @description Connection metadata */
|
|
337
|
+
metadata?: { [key: string]: unknown };
|
|
338
|
+
/** @description Connection status */
|
|
339
|
+
status: string;
|
|
340
|
+
/**
|
|
341
|
+
* Format: uuid
|
|
342
|
+
* @description Associated credential ID
|
|
343
|
+
*/
|
|
344
|
+
credentialId?: string;
|
|
345
|
+
};
|
|
346
|
+
/** @description Status count information for connections */
|
|
347
|
+
ConnectionStatusInfo: {
|
|
348
|
+
/** @description Status value */
|
|
349
|
+
status: string;
|
|
350
|
+
/** @description Number of connections with this status */
|
|
351
|
+
count: number;
|
|
352
|
+
};
|
|
353
|
+
/** @description Paginated list of connection status counts */
|
|
354
|
+
ConnectionsStatusPage: {
|
|
355
|
+
/** @description Total number of status entries */
|
|
356
|
+
totalCount: number;
|
|
357
|
+
/** @description Current page number */
|
|
358
|
+
page: number;
|
|
359
|
+
/** @description Number of items per page */
|
|
360
|
+
pageSize: number;
|
|
361
|
+
/** @description List of status counts */
|
|
362
|
+
connectionsStatus: {
|
|
363
|
+
/** @description Status value */
|
|
364
|
+
status: string;
|
|
365
|
+
/** @description Number of connections with this status */
|
|
366
|
+
count: number;
|
|
367
|
+
}[];
|
|
368
|
+
};
|
|
369
|
+
/** @description Meshery server instance information */
|
|
370
|
+
MesheryInstance: {
|
|
371
|
+
/**
|
|
372
|
+
* Format: uuid
|
|
373
|
+
* @description Instance ID
|
|
374
|
+
*/
|
|
375
|
+
id?: string;
|
|
376
|
+
/** @description Instance name */
|
|
377
|
+
name?: string;
|
|
378
|
+
/**
|
|
379
|
+
* Format: uuid
|
|
380
|
+
* @description Server ID
|
|
381
|
+
*/
|
|
382
|
+
serverId?: string;
|
|
383
|
+
/** @description Meshery server version */
|
|
384
|
+
serverVersion?: string;
|
|
385
|
+
/** @description Server location URL */
|
|
386
|
+
serverLocation?: string;
|
|
387
|
+
/** @description Server build SHA */
|
|
388
|
+
serverBuildSha?: string;
|
|
389
|
+
/**
|
|
390
|
+
* Format: date-time
|
|
391
|
+
* @description Creation timestamp
|
|
392
|
+
*/
|
|
393
|
+
createdAt?: string;
|
|
394
|
+
/**
|
|
395
|
+
* Format: date-time
|
|
396
|
+
* @description Last update timestamp
|
|
397
|
+
*/
|
|
398
|
+
updatedAt?: string;
|
|
399
|
+
/**
|
|
400
|
+
* Format: date-time
|
|
401
|
+
* @description Deletion timestamp
|
|
402
|
+
*/
|
|
403
|
+
deletedAt?: string;
|
|
404
|
+
};
|
|
405
|
+
/** @description Paginated list of Meshery instances */
|
|
406
|
+
MesheryInstancePage: {
|
|
407
|
+
/** @description List of Meshery instances */
|
|
408
|
+
mesheryInstances: {
|
|
409
|
+
/**
|
|
410
|
+
* Format: uuid
|
|
411
|
+
* @description Instance ID
|
|
412
|
+
*/
|
|
413
|
+
id?: string;
|
|
414
|
+
/** @description Instance name */
|
|
415
|
+
name?: string;
|
|
416
|
+
/**
|
|
417
|
+
* Format: uuid
|
|
418
|
+
* @description Server ID
|
|
419
|
+
*/
|
|
420
|
+
serverId?: string;
|
|
421
|
+
/** @description Meshery server version */
|
|
422
|
+
serverVersion?: string;
|
|
423
|
+
/** @description Server location URL */
|
|
424
|
+
serverLocation?: string;
|
|
425
|
+
/** @description Server build SHA */
|
|
426
|
+
serverBuildSha?: string;
|
|
427
|
+
/**
|
|
428
|
+
* Format: date-time
|
|
429
|
+
* @description Creation timestamp
|
|
430
|
+
*/
|
|
431
|
+
createdAt?: string;
|
|
432
|
+
/**
|
|
433
|
+
* Format: date-time
|
|
434
|
+
* @description Last update timestamp
|
|
435
|
+
*/
|
|
436
|
+
updatedAt?: string;
|
|
437
|
+
/**
|
|
438
|
+
* Format: date-time
|
|
439
|
+
* @description Deletion timestamp
|
|
440
|
+
*/
|
|
441
|
+
deletedAt?: string;
|
|
442
|
+
}[];
|
|
443
|
+
/** @description Current page number */
|
|
444
|
+
page: number;
|
|
445
|
+
/** @description Number of items per page */
|
|
446
|
+
pageSize: number;
|
|
447
|
+
/** @description Total number of instances */
|
|
448
|
+
totalCount: number;
|
|
449
|
+
};
|
|
450
|
+
/** @description Meshery version compatibility check */
|
|
451
|
+
MesheryCompatibility: {
|
|
452
|
+
/** @description Meshery version string */
|
|
453
|
+
mesheryVersion?: string;
|
|
454
|
+
/** @description Whether to check compatibility */
|
|
455
|
+
checkCompatibility?: boolean;
|
|
456
|
+
};
|
|
457
|
+
};
|
|
458
|
+
responses: {
|
|
459
|
+
/** Invalid request body or request param */
|
|
460
|
+
400: {
|
|
461
|
+
content: {
|
|
462
|
+
"text/plain": string;
|
|
463
|
+
};
|
|
464
|
+
};
|
|
465
|
+
/** Expired JWT token used or insufficient privilege */
|
|
466
|
+
401: {
|
|
467
|
+
content: {
|
|
468
|
+
"text/plain": string;
|
|
469
|
+
};
|
|
470
|
+
};
|
|
471
|
+
/** Result not found */
|
|
472
|
+
404: {
|
|
473
|
+
content: {
|
|
474
|
+
"text/plain": string;
|
|
475
|
+
};
|
|
476
|
+
};
|
|
477
|
+
/** Internal server error */
|
|
478
|
+
500: {
|
|
479
|
+
content: {
|
|
480
|
+
"text/plain": string;
|
|
481
|
+
};
|
|
482
|
+
};
|
|
483
|
+
};
|
|
484
|
+
parameters: {
|
|
485
|
+
/** @description Connection ID */
|
|
486
|
+
connectionId: string;
|
|
487
|
+
/** @description Connection kind (meshery, kubernetes, prometheus, grafana, etc.) */
|
|
488
|
+
connectionKind: string;
|
|
489
|
+
/** @description Environment ID */
|
|
490
|
+
environmentId: string;
|
|
491
|
+
/** @description Meshery server ID */
|
|
492
|
+
mesheryServerId: string;
|
|
493
|
+
/** @description Page number */
|
|
494
|
+
page: number;
|
|
495
|
+
/** @description Number of items per page */
|
|
496
|
+
pageSize: number;
|
|
497
|
+
/** @description Search term */
|
|
498
|
+
search: string;
|
|
499
|
+
/** @description Sort order */
|
|
500
|
+
order: string;
|
|
501
|
+
/** @description Organization ID to scope the request. */
|
|
502
|
+
orgIdQuery: string;
|
|
503
|
+
};
|
|
504
|
+
}
|
|
505
|
+
|
|
506
|
+
export interface operations {
|
|
507
|
+
/** Returns a paginated list of connections for the authenticated user with filtering, sorting and pagination support */
|
|
508
|
+
getConnections: {
|
|
509
|
+
parameters: {
|
|
510
|
+
query: {
|
|
511
|
+
/** Page number */
|
|
512
|
+
page?: number;
|
|
513
|
+
/** Number of items per page */
|
|
514
|
+
pageSize?: number;
|
|
515
|
+
/** Search term */
|
|
516
|
+
search?: string;
|
|
517
|
+
/** Sort order */
|
|
518
|
+
order?: string;
|
|
519
|
+
/** Organization ID to scope the request. */
|
|
520
|
+
orgId?: string;
|
|
521
|
+
/** Filter connections (general filter string) */
|
|
522
|
+
filter?: string;
|
|
523
|
+
/** Filter by connection kind (e.g., kubernetes, prometheus, grafana) */
|
|
524
|
+
kind?: string[];
|
|
525
|
+
/** Filter by connection status */
|
|
526
|
+
status?: (
|
|
527
|
+
| "discovered"
|
|
528
|
+
| "registered"
|
|
529
|
+
| "connected"
|
|
530
|
+
| "ignored"
|
|
531
|
+
| "maintenance"
|
|
532
|
+
| "disconnected"
|
|
533
|
+
| "deleted"
|
|
534
|
+
| "not found"
|
|
535
|
+
)[];
|
|
536
|
+
/** Filter by connection type */
|
|
537
|
+
type?: string[];
|
|
538
|
+
/** Filter by connection name (partial match supported) */
|
|
539
|
+
name?: string;
|
|
540
|
+
};
|
|
541
|
+
};
|
|
542
|
+
responses: {
|
|
543
|
+
/** Paginated list of connections with summary information */
|
|
544
|
+
200: {
|
|
545
|
+
content: {
|
|
546
|
+
"application/json": {
|
|
547
|
+
/** @description List of connections on this page */
|
|
548
|
+
connections: {
|
|
549
|
+
/**
|
|
550
|
+
* Format: uuid
|
|
551
|
+
* @description Connection ID
|
|
552
|
+
*/
|
|
553
|
+
id: string;
|
|
554
|
+
/** @description Connection Name */
|
|
555
|
+
name: string;
|
|
556
|
+
/** @description Human-readable description of the connection and its purpose. */
|
|
557
|
+
description?: string;
|
|
558
|
+
/**
|
|
559
|
+
* Format: uri
|
|
560
|
+
* @description URL of the remote resource this connection points to (e.g. the Helm repository URL, the Kubernetes API server endpoint, the Grafana instance URL).
|
|
561
|
+
*/
|
|
562
|
+
url?: string;
|
|
563
|
+
/**
|
|
564
|
+
* Format: uuid
|
|
565
|
+
* @description Associated Credential ID
|
|
566
|
+
*/
|
|
567
|
+
credentialId?: string;
|
|
568
|
+
/** @description Connection Type (platform, telemetry, collaboration) */
|
|
569
|
+
type: string;
|
|
570
|
+
/** @description Connection Subtype (cloud, identity, metrics, chat, git, orchestration) */
|
|
571
|
+
subType: string;
|
|
572
|
+
/** @description Connection Kind (meshery, kubernetes, prometheus, grafana, gke, aws, azure, slack, github) */
|
|
573
|
+
kind: string;
|
|
574
|
+
/** @description Additional connection metadata */
|
|
575
|
+
metadata?: { [key: string]: unknown };
|
|
576
|
+
/**
|
|
577
|
+
* @description Connection Status
|
|
578
|
+
* @enum {string}
|
|
579
|
+
*/
|
|
580
|
+
status:
|
|
581
|
+
| "discovered"
|
|
582
|
+
| "registered"
|
|
583
|
+
| "connected"
|
|
584
|
+
| "ignored"
|
|
585
|
+
| "maintenance"
|
|
586
|
+
| "disconnected"
|
|
587
|
+
| "deleted"
|
|
588
|
+
| "not found";
|
|
589
|
+
/**
|
|
590
|
+
* Format: uuid
|
|
591
|
+
* @description User ID who owns this connection
|
|
592
|
+
*/
|
|
593
|
+
userId?: string;
|
|
594
|
+
/**
|
|
595
|
+
* Format: date-time
|
|
596
|
+
* @description Timestamp when the connection was created.
|
|
597
|
+
*/
|
|
598
|
+
createdAt?: string;
|
|
599
|
+
/**
|
|
600
|
+
* Format: date-time
|
|
601
|
+
* @description Timestamp when the connection was last updated.
|
|
602
|
+
*/
|
|
603
|
+
updatedAt?: string;
|
|
604
|
+
/**
|
|
605
|
+
* Format: date-time
|
|
606
|
+
* @description Timestamp when the connection was soft-deleted, if applicable.
|
|
607
|
+
*/
|
|
608
|
+
deletedAt?: string;
|
|
609
|
+
/** @description Associated environments for this connection */
|
|
610
|
+
environments?: {
|
|
611
|
+
/**
|
|
612
|
+
* Format: uuid
|
|
613
|
+
* @description ID
|
|
614
|
+
*/
|
|
615
|
+
id: string;
|
|
616
|
+
/**
|
|
617
|
+
* @description Specifies the version of the schema to which the environment conforms.
|
|
618
|
+
* @default environments.meshery.io/v1beta3
|
|
619
|
+
* @example [
|
|
620
|
+
* "v1",
|
|
621
|
+
* "v1alpha1",
|
|
622
|
+
* "v2beta3",
|
|
623
|
+
* "v1.custom-suffix",
|
|
624
|
+
* "models.meshery.io/v1beta1",
|
|
625
|
+
* "capability.meshery.io/v1alpha1"
|
|
626
|
+
* ]
|
|
627
|
+
*/
|
|
628
|
+
schemaVersion: string;
|
|
629
|
+
/** @description Environment name */
|
|
630
|
+
name: string;
|
|
631
|
+
/** @description Environment description */
|
|
632
|
+
description: string;
|
|
633
|
+
/**
|
|
634
|
+
* Format: uuid
|
|
635
|
+
* @description Environment organization ID
|
|
636
|
+
*/
|
|
637
|
+
organizationId: string;
|
|
638
|
+
/**
|
|
639
|
+
* Format: uuid
|
|
640
|
+
* @description Environment owner
|
|
641
|
+
*/
|
|
642
|
+
owner?: string;
|
|
643
|
+
/**
|
|
644
|
+
* Format: date-time
|
|
645
|
+
* @description Timestamp when the environment was created.
|
|
646
|
+
*/
|
|
647
|
+
createdAt?: string;
|
|
648
|
+
/** @description Additional metadata associated with the environment. */
|
|
649
|
+
metadata?: { [key: string]: unknown };
|
|
650
|
+
/**
|
|
651
|
+
* Format: date-time
|
|
652
|
+
* @description Timestamp when the environment was last updated.
|
|
653
|
+
*/
|
|
654
|
+
updatedAt?: string;
|
|
655
|
+
/**
|
|
656
|
+
* Format: date-time
|
|
657
|
+
* @description Timestamp when the environment was soft deleted. Null while the environment remains active.
|
|
658
|
+
*/
|
|
659
|
+
deletedAt?: string | null;
|
|
660
|
+
}[];
|
|
661
|
+
/**
|
|
662
|
+
* @description Specifies the version of the schema used for the definition.
|
|
663
|
+
* @default connections.meshery.io/v1beta3
|
|
664
|
+
* @example [
|
|
665
|
+
* "v1",
|
|
666
|
+
* "v1alpha1",
|
|
667
|
+
* "v2beta3",
|
|
668
|
+
* "v1.custom-suffix",
|
|
669
|
+
* "models.meshery.io/v1beta1",
|
|
670
|
+
* "capability.meshery.io/v1alpha1"
|
|
671
|
+
* ]
|
|
672
|
+
*/
|
|
673
|
+
schemaVersion: string;
|
|
674
|
+
}[];
|
|
675
|
+
/** @description Total number of connections on all pages */
|
|
676
|
+
totalCount: number;
|
|
677
|
+
/** @description Current page number */
|
|
678
|
+
page: number;
|
|
679
|
+
/** @description Number of elements per page */
|
|
680
|
+
pageSize: number;
|
|
681
|
+
/** @description Aggregate count of connections grouped by status */
|
|
682
|
+
statusSummary?: { [key: string]: number };
|
|
683
|
+
};
|
|
684
|
+
};
|
|
685
|
+
};
|
|
686
|
+
/** Expired JWT token used or insufficient privilege */
|
|
687
|
+
401: {
|
|
688
|
+
content: {
|
|
689
|
+
"text/plain": string;
|
|
690
|
+
};
|
|
691
|
+
};
|
|
692
|
+
/** Internal server error */
|
|
693
|
+
500: {
|
|
694
|
+
content: {
|
|
695
|
+
"text/plain": string;
|
|
696
|
+
};
|
|
697
|
+
};
|
|
698
|
+
};
|
|
699
|
+
};
|
|
700
|
+
/** Register a new connection with credentials */
|
|
701
|
+
registerConnection: {
|
|
702
|
+
responses: {
|
|
703
|
+
/** Connection registered */
|
|
704
|
+
201: {
|
|
705
|
+
content: {
|
|
706
|
+
"application/json": {
|
|
707
|
+
/**
|
|
708
|
+
* Format: uuid
|
|
709
|
+
* @description Connection ID
|
|
710
|
+
*/
|
|
711
|
+
id: string;
|
|
712
|
+
/** @description Connection Name */
|
|
713
|
+
name: string;
|
|
714
|
+
/** @description Human-readable description of the connection and its purpose. */
|
|
715
|
+
description?: string;
|
|
716
|
+
/**
|
|
717
|
+
* Format: uri
|
|
718
|
+
* @description URL of the remote resource this connection points to (e.g. the Helm repository URL, the Kubernetes API server endpoint, the Grafana instance URL).
|
|
719
|
+
*/
|
|
720
|
+
url?: string;
|
|
721
|
+
/**
|
|
722
|
+
* Format: uuid
|
|
723
|
+
* @description Associated Credential ID
|
|
724
|
+
*/
|
|
725
|
+
credentialId?: string;
|
|
726
|
+
/** @description Connection Type (platform, telemetry, collaboration) */
|
|
727
|
+
type: string;
|
|
728
|
+
/** @description Connection Subtype (cloud, identity, metrics, chat, git, orchestration) */
|
|
729
|
+
subType: string;
|
|
730
|
+
/** @description Connection Kind (meshery, kubernetes, prometheus, grafana, gke, aws, azure, slack, github) */
|
|
731
|
+
kind: string;
|
|
732
|
+
/** @description Additional connection metadata */
|
|
733
|
+
metadata?: { [key: string]: unknown };
|
|
734
|
+
/**
|
|
735
|
+
* @description Connection Status
|
|
736
|
+
* @enum {string}
|
|
737
|
+
*/
|
|
738
|
+
status:
|
|
739
|
+
| "discovered"
|
|
740
|
+
| "registered"
|
|
741
|
+
| "connected"
|
|
742
|
+
| "ignored"
|
|
743
|
+
| "maintenance"
|
|
744
|
+
| "disconnected"
|
|
745
|
+
| "deleted"
|
|
746
|
+
| "not found";
|
|
747
|
+
/**
|
|
748
|
+
* Format: uuid
|
|
749
|
+
* @description User ID who owns this connection
|
|
750
|
+
*/
|
|
751
|
+
userId?: string;
|
|
752
|
+
/**
|
|
753
|
+
* Format: date-time
|
|
754
|
+
* @description Timestamp when the connection was created.
|
|
755
|
+
*/
|
|
756
|
+
createdAt?: string;
|
|
757
|
+
/**
|
|
758
|
+
* Format: date-time
|
|
759
|
+
* @description Timestamp when the connection was last updated.
|
|
760
|
+
*/
|
|
761
|
+
updatedAt?: string;
|
|
762
|
+
/**
|
|
763
|
+
* Format: date-time
|
|
764
|
+
* @description Timestamp when the connection was soft-deleted, if applicable.
|
|
765
|
+
*/
|
|
766
|
+
deletedAt?: string;
|
|
767
|
+
/** @description Associated environments for this connection */
|
|
768
|
+
environments?: {
|
|
769
|
+
/**
|
|
770
|
+
* Format: uuid
|
|
771
|
+
* @description ID
|
|
772
|
+
*/
|
|
773
|
+
id: string;
|
|
774
|
+
/**
|
|
775
|
+
* @description Specifies the version of the schema to which the environment conforms.
|
|
776
|
+
* @default environments.meshery.io/v1beta3
|
|
777
|
+
* @example [
|
|
778
|
+
* "v1",
|
|
779
|
+
* "v1alpha1",
|
|
780
|
+
* "v2beta3",
|
|
781
|
+
* "v1.custom-suffix",
|
|
782
|
+
* "models.meshery.io/v1beta1",
|
|
783
|
+
* "capability.meshery.io/v1alpha1"
|
|
784
|
+
* ]
|
|
785
|
+
*/
|
|
786
|
+
schemaVersion: string;
|
|
787
|
+
/** @description Environment name */
|
|
788
|
+
name: string;
|
|
789
|
+
/** @description Environment description */
|
|
790
|
+
description: string;
|
|
791
|
+
/**
|
|
792
|
+
* Format: uuid
|
|
793
|
+
* @description Environment organization ID
|
|
794
|
+
*/
|
|
795
|
+
organizationId: string;
|
|
796
|
+
/**
|
|
797
|
+
* Format: uuid
|
|
798
|
+
* @description Environment owner
|
|
799
|
+
*/
|
|
800
|
+
owner?: string;
|
|
801
|
+
/**
|
|
802
|
+
* Format: date-time
|
|
803
|
+
* @description Timestamp when the environment was created.
|
|
804
|
+
*/
|
|
805
|
+
createdAt?: string;
|
|
806
|
+
/** @description Additional metadata associated with the environment. */
|
|
807
|
+
metadata?: { [key: string]: unknown };
|
|
808
|
+
/**
|
|
809
|
+
* Format: date-time
|
|
810
|
+
* @description Timestamp when the environment was last updated.
|
|
811
|
+
*/
|
|
812
|
+
updatedAt?: string;
|
|
813
|
+
/**
|
|
814
|
+
* Format: date-time
|
|
815
|
+
* @description Timestamp when the environment was soft deleted. Null while the environment remains active.
|
|
816
|
+
*/
|
|
817
|
+
deletedAt?: string | null;
|
|
818
|
+
}[];
|
|
819
|
+
/**
|
|
820
|
+
* @description Specifies the version of the schema used for the definition.
|
|
821
|
+
* @default connections.meshery.io/v1beta3
|
|
822
|
+
* @example [
|
|
823
|
+
* "v1",
|
|
824
|
+
* "v1alpha1",
|
|
825
|
+
* "v2beta3",
|
|
826
|
+
* "v1.custom-suffix",
|
|
827
|
+
* "models.meshery.io/v1beta1",
|
|
828
|
+
* "capability.meshery.io/v1alpha1"
|
|
829
|
+
* ]
|
|
830
|
+
*/
|
|
831
|
+
schemaVersion: string;
|
|
832
|
+
};
|
|
833
|
+
};
|
|
834
|
+
};
|
|
835
|
+
/** Invalid request body or request param */
|
|
836
|
+
400: {
|
|
837
|
+
content: {
|
|
838
|
+
"text/plain": string;
|
|
839
|
+
};
|
|
840
|
+
};
|
|
841
|
+
/** Expired JWT token used or insufficient privilege */
|
|
842
|
+
401: {
|
|
843
|
+
content: {
|
|
844
|
+
"text/plain": string;
|
|
845
|
+
};
|
|
846
|
+
};
|
|
847
|
+
/** Internal server error */
|
|
848
|
+
500: {
|
|
849
|
+
content: {
|
|
850
|
+
"text/plain": string;
|
|
851
|
+
};
|
|
852
|
+
};
|
|
853
|
+
};
|
|
854
|
+
requestBody: {
|
|
855
|
+
content: {
|
|
856
|
+
"application/json": {
|
|
857
|
+
/**
|
|
858
|
+
* Format: uuid
|
|
859
|
+
* @description Connection ID
|
|
860
|
+
*/
|
|
861
|
+
id?: string;
|
|
862
|
+
/** @description Connection name */
|
|
863
|
+
name: string;
|
|
864
|
+
/** @description Connection kind */
|
|
865
|
+
kind: string;
|
|
866
|
+
/** @description Connection type */
|
|
867
|
+
type: string;
|
|
868
|
+
/** @description Connection sub-type */
|
|
869
|
+
subType: string;
|
|
870
|
+
/** @description Credential secret data */
|
|
871
|
+
credentialSecret?: { [key: string]: unknown };
|
|
872
|
+
/** @description Connection metadata */
|
|
873
|
+
metadata?: { [key: string]: unknown };
|
|
874
|
+
/** @description Connection status */
|
|
875
|
+
status: string;
|
|
876
|
+
/**
|
|
877
|
+
* Format: uuid
|
|
878
|
+
* @description Associated credential ID
|
|
879
|
+
*/
|
|
880
|
+
credentialId?: string;
|
|
881
|
+
};
|
|
882
|
+
};
|
|
883
|
+
};
|
|
884
|
+
};
|
|
885
|
+
/** Returns a specific connection by its ID */
|
|
886
|
+
getConnectionById: {
|
|
887
|
+
parameters: {
|
|
888
|
+
path: {
|
|
889
|
+
/** Connection ID */
|
|
890
|
+
connectionId: string;
|
|
891
|
+
};
|
|
892
|
+
};
|
|
893
|
+
responses: {
|
|
894
|
+
/** Connection details */
|
|
895
|
+
200: {
|
|
896
|
+
content: {
|
|
897
|
+
"application/json": {
|
|
898
|
+
/**
|
|
899
|
+
* Format: uuid
|
|
900
|
+
* @description Connection ID
|
|
901
|
+
*/
|
|
902
|
+
id: string;
|
|
903
|
+
/** @description Connection Name */
|
|
904
|
+
name: string;
|
|
905
|
+
/** @description Human-readable description of the connection and its purpose. */
|
|
906
|
+
description?: string;
|
|
907
|
+
/**
|
|
908
|
+
* Format: uri
|
|
909
|
+
* @description URL of the remote resource this connection points to (e.g. the Helm repository URL, the Kubernetes API server endpoint, the Grafana instance URL).
|
|
910
|
+
*/
|
|
911
|
+
url?: string;
|
|
912
|
+
/**
|
|
913
|
+
* Format: uuid
|
|
914
|
+
* @description Associated Credential ID
|
|
915
|
+
*/
|
|
916
|
+
credentialId?: string;
|
|
917
|
+
/** @description Connection Type (platform, telemetry, collaboration) */
|
|
918
|
+
type: string;
|
|
919
|
+
/** @description Connection Subtype (cloud, identity, metrics, chat, git, orchestration) */
|
|
920
|
+
subType: string;
|
|
921
|
+
/** @description Connection Kind (meshery, kubernetes, prometheus, grafana, gke, aws, azure, slack, github) */
|
|
922
|
+
kind: string;
|
|
923
|
+
/** @description Additional connection metadata */
|
|
924
|
+
metadata?: { [key: string]: unknown };
|
|
925
|
+
/**
|
|
926
|
+
* @description Connection Status
|
|
927
|
+
* @enum {string}
|
|
928
|
+
*/
|
|
929
|
+
status:
|
|
930
|
+
| "discovered"
|
|
931
|
+
| "registered"
|
|
932
|
+
| "connected"
|
|
933
|
+
| "ignored"
|
|
934
|
+
| "maintenance"
|
|
935
|
+
| "disconnected"
|
|
936
|
+
| "deleted"
|
|
937
|
+
| "not found";
|
|
938
|
+
/**
|
|
939
|
+
* Format: uuid
|
|
940
|
+
* @description User ID who owns this connection
|
|
941
|
+
*/
|
|
942
|
+
userId?: string;
|
|
943
|
+
/**
|
|
944
|
+
* Format: date-time
|
|
945
|
+
* @description Timestamp when the connection was created.
|
|
946
|
+
*/
|
|
947
|
+
createdAt?: string;
|
|
948
|
+
/**
|
|
949
|
+
* Format: date-time
|
|
950
|
+
* @description Timestamp when the connection was last updated.
|
|
951
|
+
*/
|
|
952
|
+
updatedAt?: string;
|
|
953
|
+
/**
|
|
954
|
+
* Format: date-time
|
|
955
|
+
* @description Timestamp when the connection was soft-deleted, if applicable.
|
|
956
|
+
*/
|
|
957
|
+
deletedAt?: string;
|
|
958
|
+
/** @description Associated environments for this connection */
|
|
959
|
+
environments?: {
|
|
960
|
+
/**
|
|
961
|
+
* Format: uuid
|
|
962
|
+
* @description ID
|
|
963
|
+
*/
|
|
964
|
+
id: string;
|
|
965
|
+
/**
|
|
966
|
+
* @description Specifies the version of the schema to which the environment conforms.
|
|
967
|
+
* @default environments.meshery.io/v1beta3
|
|
968
|
+
* @example [
|
|
969
|
+
* "v1",
|
|
970
|
+
* "v1alpha1",
|
|
971
|
+
* "v2beta3",
|
|
972
|
+
* "v1.custom-suffix",
|
|
973
|
+
* "models.meshery.io/v1beta1",
|
|
974
|
+
* "capability.meshery.io/v1alpha1"
|
|
975
|
+
* ]
|
|
976
|
+
*/
|
|
977
|
+
schemaVersion: string;
|
|
978
|
+
/** @description Environment name */
|
|
979
|
+
name: string;
|
|
980
|
+
/** @description Environment description */
|
|
981
|
+
description: string;
|
|
982
|
+
/**
|
|
983
|
+
* Format: uuid
|
|
984
|
+
* @description Environment organization ID
|
|
985
|
+
*/
|
|
986
|
+
organizationId: string;
|
|
987
|
+
/**
|
|
988
|
+
* Format: uuid
|
|
989
|
+
* @description Environment owner
|
|
990
|
+
*/
|
|
991
|
+
owner?: string;
|
|
992
|
+
/**
|
|
993
|
+
* Format: date-time
|
|
994
|
+
* @description Timestamp when the environment was created.
|
|
995
|
+
*/
|
|
996
|
+
createdAt?: string;
|
|
997
|
+
/** @description Additional metadata associated with the environment. */
|
|
998
|
+
metadata?: { [key: string]: unknown };
|
|
999
|
+
/**
|
|
1000
|
+
* Format: date-time
|
|
1001
|
+
* @description Timestamp when the environment was last updated.
|
|
1002
|
+
*/
|
|
1003
|
+
updatedAt?: string;
|
|
1004
|
+
/**
|
|
1005
|
+
* Format: date-time
|
|
1006
|
+
* @description Timestamp when the environment was soft deleted. Null while the environment remains active.
|
|
1007
|
+
*/
|
|
1008
|
+
deletedAt?: string | null;
|
|
1009
|
+
}[];
|
|
1010
|
+
/**
|
|
1011
|
+
* @description Specifies the version of the schema used for the definition.
|
|
1012
|
+
* @default connections.meshery.io/v1beta3
|
|
1013
|
+
* @example [
|
|
1014
|
+
* "v1",
|
|
1015
|
+
* "v1alpha1",
|
|
1016
|
+
* "v2beta3",
|
|
1017
|
+
* "v1.custom-suffix",
|
|
1018
|
+
* "models.meshery.io/v1beta1",
|
|
1019
|
+
* "capability.meshery.io/v1alpha1"
|
|
1020
|
+
* ]
|
|
1021
|
+
*/
|
|
1022
|
+
schemaVersion: string;
|
|
1023
|
+
};
|
|
1024
|
+
};
|
|
1025
|
+
};
|
|
1026
|
+
/** Expired JWT token used or insufficient privilege */
|
|
1027
|
+
401: {
|
|
1028
|
+
content: {
|
|
1029
|
+
"text/plain": string;
|
|
1030
|
+
};
|
|
1031
|
+
};
|
|
1032
|
+
/** Result not found */
|
|
1033
|
+
404: {
|
|
1034
|
+
content: {
|
|
1035
|
+
"text/plain": string;
|
|
1036
|
+
};
|
|
1037
|
+
};
|
|
1038
|
+
/** Internal server error */
|
|
1039
|
+
500: {
|
|
1040
|
+
content: {
|
|
1041
|
+
"text/plain": string;
|
|
1042
|
+
};
|
|
1043
|
+
};
|
|
1044
|
+
};
|
|
1045
|
+
};
|
|
1046
|
+
/** Update an existing connection */
|
|
1047
|
+
updateConnection: {
|
|
1048
|
+
parameters: {
|
|
1049
|
+
path: {
|
|
1050
|
+
/** Connection ID */
|
|
1051
|
+
connectionId: string;
|
|
1052
|
+
};
|
|
1053
|
+
};
|
|
1054
|
+
responses: {
|
|
1055
|
+
/** Connection updated */
|
|
1056
|
+
200: {
|
|
1057
|
+
content: {
|
|
1058
|
+
"application/json": {
|
|
1059
|
+
/**
|
|
1060
|
+
* Format: uuid
|
|
1061
|
+
* @description Connection ID
|
|
1062
|
+
*/
|
|
1063
|
+
id: string;
|
|
1064
|
+
/** @description Connection Name */
|
|
1065
|
+
name: string;
|
|
1066
|
+
/** @description Human-readable description of the connection and its purpose. */
|
|
1067
|
+
description?: string;
|
|
1068
|
+
/**
|
|
1069
|
+
* Format: uri
|
|
1070
|
+
* @description URL of the remote resource this connection points to (e.g. the Helm repository URL, the Kubernetes API server endpoint, the Grafana instance URL).
|
|
1071
|
+
*/
|
|
1072
|
+
url?: string;
|
|
1073
|
+
/**
|
|
1074
|
+
* Format: uuid
|
|
1075
|
+
* @description Associated Credential ID
|
|
1076
|
+
*/
|
|
1077
|
+
credentialId?: string;
|
|
1078
|
+
/** @description Connection Type (platform, telemetry, collaboration) */
|
|
1079
|
+
type: string;
|
|
1080
|
+
/** @description Connection Subtype (cloud, identity, metrics, chat, git, orchestration) */
|
|
1081
|
+
subType: string;
|
|
1082
|
+
/** @description Connection Kind (meshery, kubernetes, prometheus, grafana, gke, aws, azure, slack, github) */
|
|
1083
|
+
kind: string;
|
|
1084
|
+
/** @description Additional connection metadata */
|
|
1085
|
+
metadata?: { [key: string]: unknown };
|
|
1086
|
+
/**
|
|
1087
|
+
* @description Connection Status
|
|
1088
|
+
* @enum {string}
|
|
1089
|
+
*/
|
|
1090
|
+
status:
|
|
1091
|
+
| "discovered"
|
|
1092
|
+
| "registered"
|
|
1093
|
+
| "connected"
|
|
1094
|
+
| "ignored"
|
|
1095
|
+
| "maintenance"
|
|
1096
|
+
| "disconnected"
|
|
1097
|
+
| "deleted"
|
|
1098
|
+
| "not found";
|
|
1099
|
+
/**
|
|
1100
|
+
* Format: uuid
|
|
1101
|
+
* @description User ID who owns this connection
|
|
1102
|
+
*/
|
|
1103
|
+
userId?: string;
|
|
1104
|
+
/**
|
|
1105
|
+
* Format: date-time
|
|
1106
|
+
* @description Timestamp when the connection was created.
|
|
1107
|
+
*/
|
|
1108
|
+
createdAt?: string;
|
|
1109
|
+
/**
|
|
1110
|
+
* Format: date-time
|
|
1111
|
+
* @description Timestamp when the connection was last updated.
|
|
1112
|
+
*/
|
|
1113
|
+
updatedAt?: string;
|
|
1114
|
+
/**
|
|
1115
|
+
* Format: date-time
|
|
1116
|
+
* @description Timestamp when the connection was soft-deleted, if applicable.
|
|
1117
|
+
*/
|
|
1118
|
+
deletedAt?: string;
|
|
1119
|
+
/** @description Associated environments for this connection */
|
|
1120
|
+
environments?: {
|
|
1121
|
+
/**
|
|
1122
|
+
* Format: uuid
|
|
1123
|
+
* @description ID
|
|
1124
|
+
*/
|
|
1125
|
+
id: string;
|
|
1126
|
+
/**
|
|
1127
|
+
* @description Specifies the version of the schema to which the environment conforms.
|
|
1128
|
+
* @default environments.meshery.io/v1beta3
|
|
1129
|
+
* @example [
|
|
1130
|
+
* "v1",
|
|
1131
|
+
* "v1alpha1",
|
|
1132
|
+
* "v2beta3",
|
|
1133
|
+
* "v1.custom-suffix",
|
|
1134
|
+
* "models.meshery.io/v1beta1",
|
|
1135
|
+
* "capability.meshery.io/v1alpha1"
|
|
1136
|
+
* ]
|
|
1137
|
+
*/
|
|
1138
|
+
schemaVersion: string;
|
|
1139
|
+
/** @description Environment name */
|
|
1140
|
+
name: string;
|
|
1141
|
+
/** @description Environment description */
|
|
1142
|
+
description: string;
|
|
1143
|
+
/**
|
|
1144
|
+
* Format: uuid
|
|
1145
|
+
* @description Environment organization ID
|
|
1146
|
+
*/
|
|
1147
|
+
organizationId: string;
|
|
1148
|
+
/**
|
|
1149
|
+
* Format: uuid
|
|
1150
|
+
* @description Environment owner
|
|
1151
|
+
*/
|
|
1152
|
+
owner?: string;
|
|
1153
|
+
/**
|
|
1154
|
+
* Format: date-time
|
|
1155
|
+
* @description Timestamp when the environment was created.
|
|
1156
|
+
*/
|
|
1157
|
+
createdAt?: string;
|
|
1158
|
+
/** @description Additional metadata associated with the environment. */
|
|
1159
|
+
metadata?: { [key: string]: unknown };
|
|
1160
|
+
/**
|
|
1161
|
+
* Format: date-time
|
|
1162
|
+
* @description Timestamp when the environment was last updated.
|
|
1163
|
+
*/
|
|
1164
|
+
updatedAt?: string;
|
|
1165
|
+
/**
|
|
1166
|
+
* Format: date-time
|
|
1167
|
+
* @description Timestamp when the environment was soft deleted. Null while the environment remains active.
|
|
1168
|
+
*/
|
|
1169
|
+
deletedAt?: string | null;
|
|
1170
|
+
}[];
|
|
1171
|
+
/**
|
|
1172
|
+
* @description Specifies the version of the schema used for the definition.
|
|
1173
|
+
* @default connections.meshery.io/v1beta3
|
|
1174
|
+
* @example [
|
|
1175
|
+
* "v1",
|
|
1176
|
+
* "v1alpha1",
|
|
1177
|
+
* "v2beta3",
|
|
1178
|
+
* "v1.custom-suffix",
|
|
1179
|
+
* "models.meshery.io/v1beta1",
|
|
1180
|
+
* "capability.meshery.io/v1alpha1"
|
|
1181
|
+
* ]
|
|
1182
|
+
*/
|
|
1183
|
+
schemaVersion: string;
|
|
1184
|
+
};
|
|
1185
|
+
};
|
|
1186
|
+
};
|
|
1187
|
+
/** Invalid request body or request param */
|
|
1188
|
+
400: {
|
|
1189
|
+
content: {
|
|
1190
|
+
"text/plain": string;
|
|
1191
|
+
};
|
|
1192
|
+
};
|
|
1193
|
+
/** Expired JWT token used or insufficient privilege */
|
|
1194
|
+
401: {
|
|
1195
|
+
content: {
|
|
1196
|
+
"text/plain": string;
|
|
1197
|
+
};
|
|
1198
|
+
};
|
|
1199
|
+
/** Result not found */
|
|
1200
|
+
404: {
|
|
1201
|
+
content: {
|
|
1202
|
+
"text/plain": string;
|
|
1203
|
+
};
|
|
1204
|
+
};
|
|
1205
|
+
/** Internal server error */
|
|
1206
|
+
500: {
|
|
1207
|
+
content: {
|
|
1208
|
+
"text/plain": string;
|
|
1209
|
+
};
|
|
1210
|
+
};
|
|
1211
|
+
};
|
|
1212
|
+
requestBody: {
|
|
1213
|
+
content: {
|
|
1214
|
+
"application/json": {
|
|
1215
|
+
/**
|
|
1216
|
+
* Format: uuid
|
|
1217
|
+
* @description Connection ID
|
|
1218
|
+
*/
|
|
1219
|
+
id?: string;
|
|
1220
|
+
/** @description Connection name */
|
|
1221
|
+
name: string;
|
|
1222
|
+
/** @description Connection kind */
|
|
1223
|
+
kind: string;
|
|
1224
|
+
/** @description Connection type */
|
|
1225
|
+
type: string;
|
|
1226
|
+
/** @description Connection sub-type */
|
|
1227
|
+
subType: string;
|
|
1228
|
+
/** @description Credential secret data */
|
|
1229
|
+
credentialSecret?: { [key: string]: unknown };
|
|
1230
|
+
/** @description Connection metadata */
|
|
1231
|
+
metadata?: { [key: string]: unknown };
|
|
1232
|
+
/** @description Connection status */
|
|
1233
|
+
status: string;
|
|
1234
|
+
/**
|
|
1235
|
+
* Format: uuid
|
|
1236
|
+
* @description Associated credential ID
|
|
1237
|
+
*/
|
|
1238
|
+
credentialId?: string;
|
|
1239
|
+
};
|
|
1240
|
+
};
|
|
1241
|
+
};
|
|
1242
|
+
};
|
|
1243
|
+
/** Delete a specific connection */
|
|
1244
|
+
deleteConnection: {
|
|
1245
|
+
parameters: {
|
|
1246
|
+
path: {
|
|
1247
|
+
/** Connection ID */
|
|
1248
|
+
connectionId: string;
|
|
1249
|
+
};
|
|
1250
|
+
};
|
|
1251
|
+
responses: {
|
|
1252
|
+
/** Connection deleted */
|
|
1253
|
+
204: never;
|
|
1254
|
+
/** Expired JWT token used or insufficient privilege */
|
|
1255
|
+
401: {
|
|
1256
|
+
content: {
|
|
1257
|
+
"text/plain": string;
|
|
1258
|
+
};
|
|
1259
|
+
};
|
|
1260
|
+
/** Result not found */
|
|
1261
|
+
404: {
|
|
1262
|
+
content: {
|
|
1263
|
+
"text/plain": string;
|
|
1264
|
+
};
|
|
1265
|
+
};
|
|
1266
|
+
/** Internal server error */
|
|
1267
|
+
500: {
|
|
1268
|
+
content: {
|
|
1269
|
+
"text/plain": string;
|
|
1270
|
+
};
|
|
1271
|
+
};
|
|
1272
|
+
};
|
|
1273
|
+
};
|
|
1274
|
+
/** Delete a Meshery server connection by server ID */
|
|
1275
|
+
deleteMesheryConnection: {
|
|
1276
|
+
parameters: {
|
|
1277
|
+
path: {
|
|
1278
|
+
/** Meshery server ID */
|
|
1279
|
+
mesheryServerId: string;
|
|
1280
|
+
};
|
|
1281
|
+
};
|
|
1282
|
+
responses: {
|
|
1283
|
+
/** Meshery connection deleted */
|
|
1284
|
+
204: never;
|
|
1285
|
+
/** Expired JWT token used or insufficient privilege */
|
|
1286
|
+
401: {
|
|
1287
|
+
content: {
|
|
1288
|
+
"text/plain": string;
|
|
1289
|
+
};
|
|
1290
|
+
};
|
|
1291
|
+
/** Result not found */
|
|
1292
|
+
404: {
|
|
1293
|
+
content: {
|
|
1294
|
+
"text/plain": string;
|
|
1295
|
+
};
|
|
1296
|
+
};
|
|
1297
|
+
/** Internal server error */
|
|
1298
|
+
500: {
|
|
1299
|
+
content: {
|
|
1300
|
+
"text/plain": string;
|
|
1301
|
+
};
|
|
1302
|
+
};
|
|
1303
|
+
};
|
|
1304
|
+
};
|
|
1305
|
+
/** Get Kubernetes context for a specific connection */
|
|
1306
|
+
getKubernetesContext: {
|
|
1307
|
+
parameters: {
|
|
1308
|
+
path: {
|
|
1309
|
+
/** Connection ID */
|
|
1310
|
+
connectionId: string;
|
|
1311
|
+
};
|
|
1312
|
+
};
|
|
1313
|
+
responses: {
|
|
1314
|
+
/** Kubernetes context */
|
|
1315
|
+
200: {
|
|
1316
|
+
content: {
|
|
1317
|
+
"application/json": { [key: string]: unknown };
|
|
1318
|
+
};
|
|
1319
|
+
};
|
|
1320
|
+
/** Expired JWT token used or insufficient privilege */
|
|
1321
|
+
401: {
|
|
1322
|
+
content: {
|
|
1323
|
+
"text/plain": string;
|
|
1324
|
+
};
|
|
1325
|
+
};
|
|
1326
|
+
/** Result not found */
|
|
1327
|
+
404: {
|
|
1328
|
+
content: {
|
|
1329
|
+
"text/plain": string;
|
|
1330
|
+
};
|
|
1331
|
+
};
|
|
1332
|
+
/** Internal server error */
|
|
1333
|
+
500: {
|
|
1334
|
+
content: {
|
|
1335
|
+
"text/plain": string;
|
|
1336
|
+
};
|
|
1337
|
+
};
|
|
1338
|
+
};
|
|
1339
|
+
};
|
|
1340
|
+
/** Associate a connection with an environment */
|
|
1341
|
+
addConnectionToEnvironment: {
|
|
1342
|
+
parameters: {
|
|
1343
|
+
path: {
|
|
1344
|
+
/** Environment ID */
|
|
1345
|
+
environmentId: string;
|
|
1346
|
+
/** Connection ID */
|
|
1347
|
+
connectionId: string;
|
|
1348
|
+
};
|
|
1349
|
+
};
|
|
1350
|
+
responses: {
|
|
1351
|
+
/** Connection added to environment */
|
|
1352
|
+
201: unknown;
|
|
1353
|
+
/** Invalid request body or request param */
|
|
1354
|
+
400: {
|
|
1355
|
+
content: {
|
|
1356
|
+
"text/plain": string;
|
|
1357
|
+
};
|
|
1358
|
+
};
|
|
1359
|
+
/** Expired JWT token used or insufficient privilege */
|
|
1360
|
+
401: {
|
|
1361
|
+
content: {
|
|
1362
|
+
"text/plain": string;
|
|
1363
|
+
};
|
|
1364
|
+
};
|
|
1365
|
+
/** Result not found */
|
|
1366
|
+
404: {
|
|
1367
|
+
content: {
|
|
1368
|
+
"text/plain": string;
|
|
1369
|
+
};
|
|
1370
|
+
};
|
|
1371
|
+
/** Internal server error */
|
|
1372
|
+
500: {
|
|
1373
|
+
content: {
|
|
1374
|
+
"text/plain": string;
|
|
1375
|
+
};
|
|
1376
|
+
};
|
|
1377
|
+
};
|
|
1378
|
+
};
|
|
1379
|
+
/** Disassociate a connection from an environment */
|
|
1380
|
+
removeConnectionFromEnvironment: {
|
|
1381
|
+
parameters: {
|
|
1382
|
+
path: {
|
|
1383
|
+
/** Environment ID */
|
|
1384
|
+
environmentId: string;
|
|
1385
|
+
/** Connection ID */
|
|
1386
|
+
connectionId: string;
|
|
1387
|
+
};
|
|
1388
|
+
};
|
|
1389
|
+
responses: {
|
|
1390
|
+
/** Connection removed from environment */
|
|
1391
|
+
204: never;
|
|
1392
|
+
/** Expired JWT token used or insufficient privilege */
|
|
1393
|
+
401: {
|
|
1394
|
+
content: {
|
|
1395
|
+
"text/plain": string;
|
|
1396
|
+
};
|
|
1397
|
+
};
|
|
1398
|
+
/** Result not found */
|
|
1399
|
+
404: {
|
|
1400
|
+
content: {
|
|
1401
|
+
"text/plain": string;
|
|
1402
|
+
};
|
|
1403
|
+
};
|
|
1404
|
+
/** Internal server error */
|
|
1405
|
+
500: {
|
|
1406
|
+
content: {
|
|
1407
|
+
"text/plain": string;
|
|
1408
|
+
};
|
|
1409
|
+
};
|
|
1410
|
+
};
|
|
1411
|
+
};
|
|
1412
|
+
}
|
|
1413
|
+
|
|
1414
|
+
export interface external {}
|