@meshery/schemas 1.3.72 → 1.3.74
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/cloudApi.d.mts +23587 -20833
- package/dist/cloudApi.d.ts +23587 -20833
- package/dist/cloudApi.js +1 -1
- package/dist/cloudApi.mjs +1 -1
- package/dist/constructs/v1beta2/schedule/Schedule.d.ts +4 -0
- package/dist/constructs/v1beta2/schedule/ScheduleSchema.js +7 -4
- package/dist/constructs/v1beta2/schedule/ScheduleSchema.mjs +7 -4
- package/dist/constructs/v1beta3/academy/Academy.d.ts +9 -9
- package/dist/constructs/v1beta3/academy/AcademySchema.js +2 -2
- package/dist/constructs/v1beta3/academy/AcademySchema.mjs +2 -2
- package/dist/constructs/v1beta3/claim/Claim.d.ts +919 -0
- package/dist/constructs/v1beta3/claim/ClaimSchema.d.ts +2 -0
- package/dist/constructs/v1beta3/claim/ClaimSchema.js +88 -0
- package/dist/constructs/v1beta3/claim/ClaimSchema.mjs +88 -0
- package/dist/constructs/v1beta3/connection/Connection.d.ts +5 -0
- package/dist/constructs/v1beta3/connection/ConnectionSchema.js +1 -1
- package/dist/constructs/v1beta3/connection/ConnectionSchema.mjs +1 -1
- package/dist/constructs/v1beta3/{blowhorn_content/BlowhornContent.d.ts → content_piece/ContentPiece.d.ts} +101 -83
- package/dist/constructs/v1beta3/content_piece/ContentPieceSchema.d.ts +2 -0
- package/dist/constructs/v1beta3/content_piece/ContentPieceSchema.js +48 -0
- package/dist/constructs/v1beta3/content_piece/ContentPieceSchema.mjs +48 -0
- package/dist/constructs/v1beta3/invitation/Invitation.d.ts +33 -33
- package/dist/constructs/v1beta3/invitation/InvitationSchema.js +1 -1
- package/dist/constructs/v1beta3/invitation/InvitationSchema.mjs +1 -1
- package/dist/constructs/v1beta3/schedule/Schedule.d.ts +3804 -0
- package/dist/constructs/v1beta3/schedule/Schedule.js +1 -0
- package/dist/constructs/v1beta3/schedule/Schedule.mjs +0 -0
- package/dist/constructs/v1beta3/schedule/ScheduleSchema.d.ts +2 -0
- package/dist/constructs/v1beta3/schedule/ScheduleSchema.js +61 -0
- package/dist/constructs/v1beta3/schedule/ScheduleSchema.mjs +61 -0
- package/dist/index.d.mts +17 -1
- package/dist/index.d.ts +17 -1
- package/dist/index.js +2 -2
- package/dist/index.mjs +2 -2
- package/package.json +1 -1
- package/dist/constructs/v1beta3/blowhorn_content/BlowhornContentSchema.d.ts +0 -2
- package/dist/constructs/v1beta3/blowhorn_content/BlowhornContentSchema.js +0 -43
- package/dist/constructs/v1beta3/blowhorn_content/BlowhornContentSchema.mjs +0 -43
- package/dist/constructs/v1beta3/job_lease/JobLease.d.ts +0 -2570
- package/dist/constructs/v1beta3/job_lease/JobLeaseSchema.d.ts +0 -2
- package/dist/constructs/v1beta3/job_lease/JobLeaseSchema.js +0 -83
- package/dist/constructs/v1beta3/job_lease/JobLeaseSchema.mjs +0 -83
- /package/dist/constructs/v1beta3/{blowhorn_content/BlowhornContent.js → claim/Claim.js} +0 -0
- /package/dist/constructs/v1beta3/{blowhorn_content/BlowhornContent.mjs → claim/Claim.mjs} +0 -0
- /package/dist/constructs/v1beta3/{job_lease/JobLease.js → content_piece/ContentPiece.js} +0 -0
- /package/dist/constructs/v1beta3/{job_lease/JobLease.mjs → content_piece/ContentPiece.mjs} +0 -0
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
*/
|
|
5
5
|
|
|
6
6
|
export interface paths {
|
|
7
|
-
"/api/
|
|
7
|
+
"/api/content/pieces": {
|
|
8
8
|
parameters: {
|
|
9
9
|
query?: never;
|
|
10
10
|
header?: never;
|
|
@@ -12,47 +12,47 @@ export interface paths {
|
|
|
12
12
|
cookie?: never;
|
|
13
13
|
};
|
|
14
14
|
/**
|
|
15
|
-
* List
|
|
16
|
-
* @description Returns a paginated list of
|
|
15
|
+
* List content pieces
|
|
16
|
+
* @description Returns a paginated list of content pieces in the organization of the authenticated session.
|
|
17
17
|
*/
|
|
18
|
-
get: operations["
|
|
18
|
+
get: operations["listContentPieces"];
|
|
19
19
|
put?: never;
|
|
20
20
|
/**
|
|
21
|
-
* Insert
|
|
22
|
-
* @description Inserts a new
|
|
21
|
+
* Insert a content piece
|
|
22
|
+
* @description Inserts a new content piece. Insert-only: any supplied
|
|
23
23
|
* `id` and `expectedFingerprint` are ignored; existing rows change
|
|
24
|
-
* only through the conditional `
|
|
24
|
+
* only through the conditional `updateContentPiece`. The
|
|
25
25
|
* `fingerprint` is server-computed.
|
|
26
26
|
*/
|
|
27
|
-
post: operations["
|
|
27
|
+
post: operations["insertContentPiece"];
|
|
28
28
|
delete?: never;
|
|
29
29
|
options?: never;
|
|
30
30
|
head?: never;
|
|
31
31
|
patch?: never;
|
|
32
32
|
trace?: never;
|
|
33
33
|
};
|
|
34
|
-
"/api/
|
|
34
|
+
"/api/content/pieces/{contentPieceId}": {
|
|
35
35
|
parameters: {
|
|
36
36
|
query?: never;
|
|
37
37
|
header?: never;
|
|
38
38
|
path?: never;
|
|
39
39
|
cookie?: never;
|
|
40
40
|
};
|
|
41
|
-
/** Get
|
|
42
|
-
get: operations["
|
|
41
|
+
/** Get a content piece by ID */
|
|
42
|
+
get: operations["getContentPiece"];
|
|
43
43
|
/**
|
|
44
|
-
* Update
|
|
45
|
-
* @description Conditionally updates the
|
|
44
|
+
* Update a content piece
|
|
45
|
+
* @description Conditionally updates the content piece. When
|
|
46
46
|
* `expectedFingerprint` is supplied and stale, the update is
|
|
47
47
|
* refused with a 409.
|
|
48
48
|
*/
|
|
49
|
-
put: operations["
|
|
49
|
+
put: operations["updateContentPiece"];
|
|
50
50
|
post?: never;
|
|
51
51
|
/**
|
|
52
|
-
* Delete
|
|
53
|
-
* @description Soft-deletes the
|
|
52
|
+
* Delete a content piece
|
|
53
|
+
* @description Soft-deletes the content piece.
|
|
54
54
|
*/
|
|
55
|
-
delete: operations["
|
|
55
|
+
delete: operations["deleteContentPiece"];
|
|
56
56
|
options?: never;
|
|
57
57
|
head?: never;
|
|
58
58
|
patch?: never;
|
|
@@ -63,16 +63,16 @@ export type webhooks = Record<string, never>;
|
|
|
63
63
|
export interface components {
|
|
64
64
|
schemas: {
|
|
65
65
|
/**
|
|
66
|
-
*
|
|
67
|
-
* @description Server-returned
|
|
68
|
-
* Content
|
|
66
|
+
* Content Piece Schema
|
|
67
|
+
* @description Server-returned content piece as persisted by meshery-cloud.
|
|
68
|
+
* Content pieces carry a row number and a server-computed fingerprint over
|
|
69
69
|
* their canonical values; updates are conditional on the fingerprint the
|
|
70
70
|
* writer read, so stale writes are refused rather than silently applied.
|
|
71
71
|
*/
|
|
72
|
-
|
|
72
|
+
ContentPiece: {
|
|
73
73
|
/**
|
|
74
74
|
* Format: uuid
|
|
75
|
-
* @description Server-generated
|
|
75
|
+
* @description Server-generated content piece ID.
|
|
76
76
|
*/
|
|
77
77
|
id: string;
|
|
78
78
|
/**
|
|
@@ -80,7 +80,7 @@ export interface components {
|
|
|
80
80
|
* @description Owning organization ID. Derived from the authenticated session, never client-settable.
|
|
81
81
|
*/
|
|
82
82
|
organizationId: string;
|
|
83
|
-
/** @description Subject of the owning
|
|
83
|
+
/** @description Subject of the owning profile. */
|
|
84
84
|
profile: string;
|
|
85
85
|
/** @description Row number of the content within the owning profile. */
|
|
86
86
|
rowNumber: number;
|
|
@@ -90,34 +90,34 @@ export interface components {
|
|
|
90
90
|
data?: Record<string, never>;
|
|
91
91
|
/**
|
|
92
92
|
* Format: date-time
|
|
93
|
-
* @description Timestamp of
|
|
93
|
+
* @description Timestamp of content piece creation.
|
|
94
94
|
*/
|
|
95
95
|
createdAt: string;
|
|
96
96
|
/**
|
|
97
97
|
* Format: date-time
|
|
98
|
-
* @description Timestamp of last
|
|
98
|
+
* @description Timestamp of last content piece modification.
|
|
99
99
|
*/
|
|
100
100
|
updatedAt: string;
|
|
101
101
|
/**
|
|
102
102
|
* Format: date-time
|
|
103
|
-
* @description Timestamp when the
|
|
103
|
+
* @description Timestamp when the content piece was soft-deleted.
|
|
104
104
|
*/
|
|
105
105
|
deletedAt?: string | null;
|
|
106
106
|
};
|
|
107
107
|
/**
|
|
108
|
-
* @description Payload for inserting or updating a
|
|
108
|
+
* @description Payload for inserting or updating a content piece.
|
|
109
109
|
* Contains only client-settable fields; the owning
|
|
110
110
|
* `organizationId` (derived from the authenticated session), the
|
|
111
111
|
* server-computed `fingerprint` and the server-generated
|
|
112
112
|
* `createdAt` / `updatedAt` timestamps are intentionally excluded.
|
|
113
113
|
*/
|
|
114
|
-
|
|
114
|
+
ContentPiecePayload: {
|
|
115
115
|
/**
|
|
116
116
|
* Format: uuid
|
|
117
|
-
* @description Existing
|
|
117
|
+
* @description Existing content piece ID for updates; ignored on insert.
|
|
118
118
|
*/
|
|
119
119
|
id?: string;
|
|
120
|
-
/** @description Subject of the owning
|
|
120
|
+
/** @description Subject of the owning profile. */
|
|
121
121
|
profile: string;
|
|
122
122
|
/** @description Row number of the content within the owning profile. */
|
|
123
123
|
rowNumber: number;
|
|
@@ -131,19 +131,19 @@ export interface components {
|
|
|
131
131
|
*/
|
|
132
132
|
expectedFingerprint?: string;
|
|
133
133
|
};
|
|
134
|
-
/** @description Paginated collection of
|
|
135
|
-
|
|
134
|
+
/** @description Paginated collection of content pieces. */
|
|
135
|
+
ContentPiecePage: {
|
|
136
136
|
/** @description Current page number of the result set. */
|
|
137
137
|
page?: number;
|
|
138
138
|
/** @description Number of items per page. */
|
|
139
139
|
pageSize?: number;
|
|
140
140
|
/** @description Total number of items available. */
|
|
141
141
|
totalCount?: number;
|
|
142
|
-
/** @description
|
|
143
|
-
|
|
142
|
+
/** @description Content pieces included on this page of results. */
|
|
143
|
+
contentPieces?: {
|
|
144
144
|
/**
|
|
145
145
|
* Format: uuid
|
|
146
|
-
* @description Server-generated
|
|
146
|
+
* @description Server-generated content piece ID.
|
|
147
147
|
*/
|
|
148
148
|
id: string;
|
|
149
149
|
/**
|
|
@@ -151,7 +151,7 @@ export interface components {
|
|
|
151
151
|
* @description Owning organization ID. Derived from the authenticated session, never client-settable.
|
|
152
152
|
*/
|
|
153
153
|
organizationId: string;
|
|
154
|
-
/** @description Subject of the owning
|
|
154
|
+
/** @description Subject of the owning profile. */
|
|
155
155
|
profile: string;
|
|
156
156
|
/** @description Row number of the content within the owning profile. */
|
|
157
157
|
rowNumber: number;
|
|
@@ -161,17 +161,17 @@ export interface components {
|
|
|
161
161
|
data?: Record<string, never>;
|
|
162
162
|
/**
|
|
163
163
|
* Format: date-time
|
|
164
|
-
* @description Timestamp of
|
|
164
|
+
* @description Timestamp of content piece creation.
|
|
165
165
|
*/
|
|
166
166
|
createdAt: string;
|
|
167
167
|
/**
|
|
168
168
|
* Format: date-time
|
|
169
|
-
* @description Timestamp of last
|
|
169
|
+
* @description Timestamp of last content piece modification.
|
|
170
170
|
*/
|
|
171
171
|
updatedAt: string;
|
|
172
172
|
/**
|
|
173
173
|
* Format: date-time
|
|
174
|
-
* @description Timestamp when the
|
|
174
|
+
* @description Timestamp when the content piece was soft-deleted.
|
|
175
175
|
*/
|
|
176
176
|
deletedAt?: string | null;
|
|
177
177
|
}[];
|
|
@@ -225,8 +225,8 @@ export interface components {
|
|
|
225
225
|
};
|
|
226
226
|
};
|
|
227
227
|
parameters: {
|
|
228
|
-
/** @description
|
|
229
|
-
|
|
228
|
+
/** @description Content piece ID */
|
|
229
|
+
contentPieceId: string;
|
|
230
230
|
/** @description Get responses by page */
|
|
231
231
|
page: number;
|
|
232
232
|
/** @description Number of items per page (canonical camelCase form). */
|
|
@@ -248,7 +248,7 @@ export interface components {
|
|
|
248
248
|
}
|
|
249
249
|
export type $defs = Record<string, never>;
|
|
250
250
|
export interface operations {
|
|
251
|
-
|
|
251
|
+
listContentPieces: {
|
|
252
252
|
parameters: {
|
|
253
253
|
query?: {
|
|
254
254
|
/** @description Get responses by page */
|
|
@@ -274,7 +274,7 @@ export interface operations {
|
|
|
274
274
|
};
|
|
275
275
|
requestBody?: never;
|
|
276
276
|
responses: {
|
|
277
|
-
/** @description
|
|
277
|
+
/** @description Content piece page */
|
|
278
278
|
200: {
|
|
279
279
|
headers: {
|
|
280
280
|
[name: string]: unknown;
|
|
@@ -287,11 +287,11 @@ export interface operations {
|
|
|
287
287
|
pageSize?: number;
|
|
288
288
|
/** @description Total number of items available. */
|
|
289
289
|
totalCount?: number;
|
|
290
|
-
/** @description
|
|
291
|
-
|
|
290
|
+
/** @description Content pieces included on this page of results. */
|
|
291
|
+
contentPieces?: {
|
|
292
292
|
/**
|
|
293
293
|
* Format: uuid
|
|
294
|
-
* @description Server-generated
|
|
294
|
+
* @description Server-generated content piece ID.
|
|
295
295
|
*/
|
|
296
296
|
id: string;
|
|
297
297
|
/**
|
|
@@ -299,7 +299,7 @@ export interface operations {
|
|
|
299
299
|
* @description Owning organization ID. Derived from the authenticated session, never client-settable.
|
|
300
300
|
*/
|
|
301
301
|
organizationId: string;
|
|
302
|
-
/** @description Subject of the owning
|
|
302
|
+
/** @description Subject of the owning profile. */
|
|
303
303
|
profile: string;
|
|
304
304
|
/** @description Row number of the content within the owning profile. */
|
|
305
305
|
rowNumber: number;
|
|
@@ -309,17 +309,17 @@ export interface operations {
|
|
|
309
309
|
data?: Record<string, never>;
|
|
310
310
|
/**
|
|
311
311
|
* Format: date-time
|
|
312
|
-
* @description Timestamp of
|
|
312
|
+
* @description Timestamp of content piece creation.
|
|
313
313
|
*/
|
|
314
314
|
createdAt: string;
|
|
315
315
|
/**
|
|
316
316
|
* Format: date-time
|
|
317
|
-
* @description Timestamp of last
|
|
317
|
+
* @description Timestamp of last content piece modification.
|
|
318
318
|
*/
|
|
319
319
|
updatedAt: string;
|
|
320
320
|
/**
|
|
321
321
|
* Format: date-time
|
|
322
|
-
* @description Timestamp when the
|
|
322
|
+
* @description Timestamp when the content piece was soft-deleted.
|
|
323
323
|
*/
|
|
324
324
|
deletedAt?: string | null;
|
|
325
325
|
}[];
|
|
@@ -335,6 +335,15 @@ export interface operations {
|
|
|
335
335
|
"text/plain": string;
|
|
336
336
|
};
|
|
337
337
|
};
|
|
338
|
+
/** @description Result not found */
|
|
339
|
+
404: {
|
|
340
|
+
headers: {
|
|
341
|
+
[name: string]: unknown;
|
|
342
|
+
};
|
|
343
|
+
content: {
|
|
344
|
+
"text/plain": string;
|
|
345
|
+
};
|
|
346
|
+
};
|
|
338
347
|
/** @description Internal server error */
|
|
339
348
|
500: {
|
|
340
349
|
headers: {
|
|
@@ -346,7 +355,7 @@ export interface operations {
|
|
|
346
355
|
};
|
|
347
356
|
};
|
|
348
357
|
};
|
|
349
|
-
|
|
358
|
+
insertContentPiece: {
|
|
350
359
|
parameters: {
|
|
351
360
|
query?: never;
|
|
352
361
|
header?: never;
|
|
@@ -358,10 +367,10 @@ export interface operations {
|
|
|
358
367
|
"application/json": {
|
|
359
368
|
/**
|
|
360
369
|
* Format: uuid
|
|
361
|
-
* @description Existing
|
|
370
|
+
* @description Existing content piece ID for updates; ignored on insert.
|
|
362
371
|
*/
|
|
363
372
|
id?: string;
|
|
364
|
-
/** @description Subject of the owning
|
|
373
|
+
/** @description Subject of the owning profile. */
|
|
365
374
|
profile: string;
|
|
366
375
|
/** @description Row number of the content within the owning profile. */
|
|
367
376
|
rowNumber: number;
|
|
@@ -378,7 +387,7 @@ export interface operations {
|
|
|
378
387
|
};
|
|
379
388
|
};
|
|
380
389
|
responses: {
|
|
381
|
-
/** @description
|
|
390
|
+
/** @description Content piece created */
|
|
382
391
|
201: {
|
|
383
392
|
headers: {
|
|
384
393
|
[name: string]: unknown;
|
|
@@ -387,7 +396,7 @@ export interface operations {
|
|
|
387
396
|
"application/json": {
|
|
388
397
|
/**
|
|
389
398
|
* Format: uuid
|
|
390
|
-
* @description Server-generated
|
|
399
|
+
* @description Server-generated content piece ID.
|
|
391
400
|
*/
|
|
392
401
|
id: string;
|
|
393
402
|
/**
|
|
@@ -395,7 +404,7 @@ export interface operations {
|
|
|
395
404
|
* @description Owning organization ID. Derived from the authenticated session, never client-settable.
|
|
396
405
|
*/
|
|
397
406
|
organizationId: string;
|
|
398
|
-
/** @description Subject of the owning
|
|
407
|
+
/** @description Subject of the owning profile. */
|
|
399
408
|
profile: string;
|
|
400
409
|
/** @description Row number of the content within the owning profile. */
|
|
401
410
|
rowNumber: number;
|
|
@@ -405,17 +414,17 @@ export interface operations {
|
|
|
405
414
|
data?: Record<string, never>;
|
|
406
415
|
/**
|
|
407
416
|
* Format: date-time
|
|
408
|
-
* @description Timestamp of
|
|
417
|
+
* @description Timestamp of content piece creation.
|
|
409
418
|
*/
|
|
410
419
|
createdAt: string;
|
|
411
420
|
/**
|
|
412
421
|
* Format: date-time
|
|
413
|
-
* @description Timestamp of last
|
|
422
|
+
* @description Timestamp of last content piece modification.
|
|
414
423
|
*/
|
|
415
424
|
updatedAt: string;
|
|
416
425
|
/**
|
|
417
426
|
* Format: date-time
|
|
418
|
-
* @description Timestamp when the
|
|
427
|
+
* @description Timestamp when the content piece was soft-deleted.
|
|
419
428
|
*/
|
|
420
429
|
deletedAt?: string | null;
|
|
421
430
|
};
|
|
@@ -439,6 +448,15 @@ export interface operations {
|
|
|
439
448
|
"text/plain": string;
|
|
440
449
|
};
|
|
441
450
|
};
|
|
451
|
+
/** @description Result not found */
|
|
452
|
+
404: {
|
|
453
|
+
headers: {
|
|
454
|
+
[name: string]: unknown;
|
|
455
|
+
};
|
|
456
|
+
content: {
|
|
457
|
+
"text/plain": string;
|
|
458
|
+
};
|
|
459
|
+
};
|
|
442
460
|
/** @description Internal server error */
|
|
443
461
|
500: {
|
|
444
462
|
headers: {
|
|
@@ -450,19 +468,19 @@ export interface operations {
|
|
|
450
468
|
};
|
|
451
469
|
};
|
|
452
470
|
};
|
|
453
|
-
|
|
471
|
+
getContentPiece: {
|
|
454
472
|
parameters: {
|
|
455
473
|
query?: never;
|
|
456
474
|
header?: never;
|
|
457
475
|
path: {
|
|
458
|
-
/** @description
|
|
459
|
-
|
|
476
|
+
/** @description Content piece ID */
|
|
477
|
+
contentPieceId: string;
|
|
460
478
|
};
|
|
461
479
|
cookie?: never;
|
|
462
480
|
};
|
|
463
481
|
requestBody?: never;
|
|
464
482
|
responses: {
|
|
465
|
-
/** @description
|
|
483
|
+
/** @description Content piece response */
|
|
466
484
|
200: {
|
|
467
485
|
headers: {
|
|
468
486
|
[name: string]: unknown;
|
|
@@ -471,7 +489,7 @@ export interface operations {
|
|
|
471
489
|
"application/json": {
|
|
472
490
|
/**
|
|
473
491
|
* Format: uuid
|
|
474
|
-
* @description Server-generated
|
|
492
|
+
* @description Server-generated content piece ID.
|
|
475
493
|
*/
|
|
476
494
|
id: string;
|
|
477
495
|
/**
|
|
@@ -479,7 +497,7 @@ export interface operations {
|
|
|
479
497
|
* @description Owning organization ID. Derived from the authenticated session, never client-settable.
|
|
480
498
|
*/
|
|
481
499
|
organizationId: string;
|
|
482
|
-
/** @description Subject of the owning
|
|
500
|
+
/** @description Subject of the owning profile. */
|
|
483
501
|
profile: string;
|
|
484
502
|
/** @description Row number of the content within the owning profile. */
|
|
485
503
|
rowNumber: number;
|
|
@@ -489,17 +507,17 @@ export interface operations {
|
|
|
489
507
|
data?: Record<string, never>;
|
|
490
508
|
/**
|
|
491
509
|
* Format: date-time
|
|
492
|
-
* @description Timestamp of
|
|
510
|
+
* @description Timestamp of content piece creation.
|
|
493
511
|
*/
|
|
494
512
|
createdAt: string;
|
|
495
513
|
/**
|
|
496
514
|
* Format: date-time
|
|
497
|
-
* @description Timestamp of last
|
|
515
|
+
* @description Timestamp of last content piece modification.
|
|
498
516
|
*/
|
|
499
517
|
updatedAt: string;
|
|
500
518
|
/**
|
|
501
519
|
* Format: date-time
|
|
502
|
-
* @description Timestamp when the
|
|
520
|
+
* @description Timestamp when the content piece was soft-deleted.
|
|
503
521
|
*/
|
|
504
522
|
deletedAt?: string | null;
|
|
505
523
|
};
|
|
@@ -543,13 +561,13 @@ export interface operations {
|
|
|
543
561
|
};
|
|
544
562
|
};
|
|
545
563
|
};
|
|
546
|
-
|
|
564
|
+
updateContentPiece: {
|
|
547
565
|
parameters: {
|
|
548
566
|
query?: never;
|
|
549
567
|
header?: never;
|
|
550
568
|
path: {
|
|
551
|
-
/** @description
|
|
552
|
-
|
|
569
|
+
/** @description Content piece ID */
|
|
570
|
+
contentPieceId: string;
|
|
553
571
|
};
|
|
554
572
|
cookie?: never;
|
|
555
573
|
};
|
|
@@ -558,10 +576,10 @@ export interface operations {
|
|
|
558
576
|
"application/json": {
|
|
559
577
|
/**
|
|
560
578
|
* Format: uuid
|
|
561
|
-
* @description Existing
|
|
579
|
+
* @description Existing content piece ID for updates; ignored on insert.
|
|
562
580
|
*/
|
|
563
581
|
id?: string;
|
|
564
|
-
/** @description Subject of the owning
|
|
582
|
+
/** @description Subject of the owning profile. */
|
|
565
583
|
profile: string;
|
|
566
584
|
/** @description Row number of the content within the owning profile. */
|
|
567
585
|
rowNumber: number;
|
|
@@ -578,7 +596,7 @@ export interface operations {
|
|
|
578
596
|
};
|
|
579
597
|
};
|
|
580
598
|
responses: {
|
|
581
|
-
/** @description
|
|
599
|
+
/** @description Content piece updated */
|
|
582
600
|
200: {
|
|
583
601
|
headers: {
|
|
584
602
|
[name: string]: unknown;
|
|
@@ -587,7 +605,7 @@ export interface operations {
|
|
|
587
605
|
"application/json": {
|
|
588
606
|
/**
|
|
589
607
|
* Format: uuid
|
|
590
|
-
* @description Server-generated
|
|
608
|
+
* @description Server-generated content piece ID.
|
|
591
609
|
*/
|
|
592
610
|
id: string;
|
|
593
611
|
/**
|
|
@@ -595,7 +613,7 @@ export interface operations {
|
|
|
595
613
|
* @description Owning organization ID. Derived from the authenticated session, never client-settable.
|
|
596
614
|
*/
|
|
597
615
|
organizationId: string;
|
|
598
|
-
/** @description Subject of the owning
|
|
616
|
+
/** @description Subject of the owning profile. */
|
|
599
617
|
profile: string;
|
|
600
618
|
/** @description Row number of the content within the owning profile. */
|
|
601
619
|
rowNumber: number;
|
|
@@ -605,17 +623,17 @@ export interface operations {
|
|
|
605
623
|
data?: Record<string, never>;
|
|
606
624
|
/**
|
|
607
625
|
* Format: date-time
|
|
608
|
-
* @description Timestamp of
|
|
626
|
+
* @description Timestamp of content piece creation.
|
|
609
627
|
*/
|
|
610
628
|
createdAt: string;
|
|
611
629
|
/**
|
|
612
630
|
* Format: date-time
|
|
613
|
-
* @description Timestamp of last
|
|
631
|
+
* @description Timestamp of last content piece modification.
|
|
614
632
|
*/
|
|
615
633
|
updatedAt: string;
|
|
616
634
|
/**
|
|
617
635
|
* Format: date-time
|
|
618
|
-
* @description Timestamp when the
|
|
636
|
+
* @description Timestamp when the content piece was soft-deleted.
|
|
619
637
|
*/
|
|
620
638
|
deletedAt?: string | null;
|
|
621
639
|
};
|
|
@@ -668,19 +686,19 @@ export interface operations {
|
|
|
668
686
|
};
|
|
669
687
|
};
|
|
670
688
|
};
|
|
671
|
-
|
|
689
|
+
deleteContentPiece: {
|
|
672
690
|
parameters: {
|
|
673
691
|
query?: never;
|
|
674
692
|
header?: never;
|
|
675
693
|
path: {
|
|
676
|
-
/** @description
|
|
677
|
-
|
|
694
|
+
/** @description Content piece ID */
|
|
695
|
+
contentPieceId: string;
|
|
678
696
|
};
|
|
679
697
|
cookie?: never;
|
|
680
698
|
};
|
|
681
699
|
requestBody?: never;
|
|
682
700
|
responses: {
|
|
683
|
-
/** @description
|
|
701
|
+
/** @description Content piece deleted */
|
|
684
702
|
204: {
|
|
685
703
|
headers: {
|
|
686
704
|
[name: string]: unknown;
|
|
@@ -0,0 +1,48 @@
|
|
|
1
|
+
'use strict';var e={openapi:"3.0.0",info:{title:"ContentPiece",description:`OpenAPI schema for content pieces - fingerprinted content
|
|
2
|
+
values keyed by owning profile and row number, with conditional
|
|
3
|
+
updates.
|
|
4
|
+
Organization scope: every operation acts only in the organization the
|
|
5
|
+
session resolved to (X-Current-Orgid, then the user's selected
|
|
6
|
+
organization), and only when the caller is a live member of it. A
|
|
7
|
+
caller who is not a member receives the same 404 as an unknown id, so
|
|
8
|
+
the existence of another organization's rows is never disclosed.
|
|
9
|
+
`,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:"contentPieces",description:"Operations related to content pieces."}],paths:{"/api/content/pieces":{get:{"x-internal":["cloud"],tags:["contentPieces"],summary:"List content pieces",operationId:"listContentPieces",description:"Returns a paginated list of content pieces in the organization of the authenticated session.",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 owning profile subject.",schema:{type:"string"}}],responses:{200:{description:"Content piece page",content:{"application/json":{schema:{type:"object",description:"Paginated collection of content pieces.",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},contentPieces:{type:"array",items:{"x-go-type":"ContentPiece",$schema:"http://json-schema.org/draft-07/schema#",title:"Content Piece Schema",description:`Server-returned content piece as persisted by meshery-cloud.
|
|
10
|
+
Content pieces carry a row number and a server-computed fingerprint over
|
|
11
|
+
their canonical values; updates are conditional on the fingerprint the
|
|
12
|
+
writer read, so stale writes are refused rather than silently applied.
|
|
13
|
+
`,type:"object",additionalProperties:false,required:["id","organizationId","profile","rowNumber","fingerprint","createdAt","updatedAt"],properties:{id:{description:"Server-generated content piece 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 owning profile.",minLength:1,maxLength:255,"x-oapi-codegen-extra-tags":{db:"profile"},"x-order":3},rowNumber:{type:"integer",description:"Row number of the content within the owning profile.",minimum:0,"x-oapi-codegen-extra-tags":{db:"row_number"},"x-order":4},fingerprint:{type:"string",description:"Hex digest over the canonical content values, typed so null, empty string, zero and false differ. Server-computed; used for conditional updates.",minLength:1,maxLength:255,"x-oapi-codegen-extra-tags":{db:"fingerprint"},"x-order":5},data:{type:"object",description:"Content values, stored as a JSON blob.","x-go-type":"core.Map","x-go-type-import":{path:"github.com/meshery/schemas/models/core",name:"core"},"x-go-type-skip-optional-pointer":true,"x-oapi-codegen-extra-tags":{db:"data"},"x-order":6},createdAt:{description:"Timestamp of content piece creation.","x-oapi-codegen-extra-tags":{db:"created_at"},"x-order":7,type:"string",format:"date-time","x-go-type-skip-optional-pointer":true},updatedAt:{description:"Timestamp of last content piece modification.","x-oapi-codegen-extra-tags":{db:"updated_at"},"x-order":8,type:"string",format:"date-time","x-go-type-skip-optional-pointer":true},deletedAt:{type:"string",format:"date-time",description:"Timestamp when the content piece was soft-deleted.",nullable:true,"x-go-type":"core.NullTime","x-go-type-import":{path:"github.com/meshery/schemas/models/core",name:"core"},"x-oapi-codegen-extra-tags":{db:"deleted_at",json:"deletedAt,omitempty"},"x-order":9}}},description:"Content pieces included on this page of results."}}}}}},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"}}}}}},post:{"x-internal":["cloud"],tags:["contentPieces"],summary:"Insert a content piece",operationId:"insertContentPiece",description:"Inserts a new content piece. Insert-only: any supplied\n`id` and `expectedFingerprint` are ignored; existing rows change\nonly through the conditional `updateContentPiece`. The\n`fingerprint` is server-computed.\n",requestBody:{required:true,content:{"application/json":{schema:{type:"object",description:"Payload for inserting or updating a content piece.\nContains only client-settable fields; the owning\n`organizationId` (derived from the authenticated session), the\nserver-computed `fingerprint` and the server-generated\n`createdAt` / `updatedAt` timestamps are intentionally excluded.\n",required:["profile","rowNumber"],properties:{id:{description:"Existing content piece ID for updates; ignored on insert.","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 owning profile.",minLength:1,maxLength:255},rowNumber:{type:"integer",description:"Row number of the content within the owning profile.",minimum:0},data:{type:"object",description:"Content values, stored as a JSON blob.","x-go-type":"core.Map","x-go-type-import":{path:"github.com/meshery/schemas/models/core",name:"core"},"x-go-type-skip-optional-pointer":true},expectedFingerprint:{type:"string",description:`Optimistic-concurrency precondition for update: when supplied,
|
|
14
|
+
the update applies only when the stored fingerprint still
|
|
15
|
+
matches, and is refused with a 409 otherwise. Ignored on
|
|
16
|
+
insert.
|
|
17
|
+
`,maxLength:255}}}}}},responses:{201:{description:"Content piece created",content:{"application/json":{schema:{$schema:"http://json-schema.org/draft-07/schema#",title:"Content Piece Schema",description:`Server-returned content piece as persisted by meshery-cloud.
|
|
18
|
+
Content pieces carry a row number and a server-computed fingerprint over
|
|
19
|
+
their canonical values; updates are conditional on the fingerprint the
|
|
20
|
+
writer read, so stale writes are refused rather than silently applied.
|
|
21
|
+
`,type:"object",additionalProperties:false,required:["id","organizationId","profile","rowNumber","fingerprint","createdAt","updatedAt"],properties:{id:{description:"Server-generated content piece 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 owning profile.",minLength:1,maxLength:255,"x-oapi-codegen-extra-tags":{db:"profile"},"x-order":3},rowNumber:{type:"integer",description:"Row number of the content within the owning profile.",minimum:0,"x-oapi-codegen-extra-tags":{db:"row_number"},"x-order":4},fingerprint:{type:"string",description:"Hex digest over the canonical content values, typed so null, empty string, zero and false differ. Server-computed; used for conditional updates.",minLength:1,maxLength:255,"x-oapi-codegen-extra-tags":{db:"fingerprint"},"x-order":5},data:{type:"object",description:"Content values, stored as a JSON blob.","x-go-type":"core.Map","x-go-type-import":{path:"github.com/meshery/schemas/models/core",name:"core"},"x-go-type-skip-optional-pointer":true,"x-oapi-codegen-extra-tags":{db:"data"},"x-order":6},createdAt:{description:"Timestamp of content piece creation.","x-oapi-codegen-extra-tags":{db:"created_at"},"x-order":7,type:"string",format:"date-time","x-go-type-skip-optional-pointer":true},updatedAt:{description:"Timestamp of last content piece modification.","x-oapi-codegen-extra-tags":{db:"updated_at"},"x-order":8,type:"string",format:"date-time","x-go-type-skip-optional-pointer":true},deletedAt:{type:"string",format:"date-time",description:"Timestamp when the content piece was soft-deleted.",nullable:true,"x-go-type":"core.NullTime","x-go-type-import":{path:"github.com/meshery/schemas/models/core",name:"core"},"x-oapi-codegen-extra-tags":{db:"deleted_at",json:"deletedAt,omitempty"},"x-order":9}}}}}},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"}}}},500:{description:"Internal server error",content:{"text/plain":{schema:{type:"string"}}}}}}},"/api/content/pieces/{contentPieceId}":{get:{"x-internal":["cloud"],tags:["contentPieces"],summary:"Get a content piece by ID",operationId:"getContentPiece",parameters:[{name:"contentPieceId",in:"path",description:"Content piece 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:{200:{description:"Content piece response",content:{"application/json":{schema:{$schema:"http://json-schema.org/draft-07/schema#",title:"Content Piece Schema",description:`Server-returned content piece as persisted by meshery-cloud.
|
|
22
|
+
Content pieces carry a row number and a server-computed fingerprint over
|
|
23
|
+
their canonical values; updates are conditional on the fingerprint the
|
|
24
|
+
writer read, so stale writes are refused rather than silently applied.
|
|
25
|
+
`,type:"object",additionalProperties:false,required:["id","organizationId","profile","rowNumber","fingerprint","createdAt","updatedAt"],properties:{id:{description:"Server-generated content piece 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 owning profile.",minLength:1,maxLength:255,"x-oapi-codegen-extra-tags":{db:"profile"},"x-order":3},rowNumber:{type:"integer",description:"Row number of the content within the owning profile.",minimum:0,"x-oapi-codegen-extra-tags":{db:"row_number"},"x-order":4},fingerprint:{type:"string",description:"Hex digest over the canonical content values, typed so null, empty string, zero and false differ. Server-computed; used for conditional updates.",minLength:1,maxLength:255,"x-oapi-codegen-extra-tags":{db:"fingerprint"},"x-order":5},data:{type:"object",description:"Content values, stored as a JSON blob.","x-go-type":"core.Map","x-go-type-import":{path:"github.com/meshery/schemas/models/core",name:"core"},"x-go-type-skip-optional-pointer":true,"x-oapi-codegen-extra-tags":{db:"data"},"x-order":6},createdAt:{description:"Timestamp of content piece creation.","x-oapi-codegen-extra-tags":{db:"created_at"},"x-order":7,type:"string",format:"date-time","x-go-type-skip-optional-pointer":true},updatedAt:{description:"Timestamp of last content piece modification.","x-oapi-codegen-extra-tags":{db:"updated_at"},"x-order":8,type:"string",format:"date-time","x-go-type-skip-optional-pointer":true},deletedAt:{type:"string",format:"date-time",description:"Timestamp when the content piece was soft-deleted.",nullable:true,"x-go-type":"core.NullTime","x-go-type-import":{path:"github.com/meshery/schemas/models/core",name:"core"},"x-oapi-codegen-extra-tags":{db:"deleted_at",json:"deletedAt,omitempty"},"x-order":9}}}}}},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"}}}},500:{description:"Internal server error",content:{"text/plain":{schema:{type:"string"}}}}}},put:{"x-internal":["cloud"],tags:["contentPieces"],summary:"Update a content piece",operationId:"updateContentPiece",description:`Conditionally updates the content piece. When
|
|
26
|
+
\`expectedFingerprint\` is supplied and stale, the update is
|
|
27
|
+
refused with a 409.
|
|
28
|
+
`,parameters:[{name:"contentPieceId",in:"path",description:"Content piece 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"}}}],requestBody:{required:true,content:{"application/json":{schema:{type:"object",description:"Payload for inserting or updating a content piece.\nContains only client-settable fields; the owning\n`organizationId` (derived from the authenticated session), the\nserver-computed `fingerprint` and the server-generated\n`createdAt` / `updatedAt` timestamps are intentionally excluded.\n",required:["profile","rowNumber"],properties:{id:{description:"Existing content piece ID for updates; ignored on insert.","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 owning profile.",minLength:1,maxLength:255},rowNumber:{type:"integer",description:"Row number of the content within the owning profile.",minimum:0},data:{type:"object",description:"Content values, stored as a JSON blob.","x-go-type":"core.Map","x-go-type-import":{path:"github.com/meshery/schemas/models/core",name:"core"},"x-go-type-skip-optional-pointer":true},expectedFingerprint:{type:"string",description:`Optimistic-concurrency precondition for update: when supplied,
|
|
29
|
+
the update applies only when the stored fingerprint still
|
|
30
|
+
matches, and is refused with a 409 otherwise. Ignored on
|
|
31
|
+
insert.
|
|
32
|
+
`,maxLength:255}}}}}},responses:{200:{description:"Content piece updated",content:{"application/json":{schema:{$schema:"http://json-schema.org/draft-07/schema#",title:"Content Piece Schema",description:`Server-returned content piece as persisted by meshery-cloud.
|
|
33
|
+
Content pieces carry a row number and a server-computed fingerprint over
|
|
34
|
+
their canonical values; updates are conditional on the fingerprint the
|
|
35
|
+
writer read, so stale writes are refused rather than silently applied.
|
|
36
|
+
`,type:"object",additionalProperties:false,required:["id","organizationId","profile","rowNumber","fingerprint","createdAt","updatedAt"],properties:{id:{description:"Server-generated content piece 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 owning profile.",minLength:1,maxLength:255,"x-oapi-codegen-extra-tags":{db:"profile"},"x-order":3},rowNumber:{type:"integer",description:"Row number of the content within the owning profile.",minimum:0,"x-oapi-codegen-extra-tags":{db:"row_number"},"x-order":4},fingerprint:{type:"string",description:"Hex digest over the canonical content values, typed so null, empty string, zero and false differ. Server-computed; used for conditional updates.",minLength:1,maxLength:255,"x-oapi-codegen-extra-tags":{db:"fingerprint"},"x-order":5},data:{type:"object",description:"Content values, stored as a JSON blob.","x-go-type":"core.Map","x-go-type-import":{path:"github.com/meshery/schemas/models/core",name:"core"},"x-go-type-skip-optional-pointer":true,"x-oapi-codegen-extra-tags":{db:"data"},"x-order":6},createdAt:{description:"Timestamp of content piece creation.","x-oapi-codegen-extra-tags":{db:"created_at"},"x-order":7,type:"string",format:"date-time","x-go-type-skip-optional-pointer":true},updatedAt:{description:"Timestamp of last content piece modification.","x-oapi-codegen-extra-tags":{db:"updated_at"},"x-order":8,type:"string",format:"date-time","x-go-type-skip-optional-pointer":true},deletedAt:{type:"string",format:"date-time",description:"Timestamp when the content piece was soft-deleted.",nullable:true,"x-go-type":"core.NullTime","x-go-type-import":{path:"github.com/meshery/schemas/models/core",name:"core"},"x-oapi-codegen-extra-tags":{db:"deleted_at",json:"deletedAt,omitempty"},"x-order":9}}}}}},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 stale expectedFingerprint precondition no longer matches the stored content fingerprint",content:{"text/plain":{schema:{type:"string"}}}},500:{description:"Internal server error",content:{"text/plain":{schema:{type:"string"}}}}}},delete:{"x-internal":["cloud"],tags:["contentPieces"],summary:"Delete a content piece",operationId:"deleteContentPiece",description:"Soft-deletes the content piece.",parameters:[{name:"contentPieceId",in:"path",description:"Content piece 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:"Content piece deleted"},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 stale expectedFingerprint precondition no longer matches the stored content fingerprint",content:{"text/plain":{schema:{type:"string"}}}},500:{description:"Internal server error",content:{"text/plain":{schema:{type:"string"}}}}},parameters:{contentPieceId:{name:"contentPieceId",in:"path",description:"Content piece 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:{ContentPiece:{$schema:"http://json-schema.org/draft-07/schema#",title:"Content Piece Schema",description:`Server-returned content piece as persisted by meshery-cloud.
|
|
37
|
+
Content pieces carry a row number and a server-computed fingerprint over
|
|
38
|
+
their canonical values; updates are conditional on the fingerprint the
|
|
39
|
+
writer read, so stale writes are refused rather than silently applied.
|
|
40
|
+
`,type:"object",additionalProperties:false,required:["id","organizationId","profile","rowNumber","fingerprint","createdAt","updatedAt"],properties:{id:{description:"Server-generated content piece 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 owning profile.",minLength:1,maxLength:255,"x-oapi-codegen-extra-tags":{db:"profile"},"x-order":3},rowNumber:{type:"integer",description:"Row number of the content within the owning profile.",minimum:0,"x-oapi-codegen-extra-tags":{db:"row_number"},"x-order":4},fingerprint:{type:"string",description:"Hex digest over the canonical content values, typed so null, empty string, zero and false differ. Server-computed; used for conditional updates.",minLength:1,maxLength:255,"x-oapi-codegen-extra-tags":{db:"fingerprint"},"x-order":5},data:{type:"object",description:"Content values, stored as a JSON blob.","x-go-type":"core.Map","x-go-type-import":{path:"github.com/meshery/schemas/models/core",name:"core"},"x-go-type-skip-optional-pointer":true,"x-oapi-codegen-extra-tags":{db:"data"},"x-order":6},createdAt:{description:"Timestamp of content piece creation.","x-oapi-codegen-extra-tags":{db:"created_at"},"x-order":7,type:"string",format:"date-time","x-go-type-skip-optional-pointer":true},updatedAt:{description:"Timestamp of last content piece modification.","x-oapi-codegen-extra-tags":{db:"updated_at"},"x-order":8,type:"string",format:"date-time","x-go-type-skip-optional-pointer":true},deletedAt:{type:"string",format:"date-time",description:"Timestamp when the content piece was soft-deleted.",nullable:true,"x-go-type":"core.NullTime","x-go-type-import":{path:"github.com/meshery/schemas/models/core",name:"core"},"x-oapi-codegen-extra-tags":{db:"deleted_at",json:"deletedAt,omitempty"},"x-order":9}}},ContentPiecePayload:{type:"object",description:"Payload for inserting or updating a content piece.\nContains only client-settable fields; the owning\n`organizationId` (derived from the authenticated session), the\nserver-computed `fingerprint` and the server-generated\n`createdAt` / `updatedAt` timestamps are intentionally excluded.\n",required:["profile","rowNumber"],properties:{id:{description:"Existing content piece ID for updates; ignored on insert.","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 owning profile.",minLength:1,maxLength:255},rowNumber:{type:"integer",description:"Row number of the content within the owning profile.",minimum:0},data:{type:"object",description:"Content values, stored as a JSON blob.","x-go-type":"core.Map","x-go-type-import":{path:"github.com/meshery/schemas/models/core",name:"core"},"x-go-type-skip-optional-pointer":true},expectedFingerprint:{type:"string",description:`Optimistic-concurrency precondition for update: when supplied,
|
|
41
|
+
the update applies only when the stored fingerprint still
|
|
42
|
+
matches, and is refused with a 409 otherwise. Ignored on
|
|
43
|
+
insert.
|
|
44
|
+
`,maxLength:255}}},ContentPiecePage:{type:"object",description:"Paginated collection of content pieces.",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},contentPieces:{type:"array",items:{"x-go-type":"ContentPiece",$schema:"http://json-schema.org/draft-07/schema#",title:"Content Piece Schema",description:`Server-returned content piece as persisted by meshery-cloud.
|
|
45
|
+
Content pieces carry a row number and a server-computed fingerprint over
|
|
46
|
+
their canonical values; updates are conditional on the fingerprint the
|
|
47
|
+
writer read, so stale writes are refused rather than silently applied.
|
|
48
|
+
`,type:"object",additionalProperties:false,required:["id","organizationId","profile","rowNumber","fingerprint","createdAt","updatedAt"],properties:{id:{description:"Server-generated content piece 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 owning profile.",minLength:1,maxLength:255,"x-oapi-codegen-extra-tags":{db:"profile"},"x-order":3},rowNumber:{type:"integer",description:"Row number of the content within the owning profile.",minimum:0,"x-oapi-codegen-extra-tags":{db:"row_number"},"x-order":4},fingerprint:{type:"string",description:"Hex digest over the canonical content values, typed so null, empty string, zero and false differ. Server-computed; used for conditional updates.",minLength:1,maxLength:255,"x-oapi-codegen-extra-tags":{db:"fingerprint"},"x-order":5},data:{type:"object",description:"Content values, stored as a JSON blob.","x-go-type":"core.Map","x-go-type-import":{path:"github.com/meshery/schemas/models/core",name:"core"},"x-go-type-skip-optional-pointer":true,"x-oapi-codegen-extra-tags":{db:"data"},"x-order":6},createdAt:{description:"Timestamp of content piece creation.","x-oapi-codegen-extra-tags":{db:"created_at"},"x-order":7,type:"string",format:"date-time","x-go-type-skip-optional-pointer":true},updatedAt:{description:"Timestamp of last content piece modification.","x-oapi-codegen-extra-tags":{db:"updated_at"},"x-order":8,type:"string",format:"date-time","x-go-type-skip-optional-pointer":true},deletedAt:{type:"string",format:"date-time",description:"Timestamp when the content piece was soft-deleted.",nullable:true,"x-go-type":"core.NullTime","x-go-type-import":{path:"github.com/meshery/schemas/models/core",name:"core"},"x-oapi-codegen-extra-tags":{db:"deleted_at",json:"deletedAt,omitempty"},"x-order":9}}},description:"Content pieces included on this page of results."}}}}}},t=e;module.exports=t;
|