@meshery/schemas 1.3.83 → 1.3.85
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 +11352 -13637
- package/dist/cloudApi.d.ts +11352 -13637
- package/dist/cloudApi.js +1 -1
- package/dist/cloudApi.mjs +1 -1
- package/dist/constructs/v1beta3/content_piece/ContentPiece.d.ts +2 -1
- package/dist/constructs/v1beta3/content_piece/ContentPieceSchema.js +1 -1
- package/dist/constructs/v1beta3/content_piece/ContentPieceSchema.mjs +1 -1
- package/dist/constructs/v1beta3/ledger/Ledger.d.ts +609 -0
- package/dist/constructs/v1beta3/ledger/LedgerSchema.d.ts +2 -0
- package/dist/constructs/v1beta3/ledger/LedgerSchema.js +22 -0
- package/dist/constructs/v1beta3/ledger/LedgerSchema.mjs +22 -0
- package/dist/constructs/v1beta3/provider_capability/ProviderCapability.d.ts +243 -0
- package/dist/constructs/v1beta3/provider_capability/ProviderCapabilitySchema.d.ts +2 -0
- package/dist/constructs/v1beta3/provider_capability/ProviderCapabilitySchema.js +30 -0
- package/dist/constructs/v1beta3/provider_capability/ProviderCapabilitySchema.mjs +30 -0
- package/package.json +1 -1
- package/dist/constructs/v1beta3/blowhorn_binding/BlowhornBinding.d.ts +0 -462
- package/dist/constructs/v1beta3/blowhorn_binding/BlowhornBindingSchema.d.ts +0 -2
- package/dist/constructs/v1beta3/blowhorn_binding/BlowhornBindingSchema.js +0 -23
- package/dist/constructs/v1beta3/blowhorn_binding/BlowhornBindingSchema.mjs +0 -23
- package/dist/constructs/v1beta3/blowhorn_ledger/BlowhornLedger.d.ts +0 -1546
- package/dist/constructs/v1beta3/blowhorn_ledger/BlowhornLedgerSchema.d.ts +0 -2
- package/dist/constructs/v1beta3/blowhorn_ledger/BlowhornLedgerSchema.js +0 -69
- package/dist/constructs/v1beta3/blowhorn_ledger/BlowhornLedgerSchema.mjs +0 -69
- /package/dist/constructs/v1beta3/{blowhorn_binding/BlowhornBinding.js → ledger/Ledger.js} +0 -0
- /package/dist/constructs/v1beta3/{blowhorn_binding/BlowhornBinding.mjs → ledger/Ledger.mjs} +0 -0
- /package/dist/constructs/v1beta3/{blowhorn_ledger/BlowhornLedger.js → provider_capability/ProviderCapability.js} +0 -0
- /package/dist/constructs/v1beta3/{blowhorn_ledger/BlowhornLedger.mjs → provider_capability/ProviderCapability.mjs} +0 -0
|
@@ -0,0 +1,609 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* This file was auto-generated by openapi-typescript.
|
|
3
|
+
* Do not make direct changes to the file.
|
|
4
|
+
*/
|
|
5
|
+
|
|
6
|
+
export interface paths {
|
|
7
|
+
"/api/ledgers/{ledger}/entries": {
|
|
8
|
+
parameters: {
|
|
9
|
+
query?: never;
|
|
10
|
+
header?: never;
|
|
11
|
+
path?: never;
|
|
12
|
+
cookie?: never;
|
|
13
|
+
};
|
|
14
|
+
get?: never;
|
|
15
|
+
put?: never;
|
|
16
|
+
/**
|
|
17
|
+
* Record a ledger entry
|
|
18
|
+
* @description Records `entryKey` in the ledger. A new key creates the entry and returns `201`. An existing key never creates a second entry and is not changed: the stored entry is returned unchanged with `200`, and the supplied `value` is ignored. Recording never changes `claimedBy` or `claimedAt`.
|
|
19
|
+
*/
|
|
20
|
+
post: operations["recordLedgerEntry"];
|
|
21
|
+
delete?: never;
|
|
22
|
+
options?: never;
|
|
23
|
+
head?: never;
|
|
24
|
+
patch?: never;
|
|
25
|
+
trace?: never;
|
|
26
|
+
};
|
|
27
|
+
"/api/ledgers/{ledger}/claims": {
|
|
28
|
+
parameters: {
|
|
29
|
+
query?: never;
|
|
30
|
+
header?: never;
|
|
31
|
+
path?: never;
|
|
32
|
+
cookie?: never;
|
|
33
|
+
};
|
|
34
|
+
get?: never;
|
|
35
|
+
put?: never;
|
|
36
|
+
/**
|
|
37
|
+
* Claim a ledger key if absent
|
|
38
|
+
* @description Atomically gives `entryKey` to `claimant`. When the key is not in the ledger, the entry is created already claimed and returned with `201`. When it is recorded but unclaimed, it is claimed and returned with `200`. When `claimant` already holds it, the call is a replay and returns the entry with `200`. When another claimant holds it, the call is refused with `409` and nothing changes. A claim is permanent: it ends only when the entry is deleted.
|
|
39
|
+
*/
|
|
40
|
+
post: operations["claimLedgerEntry"];
|
|
41
|
+
delete?: never;
|
|
42
|
+
options?: never;
|
|
43
|
+
head?: never;
|
|
44
|
+
patch?: never;
|
|
45
|
+
trace?: never;
|
|
46
|
+
};
|
|
47
|
+
"/api/ledgers/{ledger}/entries/{entryKey}": {
|
|
48
|
+
parameters: {
|
|
49
|
+
query?: never;
|
|
50
|
+
header?: never;
|
|
51
|
+
path?: never;
|
|
52
|
+
cookie?: never;
|
|
53
|
+
};
|
|
54
|
+
/**
|
|
55
|
+
* Get a ledger entry
|
|
56
|
+
* @description Returns the entry recorded under `entryKey` in the ledger, or `404` when the key is not in this ledger.
|
|
57
|
+
*/
|
|
58
|
+
get: operations["getLedgerEntry"];
|
|
59
|
+
put?: never;
|
|
60
|
+
post?: never;
|
|
61
|
+
/**
|
|
62
|
+
* Delete a ledger entry
|
|
63
|
+
* @description Removes the entry, and with it any claim, so its key can be recorded or claimed again. Returns `404` when the key is not in this ledger.
|
|
64
|
+
*/
|
|
65
|
+
delete: operations["deleteLedgerEntry"];
|
|
66
|
+
options?: never;
|
|
67
|
+
head?: never;
|
|
68
|
+
patch?: never;
|
|
69
|
+
trace?: never;
|
|
70
|
+
};
|
|
71
|
+
}
|
|
72
|
+
export type webhooks = Record<string, never>;
|
|
73
|
+
export interface components {
|
|
74
|
+
schemas: {
|
|
75
|
+
/**
|
|
76
|
+
* Ledger Entry Schema
|
|
77
|
+
* @description Server-returned ledger entry. An organization keeps any number of named ledgers, each an idempotent set keyed by entryKey: recording an existing key never creates a second entry and returns the stored entry unchanged, and claim-if-absent gives a key to exactly one claimant, so two workers never both act on it. Any organization member may read, claim and delete entries; claimedBy is an advisory label, not an authorization principal.
|
|
78
|
+
*/
|
|
79
|
+
LedgerEntry: {
|
|
80
|
+
/**
|
|
81
|
+
* Format: uuid
|
|
82
|
+
* @description Server-generated ledger entry ID.
|
|
83
|
+
*/
|
|
84
|
+
id: string;
|
|
85
|
+
/**
|
|
86
|
+
* Format: uuid
|
|
87
|
+
* @description Owning organization ID. Derived from the authenticated session, never client-settable.
|
|
88
|
+
*/
|
|
89
|
+
organizationId: string;
|
|
90
|
+
/** @description Name of the ledger (the idempotent set) the entry belongs to. */
|
|
91
|
+
ledger: string;
|
|
92
|
+
/** @description Key within the ledger. Unique per (organization, ledger). */
|
|
93
|
+
entryKey: string;
|
|
94
|
+
/** @description Entry value, stored as a JSON blob. */
|
|
95
|
+
value?: Record<string, never>;
|
|
96
|
+
/** @description Claimant that holds the entry, if any. Set only by claim-if-absent and never changed afterwards. */
|
|
97
|
+
claimedBy?: string;
|
|
98
|
+
/**
|
|
99
|
+
* Format: date-time
|
|
100
|
+
* @description Time the entry was claimed, if any. Set only by claim-if-absent.
|
|
101
|
+
*/
|
|
102
|
+
claimedAt?: string | null;
|
|
103
|
+
/**
|
|
104
|
+
* Format: date-time
|
|
105
|
+
* @description Timestamp of ledger entry creation.
|
|
106
|
+
*/
|
|
107
|
+
createdAt: string;
|
|
108
|
+
/**
|
|
109
|
+
* Format: date-time
|
|
110
|
+
* @description Timestamp of last ledger entry modification.
|
|
111
|
+
*/
|
|
112
|
+
updatedAt: string;
|
|
113
|
+
};
|
|
114
|
+
/** @description Payload for recording a ledger entry. The ledger comes from the path and the organization from the session; claim fields and timestamps are server-owned. */
|
|
115
|
+
LedgerEntryPayload: {
|
|
116
|
+
/** @description Key within the ledger. */
|
|
117
|
+
entryKey: string;
|
|
118
|
+
/** @description Entry value, stored as a JSON object. */
|
|
119
|
+
value?: Record<string, never>;
|
|
120
|
+
};
|
|
121
|
+
/** @description Claim-if-absent payload giving a key to one claimant. */
|
|
122
|
+
LedgerClaimPayload: {
|
|
123
|
+
/** @description Key to claim. */
|
|
124
|
+
entryKey: string;
|
|
125
|
+
/** @description Advisory label naming the worker taking the key, for example a worker name. It is not bound to the caller. */
|
|
126
|
+
claimant: string;
|
|
127
|
+
/** @description Value stored when the claim creates the entry; ignored when the entry already exists. */
|
|
128
|
+
value?: Record<string, never>;
|
|
129
|
+
};
|
|
130
|
+
};
|
|
131
|
+
responses: {
|
|
132
|
+
/** @description Invalid request body or request param */
|
|
133
|
+
400: {
|
|
134
|
+
headers: {
|
|
135
|
+
[name: string]: unknown;
|
|
136
|
+
};
|
|
137
|
+
content: {
|
|
138
|
+
"text/plain": string;
|
|
139
|
+
};
|
|
140
|
+
};
|
|
141
|
+
/** @description Expired JWT token used or insufficient privilege */
|
|
142
|
+
401: {
|
|
143
|
+
headers: {
|
|
144
|
+
[name: string]: unknown;
|
|
145
|
+
};
|
|
146
|
+
content: {
|
|
147
|
+
"text/plain": string;
|
|
148
|
+
};
|
|
149
|
+
};
|
|
150
|
+
/** @description Result not found */
|
|
151
|
+
404: {
|
|
152
|
+
headers: {
|
|
153
|
+
[name: string]: unknown;
|
|
154
|
+
};
|
|
155
|
+
content: {
|
|
156
|
+
"text/plain": string;
|
|
157
|
+
};
|
|
158
|
+
};
|
|
159
|
+
/** @description Conflict - another claimant holds the ledger entry */
|
|
160
|
+
409: {
|
|
161
|
+
headers: {
|
|
162
|
+
[name: string]: unknown;
|
|
163
|
+
};
|
|
164
|
+
content: {
|
|
165
|
+
"text/plain": string;
|
|
166
|
+
};
|
|
167
|
+
};
|
|
168
|
+
/** @description Internal server error */
|
|
169
|
+
500: {
|
|
170
|
+
headers: {
|
|
171
|
+
[name: string]: unknown;
|
|
172
|
+
};
|
|
173
|
+
content: {
|
|
174
|
+
"text/plain": string;
|
|
175
|
+
};
|
|
176
|
+
};
|
|
177
|
+
};
|
|
178
|
+
parameters: {
|
|
179
|
+
/** @description Name of the ledger, for example `processed-profiles`. */
|
|
180
|
+
ledger: string;
|
|
181
|
+
/** @description Key within the ledger. URL-encode keys that contain reserved characters such as `/`. */
|
|
182
|
+
entryKey: string;
|
|
183
|
+
};
|
|
184
|
+
requestBodies: never;
|
|
185
|
+
headers: never;
|
|
186
|
+
pathItems: never;
|
|
187
|
+
}
|
|
188
|
+
export type $defs = Record<string, never>;
|
|
189
|
+
export interface operations {
|
|
190
|
+
recordLedgerEntry: {
|
|
191
|
+
parameters: {
|
|
192
|
+
query?: never;
|
|
193
|
+
header?: never;
|
|
194
|
+
path: {
|
|
195
|
+
/** @description Name of the ledger, for example `processed-profiles`. */
|
|
196
|
+
ledger: string;
|
|
197
|
+
};
|
|
198
|
+
cookie?: never;
|
|
199
|
+
};
|
|
200
|
+
requestBody: {
|
|
201
|
+
content: {
|
|
202
|
+
"application/json": {
|
|
203
|
+
/** @description Key within the ledger. */
|
|
204
|
+
entryKey: string;
|
|
205
|
+
/** @description Entry value, stored as a JSON object. */
|
|
206
|
+
value?: Record<string, never>;
|
|
207
|
+
};
|
|
208
|
+
};
|
|
209
|
+
};
|
|
210
|
+
responses: {
|
|
211
|
+
/** @description The key was already recorded; the stored entry, unchanged */
|
|
212
|
+
200: {
|
|
213
|
+
headers: {
|
|
214
|
+
[name: string]: unknown;
|
|
215
|
+
};
|
|
216
|
+
content: {
|
|
217
|
+
"application/json": {
|
|
218
|
+
/**
|
|
219
|
+
* Format: uuid
|
|
220
|
+
* @description Server-generated ledger entry ID.
|
|
221
|
+
*/
|
|
222
|
+
id: string;
|
|
223
|
+
/**
|
|
224
|
+
* Format: uuid
|
|
225
|
+
* @description Owning organization ID. Derived from the authenticated session, never client-settable.
|
|
226
|
+
*/
|
|
227
|
+
organizationId: string;
|
|
228
|
+
/** @description Name of the ledger (the idempotent set) the entry belongs to. */
|
|
229
|
+
ledger: string;
|
|
230
|
+
/** @description Key within the ledger. Unique per (organization, ledger). */
|
|
231
|
+
entryKey: string;
|
|
232
|
+
/** @description Entry value, stored as a JSON blob. */
|
|
233
|
+
value?: Record<string, never>;
|
|
234
|
+
/** @description Claimant that holds the entry, if any. Set only by claim-if-absent and never changed afterwards. */
|
|
235
|
+
claimedBy?: string;
|
|
236
|
+
/**
|
|
237
|
+
* Format: date-time
|
|
238
|
+
* @description Time the entry was claimed, if any. Set only by claim-if-absent.
|
|
239
|
+
*/
|
|
240
|
+
claimedAt?: string | null;
|
|
241
|
+
/**
|
|
242
|
+
* Format: date-time
|
|
243
|
+
* @description Timestamp of ledger entry creation.
|
|
244
|
+
*/
|
|
245
|
+
createdAt: string;
|
|
246
|
+
/**
|
|
247
|
+
* Format: date-time
|
|
248
|
+
* @description Timestamp of last ledger entry modification.
|
|
249
|
+
*/
|
|
250
|
+
updatedAt: string;
|
|
251
|
+
};
|
|
252
|
+
};
|
|
253
|
+
};
|
|
254
|
+
/** @description The key was recorded */
|
|
255
|
+
201: {
|
|
256
|
+
headers: {
|
|
257
|
+
[name: string]: unknown;
|
|
258
|
+
};
|
|
259
|
+
content: {
|
|
260
|
+
"application/json": {
|
|
261
|
+
/**
|
|
262
|
+
* Format: uuid
|
|
263
|
+
* @description Server-generated ledger entry ID.
|
|
264
|
+
*/
|
|
265
|
+
id: string;
|
|
266
|
+
/**
|
|
267
|
+
* Format: uuid
|
|
268
|
+
* @description Owning organization ID. Derived from the authenticated session, never client-settable.
|
|
269
|
+
*/
|
|
270
|
+
organizationId: string;
|
|
271
|
+
/** @description Name of the ledger (the idempotent set) the entry belongs to. */
|
|
272
|
+
ledger: string;
|
|
273
|
+
/** @description Key within the ledger. Unique per (organization, ledger). */
|
|
274
|
+
entryKey: string;
|
|
275
|
+
/** @description Entry value, stored as a JSON blob. */
|
|
276
|
+
value?: Record<string, never>;
|
|
277
|
+
/** @description Claimant that holds the entry, if any. Set only by claim-if-absent and never changed afterwards. */
|
|
278
|
+
claimedBy?: string;
|
|
279
|
+
/**
|
|
280
|
+
* Format: date-time
|
|
281
|
+
* @description Time the entry was claimed, if any. Set only by claim-if-absent.
|
|
282
|
+
*/
|
|
283
|
+
claimedAt?: string | null;
|
|
284
|
+
/**
|
|
285
|
+
* Format: date-time
|
|
286
|
+
* @description Timestamp of ledger entry creation.
|
|
287
|
+
*/
|
|
288
|
+
createdAt: string;
|
|
289
|
+
/**
|
|
290
|
+
* Format: date-time
|
|
291
|
+
* @description Timestamp of last ledger entry modification.
|
|
292
|
+
*/
|
|
293
|
+
updatedAt: string;
|
|
294
|
+
};
|
|
295
|
+
};
|
|
296
|
+
};
|
|
297
|
+
/** @description Invalid request body or request param */
|
|
298
|
+
400: {
|
|
299
|
+
headers: {
|
|
300
|
+
[name: string]: unknown;
|
|
301
|
+
};
|
|
302
|
+
content: {
|
|
303
|
+
"text/plain": string;
|
|
304
|
+
};
|
|
305
|
+
};
|
|
306
|
+
/** @description Expired JWT token used or insufficient privilege */
|
|
307
|
+
401: {
|
|
308
|
+
headers: {
|
|
309
|
+
[name: string]: unknown;
|
|
310
|
+
};
|
|
311
|
+
content: {
|
|
312
|
+
"text/plain": string;
|
|
313
|
+
};
|
|
314
|
+
};
|
|
315
|
+
/** @description Internal server error */
|
|
316
|
+
500: {
|
|
317
|
+
headers: {
|
|
318
|
+
[name: string]: unknown;
|
|
319
|
+
};
|
|
320
|
+
content: {
|
|
321
|
+
"text/plain": string;
|
|
322
|
+
};
|
|
323
|
+
};
|
|
324
|
+
};
|
|
325
|
+
};
|
|
326
|
+
claimLedgerEntry: {
|
|
327
|
+
parameters: {
|
|
328
|
+
query?: never;
|
|
329
|
+
header?: never;
|
|
330
|
+
path: {
|
|
331
|
+
/** @description Name of the ledger, for example `processed-profiles`. */
|
|
332
|
+
ledger: string;
|
|
333
|
+
};
|
|
334
|
+
cookie?: never;
|
|
335
|
+
};
|
|
336
|
+
requestBody: {
|
|
337
|
+
content: {
|
|
338
|
+
"application/json": {
|
|
339
|
+
/** @description Key to claim. */
|
|
340
|
+
entryKey: string;
|
|
341
|
+
/** @description Advisory label naming the worker taking the key, for example a worker name. It is not bound to the caller. */
|
|
342
|
+
claimant: string;
|
|
343
|
+
/** @description Value stored when the claim creates the entry; ignored when the entry already exists. */
|
|
344
|
+
value?: Record<string, never>;
|
|
345
|
+
};
|
|
346
|
+
};
|
|
347
|
+
};
|
|
348
|
+
responses: {
|
|
349
|
+
/** @description The caller's claimant now holds the existing entry */
|
|
350
|
+
200: {
|
|
351
|
+
headers: {
|
|
352
|
+
[name: string]: unknown;
|
|
353
|
+
};
|
|
354
|
+
content: {
|
|
355
|
+
"application/json": {
|
|
356
|
+
/**
|
|
357
|
+
* Format: uuid
|
|
358
|
+
* @description Server-generated ledger entry ID.
|
|
359
|
+
*/
|
|
360
|
+
id: string;
|
|
361
|
+
/**
|
|
362
|
+
* Format: uuid
|
|
363
|
+
* @description Owning organization ID. Derived from the authenticated session, never client-settable.
|
|
364
|
+
*/
|
|
365
|
+
organizationId: string;
|
|
366
|
+
/** @description Name of the ledger (the idempotent set) the entry belongs to. */
|
|
367
|
+
ledger: string;
|
|
368
|
+
/** @description Key within the ledger. Unique per (organization, ledger). */
|
|
369
|
+
entryKey: string;
|
|
370
|
+
/** @description Entry value, stored as a JSON blob. */
|
|
371
|
+
value?: Record<string, never>;
|
|
372
|
+
/** @description Claimant that holds the entry, if any. Set only by claim-if-absent and never changed afterwards. */
|
|
373
|
+
claimedBy?: string;
|
|
374
|
+
/**
|
|
375
|
+
* Format: date-time
|
|
376
|
+
* @description Time the entry was claimed, if any. Set only by claim-if-absent.
|
|
377
|
+
*/
|
|
378
|
+
claimedAt?: string | null;
|
|
379
|
+
/**
|
|
380
|
+
* Format: date-time
|
|
381
|
+
* @description Timestamp of ledger entry creation.
|
|
382
|
+
*/
|
|
383
|
+
createdAt: string;
|
|
384
|
+
/**
|
|
385
|
+
* Format: date-time
|
|
386
|
+
* @description Timestamp of last ledger entry modification.
|
|
387
|
+
*/
|
|
388
|
+
updatedAt: string;
|
|
389
|
+
};
|
|
390
|
+
};
|
|
391
|
+
};
|
|
392
|
+
/** @description The key was absent; it was recorded and claimed */
|
|
393
|
+
201: {
|
|
394
|
+
headers: {
|
|
395
|
+
[name: string]: unknown;
|
|
396
|
+
};
|
|
397
|
+
content: {
|
|
398
|
+
"application/json": {
|
|
399
|
+
/**
|
|
400
|
+
* Format: uuid
|
|
401
|
+
* @description Server-generated ledger entry ID.
|
|
402
|
+
*/
|
|
403
|
+
id: string;
|
|
404
|
+
/**
|
|
405
|
+
* Format: uuid
|
|
406
|
+
* @description Owning organization ID. Derived from the authenticated session, never client-settable.
|
|
407
|
+
*/
|
|
408
|
+
organizationId: string;
|
|
409
|
+
/** @description Name of the ledger (the idempotent set) the entry belongs to. */
|
|
410
|
+
ledger: string;
|
|
411
|
+
/** @description Key within the ledger. Unique per (organization, ledger). */
|
|
412
|
+
entryKey: string;
|
|
413
|
+
/** @description Entry value, stored as a JSON blob. */
|
|
414
|
+
value?: Record<string, never>;
|
|
415
|
+
/** @description Claimant that holds the entry, if any. Set only by claim-if-absent and never changed afterwards. */
|
|
416
|
+
claimedBy?: string;
|
|
417
|
+
/**
|
|
418
|
+
* Format: date-time
|
|
419
|
+
* @description Time the entry was claimed, if any. Set only by claim-if-absent.
|
|
420
|
+
*/
|
|
421
|
+
claimedAt?: string | null;
|
|
422
|
+
/**
|
|
423
|
+
* Format: date-time
|
|
424
|
+
* @description Timestamp of ledger entry creation.
|
|
425
|
+
*/
|
|
426
|
+
createdAt: string;
|
|
427
|
+
/**
|
|
428
|
+
* Format: date-time
|
|
429
|
+
* @description Timestamp of last ledger entry modification.
|
|
430
|
+
*/
|
|
431
|
+
updatedAt: string;
|
|
432
|
+
};
|
|
433
|
+
};
|
|
434
|
+
};
|
|
435
|
+
/** @description Invalid request body or request param */
|
|
436
|
+
400: {
|
|
437
|
+
headers: {
|
|
438
|
+
[name: string]: unknown;
|
|
439
|
+
};
|
|
440
|
+
content: {
|
|
441
|
+
"text/plain": string;
|
|
442
|
+
};
|
|
443
|
+
};
|
|
444
|
+
/** @description Expired JWT token used or insufficient privilege */
|
|
445
|
+
401: {
|
|
446
|
+
headers: {
|
|
447
|
+
[name: string]: unknown;
|
|
448
|
+
};
|
|
449
|
+
content: {
|
|
450
|
+
"text/plain": string;
|
|
451
|
+
};
|
|
452
|
+
};
|
|
453
|
+
/** @description Conflict - another claimant holds the ledger entry */
|
|
454
|
+
409: {
|
|
455
|
+
headers: {
|
|
456
|
+
[name: string]: unknown;
|
|
457
|
+
};
|
|
458
|
+
content: {
|
|
459
|
+
"text/plain": string;
|
|
460
|
+
};
|
|
461
|
+
};
|
|
462
|
+
/** @description Internal server error */
|
|
463
|
+
500: {
|
|
464
|
+
headers: {
|
|
465
|
+
[name: string]: unknown;
|
|
466
|
+
};
|
|
467
|
+
content: {
|
|
468
|
+
"text/plain": string;
|
|
469
|
+
};
|
|
470
|
+
};
|
|
471
|
+
};
|
|
472
|
+
};
|
|
473
|
+
getLedgerEntry: {
|
|
474
|
+
parameters: {
|
|
475
|
+
query?: never;
|
|
476
|
+
header?: never;
|
|
477
|
+
path: {
|
|
478
|
+
/** @description Name of the ledger, for example `processed-profiles`. */
|
|
479
|
+
ledger: string;
|
|
480
|
+
/** @description Key within the ledger. URL-encode keys that contain reserved characters such as `/`. */
|
|
481
|
+
entryKey: string;
|
|
482
|
+
};
|
|
483
|
+
cookie?: never;
|
|
484
|
+
};
|
|
485
|
+
requestBody?: never;
|
|
486
|
+
responses: {
|
|
487
|
+
/** @description Ledger entry */
|
|
488
|
+
200: {
|
|
489
|
+
headers: {
|
|
490
|
+
[name: string]: unknown;
|
|
491
|
+
};
|
|
492
|
+
content: {
|
|
493
|
+
"application/json": {
|
|
494
|
+
/**
|
|
495
|
+
* Format: uuid
|
|
496
|
+
* @description Server-generated ledger entry ID.
|
|
497
|
+
*/
|
|
498
|
+
id: string;
|
|
499
|
+
/**
|
|
500
|
+
* Format: uuid
|
|
501
|
+
* @description Owning organization ID. Derived from the authenticated session, never client-settable.
|
|
502
|
+
*/
|
|
503
|
+
organizationId: string;
|
|
504
|
+
/** @description Name of the ledger (the idempotent set) the entry belongs to. */
|
|
505
|
+
ledger: string;
|
|
506
|
+
/** @description Key within the ledger. Unique per (organization, ledger). */
|
|
507
|
+
entryKey: string;
|
|
508
|
+
/** @description Entry value, stored as a JSON blob. */
|
|
509
|
+
value?: Record<string, never>;
|
|
510
|
+
/** @description Claimant that holds the entry, if any. Set only by claim-if-absent and never changed afterwards. */
|
|
511
|
+
claimedBy?: string;
|
|
512
|
+
/**
|
|
513
|
+
* Format: date-time
|
|
514
|
+
* @description Time the entry was claimed, if any. Set only by claim-if-absent.
|
|
515
|
+
*/
|
|
516
|
+
claimedAt?: string | null;
|
|
517
|
+
/**
|
|
518
|
+
* Format: date-time
|
|
519
|
+
* @description Timestamp of ledger entry creation.
|
|
520
|
+
*/
|
|
521
|
+
createdAt: string;
|
|
522
|
+
/**
|
|
523
|
+
* Format: date-time
|
|
524
|
+
* @description Timestamp of last ledger entry modification.
|
|
525
|
+
*/
|
|
526
|
+
updatedAt: string;
|
|
527
|
+
};
|
|
528
|
+
};
|
|
529
|
+
};
|
|
530
|
+
/** @description Expired JWT token used or insufficient privilege */
|
|
531
|
+
401: {
|
|
532
|
+
headers: {
|
|
533
|
+
[name: string]: unknown;
|
|
534
|
+
};
|
|
535
|
+
content: {
|
|
536
|
+
"text/plain": string;
|
|
537
|
+
};
|
|
538
|
+
};
|
|
539
|
+
/** @description Result not found */
|
|
540
|
+
404: {
|
|
541
|
+
headers: {
|
|
542
|
+
[name: string]: unknown;
|
|
543
|
+
};
|
|
544
|
+
content: {
|
|
545
|
+
"text/plain": string;
|
|
546
|
+
};
|
|
547
|
+
};
|
|
548
|
+
/** @description Internal server error */
|
|
549
|
+
500: {
|
|
550
|
+
headers: {
|
|
551
|
+
[name: string]: unknown;
|
|
552
|
+
};
|
|
553
|
+
content: {
|
|
554
|
+
"text/plain": string;
|
|
555
|
+
};
|
|
556
|
+
};
|
|
557
|
+
};
|
|
558
|
+
};
|
|
559
|
+
deleteLedgerEntry: {
|
|
560
|
+
parameters: {
|
|
561
|
+
query?: never;
|
|
562
|
+
header?: never;
|
|
563
|
+
path: {
|
|
564
|
+
/** @description Name of the ledger, for example `processed-profiles`. */
|
|
565
|
+
ledger: string;
|
|
566
|
+
/** @description Key within the ledger. URL-encode keys that contain reserved characters such as `/`. */
|
|
567
|
+
entryKey: string;
|
|
568
|
+
};
|
|
569
|
+
cookie?: never;
|
|
570
|
+
};
|
|
571
|
+
requestBody?: never;
|
|
572
|
+
responses: {
|
|
573
|
+
/** @description Ledger entry deleted */
|
|
574
|
+
204: {
|
|
575
|
+
headers: {
|
|
576
|
+
[name: string]: unknown;
|
|
577
|
+
};
|
|
578
|
+
content?: never;
|
|
579
|
+
};
|
|
580
|
+
/** @description Expired JWT token used or insufficient privilege */
|
|
581
|
+
401: {
|
|
582
|
+
headers: {
|
|
583
|
+
[name: string]: unknown;
|
|
584
|
+
};
|
|
585
|
+
content: {
|
|
586
|
+
"text/plain": string;
|
|
587
|
+
};
|
|
588
|
+
};
|
|
589
|
+
/** @description Result not found */
|
|
590
|
+
404: {
|
|
591
|
+
headers: {
|
|
592
|
+
[name: string]: unknown;
|
|
593
|
+
};
|
|
594
|
+
content: {
|
|
595
|
+
"text/plain": string;
|
|
596
|
+
};
|
|
597
|
+
};
|
|
598
|
+
/** @description Internal server error */
|
|
599
|
+
500: {
|
|
600
|
+
headers: {
|
|
601
|
+
[name: string]: unknown;
|
|
602
|
+
};
|
|
603
|
+
content: {
|
|
604
|
+
"text/plain": string;
|
|
605
|
+
};
|
|
606
|
+
};
|
|
607
|
+
};
|
|
608
|
+
};
|
|
609
|
+
}
|