@meshery/schemas 1.3.108 → 1.3.109
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 +8624 -4661
- package/dist/cloudApi.d.ts +8624 -4661
- package/dist/cloudApi.js +1 -1
- package/dist/cloudApi.mjs +1 -1
- package/dist/constructs/v1beta3/content_item/ContentItem.d.ts +682 -33
- package/dist/constructs/v1beta3/content_item/ContentItemSchema.js +215 -22
- package/dist/constructs/v1beta3/content_item/ContentItemSchema.mjs +215 -22
- package/dist/constructs/v1beta3/media_asset/MediaAsset.d.ts +2322 -0
- package/dist/constructs/v1beta3/media_asset/MediaAssetSchema.d.ts +2 -0
- package/dist/constructs/v1beta3/media_asset/MediaAssetSchema.js +61 -0
- package/dist/constructs/v1beta3/media_asset/MediaAssetSchema.mjs +61 -0
- package/dist/constructs/v1beta3/mention_alias/MentionAlias.d.ts +678 -0
- package/dist/constructs/v1beta3/mention_alias/MentionAlias.js +1 -0
- package/dist/constructs/v1beta3/mention_alias/MentionAlias.mjs +0 -0
- package/dist/constructs/v1beta3/mention_alias/MentionAliasSchema.d.ts +2 -0
- package/dist/constructs/v1beta3/mention_alias/MentionAliasSchema.js +75 -0
- package/dist/constructs/v1beta3/mention_alias/MentionAliasSchema.mjs +75 -0
- package/dist/constructs/v1beta3/{risk_profile/RiskProfile.d.ts → posture/Posture.d.ts} +7 -7
- package/dist/constructs/v1beta3/posture/Posture.js +1 -0
- package/dist/constructs/v1beta3/posture/Posture.mjs +0 -0
- package/dist/constructs/v1beta3/posture/PostureSchema.d.ts +2 -0
- package/dist/constructs/v1beta3/posture/PostureSchema.js +22 -0
- package/dist/constructs/v1beta3/posture/PostureSchema.mjs +22 -0
- package/dist/constructs/v1beta3/schedule/Schedule.d.ts +41 -41
- package/dist/constructs/v1beta3/schedule/ScheduleSchema.js +23 -23
- package/dist/constructs/v1beta3/schedule/ScheduleSchema.mjs +23 -23
- package/dist/index.d.mts +23 -1
- package/dist/index.d.ts +23 -1
- package/dist/index.js +2 -2
- package/dist/index.mjs +2 -2
- package/package.json +1 -1
- package/dist/constructs/v1beta3/risk_profile/RiskProfileSchema.d.ts +0 -2
- package/dist/constructs/v1beta3/risk_profile/RiskProfileSchema.js +0 -22
- package/dist/constructs/v1beta3/risk_profile/RiskProfileSchema.mjs +0 -22
- /package/dist/constructs/v1beta3/{risk_profile/RiskProfile.js → media_asset/MediaAsset.js} +0 -0
- /package/dist/constructs/v1beta3/{risk_profile/RiskProfile.mjs → media_asset/MediaAsset.mjs} +0 -0
|
@@ -17,7 +17,10 @@ export interface paths {
|
|
|
17
17
|
* organization of the authenticated session, ordered by `rowNumber`
|
|
18
18
|
* unless `order` names another column (`rowNumber`, `createdAt`,
|
|
19
19
|
* `updatedAt`). `search` matches the profile or the content values,
|
|
20
|
-
* case-insensitively.
|
|
20
|
+
* case-insensitively. `threadId` returns one whole thread: the root
|
|
21
|
+
* item it names and every live item whose `threadId` names it,
|
|
22
|
+
* ordered by `threadIndex` (the root first) unless `order` names
|
|
23
|
+
* another column.
|
|
21
24
|
*/
|
|
22
25
|
get: operations["listContentItems"];
|
|
23
26
|
put?: never;
|
|
@@ -38,6 +41,27 @@ export interface paths {
|
|
|
38
41
|
* (an explicit `rowNumber` of 0 is still accepted). A supplied
|
|
39
42
|
* `rowNumber` that another live content item of the organization
|
|
40
43
|
* already holds refuses the insert with a 409.
|
|
44
|
+
* A `rulesOfEngagement` outside its schema (an unknown preset or
|
|
45
|
+
* dial, or a value out of range) is refused with a 400, on insert
|
|
46
|
+
* and on update alike.
|
|
47
|
+
* Each `mediaAssetIds` entry must name a media asset of the session
|
|
48
|
+
* organization, else 400 (the same 400 for a missing, another
|
|
49
|
+
* organization's and a deleted asset), on insert and on update alike.
|
|
50
|
+
* The server does not require the asset to be ready at write time:
|
|
51
|
+
* deleting an asset does not check content item references, and such
|
|
52
|
+
* an item is refused by name when it posts, so the posting client
|
|
53
|
+
* checks readiness.
|
|
54
|
+
* Thread fields are checked against the organization's live content
|
|
55
|
+
* items in the same transaction as the insert, and a violation is
|
|
56
|
+
* refused with a 400: `threadId` must name a live item of the
|
|
57
|
+
* organization that is not itself part of a thread; `replyToId`
|
|
58
|
+
* requires `threadId` and must name that root or a live item of the
|
|
59
|
+
* same thread; `threadIndex` is required exactly when `threadId` is
|
|
60
|
+
* given and must exceed the position of the item `replyToId` names
|
|
61
|
+
* (the root counts as 0). An item of another organization, a deleted
|
|
62
|
+
* item and a missing one receive the same 400. A `threadIndex` that
|
|
63
|
+
* another live item of the same thread already holds refuses the
|
|
64
|
+
* insert with a 409.
|
|
41
65
|
*/
|
|
42
66
|
post: operations["insertContentItem"];
|
|
43
67
|
delete?: never;
|
|
@@ -62,6 +86,11 @@ export interface paths {
|
|
|
62
86
|
* refused with a 409, as is an update that would move the item
|
|
63
87
|
* onto a `rowNumber` another live content item of the organization
|
|
64
88
|
* holds. An omitted `rowNumber` keeps the stored one.
|
|
89
|
+
* An omitted `rulesOfEngagement` keeps the stored rules and `null`
|
|
90
|
+
* clears them, so a writer that does not know the field never erases
|
|
91
|
+
* it. An omitted `mediaAssetIds` keeps the stored list and `[]`
|
|
92
|
+
* clears it. The thread fields are fixed at insert: omitted, or equal to the
|
|
93
|
+
* stored values, they are kept; any other value is refused with a 400.
|
|
65
94
|
*/
|
|
66
95
|
put: operations["updateContentItem"];
|
|
67
96
|
post?: never;
|
|
@@ -70,7 +99,8 @@ export interface paths {
|
|
|
70
99
|
* @description Soft-deletes the content item. When `expectedFingerprint` is
|
|
71
100
|
* supplied, the delete applies only when the stored fingerprint
|
|
72
101
|
* still matches and is refused with a 409 otherwise; without it the
|
|
73
|
-
* delete is unconditional.
|
|
102
|
+
* delete is unconditional. Deleting an item that other items name in
|
|
103
|
+
* `threadId` or `replyToId` leaves their references as they are.
|
|
74
104
|
*/
|
|
75
105
|
delete: operations["deleteContentItem"];
|
|
76
106
|
options?: never;
|
|
@@ -88,23 +118,26 @@ export interface components {
|
|
|
88
118
|
* Content items carry a row number and a server-computed fingerprint over
|
|
89
119
|
* their canonical values; updates are conditional on the fingerprint the
|
|
90
120
|
* writer read, so stale writes are refused rather than silently applied.
|
|
121
|
+
* An item may carry its own rules of engagement, which can only tighten,
|
|
122
|
+
* and may belong to a thread through `threadId`, `replyToId` and
|
|
123
|
+
* `threadIndex`. See docs/content-item-contract.md.
|
|
91
124
|
*/
|
|
92
125
|
ContentItem: {
|
|
93
126
|
/**
|
|
94
127
|
* Format: uuid
|
|
95
|
-
* @description
|
|
128
|
+
* @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
|
|
96
129
|
*/
|
|
97
130
|
id: string;
|
|
98
131
|
/**
|
|
99
132
|
* Format: uuid
|
|
100
|
-
* @description
|
|
133
|
+
* @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
|
|
101
134
|
*/
|
|
102
135
|
organizationId: string;
|
|
103
136
|
/** @description Subject of the owning profile. */
|
|
104
137
|
profile: string;
|
|
105
138
|
/** @description Row number of the content item, unique across the live content items of the organization. */
|
|
106
139
|
rowNumber: number;
|
|
107
|
-
/** @description Hex digest over the canonical content values, typed so null, empty string, zero and false differ. Server-computed; used for conditional updates. */
|
|
140
|
+
/** @description Hex digest over the canonical content values (`data`, `profile`, `rowNumber` and, when set, `rulesOfEngagement` and `mediaAssetIds`), typed so null, empty string, zero and false differ. An item without them hashes exactly as it did before the fields existed. The thread fields are fixed at insert and are not part of it. Server-computed; used for conditional updates. */
|
|
108
141
|
fingerprint: string;
|
|
109
142
|
/** @description Content values, stored as a JSON blob. */
|
|
110
143
|
data?: Record<string, never>;
|
|
@@ -125,9 +158,61 @@ export interface components {
|
|
|
125
158
|
deletedAt?: string | null;
|
|
126
159
|
/**
|
|
127
160
|
* Format: uuid
|
|
128
|
-
* @description
|
|
161
|
+
* @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
|
|
129
162
|
*/
|
|
130
163
|
createdBy?: string;
|
|
164
|
+
/** @description The item's own rules of engagement, set by the order that wrote it. They can only tighten: the client that runs the item applies the stricter of these and the rules that apply to the item's profile and platform without them, and the warm-up and the pause after a sign-in challenge always apply. The server validates the shape and stores the value; it does not resolve it. Omitted when the item has none, in which case the item runs under the rules that apply without them. */
|
|
165
|
+
rulesOfEngagement?: {
|
|
166
|
+
/**
|
|
167
|
+
* Posture Schema
|
|
168
|
+
* @description The preset the item asks for. It applies only when it is at
|
|
169
|
+
* least as cautious as the preset its profile and platform
|
|
170
|
+
* resolve to.
|
|
171
|
+
* @enum {string}
|
|
172
|
+
*/
|
|
173
|
+
preset: "cautious" | "standard" | "brisk";
|
|
174
|
+
/**
|
|
175
|
+
* @description Dials changed for this item only. Omitted when none were
|
|
176
|
+
* changed; present, the item's rules read as adjusted.
|
|
177
|
+
*/
|
|
178
|
+
dials?: {
|
|
179
|
+
/**
|
|
180
|
+
* @description Typing and interaction pace.
|
|
181
|
+
* @enum {string}
|
|
182
|
+
*/
|
|
183
|
+
pace?: "slow" | "normal" | "fast";
|
|
184
|
+
/** @description Least time, in seconds, between two public actions on one platform for one profile. */
|
|
185
|
+
minDelaySeconds?: number;
|
|
186
|
+
/** @description Local hours with no public actions. */
|
|
187
|
+
quietHours?: {
|
|
188
|
+
/** @description Local hour the window opens. */
|
|
189
|
+
start: number;
|
|
190
|
+
/** @description Local hour the window closes. */
|
|
191
|
+
end: number;
|
|
192
|
+
};
|
|
193
|
+
/**
|
|
194
|
+
* Format: double
|
|
195
|
+
* @description Share of each built-in daily cap the item may use, above 0 and at most 1.
|
|
196
|
+
*/
|
|
197
|
+
capFraction?: number;
|
|
198
|
+
/** @description Whether the item runs without pointer movement. */
|
|
199
|
+
noMouseMove?: boolean;
|
|
200
|
+
};
|
|
201
|
+
};
|
|
202
|
+
/**
|
|
203
|
+
* Format: uuid
|
|
204
|
+
* @description ID of the root item of the thread this item belongs to: the first post of a split thread, or the first transmission of a conversation between profiles. Omitted on a standalone item and on a root itself; a root is the item other items name here. Set on insert only.
|
|
205
|
+
*/
|
|
206
|
+
threadId?: string;
|
|
207
|
+
/**
|
|
208
|
+
* Format: uuid
|
|
209
|
+
* @description ID of the item this item answers directly: the thread root or another item of the same thread. A split thread's part names the part before it; a reply in a conversation between profiles names the transmission above it. Omitted when the item answers nothing. Never set without `threadId`. Set on insert only.
|
|
210
|
+
*/
|
|
211
|
+
replyToId?: string;
|
|
212
|
+
/** @description Position of the item in its thread, counting the root as 0. Present exactly when `threadId` is, unique among the live items of the thread, and greater than the position of the item named by `replyToId`. Set on insert only. */
|
|
213
|
+
threadIndex?: number;
|
|
214
|
+
/** @description The media assets the item posts, in posting order. Ids only, never URLs. Omitted when the item posts no file. */
|
|
215
|
+
mediaAssetIds?: string[];
|
|
131
216
|
};
|
|
132
217
|
/**
|
|
133
218
|
* @description Payload for inserting or updating a content item.
|
|
@@ -139,7 +224,7 @@ export interface components {
|
|
|
139
224
|
ContentItemPayload: {
|
|
140
225
|
/**
|
|
141
226
|
* Format: uuid
|
|
142
|
-
* @description
|
|
227
|
+
* @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
|
|
143
228
|
*/
|
|
144
229
|
id?: string;
|
|
145
230
|
/** @description Subject of the owning profile. */
|
|
@@ -160,6 +245,162 @@ export interface components {
|
|
|
160
245
|
* insert.
|
|
161
246
|
*/
|
|
162
247
|
expectedFingerprint?: string;
|
|
248
|
+
/**
|
|
249
|
+
* @description The item's own rules of engagement, which can only tighten the
|
|
250
|
+
* rules its profile and platform run under. Omitted on insert, the
|
|
251
|
+
* item has none; omitted on update, the stored rules are kept;
|
|
252
|
+
* `null` on update clears them.
|
|
253
|
+
*/
|
|
254
|
+
rulesOfEngagement?: {
|
|
255
|
+
/**
|
|
256
|
+
* Posture Schema
|
|
257
|
+
* @description The preset the item asks for. It applies only when it is at
|
|
258
|
+
* least as cautious as the preset its profile and platform
|
|
259
|
+
* resolve to.
|
|
260
|
+
* @enum {string}
|
|
261
|
+
*/
|
|
262
|
+
preset: "cautious" | "standard" | "brisk";
|
|
263
|
+
/**
|
|
264
|
+
* @description Dials changed for this item only. Omitted when none were
|
|
265
|
+
* changed; present, the item's rules read as adjusted.
|
|
266
|
+
*/
|
|
267
|
+
dials?: {
|
|
268
|
+
/**
|
|
269
|
+
* @description Typing and interaction pace.
|
|
270
|
+
* @enum {string}
|
|
271
|
+
*/
|
|
272
|
+
pace?: "slow" | "normal" | "fast";
|
|
273
|
+
/** @description Least time, in seconds, between two public actions on one platform for one profile. */
|
|
274
|
+
minDelaySeconds?: number;
|
|
275
|
+
/** @description Local hours with no public actions. */
|
|
276
|
+
quietHours?: {
|
|
277
|
+
/** @description Local hour the window opens. */
|
|
278
|
+
start: number;
|
|
279
|
+
/** @description Local hour the window closes. */
|
|
280
|
+
end: number;
|
|
281
|
+
};
|
|
282
|
+
/**
|
|
283
|
+
* Format: double
|
|
284
|
+
* @description Share of each built-in daily cap the item may use, above 0 and at most 1.
|
|
285
|
+
*/
|
|
286
|
+
capFraction?: number;
|
|
287
|
+
/** @description Whether the item runs without pointer movement. */
|
|
288
|
+
noMouseMove?: boolean;
|
|
289
|
+
};
|
|
290
|
+
} | null;
|
|
291
|
+
/**
|
|
292
|
+
* Format: uuid
|
|
293
|
+
* @description ID of the thread's root item. Read on insert; on update it must
|
|
294
|
+
* be omitted or equal the stored value.
|
|
295
|
+
*/
|
|
296
|
+
threadId?: string;
|
|
297
|
+
/**
|
|
298
|
+
* Format: uuid
|
|
299
|
+
* @description ID of the item this item answers directly: the root named by
|
|
300
|
+
* `threadId` or an item of the same thread. Requires `threadId`.
|
|
301
|
+
* Read on insert; on update it must be omitted or equal the stored
|
|
302
|
+
* value.
|
|
303
|
+
*/
|
|
304
|
+
replyToId?: string;
|
|
305
|
+
/**
|
|
306
|
+
* @description Position of the item in its thread, the root counting as 0.
|
|
307
|
+
* Required exactly when `threadId` is given. Read on insert; on
|
|
308
|
+
* update it must be omitted or equal the stored value.
|
|
309
|
+
*/
|
|
310
|
+
threadIndex?: number;
|
|
311
|
+
/**
|
|
312
|
+
* @description The media assets the item posts, in posting order. Omitted on
|
|
313
|
+
* insert means none; omitted on update keeps the stored list (old
|
|
314
|
+
* clients send the whole item without it); an empty array clears it.
|
|
315
|
+
*/
|
|
316
|
+
mediaAssetIds?: string[];
|
|
317
|
+
};
|
|
318
|
+
/**
|
|
319
|
+
* @description A content item's own rules of engagement: a Posture preset and,
|
|
320
|
+
* optionally, dials changed for this item only. Every value can only
|
|
321
|
+
* tighten. The client that runs the item resolves the effective rules
|
|
322
|
+
* as the stricter of these and the rules that apply to its profile and
|
|
323
|
+
* platform without them (the more cautious preset wins, and each dial
|
|
324
|
+
* applies only where it is stricter than the resolved preset's own);
|
|
325
|
+
* the warm-up and the pause after a sign-in challenge always apply.
|
|
326
|
+
* The server validates the shape and stores the value as given; it
|
|
327
|
+
* never resolves or loosens it.
|
|
328
|
+
*/
|
|
329
|
+
ContentItemRulesOfEngagement: {
|
|
330
|
+
/**
|
|
331
|
+
* Posture Schema
|
|
332
|
+
* @description The preset the item asks for. It applies only when it is at
|
|
333
|
+
* least as cautious as the preset its profile and platform
|
|
334
|
+
* resolve to.
|
|
335
|
+
* @enum {string}
|
|
336
|
+
*/
|
|
337
|
+
preset: "cautious" | "standard" | "brisk";
|
|
338
|
+
/**
|
|
339
|
+
* @description Dials changed for this item only. Omitted when none were
|
|
340
|
+
* changed; present, the item's rules read as adjusted.
|
|
341
|
+
*/
|
|
342
|
+
dials?: {
|
|
343
|
+
/**
|
|
344
|
+
* @description Typing and interaction pace.
|
|
345
|
+
* @enum {string}
|
|
346
|
+
*/
|
|
347
|
+
pace?: "slow" | "normal" | "fast";
|
|
348
|
+
/** @description Least time, in seconds, between two public actions on one platform for one profile. */
|
|
349
|
+
minDelaySeconds?: number;
|
|
350
|
+
/** @description Local hours with no public actions. */
|
|
351
|
+
quietHours?: {
|
|
352
|
+
/** @description Local hour the window opens. */
|
|
353
|
+
start: number;
|
|
354
|
+
/** @description Local hour the window closes. */
|
|
355
|
+
end: number;
|
|
356
|
+
};
|
|
357
|
+
/**
|
|
358
|
+
* Format: double
|
|
359
|
+
* @description Share of each built-in daily cap the item may use, above 0 and at most 1.
|
|
360
|
+
*/
|
|
361
|
+
capFraction?: number;
|
|
362
|
+
/** @description Whether the item runs without pointer movement. */
|
|
363
|
+
noMouseMove?: boolean;
|
|
364
|
+
};
|
|
365
|
+
};
|
|
366
|
+
/**
|
|
367
|
+
* @description Dials of a content item's rules of engagement. Each is optional and
|
|
368
|
+
* applies only where it is stricter than the resolved preset's own
|
|
369
|
+
* value; a dial that would loosen is ignored by the client that runs
|
|
370
|
+
* the item.
|
|
371
|
+
*/
|
|
372
|
+
ContentItemRulesOfEngagementDials: {
|
|
373
|
+
/**
|
|
374
|
+
* @description Typing and interaction pace.
|
|
375
|
+
* @enum {string}
|
|
376
|
+
*/
|
|
377
|
+
pace?: "slow" | "normal" | "fast";
|
|
378
|
+
/** @description Least time, in seconds, between two public actions on one platform for one profile. */
|
|
379
|
+
minDelaySeconds?: number;
|
|
380
|
+
/** @description Local hours with no public actions. */
|
|
381
|
+
quietHours?: {
|
|
382
|
+
/** @description Local hour the window opens. */
|
|
383
|
+
start: number;
|
|
384
|
+
/** @description Local hour the window closes. */
|
|
385
|
+
end: number;
|
|
386
|
+
};
|
|
387
|
+
/**
|
|
388
|
+
* Format: double
|
|
389
|
+
* @description Share of each built-in daily cap the item may use, above 0 and at most 1.
|
|
390
|
+
*/
|
|
391
|
+
capFraction?: number;
|
|
392
|
+
/** @description Whether the item runs without pointer movement. */
|
|
393
|
+
noMouseMove?: boolean;
|
|
394
|
+
};
|
|
395
|
+
/**
|
|
396
|
+
* @description A window of local hours with no public actions, from `start` up to
|
|
397
|
+
* `end`, wrapping past midnight when `end` is earlier than `start`.
|
|
398
|
+
*/
|
|
399
|
+
ContentItemQuietHours: {
|
|
400
|
+
/** @description Local hour the window opens. */
|
|
401
|
+
start: number;
|
|
402
|
+
/** @description Local hour the window closes. */
|
|
403
|
+
end: number;
|
|
163
404
|
};
|
|
164
405
|
/** @description Paginated collection of content items. */
|
|
165
406
|
ContentItemPage: {
|
|
@@ -173,19 +414,19 @@ export interface components {
|
|
|
173
414
|
contentItems?: {
|
|
174
415
|
/**
|
|
175
416
|
* Format: uuid
|
|
176
|
-
* @description
|
|
417
|
+
* @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
|
|
177
418
|
*/
|
|
178
419
|
id: string;
|
|
179
420
|
/**
|
|
180
421
|
* Format: uuid
|
|
181
|
-
* @description
|
|
422
|
+
* @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
|
|
182
423
|
*/
|
|
183
424
|
organizationId: string;
|
|
184
425
|
/** @description Subject of the owning profile. */
|
|
185
426
|
profile: string;
|
|
186
427
|
/** @description Row number of the content item, unique across the live content items of the organization. */
|
|
187
428
|
rowNumber: number;
|
|
188
|
-
/** @description Hex digest over the canonical content values, typed so null, empty string, zero and false differ. Server-computed; used for conditional updates. */
|
|
429
|
+
/** @description Hex digest over the canonical content values (`data`, `profile`, `rowNumber` and, when set, `rulesOfEngagement` and `mediaAssetIds`), typed so null, empty string, zero and false differ. An item without them hashes exactly as it did before the fields existed. The thread fields are fixed at insert and are not part of it. Server-computed; used for conditional updates. */
|
|
189
430
|
fingerprint: string;
|
|
190
431
|
/** @description Content values, stored as a JSON blob. */
|
|
191
432
|
data?: Record<string, never>;
|
|
@@ -206,9 +447,61 @@ export interface components {
|
|
|
206
447
|
deletedAt?: string | null;
|
|
207
448
|
/**
|
|
208
449
|
* Format: uuid
|
|
209
|
-
* @description
|
|
450
|
+
* @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
|
|
210
451
|
*/
|
|
211
452
|
createdBy?: string;
|
|
453
|
+
/** @description The item's own rules of engagement, set by the order that wrote it. They can only tighten: the client that runs the item applies the stricter of these and the rules that apply to the item's profile and platform without them, and the warm-up and the pause after a sign-in challenge always apply. The server validates the shape and stores the value; it does not resolve it. Omitted when the item has none, in which case the item runs under the rules that apply without them. */
|
|
454
|
+
rulesOfEngagement?: {
|
|
455
|
+
/**
|
|
456
|
+
* Posture Schema
|
|
457
|
+
* @description The preset the item asks for. It applies only when it is at
|
|
458
|
+
* least as cautious as the preset its profile and platform
|
|
459
|
+
* resolve to.
|
|
460
|
+
* @enum {string}
|
|
461
|
+
*/
|
|
462
|
+
preset: "cautious" | "standard" | "brisk";
|
|
463
|
+
/**
|
|
464
|
+
* @description Dials changed for this item only. Omitted when none were
|
|
465
|
+
* changed; present, the item's rules read as adjusted.
|
|
466
|
+
*/
|
|
467
|
+
dials?: {
|
|
468
|
+
/**
|
|
469
|
+
* @description Typing and interaction pace.
|
|
470
|
+
* @enum {string}
|
|
471
|
+
*/
|
|
472
|
+
pace?: "slow" | "normal" | "fast";
|
|
473
|
+
/** @description Least time, in seconds, between two public actions on one platform for one profile. */
|
|
474
|
+
minDelaySeconds?: number;
|
|
475
|
+
/** @description Local hours with no public actions. */
|
|
476
|
+
quietHours?: {
|
|
477
|
+
/** @description Local hour the window opens. */
|
|
478
|
+
start: number;
|
|
479
|
+
/** @description Local hour the window closes. */
|
|
480
|
+
end: number;
|
|
481
|
+
};
|
|
482
|
+
/**
|
|
483
|
+
* Format: double
|
|
484
|
+
* @description Share of each built-in daily cap the item may use, above 0 and at most 1.
|
|
485
|
+
*/
|
|
486
|
+
capFraction?: number;
|
|
487
|
+
/** @description Whether the item runs without pointer movement. */
|
|
488
|
+
noMouseMove?: boolean;
|
|
489
|
+
};
|
|
490
|
+
};
|
|
491
|
+
/**
|
|
492
|
+
* Format: uuid
|
|
493
|
+
* @description ID of the root item of the thread this item belongs to: the first post of a split thread, or the first transmission of a conversation between profiles. Omitted on a standalone item and on a root itself; a root is the item other items name here. Set on insert only.
|
|
494
|
+
*/
|
|
495
|
+
threadId?: string;
|
|
496
|
+
/**
|
|
497
|
+
* Format: uuid
|
|
498
|
+
* @description ID of the item this item answers directly: the thread root or another item of the same thread. A split thread's part names the part before it; a reply in a conversation between profiles names the transmission above it. Omitted when the item answers nothing. Never set without `threadId`. Set on insert only.
|
|
499
|
+
*/
|
|
500
|
+
replyToId?: string;
|
|
501
|
+
/** @description Position of the item in its thread, counting the root as 0. Present exactly when `threadId` is, unique among the live items of the thread, and greater than the position of the item named by `replyToId`. Set on insert only. */
|
|
502
|
+
threadIndex?: number;
|
|
503
|
+
/** @description The media assets the item posts, in posting order. Ids only, never URLs. Omitted when the item posts no file. */
|
|
504
|
+
mediaAssetIds?: string[];
|
|
212
505
|
}[];
|
|
213
506
|
};
|
|
214
507
|
};
|
|
@@ -249,7 +542,7 @@ export interface components {
|
|
|
249
542
|
"text/plain": string;
|
|
250
543
|
};
|
|
251
544
|
};
|
|
252
|
-
/** @description Conflict - the stale expectedFingerprint precondition no longer matches the stored content fingerprint,
|
|
545
|
+
/** @description Conflict - the stale expectedFingerprint precondition no longer matches the stored content fingerprint, another live content item of the organization already holds the same rowNumber, or another live item of the same thread already holds the same threadIndex */
|
|
253
546
|
409: {
|
|
254
547
|
headers: {
|
|
255
548
|
[name: string]: unknown;
|
|
@@ -299,6 +592,11 @@ export interface components {
|
|
|
299
592
|
* delete applies only when the stored fingerprint still matches.
|
|
300
593
|
*/
|
|
301
594
|
expectedFingerprint: string;
|
|
595
|
+
/**
|
|
596
|
+
* @description Return one thread: the root item this ID names and every live item
|
|
597
|
+
* whose `threadId` names it.
|
|
598
|
+
*/
|
|
599
|
+
threadId: string;
|
|
302
600
|
/** @description Content item ID */
|
|
303
601
|
contentItemId: string;
|
|
304
602
|
/** @description Get responses by page */
|
|
@@ -341,6 +639,11 @@ export interface operations {
|
|
|
341
639
|
order?: string;
|
|
342
640
|
/** @description Filter by owning profile subject (exact match). */
|
|
343
641
|
profile?: string;
|
|
642
|
+
/**
|
|
643
|
+
* @description Return one thread: the root item this ID names and every live item
|
|
644
|
+
* whose `threadId` names it.
|
|
645
|
+
*/
|
|
646
|
+
threadId?: string;
|
|
344
647
|
};
|
|
345
648
|
header?: never;
|
|
346
649
|
path?: never;
|
|
@@ -365,19 +668,19 @@ export interface operations {
|
|
|
365
668
|
contentItems?: {
|
|
366
669
|
/**
|
|
367
670
|
* Format: uuid
|
|
368
|
-
* @description
|
|
671
|
+
* @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
|
|
369
672
|
*/
|
|
370
673
|
id: string;
|
|
371
674
|
/**
|
|
372
675
|
* Format: uuid
|
|
373
|
-
* @description
|
|
676
|
+
* @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
|
|
374
677
|
*/
|
|
375
678
|
organizationId: string;
|
|
376
679
|
/** @description Subject of the owning profile. */
|
|
377
680
|
profile: string;
|
|
378
681
|
/** @description Row number of the content item, unique across the live content items of the organization. */
|
|
379
682
|
rowNumber: number;
|
|
380
|
-
/** @description Hex digest over the canonical content values, typed so null, empty string, zero and false differ. Server-computed; used for conditional updates. */
|
|
683
|
+
/** @description Hex digest over the canonical content values (`data`, `profile`, `rowNumber` and, when set, `rulesOfEngagement` and `mediaAssetIds`), typed so null, empty string, zero and false differ. An item without them hashes exactly as it did before the fields existed. The thread fields are fixed at insert and are not part of it. Server-computed; used for conditional updates. */
|
|
381
684
|
fingerprint: string;
|
|
382
685
|
/** @description Content values, stored as a JSON blob. */
|
|
383
686
|
data?: Record<string, never>;
|
|
@@ -398,9 +701,61 @@ export interface operations {
|
|
|
398
701
|
deletedAt?: string | null;
|
|
399
702
|
/**
|
|
400
703
|
* Format: uuid
|
|
401
|
-
* @description
|
|
704
|
+
* @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
|
|
402
705
|
*/
|
|
403
706
|
createdBy?: string;
|
|
707
|
+
/** @description The item's own rules of engagement, set by the order that wrote it. They can only tighten: the client that runs the item applies the stricter of these and the rules that apply to the item's profile and platform without them, and the warm-up and the pause after a sign-in challenge always apply. The server validates the shape and stores the value; it does not resolve it. Omitted when the item has none, in which case the item runs under the rules that apply without them. */
|
|
708
|
+
rulesOfEngagement?: {
|
|
709
|
+
/**
|
|
710
|
+
* Posture Schema
|
|
711
|
+
* @description The preset the item asks for. It applies only when it is at
|
|
712
|
+
* least as cautious as the preset its profile and platform
|
|
713
|
+
* resolve to.
|
|
714
|
+
* @enum {string}
|
|
715
|
+
*/
|
|
716
|
+
preset: "cautious" | "standard" | "brisk";
|
|
717
|
+
/**
|
|
718
|
+
* @description Dials changed for this item only. Omitted when none were
|
|
719
|
+
* changed; present, the item's rules read as adjusted.
|
|
720
|
+
*/
|
|
721
|
+
dials?: {
|
|
722
|
+
/**
|
|
723
|
+
* @description Typing and interaction pace.
|
|
724
|
+
* @enum {string}
|
|
725
|
+
*/
|
|
726
|
+
pace?: "slow" | "normal" | "fast";
|
|
727
|
+
/** @description Least time, in seconds, between two public actions on one platform for one profile. */
|
|
728
|
+
minDelaySeconds?: number;
|
|
729
|
+
/** @description Local hours with no public actions. */
|
|
730
|
+
quietHours?: {
|
|
731
|
+
/** @description Local hour the window opens. */
|
|
732
|
+
start: number;
|
|
733
|
+
/** @description Local hour the window closes. */
|
|
734
|
+
end: number;
|
|
735
|
+
};
|
|
736
|
+
/**
|
|
737
|
+
* Format: double
|
|
738
|
+
* @description Share of each built-in daily cap the item may use, above 0 and at most 1.
|
|
739
|
+
*/
|
|
740
|
+
capFraction?: number;
|
|
741
|
+
/** @description Whether the item runs without pointer movement. */
|
|
742
|
+
noMouseMove?: boolean;
|
|
743
|
+
};
|
|
744
|
+
};
|
|
745
|
+
/**
|
|
746
|
+
* Format: uuid
|
|
747
|
+
* @description ID of the root item of the thread this item belongs to: the first post of a split thread, or the first transmission of a conversation between profiles. Omitted on a standalone item and on a root itself; a root is the item other items name here. Set on insert only.
|
|
748
|
+
*/
|
|
749
|
+
threadId?: string;
|
|
750
|
+
/**
|
|
751
|
+
* Format: uuid
|
|
752
|
+
* @description ID of the item this item answers directly: the thread root or another item of the same thread. A split thread's part names the part before it; a reply in a conversation between profiles names the transmission above it. Omitted when the item answers nothing. Never set without `threadId`. Set on insert only.
|
|
753
|
+
*/
|
|
754
|
+
replyToId?: string;
|
|
755
|
+
/** @description Position of the item in its thread, counting the root as 0. Present exactly when `threadId` is, unique among the live items of the thread, and greater than the position of the item named by `replyToId`. Set on insert only. */
|
|
756
|
+
threadIndex?: number;
|
|
757
|
+
/** @description The media assets the item posts, in posting order. Ids only, never URLs. Omitted when the item posts no file. */
|
|
758
|
+
mediaAssetIds?: string[];
|
|
404
759
|
}[];
|
|
405
760
|
};
|
|
406
761
|
};
|
|
@@ -480,7 +835,7 @@ export interface operations {
|
|
|
480
835
|
"application/json": {
|
|
481
836
|
/**
|
|
482
837
|
* Format: uuid
|
|
483
|
-
* @description
|
|
838
|
+
* @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
|
|
484
839
|
*/
|
|
485
840
|
id?: string;
|
|
486
841
|
/** @description Subject of the owning profile. */
|
|
@@ -501,6 +856,75 @@ export interface operations {
|
|
|
501
856
|
* insert.
|
|
502
857
|
*/
|
|
503
858
|
expectedFingerprint?: string;
|
|
859
|
+
/**
|
|
860
|
+
* @description The item's own rules of engagement, which can only tighten the
|
|
861
|
+
* rules its profile and platform run under. Omitted on insert, the
|
|
862
|
+
* item has none; omitted on update, the stored rules are kept;
|
|
863
|
+
* `null` on update clears them.
|
|
864
|
+
*/
|
|
865
|
+
rulesOfEngagement?: {
|
|
866
|
+
/**
|
|
867
|
+
* Posture Schema
|
|
868
|
+
* @description The preset the item asks for. It applies only when it is at
|
|
869
|
+
* least as cautious as the preset its profile and platform
|
|
870
|
+
* resolve to.
|
|
871
|
+
* @enum {string}
|
|
872
|
+
*/
|
|
873
|
+
preset: "cautious" | "standard" | "brisk";
|
|
874
|
+
/**
|
|
875
|
+
* @description Dials changed for this item only. Omitted when none were
|
|
876
|
+
* changed; present, the item's rules read as adjusted.
|
|
877
|
+
*/
|
|
878
|
+
dials?: {
|
|
879
|
+
/**
|
|
880
|
+
* @description Typing and interaction pace.
|
|
881
|
+
* @enum {string}
|
|
882
|
+
*/
|
|
883
|
+
pace?: "slow" | "normal" | "fast";
|
|
884
|
+
/** @description Least time, in seconds, between two public actions on one platform for one profile. */
|
|
885
|
+
minDelaySeconds?: number;
|
|
886
|
+
/** @description Local hours with no public actions. */
|
|
887
|
+
quietHours?: {
|
|
888
|
+
/** @description Local hour the window opens. */
|
|
889
|
+
start: number;
|
|
890
|
+
/** @description Local hour the window closes. */
|
|
891
|
+
end: number;
|
|
892
|
+
};
|
|
893
|
+
/**
|
|
894
|
+
* Format: double
|
|
895
|
+
* @description Share of each built-in daily cap the item may use, above 0 and at most 1.
|
|
896
|
+
*/
|
|
897
|
+
capFraction?: number;
|
|
898
|
+
/** @description Whether the item runs without pointer movement. */
|
|
899
|
+
noMouseMove?: boolean;
|
|
900
|
+
};
|
|
901
|
+
} | null;
|
|
902
|
+
/**
|
|
903
|
+
* Format: uuid
|
|
904
|
+
* @description ID of the thread's root item. Read on insert; on update it must
|
|
905
|
+
* be omitted or equal the stored value.
|
|
906
|
+
*/
|
|
907
|
+
threadId?: string;
|
|
908
|
+
/**
|
|
909
|
+
* Format: uuid
|
|
910
|
+
* @description ID of the item this item answers directly: the root named by
|
|
911
|
+
* `threadId` or an item of the same thread. Requires `threadId`.
|
|
912
|
+
* Read on insert; on update it must be omitted or equal the stored
|
|
913
|
+
* value.
|
|
914
|
+
*/
|
|
915
|
+
replyToId?: string;
|
|
916
|
+
/**
|
|
917
|
+
* @description Position of the item in its thread, the root counting as 0.
|
|
918
|
+
* Required exactly when `threadId` is given. Read on insert; on
|
|
919
|
+
* update it must be omitted or equal the stored value.
|
|
920
|
+
*/
|
|
921
|
+
threadIndex?: number;
|
|
922
|
+
/**
|
|
923
|
+
* @description The media assets the item posts, in posting order. Omitted on
|
|
924
|
+
* insert means none; omitted on update keeps the stored list (old
|
|
925
|
+
* clients send the whole item without it); an empty array clears it.
|
|
926
|
+
*/
|
|
927
|
+
mediaAssetIds?: string[];
|
|
504
928
|
};
|
|
505
929
|
};
|
|
506
930
|
};
|
|
@@ -514,19 +938,19 @@ export interface operations {
|
|
|
514
938
|
"application/json": {
|
|
515
939
|
/**
|
|
516
940
|
* Format: uuid
|
|
517
|
-
* @description
|
|
941
|
+
* @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
|
|
518
942
|
*/
|
|
519
943
|
id: string;
|
|
520
944
|
/**
|
|
521
945
|
* Format: uuid
|
|
522
|
-
* @description
|
|
946
|
+
* @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
|
|
523
947
|
*/
|
|
524
948
|
organizationId: string;
|
|
525
949
|
/** @description Subject of the owning profile. */
|
|
526
950
|
profile: string;
|
|
527
951
|
/** @description Row number of the content item, unique across the live content items of the organization. */
|
|
528
952
|
rowNumber: number;
|
|
529
|
-
/** @description Hex digest over the canonical content values, typed so null, empty string, zero and false differ. Server-computed; used for conditional updates. */
|
|
953
|
+
/** @description Hex digest over the canonical content values (`data`, `profile`, `rowNumber` and, when set, `rulesOfEngagement` and `mediaAssetIds`), typed so null, empty string, zero and false differ. An item without them hashes exactly as it did before the fields existed. The thread fields are fixed at insert and are not part of it. Server-computed; used for conditional updates. */
|
|
530
954
|
fingerprint: string;
|
|
531
955
|
/** @description Content values, stored as a JSON blob. */
|
|
532
956
|
data?: Record<string, never>;
|
|
@@ -547,9 +971,61 @@ export interface operations {
|
|
|
547
971
|
deletedAt?: string | null;
|
|
548
972
|
/**
|
|
549
973
|
* Format: uuid
|
|
550
|
-
* @description
|
|
974
|
+
* @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
|
|
551
975
|
*/
|
|
552
976
|
createdBy?: string;
|
|
977
|
+
/** @description The item's own rules of engagement, set by the order that wrote it. They can only tighten: the client that runs the item applies the stricter of these and the rules that apply to the item's profile and platform without them, and the warm-up and the pause after a sign-in challenge always apply. The server validates the shape and stores the value; it does not resolve it. Omitted when the item has none, in which case the item runs under the rules that apply without them. */
|
|
978
|
+
rulesOfEngagement?: {
|
|
979
|
+
/**
|
|
980
|
+
* Posture Schema
|
|
981
|
+
* @description The preset the item asks for. It applies only when it is at
|
|
982
|
+
* least as cautious as the preset its profile and platform
|
|
983
|
+
* resolve to.
|
|
984
|
+
* @enum {string}
|
|
985
|
+
*/
|
|
986
|
+
preset: "cautious" | "standard" | "brisk";
|
|
987
|
+
/**
|
|
988
|
+
* @description Dials changed for this item only. Omitted when none were
|
|
989
|
+
* changed; present, the item's rules read as adjusted.
|
|
990
|
+
*/
|
|
991
|
+
dials?: {
|
|
992
|
+
/**
|
|
993
|
+
* @description Typing and interaction pace.
|
|
994
|
+
* @enum {string}
|
|
995
|
+
*/
|
|
996
|
+
pace?: "slow" | "normal" | "fast";
|
|
997
|
+
/** @description Least time, in seconds, between two public actions on one platform for one profile. */
|
|
998
|
+
minDelaySeconds?: number;
|
|
999
|
+
/** @description Local hours with no public actions. */
|
|
1000
|
+
quietHours?: {
|
|
1001
|
+
/** @description Local hour the window opens. */
|
|
1002
|
+
start: number;
|
|
1003
|
+
/** @description Local hour the window closes. */
|
|
1004
|
+
end: number;
|
|
1005
|
+
};
|
|
1006
|
+
/**
|
|
1007
|
+
* Format: double
|
|
1008
|
+
* @description Share of each built-in daily cap the item may use, above 0 and at most 1.
|
|
1009
|
+
*/
|
|
1010
|
+
capFraction?: number;
|
|
1011
|
+
/** @description Whether the item runs without pointer movement. */
|
|
1012
|
+
noMouseMove?: boolean;
|
|
1013
|
+
};
|
|
1014
|
+
};
|
|
1015
|
+
/**
|
|
1016
|
+
* Format: uuid
|
|
1017
|
+
* @description ID of the root item of the thread this item belongs to: the first post of a split thread, or the first transmission of a conversation between profiles. Omitted on a standalone item and on a root itself; a root is the item other items name here. Set on insert only.
|
|
1018
|
+
*/
|
|
1019
|
+
threadId?: string;
|
|
1020
|
+
/**
|
|
1021
|
+
* Format: uuid
|
|
1022
|
+
* @description ID of the item this item answers directly: the thread root or another item of the same thread. A split thread's part names the part before it; a reply in a conversation between profiles names the transmission above it. Omitted when the item answers nothing. Never set without `threadId`. Set on insert only.
|
|
1023
|
+
*/
|
|
1024
|
+
replyToId?: string;
|
|
1025
|
+
/** @description Position of the item in its thread, counting the root as 0. Present exactly when `threadId` is, unique among the live items of the thread, and greater than the position of the item named by `replyToId`. Set on insert only. */
|
|
1026
|
+
threadIndex?: number;
|
|
1027
|
+
/** @description The media assets the item posts, in posting order. Ids only, never URLs. Omitted when the item posts no file. */
|
|
1028
|
+
mediaAssetIds?: string[];
|
|
553
1029
|
};
|
|
554
1030
|
};
|
|
555
1031
|
};
|
|
@@ -589,7 +1065,7 @@ export interface operations {
|
|
|
589
1065
|
"text/plain": string;
|
|
590
1066
|
};
|
|
591
1067
|
};
|
|
592
|
-
/** @description Conflict - the stale expectedFingerprint precondition no longer matches the stored content fingerprint,
|
|
1068
|
+
/** @description Conflict - the stale expectedFingerprint precondition no longer matches the stored content fingerprint, another live content item of the organization already holds the same rowNumber, or another live item of the same thread already holds the same threadIndex */
|
|
593
1069
|
409: {
|
|
594
1070
|
headers: {
|
|
595
1071
|
[name: string]: unknown;
|
|
@@ -655,19 +1131,19 @@ export interface operations {
|
|
|
655
1131
|
"application/json": {
|
|
656
1132
|
/**
|
|
657
1133
|
* Format: uuid
|
|
658
|
-
* @description
|
|
1134
|
+
* @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
|
|
659
1135
|
*/
|
|
660
1136
|
id: string;
|
|
661
1137
|
/**
|
|
662
1138
|
* Format: uuid
|
|
663
|
-
* @description
|
|
1139
|
+
* @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
|
|
664
1140
|
*/
|
|
665
1141
|
organizationId: string;
|
|
666
1142
|
/** @description Subject of the owning profile. */
|
|
667
1143
|
profile: string;
|
|
668
1144
|
/** @description Row number of the content item, unique across the live content items of the organization. */
|
|
669
1145
|
rowNumber: number;
|
|
670
|
-
/** @description Hex digest over the canonical content values, typed so null, empty string, zero and false differ. Server-computed; used for conditional updates. */
|
|
1146
|
+
/** @description Hex digest over the canonical content values (`data`, `profile`, `rowNumber` and, when set, `rulesOfEngagement` and `mediaAssetIds`), typed so null, empty string, zero and false differ. An item without them hashes exactly as it did before the fields existed. The thread fields are fixed at insert and are not part of it. Server-computed; used for conditional updates. */
|
|
671
1147
|
fingerprint: string;
|
|
672
1148
|
/** @description Content values, stored as a JSON blob. */
|
|
673
1149
|
data?: Record<string, never>;
|
|
@@ -688,9 +1164,61 @@ export interface operations {
|
|
|
688
1164
|
deletedAt?: string | null;
|
|
689
1165
|
/**
|
|
690
1166
|
* Format: uuid
|
|
691
|
-
* @description
|
|
1167
|
+
* @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
|
|
692
1168
|
*/
|
|
693
1169
|
createdBy?: string;
|
|
1170
|
+
/** @description The item's own rules of engagement, set by the order that wrote it. They can only tighten: the client that runs the item applies the stricter of these and the rules that apply to the item's profile and platform without them, and the warm-up and the pause after a sign-in challenge always apply. The server validates the shape and stores the value; it does not resolve it. Omitted when the item has none, in which case the item runs under the rules that apply without them. */
|
|
1171
|
+
rulesOfEngagement?: {
|
|
1172
|
+
/**
|
|
1173
|
+
* Posture Schema
|
|
1174
|
+
* @description The preset the item asks for. It applies only when it is at
|
|
1175
|
+
* least as cautious as the preset its profile and platform
|
|
1176
|
+
* resolve to.
|
|
1177
|
+
* @enum {string}
|
|
1178
|
+
*/
|
|
1179
|
+
preset: "cautious" | "standard" | "brisk";
|
|
1180
|
+
/**
|
|
1181
|
+
* @description Dials changed for this item only. Omitted when none were
|
|
1182
|
+
* changed; present, the item's rules read as adjusted.
|
|
1183
|
+
*/
|
|
1184
|
+
dials?: {
|
|
1185
|
+
/**
|
|
1186
|
+
* @description Typing and interaction pace.
|
|
1187
|
+
* @enum {string}
|
|
1188
|
+
*/
|
|
1189
|
+
pace?: "slow" | "normal" | "fast";
|
|
1190
|
+
/** @description Least time, in seconds, between two public actions on one platform for one profile. */
|
|
1191
|
+
minDelaySeconds?: number;
|
|
1192
|
+
/** @description Local hours with no public actions. */
|
|
1193
|
+
quietHours?: {
|
|
1194
|
+
/** @description Local hour the window opens. */
|
|
1195
|
+
start: number;
|
|
1196
|
+
/** @description Local hour the window closes. */
|
|
1197
|
+
end: number;
|
|
1198
|
+
};
|
|
1199
|
+
/**
|
|
1200
|
+
* Format: double
|
|
1201
|
+
* @description Share of each built-in daily cap the item may use, above 0 and at most 1.
|
|
1202
|
+
*/
|
|
1203
|
+
capFraction?: number;
|
|
1204
|
+
/** @description Whether the item runs without pointer movement. */
|
|
1205
|
+
noMouseMove?: boolean;
|
|
1206
|
+
};
|
|
1207
|
+
};
|
|
1208
|
+
/**
|
|
1209
|
+
* Format: uuid
|
|
1210
|
+
* @description ID of the root item of the thread this item belongs to: the first post of a split thread, or the first transmission of a conversation between profiles. Omitted on a standalone item and on a root itself; a root is the item other items name here. Set on insert only.
|
|
1211
|
+
*/
|
|
1212
|
+
threadId?: string;
|
|
1213
|
+
/**
|
|
1214
|
+
* Format: uuid
|
|
1215
|
+
* @description ID of the item this item answers directly: the thread root or another item of the same thread. A split thread's part names the part before it; a reply in a conversation between profiles names the transmission above it. Omitted when the item answers nothing. Never set without `threadId`. Set on insert only.
|
|
1216
|
+
*/
|
|
1217
|
+
replyToId?: string;
|
|
1218
|
+
/** @description Position of the item in its thread, counting the root as 0. Present exactly when `threadId` is, unique among the live items of the thread, and greater than the position of the item named by `replyToId`. Set on insert only. */
|
|
1219
|
+
threadIndex?: number;
|
|
1220
|
+
/** @description The media assets the item posts, in posting order. Ids only, never URLs. Omitted when the item posts no file. */
|
|
1221
|
+
mediaAssetIds?: string[];
|
|
694
1222
|
};
|
|
695
1223
|
};
|
|
696
1224
|
};
|
|
@@ -781,7 +1309,7 @@ export interface operations {
|
|
|
781
1309
|
"application/json": {
|
|
782
1310
|
/**
|
|
783
1311
|
* Format: uuid
|
|
784
|
-
* @description
|
|
1312
|
+
* @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
|
|
785
1313
|
*/
|
|
786
1314
|
id?: string;
|
|
787
1315
|
/** @description Subject of the owning profile. */
|
|
@@ -802,6 +1330,75 @@ export interface operations {
|
|
|
802
1330
|
* insert.
|
|
803
1331
|
*/
|
|
804
1332
|
expectedFingerprint?: string;
|
|
1333
|
+
/**
|
|
1334
|
+
* @description The item's own rules of engagement, which can only tighten the
|
|
1335
|
+
* rules its profile and platform run under. Omitted on insert, the
|
|
1336
|
+
* item has none; omitted on update, the stored rules are kept;
|
|
1337
|
+
* `null` on update clears them.
|
|
1338
|
+
*/
|
|
1339
|
+
rulesOfEngagement?: {
|
|
1340
|
+
/**
|
|
1341
|
+
* Posture Schema
|
|
1342
|
+
* @description The preset the item asks for. It applies only when it is at
|
|
1343
|
+
* least as cautious as the preset its profile and platform
|
|
1344
|
+
* resolve to.
|
|
1345
|
+
* @enum {string}
|
|
1346
|
+
*/
|
|
1347
|
+
preset: "cautious" | "standard" | "brisk";
|
|
1348
|
+
/**
|
|
1349
|
+
* @description Dials changed for this item only. Omitted when none were
|
|
1350
|
+
* changed; present, the item's rules read as adjusted.
|
|
1351
|
+
*/
|
|
1352
|
+
dials?: {
|
|
1353
|
+
/**
|
|
1354
|
+
* @description Typing and interaction pace.
|
|
1355
|
+
* @enum {string}
|
|
1356
|
+
*/
|
|
1357
|
+
pace?: "slow" | "normal" | "fast";
|
|
1358
|
+
/** @description Least time, in seconds, between two public actions on one platform for one profile. */
|
|
1359
|
+
minDelaySeconds?: number;
|
|
1360
|
+
/** @description Local hours with no public actions. */
|
|
1361
|
+
quietHours?: {
|
|
1362
|
+
/** @description Local hour the window opens. */
|
|
1363
|
+
start: number;
|
|
1364
|
+
/** @description Local hour the window closes. */
|
|
1365
|
+
end: number;
|
|
1366
|
+
};
|
|
1367
|
+
/**
|
|
1368
|
+
* Format: double
|
|
1369
|
+
* @description Share of each built-in daily cap the item may use, above 0 and at most 1.
|
|
1370
|
+
*/
|
|
1371
|
+
capFraction?: number;
|
|
1372
|
+
/** @description Whether the item runs without pointer movement. */
|
|
1373
|
+
noMouseMove?: boolean;
|
|
1374
|
+
};
|
|
1375
|
+
} | null;
|
|
1376
|
+
/**
|
|
1377
|
+
* Format: uuid
|
|
1378
|
+
* @description ID of the thread's root item. Read on insert; on update it must
|
|
1379
|
+
* be omitted or equal the stored value.
|
|
1380
|
+
*/
|
|
1381
|
+
threadId?: string;
|
|
1382
|
+
/**
|
|
1383
|
+
* Format: uuid
|
|
1384
|
+
* @description ID of the item this item answers directly: the root named by
|
|
1385
|
+
* `threadId` or an item of the same thread. Requires `threadId`.
|
|
1386
|
+
* Read on insert; on update it must be omitted or equal the stored
|
|
1387
|
+
* value.
|
|
1388
|
+
*/
|
|
1389
|
+
replyToId?: string;
|
|
1390
|
+
/**
|
|
1391
|
+
* @description Position of the item in its thread, the root counting as 0.
|
|
1392
|
+
* Required exactly when `threadId` is given. Read on insert; on
|
|
1393
|
+
* update it must be omitted or equal the stored value.
|
|
1394
|
+
*/
|
|
1395
|
+
threadIndex?: number;
|
|
1396
|
+
/**
|
|
1397
|
+
* @description The media assets the item posts, in posting order. Omitted on
|
|
1398
|
+
* insert means none; omitted on update keeps the stored list (old
|
|
1399
|
+
* clients send the whole item without it); an empty array clears it.
|
|
1400
|
+
*/
|
|
1401
|
+
mediaAssetIds?: string[];
|
|
805
1402
|
};
|
|
806
1403
|
};
|
|
807
1404
|
};
|
|
@@ -815,19 +1412,19 @@ export interface operations {
|
|
|
815
1412
|
"application/json": {
|
|
816
1413
|
/**
|
|
817
1414
|
* Format: uuid
|
|
818
|
-
* @description
|
|
1415
|
+
* @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
|
|
819
1416
|
*/
|
|
820
1417
|
id: string;
|
|
821
1418
|
/**
|
|
822
1419
|
* Format: uuid
|
|
823
|
-
* @description
|
|
1420
|
+
* @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
|
|
824
1421
|
*/
|
|
825
1422
|
organizationId: string;
|
|
826
1423
|
/** @description Subject of the owning profile. */
|
|
827
1424
|
profile: string;
|
|
828
1425
|
/** @description Row number of the content item, unique across the live content items of the organization. */
|
|
829
1426
|
rowNumber: number;
|
|
830
|
-
/** @description Hex digest over the canonical content values, typed so null, empty string, zero and false differ. Server-computed; used for conditional updates. */
|
|
1427
|
+
/** @description Hex digest over the canonical content values (`data`, `profile`, `rowNumber` and, when set, `rulesOfEngagement` and `mediaAssetIds`), typed so null, empty string, zero and false differ. An item without them hashes exactly as it did before the fields existed. The thread fields are fixed at insert and are not part of it. Server-computed; used for conditional updates. */
|
|
831
1428
|
fingerprint: string;
|
|
832
1429
|
/** @description Content values, stored as a JSON blob. */
|
|
833
1430
|
data?: Record<string, never>;
|
|
@@ -848,9 +1445,61 @@ export interface operations {
|
|
|
848
1445
|
deletedAt?: string | null;
|
|
849
1446
|
/**
|
|
850
1447
|
* Format: uuid
|
|
851
|
-
* @description
|
|
1448
|
+
* @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
|
|
852
1449
|
*/
|
|
853
1450
|
createdBy?: string;
|
|
1451
|
+
/** @description The item's own rules of engagement, set by the order that wrote it. They can only tighten: the client that runs the item applies the stricter of these and the rules that apply to the item's profile and platform without them, and the warm-up and the pause after a sign-in challenge always apply. The server validates the shape and stores the value; it does not resolve it. Omitted when the item has none, in which case the item runs under the rules that apply without them. */
|
|
1452
|
+
rulesOfEngagement?: {
|
|
1453
|
+
/**
|
|
1454
|
+
* Posture Schema
|
|
1455
|
+
* @description The preset the item asks for. It applies only when it is at
|
|
1456
|
+
* least as cautious as the preset its profile and platform
|
|
1457
|
+
* resolve to.
|
|
1458
|
+
* @enum {string}
|
|
1459
|
+
*/
|
|
1460
|
+
preset: "cautious" | "standard" | "brisk";
|
|
1461
|
+
/**
|
|
1462
|
+
* @description Dials changed for this item only. Omitted when none were
|
|
1463
|
+
* changed; present, the item's rules read as adjusted.
|
|
1464
|
+
*/
|
|
1465
|
+
dials?: {
|
|
1466
|
+
/**
|
|
1467
|
+
* @description Typing and interaction pace.
|
|
1468
|
+
* @enum {string}
|
|
1469
|
+
*/
|
|
1470
|
+
pace?: "slow" | "normal" | "fast";
|
|
1471
|
+
/** @description Least time, in seconds, between two public actions on one platform for one profile. */
|
|
1472
|
+
minDelaySeconds?: number;
|
|
1473
|
+
/** @description Local hours with no public actions. */
|
|
1474
|
+
quietHours?: {
|
|
1475
|
+
/** @description Local hour the window opens. */
|
|
1476
|
+
start: number;
|
|
1477
|
+
/** @description Local hour the window closes. */
|
|
1478
|
+
end: number;
|
|
1479
|
+
};
|
|
1480
|
+
/**
|
|
1481
|
+
* Format: double
|
|
1482
|
+
* @description Share of each built-in daily cap the item may use, above 0 and at most 1.
|
|
1483
|
+
*/
|
|
1484
|
+
capFraction?: number;
|
|
1485
|
+
/** @description Whether the item runs without pointer movement. */
|
|
1486
|
+
noMouseMove?: boolean;
|
|
1487
|
+
};
|
|
1488
|
+
};
|
|
1489
|
+
/**
|
|
1490
|
+
* Format: uuid
|
|
1491
|
+
* @description ID of the root item of the thread this item belongs to: the first post of a split thread, or the first transmission of a conversation between profiles. Omitted on a standalone item and on a root itself; a root is the item other items name here. Set on insert only.
|
|
1492
|
+
*/
|
|
1493
|
+
threadId?: string;
|
|
1494
|
+
/**
|
|
1495
|
+
* Format: uuid
|
|
1496
|
+
* @description ID of the item this item answers directly: the thread root or another item of the same thread. A split thread's part names the part before it; a reply in a conversation between profiles names the transmission above it. Omitted when the item answers nothing. Never set without `threadId`. Set on insert only.
|
|
1497
|
+
*/
|
|
1498
|
+
replyToId?: string;
|
|
1499
|
+
/** @description Position of the item in its thread, counting the root as 0. Present exactly when `threadId` is, unique among the live items of the thread, and greater than the position of the item named by `replyToId`. Set on insert only. */
|
|
1500
|
+
threadIndex?: number;
|
|
1501
|
+
/** @description The media assets the item posts, in posting order. Ids only, never URLs. Omitted when the item posts no file. */
|
|
1502
|
+
mediaAssetIds?: string[];
|
|
854
1503
|
};
|
|
855
1504
|
};
|
|
856
1505
|
};
|
|
@@ -890,7 +1539,7 @@ export interface operations {
|
|
|
890
1539
|
"text/plain": string;
|
|
891
1540
|
};
|
|
892
1541
|
};
|
|
893
|
-
/** @description Conflict - the stale expectedFingerprint precondition no longer matches the stored content fingerprint,
|
|
1542
|
+
/** @description Conflict - the stale expectedFingerprint precondition no longer matches the stored content fingerprint, another live content item of the organization already holds the same rowNumber, or another live item of the same thread already holds the same threadIndex */
|
|
894
1543
|
409: {
|
|
895
1544
|
headers: {
|
|
896
1545
|
[name: string]: unknown;
|
|
@@ -996,7 +1645,7 @@ export interface operations {
|
|
|
996
1645
|
"text/plain": string;
|
|
997
1646
|
};
|
|
998
1647
|
};
|
|
999
|
-
/** @description Conflict - the stale expectedFingerprint precondition no longer matches the stored content fingerprint,
|
|
1648
|
+
/** @description Conflict - the stale expectedFingerprint precondition no longer matches the stored content fingerprint, another live content item of the organization already holds the same rowNumber, or another live item of the same thread already holds the same threadIndex */
|
|
1000
1649
|
409: {
|
|
1001
1650
|
headers: {
|
|
1002
1651
|
[name: string]: unknown;
|