@meshery/schemas 1.3.60 → 1.3.61
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/README.md +9 -1
- package/dist/cloudApi.d.mts +19648 -6714
- package/dist/cloudApi.d.ts +19648 -6714
- package/dist/cloudApi.js +1 -1
- package/dist/cloudApi.mjs +1 -1
- package/dist/constructs/v1beta1/organization_smtp/OrganizationSmtp.d.ts +2 -2
- package/dist/constructs/v1beta1/organization_smtp/OrganizationSmtpSchema.js +1 -1
- package/dist/constructs/v1beta1/organization_smtp/OrganizationSmtpSchema.mjs +1 -1
- package/dist/constructs/v1beta1/registry/Registry.d.ts +6 -6
- package/dist/constructs/v1beta1/registry/RegistrySchema.js +3 -3
- package/dist/constructs/v1beta1/registry/RegistrySchema.mjs +3 -3
- package/dist/constructs/v1beta3/blowhorn_binding/BlowhornBinding.d.ts +462 -0
- package/dist/constructs/v1beta3/blowhorn_binding/BlowhornBinding.js +1 -0
- package/dist/constructs/v1beta3/blowhorn_binding/BlowhornBinding.mjs +0 -0
- package/dist/constructs/v1beta3/blowhorn_binding/BlowhornBindingSchema.d.ts +2 -0
- package/dist/constructs/v1beta3/blowhorn_binding/BlowhornBindingSchema.js +23 -0
- package/dist/constructs/v1beta3/blowhorn_binding/BlowhornBindingSchema.mjs +23 -0
- package/dist/constructs/v1beta3/blowhorn_content/BlowhornContent.d.ts +719 -0
- package/dist/constructs/v1beta3/blowhorn_content/BlowhornContent.js +1 -0
- package/dist/constructs/v1beta3/blowhorn_content/BlowhornContent.mjs +0 -0
- package/dist/constructs/v1beta3/blowhorn_content/BlowhornContentSchema.d.ts +2 -0
- package/dist/constructs/v1beta3/blowhorn_content/BlowhornContentSchema.js +43 -0
- package/dist/constructs/v1beta3/blowhorn_content/BlowhornContentSchema.mjs +43 -0
- package/dist/constructs/v1beta3/blowhorn_destination/BlowhornDestination.d.ts +516 -0
- package/dist/constructs/v1beta3/blowhorn_destination/BlowhornDestination.js +1 -0
- package/dist/constructs/v1beta3/blowhorn_destination/BlowhornDestination.mjs +0 -0
- package/dist/constructs/v1beta3/blowhorn_destination/BlowhornDestinationSchema.d.ts +2 -0
- package/dist/constructs/v1beta3/blowhorn_destination/BlowhornDestinationSchema.js +23 -0
- package/dist/constructs/v1beta3/blowhorn_destination/BlowhornDestinationSchema.mjs +23 -0
- package/dist/constructs/v1beta3/blowhorn_health/BlowhornHealth.d.ts +131 -0
- package/dist/constructs/v1beta3/blowhorn_health/BlowhornHealth.js +1 -0
- package/dist/constructs/v1beta3/blowhorn_health/BlowhornHealth.mjs +0 -0
- package/dist/constructs/v1beta3/blowhorn_health/BlowhornHealthSchema.d.ts +2 -0
- package/dist/constructs/v1beta3/blowhorn_health/BlowhornHealthSchema.js +7 -0
- package/dist/constructs/v1beta3/blowhorn_health/BlowhornHealthSchema.mjs +7 -0
- package/dist/constructs/v1beta3/blowhorn_ledger/BlowhornLedger.d.ts +1546 -0
- package/dist/constructs/v1beta3/blowhorn_ledger/BlowhornLedger.js +1 -0
- package/dist/constructs/v1beta3/blowhorn_ledger/BlowhornLedger.mjs +0 -0
- package/dist/constructs/v1beta3/blowhorn_ledger/BlowhornLedgerSchema.d.ts +2 -0
- package/dist/constructs/v1beta3/blowhorn_ledger/BlowhornLedgerSchema.js +69 -0
- package/dist/constructs/v1beta3/blowhorn_ledger/BlowhornLedgerSchema.mjs +69 -0
- package/dist/constructs/v1beta3/blowhorn_profile/BlowhornProfile.d.ts +776 -0
- package/dist/constructs/v1beta3/blowhorn_profile/BlowhornProfile.js +1 -0
- package/dist/constructs/v1beta3/blowhorn_profile/BlowhornProfile.mjs +0 -0
- package/dist/constructs/v1beta3/blowhorn_profile/BlowhornProfileSchema.d.ts +2 -0
- package/dist/constructs/v1beta3/blowhorn_profile/BlowhornProfileSchema.js +45 -0
- package/dist/constructs/v1beta3/blowhorn_profile/BlowhornProfileSchema.mjs +45 -0
- package/dist/constructs/v1beta3/blowhorn_run/BlowhornRun.d.ts +784 -0
- package/dist/constructs/v1beta3/blowhorn_run/BlowhornRun.js +1 -0
- package/dist/constructs/v1beta3/blowhorn_run/BlowhornRun.mjs +0 -0
- package/dist/constructs/v1beta3/blowhorn_run/BlowhornRunSchema.d.ts +2 -0
- package/dist/constructs/v1beta3/blowhorn_run/BlowhornRunSchema.js +51 -0
- package/dist/constructs/v1beta3/blowhorn_run/BlowhornRunSchema.mjs +51 -0
- package/dist/constructs/v1beta3/connection/Connection.d.ts +14 -14
- package/dist/constructs/v1beta3/connection/ConnectionSchema.js +1 -1
- package/dist/constructs/v1beta3/connection/ConnectionSchema.mjs +1 -1
- package/dist/constructs/v1beta3/environment/Environment.d.ts +12 -12
- package/dist/constructs/v1beta3/environment/EnvironmentSchema.js +1 -1
- package/dist/constructs/v1beta3/environment/EnvironmentSchema.mjs +1 -1
- package/dist/constructs/v1beta3/job_lease/JobLease.d.ts +2570 -0
- package/dist/constructs/v1beta3/job_lease/JobLease.js +1 -0
- package/dist/constructs/v1beta3/job_lease/JobLease.mjs +0 -0
- package/dist/constructs/v1beta3/job_lease/JobLeaseSchema.d.ts +2 -0
- package/dist/constructs/v1beta3/job_lease/JobLeaseSchema.js +83 -0
- package/dist/constructs/v1beta3/job_lease/JobLeaseSchema.mjs +83 -0
- package/dist/constructs/v1beta3/token/Token.d.ts +4 -2
- package/dist/constructs/v1beta3/token/TokenSchema.js +1 -1
- package/dist/constructs/v1beta3/token/TokenSchema.mjs +1 -1
- package/dist/constructs/v1beta3/workspace/Workspace.d.ts +2 -2
- package/dist/constructs/v1beta3/workspace/WorkspaceSchema.js +1 -1
- package/dist/constructs/v1beta3/workspace/WorkspaceSchema.mjs +1 -1
- package/dist/mesheryApi.d.mts +24 -24
- package/dist/mesheryApi.d.ts +24 -24
- package/dist/mesheryApi.js +1 -1
- package/dist/mesheryApi.mjs +1 -1
- package/dist/permissions.d.mts +211 -1
- package/dist/permissions.d.ts +211 -1
- package/dist/permissions.js +1 -1
- package/dist/permissions.mjs +1 -1
- package/package.json +2 -1
|
@@ -0,0 +1,462 @@
|
|
|
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/blowhorn/bindings": {
|
|
8
|
+
parameters: {
|
|
9
|
+
query?: never;
|
|
10
|
+
header?: never;
|
|
11
|
+
path?: never;
|
|
12
|
+
cookie?: never;
|
|
13
|
+
};
|
|
14
|
+
/**
|
|
15
|
+
* List Blowhorn bindings
|
|
16
|
+
* @description Returns a paginated list of Blowhorn bindings in the organization of the authenticated session, optionally filtered by profile or host.
|
|
17
|
+
*/
|
|
18
|
+
get: operations["listBlowhornBindings"];
|
|
19
|
+
put?: never;
|
|
20
|
+
/**
|
|
21
|
+
* Bind Blowhorn profile to host
|
|
22
|
+
* @description Binds a profile to a directory on a host, creating the binding or
|
|
23
|
+
* refreshing the entry for the (profile, host) pair. Binding the
|
|
24
|
+
* same profile to a different directory on the same host is refused
|
|
25
|
+
* with a 409.
|
|
26
|
+
*/
|
|
27
|
+
post: operations["bindBlowhornBinding"];
|
|
28
|
+
delete?: never;
|
|
29
|
+
options?: never;
|
|
30
|
+
head?: never;
|
|
31
|
+
patch?: never;
|
|
32
|
+
trace?: never;
|
|
33
|
+
};
|
|
34
|
+
"/api/blowhorn/bindings/{blowhornBindingId}": {
|
|
35
|
+
parameters: {
|
|
36
|
+
query?: never;
|
|
37
|
+
header?: never;
|
|
38
|
+
path?: never;
|
|
39
|
+
cookie?: never;
|
|
40
|
+
};
|
|
41
|
+
get?: never;
|
|
42
|
+
put?: never;
|
|
43
|
+
post?: never;
|
|
44
|
+
/**
|
|
45
|
+
* Unbind Blowhorn profile from host
|
|
46
|
+
* @description Removes the binding for the (profile, host) pair.
|
|
47
|
+
*/
|
|
48
|
+
delete: operations["unbindBlowhornBinding"];
|
|
49
|
+
options?: never;
|
|
50
|
+
head?: never;
|
|
51
|
+
patch?: never;
|
|
52
|
+
trace?: never;
|
|
53
|
+
};
|
|
54
|
+
}
|
|
55
|
+
export type webhooks = Record<string, never>;
|
|
56
|
+
export interface components {
|
|
57
|
+
schemas: {
|
|
58
|
+
/**
|
|
59
|
+
* Blowhorn Binding Schema
|
|
60
|
+
* @description Server-returned Blowhorn binding as persisted by meshery-cloud. A binding
|
|
61
|
+
* maps a profile to a directory on a host, keyed by the (profile, host)
|
|
62
|
+
* pair, and doubles as the device and seat record. Binding the same profile
|
|
63
|
+
* to a different directory on the same host is a conflict.
|
|
64
|
+
*/
|
|
65
|
+
BlowhornBinding: {
|
|
66
|
+
/**
|
|
67
|
+
* Format: uuid
|
|
68
|
+
* @description Server-generated Blowhorn binding ID.
|
|
69
|
+
*/
|
|
70
|
+
id: string;
|
|
71
|
+
/**
|
|
72
|
+
* Format: uuid
|
|
73
|
+
* @description Owning organization ID. Derived from the authenticated session, never client-settable.
|
|
74
|
+
*/
|
|
75
|
+
organizationId: string;
|
|
76
|
+
/** @description Subject of the bound Blowhorn profile. */
|
|
77
|
+
profile: string;
|
|
78
|
+
/** @description Host the profile is bound on. An identity, not a permission. */
|
|
79
|
+
host: string;
|
|
80
|
+
/** @description Profile directory on the host. */
|
|
81
|
+
directory: string;
|
|
82
|
+
/**
|
|
83
|
+
* Format: date-time
|
|
84
|
+
* @description Timestamp of Blowhorn binding creation.
|
|
85
|
+
*/
|
|
86
|
+
createdAt: string;
|
|
87
|
+
/**
|
|
88
|
+
* Format: date-time
|
|
89
|
+
* @description Timestamp of last Blowhorn binding modification.
|
|
90
|
+
*/
|
|
91
|
+
updatedAt: string;
|
|
92
|
+
};
|
|
93
|
+
/**
|
|
94
|
+
* @description Payload for binding a profile to a host. Contains only
|
|
95
|
+
* client-settable fields; the owning `organizationId` (derived
|
|
96
|
+
* from the authenticated session) and the server-generated
|
|
97
|
+
* `createdAt` / `updatedAt` timestamps are intentionally excluded.
|
|
98
|
+
*/
|
|
99
|
+
BlowhornBindingPayload: {
|
|
100
|
+
/**
|
|
101
|
+
* Format: uuid
|
|
102
|
+
* @description Existing Blowhorn binding ID for updates; omit on bind.
|
|
103
|
+
*/
|
|
104
|
+
id?: string;
|
|
105
|
+
/** @description Subject of the Blowhorn profile to bind. */
|
|
106
|
+
profile: string;
|
|
107
|
+
/** @description Host the profile is bound on. An identity, not a permission. */
|
|
108
|
+
host: string;
|
|
109
|
+
/** @description Profile directory on the host. */
|
|
110
|
+
directory: string;
|
|
111
|
+
};
|
|
112
|
+
/** @description Paginated collection of Blowhorn bindings. */
|
|
113
|
+
BlowhornBindingPage: {
|
|
114
|
+
/** @description Current page number of the result set. */
|
|
115
|
+
page?: number;
|
|
116
|
+
/** @description Number of items per page. */
|
|
117
|
+
pageSize?: number;
|
|
118
|
+
/** @description Total number of items available. */
|
|
119
|
+
totalCount?: number;
|
|
120
|
+
/** @description Blowhorn bindings included on this page of results. */
|
|
121
|
+
blowhornBindings?: {
|
|
122
|
+
/**
|
|
123
|
+
* Format: uuid
|
|
124
|
+
* @description Server-generated Blowhorn binding ID.
|
|
125
|
+
*/
|
|
126
|
+
id: string;
|
|
127
|
+
/**
|
|
128
|
+
* Format: uuid
|
|
129
|
+
* @description Owning organization ID. Derived from the authenticated session, never client-settable.
|
|
130
|
+
*/
|
|
131
|
+
organizationId: string;
|
|
132
|
+
/** @description Subject of the bound Blowhorn profile. */
|
|
133
|
+
profile: string;
|
|
134
|
+
/** @description Host the profile is bound on. An identity, not a permission. */
|
|
135
|
+
host: string;
|
|
136
|
+
/** @description Profile directory on the host. */
|
|
137
|
+
directory: string;
|
|
138
|
+
/**
|
|
139
|
+
* Format: date-time
|
|
140
|
+
* @description Timestamp of Blowhorn binding creation.
|
|
141
|
+
*/
|
|
142
|
+
createdAt: string;
|
|
143
|
+
/**
|
|
144
|
+
* Format: date-time
|
|
145
|
+
* @description Timestamp of last Blowhorn binding modification.
|
|
146
|
+
*/
|
|
147
|
+
updatedAt: string;
|
|
148
|
+
}[];
|
|
149
|
+
};
|
|
150
|
+
};
|
|
151
|
+
responses: {
|
|
152
|
+
/** @description Invalid request body or request param */
|
|
153
|
+
400: {
|
|
154
|
+
headers: {
|
|
155
|
+
[name: string]: unknown;
|
|
156
|
+
};
|
|
157
|
+
content: {
|
|
158
|
+
"text/plain": string;
|
|
159
|
+
};
|
|
160
|
+
};
|
|
161
|
+
/** @description Expired JWT token used or insufficient privilege */
|
|
162
|
+
401: {
|
|
163
|
+
headers: {
|
|
164
|
+
[name: string]: unknown;
|
|
165
|
+
};
|
|
166
|
+
content: {
|
|
167
|
+
"text/plain": string;
|
|
168
|
+
};
|
|
169
|
+
};
|
|
170
|
+
/** @description Result not found */
|
|
171
|
+
404: {
|
|
172
|
+
headers: {
|
|
173
|
+
[name: string]: unknown;
|
|
174
|
+
};
|
|
175
|
+
content: {
|
|
176
|
+
"text/plain": string;
|
|
177
|
+
};
|
|
178
|
+
};
|
|
179
|
+
/** @description Conflict - the profile is already bound to a different directory on this host */
|
|
180
|
+
409: {
|
|
181
|
+
headers: {
|
|
182
|
+
[name: string]: unknown;
|
|
183
|
+
};
|
|
184
|
+
content: {
|
|
185
|
+
"text/plain": string;
|
|
186
|
+
};
|
|
187
|
+
};
|
|
188
|
+
/** @description Internal server error */
|
|
189
|
+
500: {
|
|
190
|
+
headers: {
|
|
191
|
+
[name: string]: unknown;
|
|
192
|
+
};
|
|
193
|
+
content: {
|
|
194
|
+
"text/plain": string;
|
|
195
|
+
};
|
|
196
|
+
};
|
|
197
|
+
};
|
|
198
|
+
parameters: {
|
|
199
|
+
/** @description Blowhorn binding ID */
|
|
200
|
+
blowhornBindingId: string;
|
|
201
|
+
/** @description Get responses by page */
|
|
202
|
+
page: number;
|
|
203
|
+
/** @description Number of items per page (canonical camelCase form). */
|
|
204
|
+
pageSize: number;
|
|
205
|
+
/**
|
|
206
|
+
* @deprecated
|
|
207
|
+
* @description Number of items per page. Deprecated alias of pageSize;
|
|
208
|
+
* canonical `pageSize` wins when both are present.
|
|
209
|
+
*/
|
|
210
|
+
pagesize: number;
|
|
211
|
+
/** @description Get responses that match search param value */
|
|
212
|
+
search: string;
|
|
213
|
+
/** @description Get ordered responses */
|
|
214
|
+
order: string;
|
|
215
|
+
};
|
|
216
|
+
requestBodies: never;
|
|
217
|
+
headers: never;
|
|
218
|
+
pathItems: never;
|
|
219
|
+
}
|
|
220
|
+
export type $defs = Record<string, never>;
|
|
221
|
+
export interface operations {
|
|
222
|
+
listBlowhornBindings: {
|
|
223
|
+
parameters: {
|
|
224
|
+
query?: {
|
|
225
|
+
/** @description Get responses by page */
|
|
226
|
+
page?: number;
|
|
227
|
+
/** @description Number of items per page (canonical camelCase form). */
|
|
228
|
+
pageSize?: number;
|
|
229
|
+
/**
|
|
230
|
+
* @deprecated
|
|
231
|
+
* @description Number of items per page. Deprecated alias of pageSize;
|
|
232
|
+
* canonical `pageSize` wins when both are present.
|
|
233
|
+
*/
|
|
234
|
+
pagesize?: number;
|
|
235
|
+
/** @description Get responses that match search param value */
|
|
236
|
+
search?: string;
|
|
237
|
+
/** @description Get ordered responses */
|
|
238
|
+
order?: string;
|
|
239
|
+
/** @description Filter by bound profile subject. */
|
|
240
|
+
profile?: string;
|
|
241
|
+
/** @description Filter by host. */
|
|
242
|
+
host?: string;
|
|
243
|
+
};
|
|
244
|
+
header?: never;
|
|
245
|
+
path?: never;
|
|
246
|
+
cookie?: never;
|
|
247
|
+
};
|
|
248
|
+
requestBody?: never;
|
|
249
|
+
responses: {
|
|
250
|
+
/** @description Blowhorn bindings page */
|
|
251
|
+
200: {
|
|
252
|
+
headers: {
|
|
253
|
+
[name: string]: unknown;
|
|
254
|
+
};
|
|
255
|
+
content: {
|
|
256
|
+
"application/json": {
|
|
257
|
+
/** @description Current page number of the result set. */
|
|
258
|
+
page?: number;
|
|
259
|
+
/** @description Number of items per page. */
|
|
260
|
+
pageSize?: number;
|
|
261
|
+
/** @description Total number of items available. */
|
|
262
|
+
totalCount?: number;
|
|
263
|
+
/** @description Blowhorn bindings included on this page of results. */
|
|
264
|
+
blowhornBindings?: {
|
|
265
|
+
/**
|
|
266
|
+
* Format: uuid
|
|
267
|
+
* @description Server-generated Blowhorn binding ID.
|
|
268
|
+
*/
|
|
269
|
+
id: string;
|
|
270
|
+
/**
|
|
271
|
+
* Format: uuid
|
|
272
|
+
* @description Owning organization ID. Derived from the authenticated session, never client-settable.
|
|
273
|
+
*/
|
|
274
|
+
organizationId: string;
|
|
275
|
+
/** @description Subject of the bound Blowhorn profile. */
|
|
276
|
+
profile: string;
|
|
277
|
+
/** @description Host the profile is bound on. An identity, not a permission. */
|
|
278
|
+
host: string;
|
|
279
|
+
/** @description Profile directory on the host. */
|
|
280
|
+
directory: string;
|
|
281
|
+
/**
|
|
282
|
+
* Format: date-time
|
|
283
|
+
* @description Timestamp of Blowhorn binding creation.
|
|
284
|
+
*/
|
|
285
|
+
createdAt: string;
|
|
286
|
+
/**
|
|
287
|
+
* Format: date-time
|
|
288
|
+
* @description Timestamp of last Blowhorn binding modification.
|
|
289
|
+
*/
|
|
290
|
+
updatedAt: string;
|
|
291
|
+
}[];
|
|
292
|
+
};
|
|
293
|
+
};
|
|
294
|
+
};
|
|
295
|
+
/** @description Expired JWT token used or insufficient privilege */
|
|
296
|
+
401: {
|
|
297
|
+
headers: {
|
|
298
|
+
[name: string]: unknown;
|
|
299
|
+
};
|
|
300
|
+
content: {
|
|
301
|
+
"text/plain": string;
|
|
302
|
+
};
|
|
303
|
+
};
|
|
304
|
+
/** @description Internal server error */
|
|
305
|
+
500: {
|
|
306
|
+
headers: {
|
|
307
|
+
[name: string]: unknown;
|
|
308
|
+
};
|
|
309
|
+
content: {
|
|
310
|
+
"text/plain": string;
|
|
311
|
+
};
|
|
312
|
+
};
|
|
313
|
+
};
|
|
314
|
+
};
|
|
315
|
+
bindBlowhornBinding: {
|
|
316
|
+
parameters: {
|
|
317
|
+
query?: never;
|
|
318
|
+
header?: never;
|
|
319
|
+
path?: never;
|
|
320
|
+
cookie?: never;
|
|
321
|
+
};
|
|
322
|
+
requestBody: {
|
|
323
|
+
content: {
|
|
324
|
+
"application/json": {
|
|
325
|
+
/**
|
|
326
|
+
* Format: uuid
|
|
327
|
+
* @description Existing Blowhorn binding ID for updates; omit on bind.
|
|
328
|
+
*/
|
|
329
|
+
id?: string;
|
|
330
|
+
/** @description Subject of the Blowhorn profile to bind. */
|
|
331
|
+
profile: string;
|
|
332
|
+
/** @description Host the profile is bound on. An identity, not a permission. */
|
|
333
|
+
host: string;
|
|
334
|
+
/** @description Profile directory on the host. */
|
|
335
|
+
directory: string;
|
|
336
|
+
};
|
|
337
|
+
};
|
|
338
|
+
};
|
|
339
|
+
responses: {
|
|
340
|
+
/** @description Blowhorn binding saved */
|
|
341
|
+
200: {
|
|
342
|
+
headers: {
|
|
343
|
+
[name: string]: unknown;
|
|
344
|
+
};
|
|
345
|
+
content: {
|
|
346
|
+
"application/json": {
|
|
347
|
+
/**
|
|
348
|
+
* Format: uuid
|
|
349
|
+
* @description Server-generated Blowhorn binding ID.
|
|
350
|
+
*/
|
|
351
|
+
id: string;
|
|
352
|
+
/**
|
|
353
|
+
* Format: uuid
|
|
354
|
+
* @description Owning organization ID. Derived from the authenticated session, never client-settable.
|
|
355
|
+
*/
|
|
356
|
+
organizationId: string;
|
|
357
|
+
/** @description Subject of the bound Blowhorn profile. */
|
|
358
|
+
profile: string;
|
|
359
|
+
/** @description Host the profile is bound on. An identity, not a permission. */
|
|
360
|
+
host: string;
|
|
361
|
+
/** @description Profile directory on the host. */
|
|
362
|
+
directory: string;
|
|
363
|
+
/**
|
|
364
|
+
* Format: date-time
|
|
365
|
+
* @description Timestamp of Blowhorn binding creation.
|
|
366
|
+
*/
|
|
367
|
+
createdAt: string;
|
|
368
|
+
/**
|
|
369
|
+
* Format: date-time
|
|
370
|
+
* @description Timestamp of last Blowhorn binding modification.
|
|
371
|
+
*/
|
|
372
|
+
updatedAt: string;
|
|
373
|
+
};
|
|
374
|
+
};
|
|
375
|
+
};
|
|
376
|
+
/** @description Invalid request body or request param */
|
|
377
|
+
400: {
|
|
378
|
+
headers: {
|
|
379
|
+
[name: string]: unknown;
|
|
380
|
+
};
|
|
381
|
+
content: {
|
|
382
|
+
"text/plain": string;
|
|
383
|
+
};
|
|
384
|
+
};
|
|
385
|
+
/** @description Expired JWT token used or insufficient privilege */
|
|
386
|
+
401: {
|
|
387
|
+
headers: {
|
|
388
|
+
[name: string]: unknown;
|
|
389
|
+
};
|
|
390
|
+
content: {
|
|
391
|
+
"text/plain": string;
|
|
392
|
+
};
|
|
393
|
+
};
|
|
394
|
+
/** @description Conflict - the profile is already bound to a different directory on this host */
|
|
395
|
+
409: {
|
|
396
|
+
headers: {
|
|
397
|
+
[name: string]: unknown;
|
|
398
|
+
};
|
|
399
|
+
content: {
|
|
400
|
+
"text/plain": string;
|
|
401
|
+
};
|
|
402
|
+
};
|
|
403
|
+
/** @description Internal server error */
|
|
404
|
+
500: {
|
|
405
|
+
headers: {
|
|
406
|
+
[name: string]: unknown;
|
|
407
|
+
};
|
|
408
|
+
content: {
|
|
409
|
+
"text/plain": string;
|
|
410
|
+
};
|
|
411
|
+
};
|
|
412
|
+
};
|
|
413
|
+
};
|
|
414
|
+
unbindBlowhornBinding: {
|
|
415
|
+
parameters: {
|
|
416
|
+
query?: never;
|
|
417
|
+
header?: never;
|
|
418
|
+
path: {
|
|
419
|
+
/** @description Blowhorn binding ID */
|
|
420
|
+
blowhornBindingId: string;
|
|
421
|
+
};
|
|
422
|
+
cookie?: never;
|
|
423
|
+
};
|
|
424
|
+
requestBody?: never;
|
|
425
|
+
responses: {
|
|
426
|
+
/** @description Blowhorn binding removed */
|
|
427
|
+
204: {
|
|
428
|
+
headers: {
|
|
429
|
+
[name: string]: unknown;
|
|
430
|
+
};
|
|
431
|
+
content?: never;
|
|
432
|
+
};
|
|
433
|
+
/** @description Expired JWT token used or insufficient privilege */
|
|
434
|
+
401: {
|
|
435
|
+
headers: {
|
|
436
|
+
[name: string]: unknown;
|
|
437
|
+
};
|
|
438
|
+
content: {
|
|
439
|
+
"text/plain": string;
|
|
440
|
+
};
|
|
441
|
+
};
|
|
442
|
+
/** @description Result not found */
|
|
443
|
+
404: {
|
|
444
|
+
headers: {
|
|
445
|
+
[name: string]: unknown;
|
|
446
|
+
};
|
|
447
|
+
content: {
|
|
448
|
+
"text/plain": string;
|
|
449
|
+
};
|
|
450
|
+
};
|
|
451
|
+
/** @description Internal server error */
|
|
452
|
+
500: {
|
|
453
|
+
headers: {
|
|
454
|
+
[name: string]: unknown;
|
|
455
|
+
};
|
|
456
|
+
content: {
|
|
457
|
+
"text/plain": string;
|
|
458
|
+
};
|
|
459
|
+
};
|
|
460
|
+
};
|
|
461
|
+
};
|
|
462
|
+
}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
'use strict';
|
|
File without changes
|
|
@@ -0,0 +1,23 @@
|
|
|
1
|
+
'use strict';var e={openapi:"3.0.0",info:{title:"BlowhornBinding",description:`OpenAPI schema for Blowhorn bindings - per-host profile-to-directory
|
|
2
|
+
records keyed by the (profile, host) pair.
|
|
3
|
+
`,version:"v1beta3",contact:{name:"Meshery Maintainers",email:"maintainers@meshery.io",url:"https://meshery.io"},license:{name:"Apache 2.0",url:"https://www.apache.org/licenses/LICENSE-2.0.html"}},security:[{jwt:[]}],tags:[{name:"blowhornBindings",description:"Operations related to Blowhorn bindings."}],paths:{"/api/blowhorn/bindings":{get:{"x-internal":["cloud"],tags:["blowhornBindings"],summary:"List Blowhorn bindings",operationId:"listBlowhornBindings",description:"Returns a paginated list of Blowhorn bindings in the organization of the authenticated session, optionally filtered by profile or host.",parameters:[{name:"page",in:"query",description:"Get responses by page",schema:{type:"integer",minimum:0}},{name:"pageSize",in:"query",description:"Number of items per page (canonical camelCase form).",schema:{type:"integer",minimum:1}},{name:"pagesize",in:"query",description:"Number of items per page. Deprecated alias of pageSize;\ncanonical `pageSize` wins when both are present.\n",deprecated:true,schema:{type:"integer",minimum:1}},{name:"search",in:"query",description:"Get responses that match search param value",schema:{type:"string"}},{name:"order",in:"query",description:"Get ordered responses",schema:{type:"string"}},{name:"profile",in:"query",required:false,description:"Filter by bound profile subject.",schema:{type:"string"}},{name:"host",in:"query",required:false,description:"Filter by host.",schema:{type:"string"}}],responses:{200:{description:"Blowhorn bindings page",content:{"application/json":{schema:{type:"object",description:"Paginated collection of Blowhorn bindings.",properties:{page:{type:"integer",description:"Current page number of the result set.",minimum:0},pageSize:{type:"integer",description:"Number of items per page.",minimum:1},totalCount:{type:"integer",description:"Total number of items available.",minimum:0},blowhornBindings:{type:"array",items:{"x-go-type":"BlowhornBinding",$schema:"http://json-schema.org/draft-07/schema#",title:"Blowhorn Binding Schema",description:`Server-returned Blowhorn binding as persisted by meshery-cloud. A binding
|
|
4
|
+
maps a profile to a directory on a host, keyed by the (profile, host)
|
|
5
|
+
pair, and doubles as the device and seat record. Binding the same profile
|
|
6
|
+
to a different directory on the same host is a conflict.
|
|
7
|
+
`,type:"object",additionalProperties:false,required:["id","organizationId","profile","host","directory","createdAt","updatedAt"],properties:{id:{description:"Server-generated Blowhorn binding ID.","x-order":1,type:"string",format:"uuid","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}},organizationId:{description:"Owning organization ID. Derived from the authenticated session, never client-settable.","x-go-name":"OrganizationID","x-oapi-codegen-extra-tags":{db:"organization_id"},"x-order":2,type:"string",format:"uuid","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}},profile:{type:"string",description:"Subject of the bound Blowhorn profile.",minLength:1,maxLength:255,"x-oapi-codegen-extra-tags":{db:"profile"},"x-order":3},host:{type:"string",description:"Host the profile is bound on. An identity, not a permission.",minLength:1,maxLength:255,"x-oapi-codegen-extra-tags":{db:"host"},"x-order":4},directory:{type:"string",description:"Profile directory on the host.",minLength:1,maxLength:1024,"x-oapi-codegen-extra-tags":{db:"directory"},"x-order":5},createdAt:{description:"Timestamp of Blowhorn binding creation.","x-oapi-codegen-extra-tags":{db:"created_at"},"x-order":6,type:"string",format:"date-time","x-go-type-skip-optional-pointer":true},updatedAt:{description:"Timestamp of last Blowhorn binding modification.","x-oapi-codegen-extra-tags":{db:"updated_at"},"x-order":7,type:"string",format:"date-time","x-go-type-skip-optional-pointer":true}}},description:"Blowhorn bindings included on this page of results."}}}}}},401:{description:"Expired JWT token used or insufficient privilege",content:{"text/plain":{schema:{type:"string"}}}},500:{description:"Internal server error",content:{"text/plain":{schema:{type:"string"}}}}}},post:{"x-internal":["cloud"],tags:["blowhornBindings"],summary:"Bind Blowhorn profile to host",operationId:"bindBlowhornBinding",description:`Binds a profile to a directory on a host, creating the binding or
|
|
8
|
+
refreshing the entry for the (profile, host) pair. Binding the
|
|
9
|
+
same profile to a different directory on the same host is refused
|
|
10
|
+
with a 409.
|
|
11
|
+
`,requestBody:{required:true,content:{"application/json":{schema:{type:"object",description:"Payload for binding a profile to a host. Contains only\nclient-settable fields; the owning `organizationId` (derived\nfrom the authenticated session) and the server-generated\n`createdAt` / `updatedAt` timestamps are intentionally excluded.\n",required:["profile","host","directory"],properties:{id:{description:"Existing Blowhorn binding ID for updates; omit on bind.","x-oapi-codegen-extra-tags":{json:"id,omitempty"},type:"string",format:"uuid","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}},profile:{type:"string",description:"Subject of the Blowhorn profile to bind.",minLength:1,maxLength:255},host:{type:"string",description:"Host the profile is bound on. An identity, not a permission.",minLength:1,maxLength:255},directory:{type:"string",description:"Profile directory on the host.",minLength:1,maxLength:1024}}}}}},responses:{200:{description:"Blowhorn binding saved",content:{"application/json":{schema:{$schema:"http://json-schema.org/draft-07/schema#",title:"Blowhorn Binding Schema",description:`Server-returned Blowhorn binding as persisted by meshery-cloud. A binding
|
|
12
|
+
maps a profile to a directory on a host, keyed by the (profile, host)
|
|
13
|
+
pair, and doubles as the device and seat record. Binding the same profile
|
|
14
|
+
to a different directory on the same host is a conflict.
|
|
15
|
+
`,type:"object",additionalProperties:false,required:["id","organizationId","profile","host","directory","createdAt","updatedAt"],properties:{id:{description:"Server-generated Blowhorn binding ID.","x-order":1,type:"string",format:"uuid","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}},organizationId:{description:"Owning organization ID. Derived from the authenticated session, never client-settable.","x-go-name":"OrganizationID","x-oapi-codegen-extra-tags":{db:"organization_id"},"x-order":2,type:"string",format:"uuid","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}},profile:{type:"string",description:"Subject of the bound Blowhorn profile.",minLength:1,maxLength:255,"x-oapi-codegen-extra-tags":{db:"profile"},"x-order":3},host:{type:"string",description:"Host the profile is bound on. An identity, not a permission.",minLength:1,maxLength:255,"x-oapi-codegen-extra-tags":{db:"host"},"x-order":4},directory:{type:"string",description:"Profile directory on the host.",minLength:1,maxLength:1024,"x-oapi-codegen-extra-tags":{db:"directory"},"x-order":5},createdAt:{description:"Timestamp of Blowhorn binding creation.","x-oapi-codegen-extra-tags":{db:"created_at"},"x-order":6,type:"string",format:"date-time","x-go-type-skip-optional-pointer":true},updatedAt:{description:"Timestamp of last Blowhorn binding modification.","x-oapi-codegen-extra-tags":{db:"updated_at"},"x-order":7,type:"string",format:"date-time","x-go-type-skip-optional-pointer":true}}}}}},400:{description:"Invalid request body or request param",content:{"text/plain":{schema:{type:"string"}}}},401:{description:"Expired JWT token used or insufficient privilege",content:{"text/plain":{schema:{type:"string"}}}},409:{description:"Conflict - the profile is already bound to a different directory on this host",content:{"text/plain":{schema:{type:"string"}}}},500:{description:"Internal server error",content:{"text/plain":{schema:{type:"string"}}}}}}},"/api/blowhorn/bindings/{blowhornBindingId}":{delete:{"x-internal":["cloud"],tags:["blowhornBindings"],summary:"Unbind Blowhorn profile from host",operationId:"unbindBlowhornBinding",description:"Removes the binding for the (profile, host) pair.",parameters:[{name:"blowhornBindingId",in:"path",description:"Blowhorn binding ID",required:true,schema:{type:"string",format:"uuid",description:"A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}}}],responses:{204:{description:"Blowhorn binding removed"},401:{description:"Expired JWT token used or insufficient privilege",content:{"text/plain":{schema:{type:"string"}}}},404:{description:"Result not found",content:{"text/plain":{schema:{type:"string"}}}},500:{description:"Internal server error",content:{"text/plain":{schema:{type:"string"}}}}}}}},components:{securitySchemes:{jwt:{type:"http",scheme:"Bearer [REDACTED]",bearerFormat:"JWT"}},responses:{400:{description:"Invalid request body or request param",content:{"text/plain":{schema:{type:"string"}}}},401:{description:"Expired JWT token used or insufficient privilege",content:{"text/plain":{schema:{type:"string"}}}},404:{description:"Result not found",content:{"text/plain":{schema:{type:"string"}}}},409:{description:"Conflict - the profile is already bound to a different directory on this host",content:{"text/plain":{schema:{type:"string"}}}},500:{description:"Internal server error",content:{"text/plain":{schema:{type:"string"}}}}},parameters:{blowhornBindingId:{name:"blowhornBindingId",in:"path",description:"Blowhorn binding ID",required:true,schema:{type:"string",format:"uuid",description:"A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}}},page:{name:"page",in:"query",description:"Get responses by page",schema:{type:"integer",minimum:0}},pageSize:{name:"pageSize",in:"query",description:"Number of items per page (canonical camelCase form).",schema:{type:"integer",minimum:1}},pagesize:{name:"pagesize",in:"query",description:"Number of items per page. Deprecated alias of pageSize;\ncanonical `pageSize` wins when both are present.\n",deprecated:true,schema:{type:"integer",minimum:1}},search:{name:"search",in:"query",description:"Get responses that match search param value",schema:{type:"string"}},order:{name:"order",in:"query",description:"Get ordered responses",schema:{type:"string"}}},schemas:{BlowhornBinding:{$schema:"http://json-schema.org/draft-07/schema#",title:"Blowhorn Binding Schema",description:`Server-returned Blowhorn binding as persisted by meshery-cloud. A binding
|
|
16
|
+
maps a profile to a directory on a host, keyed by the (profile, host)
|
|
17
|
+
pair, and doubles as the device and seat record. Binding the same profile
|
|
18
|
+
to a different directory on the same host is a conflict.
|
|
19
|
+
`,type:"object",additionalProperties:false,required:["id","organizationId","profile","host","directory","createdAt","updatedAt"],properties:{id:{description:"Server-generated Blowhorn binding ID.","x-order":1,type:"string",format:"uuid","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}},organizationId:{description:"Owning organization ID. Derived from the authenticated session, never client-settable.","x-go-name":"OrganizationID","x-oapi-codegen-extra-tags":{db:"organization_id"},"x-order":2,type:"string",format:"uuid","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}},profile:{type:"string",description:"Subject of the bound Blowhorn profile.",minLength:1,maxLength:255,"x-oapi-codegen-extra-tags":{db:"profile"},"x-order":3},host:{type:"string",description:"Host the profile is bound on. An identity, not a permission.",minLength:1,maxLength:255,"x-oapi-codegen-extra-tags":{db:"host"},"x-order":4},directory:{type:"string",description:"Profile directory on the host.",minLength:1,maxLength:1024,"x-oapi-codegen-extra-tags":{db:"directory"},"x-order":5},createdAt:{description:"Timestamp of Blowhorn binding creation.","x-oapi-codegen-extra-tags":{db:"created_at"},"x-order":6,type:"string",format:"date-time","x-go-type-skip-optional-pointer":true},updatedAt:{description:"Timestamp of last Blowhorn binding modification.","x-oapi-codegen-extra-tags":{db:"updated_at"},"x-order":7,type:"string",format:"date-time","x-go-type-skip-optional-pointer":true}}},BlowhornBindingPayload:{type:"object",description:"Payload for binding a profile to a host. Contains only\nclient-settable fields; the owning `organizationId` (derived\nfrom the authenticated session) and the server-generated\n`createdAt` / `updatedAt` timestamps are intentionally excluded.\n",required:["profile","host","directory"],properties:{id:{description:"Existing Blowhorn binding ID for updates; omit on bind.","x-oapi-codegen-extra-tags":{json:"id,omitempty"},type:"string",format:"uuid","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}},profile:{type:"string",description:"Subject of the Blowhorn profile to bind.",minLength:1,maxLength:255},host:{type:"string",description:"Host the profile is bound on. An identity, not a permission.",minLength:1,maxLength:255},directory:{type:"string",description:"Profile directory on the host.",minLength:1,maxLength:1024}}},BlowhornBindingPage:{type:"object",description:"Paginated collection of Blowhorn bindings.",properties:{page:{type:"integer",description:"Current page number of the result set.",minimum:0},pageSize:{type:"integer",description:"Number of items per page.",minimum:1},totalCount:{type:"integer",description:"Total number of items available.",minimum:0},blowhornBindings:{type:"array",items:{"x-go-type":"BlowhornBinding",$schema:"http://json-schema.org/draft-07/schema#",title:"Blowhorn Binding Schema",description:`Server-returned Blowhorn binding as persisted by meshery-cloud. A binding
|
|
20
|
+
maps a profile to a directory on a host, keyed by the (profile, host)
|
|
21
|
+
pair, and doubles as the device and seat record. Binding the same profile
|
|
22
|
+
to a different directory on the same host is a conflict.
|
|
23
|
+
`,type:"object",additionalProperties:false,required:["id","organizationId","profile","host","directory","createdAt","updatedAt"],properties:{id:{description:"Server-generated Blowhorn binding ID.","x-order":1,type:"string",format:"uuid","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}},organizationId:{description:"Owning organization ID. Derived from the authenticated session, never client-settable.","x-go-name":"OrganizationID","x-oapi-codegen-extra-tags":{db:"organization_id"},"x-order":2,type:"string",format:"uuid","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}},profile:{type:"string",description:"Subject of the bound Blowhorn profile.",minLength:1,maxLength:255,"x-oapi-codegen-extra-tags":{db:"profile"},"x-order":3},host:{type:"string",description:"Host the profile is bound on. An identity, not a permission.",minLength:1,maxLength:255,"x-oapi-codegen-extra-tags":{db:"host"},"x-order":4},directory:{type:"string",description:"Profile directory on the host.",minLength:1,maxLength:1024,"x-oapi-codegen-extra-tags":{db:"directory"},"x-order":5},createdAt:{description:"Timestamp of Blowhorn binding creation.","x-oapi-codegen-extra-tags":{db:"created_at"},"x-order":6,type:"string",format:"date-time","x-go-type-skip-optional-pointer":true},updatedAt:{description:"Timestamp of last Blowhorn binding modification.","x-oapi-codegen-extra-tags":{db:"updated_at"},"x-order":7,type:"string",format:"date-time","x-go-type-skip-optional-pointer":true}}},description:"Blowhorn bindings included on this page of results."}}}}}},t=e;module.exports=t;
|
|
@@ -0,0 +1,23 @@
|
|
|
1
|
+
var e={openapi:"3.0.0",info:{title:"BlowhornBinding",description:`OpenAPI schema for Blowhorn bindings - per-host profile-to-directory
|
|
2
|
+
records keyed by the (profile, host) pair.
|
|
3
|
+
`,version:"v1beta3",contact:{name:"Meshery Maintainers",email:"maintainers@meshery.io",url:"https://meshery.io"},license:{name:"Apache 2.0",url:"https://www.apache.org/licenses/LICENSE-2.0.html"}},security:[{jwt:[]}],tags:[{name:"blowhornBindings",description:"Operations related to Blowhorn bindings."}],paths:{"/api/blowhorn/bindings":{get:{"x-internal":["cloud"],tags:["blowhornBindings"],summary:"List Blowhorn bindings",operationId:"listBlowhornBindings",description:"Returns a paginated list of Blowhorn bindings in the organization of the authenticated session, optionally filtered by profile or host.",parameters:[{name:"page",in:"query",description:"Get responses by page",schema:{type:"integer",minimum:0}},{name:"pageSize",in:"query",description:"Number of items per page (canonical camelCase form).",schema:{type:"integer",minimum:1}},{name:"pagesize",in:"query",description:"Number of items per page. Deprecated alias of pageSize;\ncanonical `pageSize` wins when both are present.\n",deprecated:true,schema:{type:"integer",minimum:1}},{name:"search",in:"query",description:"Get responses that match search param value",schema:{type:"string"}},{name:"order",in:"query",description:"Get ordered responses",schema:{type:"string"}},{name:"profile",in:"query",required:false,description:"Filter by bound profile subject.",schema:{type:"string"}},{name:"host",in:"query",required:false,description:"Filter by host.",schema:{type:"string"}}],responses:{200:{description:"Blowhorn bindings page",content:{"application/json":{schema:{type:"object",description:"Paginated collection of Blowhorn bindings.",properties:{page:{type:"integer",description:"Current page number of the result set.",minimum:0},pageSize:{type:"integer",description:"Number of items per page.",minimum:1},totalCount:{type:"integer",description:"Total number of items available.",minimum:0},blowhornBindings:{type:"array",items:{"x-go-type":"BlowhornBinding",$schema:"http://json-schema.org/draft-07/schema#",title:"Blowhorn Binding Schema",description:`Server-returned Blowhorn binding as persisted by meshery-cloud. A binding
|
|
4
|
+
maps a profile to a directory on a host, keyed by the (profile, host)
|
|
5
|
+
pair, and doubles as the device and seat record. Binding the same profile
|
|
6
|
+
to a different directory on the same host is a conflict.
|
|
7
|
+
`,type:"object",additionalProperties:false,required:["id","organizationId","profile","host","directory","createdAt","updatedAt"],properties:{id:{description:"Server-generated Blowhorn binding ID.","x-order":1,type:"string",format:"uuid","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}},organizationId:{description:"Owning organization ID. Derived from the authenticated session, never client-settable.","x-go-name":"OrganizationID","x-oapi-codegen-extra-tags":{db:"organization_id"},"x-order":2,type:"string",format:"uuid","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}},profile:{type:"string",description:"Subject of the bound Blowhorn profile.",minLength:1,maxLength:255,"x-oapi-codegen-extra-tags":{db:"profile"},"x-order":3},host:{type:"string",description:"Host the profile is bound on. An identity, not a permission.",minLength:1,maxLength:255,"x-oapi-codegen-extra-tags":{db:"host"},"x-order":4},directory:{type:"string",description:"Profile directory on the host.",minLength:1,maxLength:1024,"x-oapi-codegen-extra-tags":{db:"directory"},"x-order":5},createdAt:{description:"Timestamp of Blowhorn binding creation.","x-oapi-codegen-extra-tags":{db:"created_at"},"x-order":6,type:"string",format:"date-time","x-go-type-skip-optional-pointer":true},updatedAt:{description:"Timestamp of last Blowhorn binding modification.","x-oapi-codegen-extra-tags":{db:"updated_at"},"x-order":7,type:"string",format:"date-time","x-go-type-skip-optional-pointer":true}}},description:"Blowhorn bindings included on this page of results."}}}}}},401:{description:"Expired JWT token used or insufficient privilege",content:{"text/plain":{schema:{type:"string"}}}},500:{description:"Internal server error",content:{"text/plain":{schema:{type:"string"}}}}}},post:{"x-internal":["cloud"],tags:["blowhornBindings"],summary:"Bind Blowhorn profile to host",operationId:"bindBlowhornBinding",description:`Binds a profile to a directory on a host, creating the binding or
|
|
8
|
+
refreshing the entry for the (profile, host) pair. Binding the
|
|
9
|
+
same profile to a different directory on the same host is refused
|
|
10
|
+
with a 409.
|
|
11
|
+
`,requestBody:{required:true,content:{"application/json":{schema:{type:"object",description:"Payload for binding a profile to a host. Contains only\nclient-settable fields; the owning `organizationId` (derived\nfrom the authenticated session) and the server-generated\n`createdAt` / `updatedAt` timestamps are intentionally excluded.\n",required:["profile","host","directory"],properties:{id:{description:"Existing Blowhorn binding ID for updates; omit on bind.","x-oapi-codegen-extra-tags":{json:"id,omitempty"},type:"string",format:"uuid","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}},profile:{type:"string",description:"Subject of the Blowhorn profile to bind.",minLength:1,maxLength:255},host:{type:"string",description:"Host the profile is bound on. An identity, not a permission.",minLength:1,maxLength:255},directory:{type:"string",description:"Profile directory on the host.",minLength:1,maxLength:1024}}}}}},responses:{200:{description:"Blowhorn binding saved",content:{"application/json":{schema:{$schema:"http://json-schema.org/draft-07/schema#",title:"Blowhorn Binding Schema",description:`Server-returned Blowhorn binding as persisted by meshery-cloud. A binding
|
|
12
|
+
maps a profile to a directory on a host, keyed by the (profile, host)
|
|
13
|
+
pair, and doubles as the device and seat record. Binding the same profile
|
|
14
|
+
to a different directory on the same host is a conflict.
|
|
15
|
+
`,type:"object",additionalProperties:false,required:["id","organizationId","profile","host","directory","createdAt","updatedAt"],properties:{id:{description:"Server-generated Blowhorn binding ID.","x-order":1,type:"string",format:"uuid","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}},organizationId:{description:"Owning organization ID. Derived from the authenticated session, never client-settable.","x-go-name":"OrganizationID","x-oapi-codegen-extra-tags":{db:"organization_id"},"x-order":2,type:"string",format:"uuid","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}},profile:{type:"string",description:"Subject of the bound Blowhorn profile.",minLength:1,maxLength:255,"x-oapi-codegen-extra-tags":{db:"profile"},"x-order":3},host:{type:"string",description:"Host the profile is bound on. An identity, not a permission.",minLength:1,maxLength:255,"x-oapi-codegen-extra-tags":{db:"host"},"x-order":4},directory:{type:"string",description:"Profile directory on the host.",minLength:1,maxLength:1024,"x-oapi-codegen-extra-tags":{db:"directory"},"x-order":5},createdAt:{description:"Timestamp of Blowhorn binding creation.","x-oapi-codegen-extra-tags":{db:"created_at"},"x-order":6,type:"string",format:"date-time","x-go-type-skip-optional-pointer":true},updatedAt:{description:"Timestamp of last Blowhorn binding modification.","x-oapi-codegen-extra-tags":{db:"updated_at"},"x-order":7,type:"string",format:"date-time","x-go-type-skip-optional-pointer":true}}}}}},400:{description:"Invalid request body or request param",content:{"text/plain":{schema:{type:"string"}}}},401:{description:"Expired JWT token used or insufficient privilege",content:{"text/plain":{schema:{type:"string"}}}},409:{description:"Conflict - the profile is already bound to a different directory on this host",content:{"text/plain":{schema:{type:"string"}}}},500:{description:"Internal server error",content:{"text/plain":{schema:{type:"string"}}}}}}},"/api/blowhorn/bindings/{blowhornBindingId}":{delete:{"x-internal":["cloud"],tags:["blowhornBindings"],summary:"Unbind Blowhorn profile from host",operationId:"unbindBlowhornBinding",description:"Removes the binding for the (profile, host) pair.",parameters:[{name:"blowhornBindingId",in:"path",description:"Blowhorn binding ID",required:true,schema:{type:"string",format:"uuid",description:"A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}}}],responses:{204:{description:"Blowhorn binding removed"},401:{description:"Expired JWT token used or insufficient privilege",content:{"text/plain":{schema:{type:"string"}}}},404:{description:"Result not found",content:{"text/plain":{schema:{type:"string"}}}},500:{description:"Internal server error",content:{"text/plain":{schema:{type:"string"}}}}}}}},components:{securitySchemes:{jwt:{type:"http",scheme:"Bearer [REDACTED]",bearerFormat:"JWT"}},responses:{400:{description:"Invalid request body or request param",content:{"text/plain":{schema:{type:"string"}}}},401:{description:"Expired JWT token used or insufficient privilege",content:{"text/plain":{schema:{type:"string"}}}},404:{description:"Result not found",content:{"text/plain":{schema:{type:"string"}}}},409:{description:"Conflict - the profile is already bound to a different directory on this host",content:{"text/plain":{schema:{type:"string"}}}},500:{description:"Internal server error",content:{"text/plain":{schema:{type:"string"}}}}},parameters:{blowhornBindingId:{name:"blowhornBindingId",in:"path",description:"Blowhorn binding ID",required:true,schema:{type:"string",format:"uuid",description:"A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}}},page:{name:"page",in:"query",description:"Get responses by page",schema:{type:"integer",minimum:0}},pageSize:{name:"pageSize",in:"query",description:"Number of items per page (canonical camelCase form).",schema:{type:"integer",minimum:1}},pagesize:{name:"pagesize",in:"query",description:"Number of items per page. Deprecated alias of pageSize;\ncanonical `pageSize` wins when both are present.\n",deprecated:true,schema:{type:"integer",minimum:1}},search:{name:"search",in:"query",description:"Get responses that match search param value",schema:{type:"string"}},order:{name:"order",in:"query",description:"Get ordered responses",schema:{type:"string"}}},schemas:{BlowhornBinding:{$schema:"http://json-schema.org/draft-07/schema#",title:"Blowhorn Binding Schema",description:`Server-returned Blowhorn binding as persisted by meshery-cloud. A binding
|
|
16
|
+
maps a profile to a directory on a host, keyed by the (profile, host)
|
|
17
|
+
pair, and doubles as the device and seat record. Binding the same profile
|
|
18
|
+
to a different directory on the same host is a conflict.
|
|
19
|
+
`,type:"object",additionalProperties:false,required:["id","organizationId","profile","host","directory","createdAt","updatedAt"],properties:{id:{description:"Server-generated Blowhorn binding ID.","x-order":1,type:"string",format:"uuid","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}},organizationId:{description:"Owning organization ID. Derived from the authenticated session, never client-settable.","x-go-name":"OrganizationID","x-oapi-codegen-extra-tags":{db:"organization_id"},"x-order":2,type:"string",format:"uuid","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}},profile:{type:"string",description:"Subject of the bound Blowhorn profile.",minLength:1,maxLength:255,"x-oapi-codegen-extra-tags":{db:"profile"},"x-order":3},host:{type:"string",description:"Host the profile is bound on. An identity, not a permission.",minLength:1,maxLength:255,"x-oapi-codegen-extra-tags":{db:"host"},"x-order":4},directory:{type:"string",description:"Profile directory on the host.",minLength:1,maxLength:1024,"x-oapi-codegen-extra-tags":{db:"directory"},"x-order":5},createdAt:{description:"Timestamp of Blowhorn binding creation.","x-oapi-codegen-extra-tags":{db:"created_at"},"x-order":6,type:"string",format:"date-time","x-go-type-skip-optional-pointer":true},updatedAt:{description:"Timestamp of last Blowhorn binding modification.","x-oapi-codegen-extra-tags":{db:"updated_at"},"x-order":7,type:"string",format:"date-time","x-go-type-skip-optional-pointer":true}}},BlowhornBindingPayload:{type:"object",description:"Payload for binding a profile to a host. Contains only\nclient-settable fields; the owning `organizationId` (derived\nfrom the authenticated session) and the server-generated\n`createdAt` / `updatedAt` timestamps are intentionally excluded.\n",required:["profile","host","directory"],properties:{id:{description:"Existing Blowhorn binding ID for updates; omit on bind.","x-oapi-codegen-extra-tags":{json:"id,omitempty"},type:"string",format:"uuid","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}},profile:{type:"string",description:"Subject of the Blowhorn profile to bind.",minLength:1,maxLength:255},host:{type:"string",description:"Host the profile is bound on. An identity, not a permission.",minLength:1,maxLength:255},directory:{type:"string",description:"Profile directory on the host.",minLength:1,maxLength:1024}}},BlowhornBindingPage:{type:"object",description:"Paginated collection of Blowhorn bindings.",properties:{page:{type:"integer",description:"Current page number of the result set.",minimum:0},pageSize:{type:"integer",description:"Number of items per page.",minimum:1},totalCount:{type:"integer",description:"Total number of items available.",minimum:0},blowhornBindings:{type:"array",items:{"x-go-type":"BlowhornBinding",$schema:"http://json-schema.org/draft-07/schema#",title:"Blowhorn Binding Schema",description:`Server-returned Blowhorn binding as persisted by meshery-cloud. A binding
|
|
20
|
+
maps a profile to a directory on a host, keyed by the (profile, host)
|
|
21
|
+
pair, and doubles as the device and seat record. Binding the same profile
|
|
22
|
+
to a different directory on the same host is a conflict.
|
|
23
|
+
`,type:"object",additionalProperties:false,required:["id","organizationId","profile","host","directory","createdAt","updatedAt"],properties:{id:{description:"Server-generated Blowhorn binding ID.","x-order":1,type:"string",format:"uuid","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}},organizationId:{description:"Owning organization ID. Derived from the authenticated session, never client-settable.","x-go-name":"OrganizationID","x-oapi-codegen-extra-tags":{db:"organization_id"},"x-order":2,type:"string",format:"uuid","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}},profile:{type:"string",description:"Subject of the bound Blowhorn profile.",minLength:1,maxLength:255,"x-oapi-codegen-extra-tags":{db:"profile"},"x-order":3},host:{type:"string",description:"Host the profile is bound on. An identity, not a permission.",minLength:1,maxLength:255,"x-oapi-codegen-extra-tags":{db:"host"},"x-order":4},directory:{type:"string",description:"Profile directory on the host.",minLength:1,maxLength:1024,"x-oapi-codegen-extra-tags":{db:"directory"},"x-order":5},createdAt:{description:"Timestamp of Blowhorn binding creation.","x-oapi-codegen-extra-tags":{db:"created_at"},"x-order":6,type:"string",format:"date-time","x-go-type-skip-optional-pointer":true},updatedAt:{description:"Timestamp of last Blowhorn binding modification.","x-oapi-codegen-extra-tags":{db:"updated_at"},"x-order":7,type:"string",format:"date-time","x-go-type-skip-optional-pointer":true}}},description:"Blowhorn bindings included on this page of results."}}}}}},t=e;export{t as default};
|