@andesine/sdk 0.7.0 → 0.9.0
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/CHANGELOG.md +35 -0
- package/README.md +5 -5
- package/dist/{client-TZ83eSln.d.ts → client-54DXm4mG.d.ts} +77 -6
- package/dist/{client-D7hqNIEY.js → client-C_F2KykP.js} +75 -1
- package/dist/client-C_F2KykP.js.map +1 -0
- package/dist/extensions.d.ts +8 -3
- package/dist/extensions.js +6 -3
- package/dist/extensions.js.map +1 -1
- package/dist/{index-BL6xmKO6.d.ts → index-DFu0YVlp.d.ts} +27 -5
- package/dist/index.d.ts +4 -4
- package/dist/index.js +1 -1
- package/dist/{schema-D7yh5Hbs.d.ts → schema-DBHoDzsT.d.ts} +2482 -594
- package/dist/streaming.d.ts +1 -1
- package/dist/webhooks.d.ts +1 -1
- package/dist/webhooks.js +991 -2237
- package/dist/webhooks.js.map +1 -1
- package/openapi.json +5588 -4918
- package/package.json +1 -1
- package/dist/client-D7hqNIEY.js.map +0 -1
- package/dist/rolldown-runtime-EAsCxrDo.js +0 -14
|
@@ -361,7 +361,7 @@ interface paths {
|
|
|
361
361
|
put?: never;
|
|
362
362
|
/**
|
|
363
363
|
* Verify a session token
|
|
364
|
-
* @description Verifies a session token from the extension frontend and returns its member. Tokens of other extensions, expired tokens, and tokens of an earlier extension generation fail with NOT_FOUND.
|
|
364
|
+
* @description Verifies a session token from the extension frontend and returns its member. Tokens of other extensions, expired tokens, and tokens of an earlier extension generation fail with NOT_FOUND. checks evaluates collection and entry actions for the member, in collections the extension can read (restricted collections included), so the backend can authorize the member's request.
|
|
365
365
|
*/
|
|
366
366
|
post: operations["extensions.verifySession"];
|
|
367
367
|
delete?: never;
|
|
@@ -430,6 +430,54 @@ interface paths {
|
|
|
430
430
|
patch?: never;
|
|
431
431
|
trace?: never;
|
|
432
432
|
};
|
|
433
|
+
"/extensions/self/publishable-keys": {
|
|
434
|
+
parameters: {
|
|
435
|
+
query?: never;
|
|
436
|
+
header?: never;
|
|
437
|
+
path?: never;
|
|
438
|
+
cookie?: never;
|
|
439
|
+
};
|
|
440
|
+
/**
|
|
441
|
+
* List managed publishable keys
|
|
442
|
+
* @description Lists the publishable keys that the extension manages. Requires the publishable-keys permission.
|
|
443
|
+
*/
|
|
444
|
+
get: operations["extensions.listSelfPublishableKeys"];
|
|
445
|
+
put?: never;
|
|
446
|
+
/**
|
|
447
|
+
* Create a managed publishable key
|
|
448
|
+
* @description Creates a publishable key that the extension manages: read:publishing, and ai-answers with answers. Its collections must be readable by the extension. Members see it in API settings and can only delete it. It stops working while the extension is disabled or revoked; losing the permission or read:publishing, or uninstalling, deletes it, and losing ai-answers removes that permission. Up to 10 keys per installation. Requires the publishable-keys permission.
|
|
449
|
+
*/
|
|
450
|
+
post: operations["extensions.createSelfPublishableKey"];
|
|
451
|
+
delete?: never;
|
|
452
|
+
options?: never;
|
|
453
|
+
head?: never;
|
|
454
|
+
patch?: never;
|
|
455
|
+
trace?: never;
|
|
456
|
+
};
|
|
457
|
+
"/extensions/self/publishable-keys/{keyID}": {
|
|
458
|
+
parameters: {
|
|
459
|
+
query?: never;
|
|
460
|
+
header?: never;
|
|
461
|
+
path?: never;
|
|
462
|
+
cookie?: never;
|
|
463
|
+
};
|
|
464
|
+
get?: never;
|
|
465
|
+
put?: never;
|
|
466
|
+
post?: never;
|
|
467
|
+
/**
|
|
468
|
+
* Delete a managed publishable key
|
|
469
|
+
* @description Deletes a key that the extension manages, if it exists. Requires the publishable-keys permission.
|
|
470
|
+
*/
|
|
471
|
+
delete: operations["extensions.deleteSelfPublishableKey"];
|
|
472
|
+
options?: never;
|
|
473
|
+
head?: never;
|
|
474
|
+
/**
|
|
475
|
+
* Update a managed publishable key
|
|
476
|
+
* @description Changes the name, collections, origins, or AI answers of a key that the extension manages. Requires the publishable-keys permission.
|
|
477
|
+
*/
|
|
478
|
+
patch: operations["extensions.updateSelfPublishableKey"];
|
|
479
|
+
trace?: never;
|
|
480
|
+
};
|
|
433
481
|
"/extensions/self/storage/entry": {
|
|
434
482
|
parameters: {
|
|
435
483
|
query?: never;
|
|
@@ -478,6 +526,28 @@ interface paths {
|
|
|
478
526
|
patch?: never;
|
|
479
527
|
trace?: never;
|
|
480
528
|
};
|
|
529
|
+
"/extensions/elements": {
|
|
530
|
+
parameters: {
|
|
531
|
+
query?: never;
|
|
532
|
+
header?: never;
|
|
533
|
+
path?: never;
|
|
534
|
+
cookie?: never;
|
|
535
|
+
};
|
|
536
|
+
/**
|
|
537
|
+
* List custom elements
|
|
538
|
+
* @description The custom elements that the workspace's active extensions draw in the editor, e.g. Tabs: their props, whether they have content, which child blocks their content accepts, and the elements that belong inside them. Write them in MDX as <Name prop="value">content</Name>. The editor guides edits by these rules and offers a clean-up; the API doesn't enforce them.
|
|
539
|
+
*
|
|
540
|
+
* Required API key permissions: read:entries. Write permissions also grant read access for the same resource.
|
|
541
|
+
*/
|
|
542
|
+
get: operations["extensions.listElements"];
|
|
543
|
+
put?: never;
|
|
544
|
+
post?: never;
|
|
545
|
+
delete?: never;
|
|
546
|
+
options?: never;
|
|
547
|
+
head?: never;
|
|
548
|
+
patch?: never;
|
|
549
|
+
trace?: never;
|
|
550
|
+
};
|
|
481
551
|
"/collections": {
|
|
482
552
|
parameters: {
|
|
483
553
|
query?: never;
|
|
@@ -572,6 +642,28 @@ interface paths {
|
|
|
572
642
|
patch?: never;
|
|
573
643
|
trace?: never;
|
|
574
644
|
};
|
|
645
|
+
"/collections/get": {
|
|
646
|
+
parameters: {
|
|
647
|
+
query?: never;
|
|
648
|
+
header?: never;
|
|
649
|
+
path?: never;
|
|
650
|
+
cookie?: never;
|
|
651
|
+
};
|
|
652
|
+
/**
|
|
653
|
+
* Get a collection
|
|
654
|
+
* @description Returns one collection by collectionID, collectionPath, or collectionSlugPath, with its name, path, and ancestors.
|
|
655
|
+
*
|
|
656
|
+
* Required API key permissions: read:collections. Write permissions also grant read access for the same resource.
|
|
657
|
+
*/
|
|
658
|
+
get: operations["collections.get"];
|
|
659
|
+
put?: never;
|
|
660
|
+
post?: never;
|
|
661
|
+
delete?: never;
|
|
662
|
+
options?: never;
|
|
663
|
+
head?: never;
|
|
664
|
+
patch?: never;
|
|
665
|
+
trace?: never;
|
|
666
|
+
};
|
|
575
667
|
"/collections/list": {
|
|
576
668
|
parameters: {
|
|
577
669
|
query?: never;
|
|
@@ -1274,6 +1366,28 @@ interface paths {
|
|
|
1274
1366
|
patch?: never;
|
|
1275
1367
|
trace?: never;
|
|
1276
1368
|
};
|
|
1369
|
+
"/schemas/{schemaID}/draft": {
|
|
1370
|
+
parameters: {
|
|
1371
|
+
query?: never;
|
|
1372
|
+
header?: never;
|
|
1373
|
+
path?: never;
|
|
1374
|
+
cookie?: never;
|
|
1375
|
+
};
|
|
1376
|
+
get?: never;
|
|
1377
|
+
put?: never;
|
|
1378
|
+
/**
|
|
1379
|
+
* Update a schema draft
|
|
1380
|
+
* @description Replaces the fields of the local schema draft. People editing the draft see the change live. Fields keep their content in entries by ID, so reuse the IDs from schemas.get. Inherited fields stay as they are; don't include them. Entries don't change until schemas.apply.
|
|
1381
|
+
*
|
|
1382
|
+
* Required API key permissions: collections. Write permissions also grant read access for the same resource.
|
|
1383
|
+
*/
|
|
1384
|
+
post: operations["schemas.updateDraft"];
|
|
1385
|
+
delete?: never;
|
|
1386
|
+
options?: never;
|
|
1387
|
+
head?: never;
|
|
1388
|
+
patch?: never;
|
|
1389
|
+
trace?: never;
|
|
1390
|
+
};
|
|
1277
1391
|
"/schemas/{schemaID}/apply": {
|
|
1278
1392
|
parameters: {
|
|
1279
1393
|
query?: never;
|
|
@@ -1285,7 +1399,7 @@ interface paths {
|
|
|
1285
1399
|
put?: never;
|
|
1286
1400
|
/**
|
|
1287
1401
|
* Apply a schema draft
|
|
1288
|
-
* @description Creates a schema version from the draft and starts any required migration of affected entry content. Review possible content removal before calling: confirmedDataLoss must be true. Use schemaMigrations.get to follow a returned migrationID.
|
|
1402
|
+
* @description Creates a schema version from the draft, or from definition, and starts any required migration of affected entry content. With definition, the draft is replaced only if the apply succeeds. Review possible content removal before calling: confirmedDataLoss must be true. Use schemaMigrations.get to follow a returned migrationID.
|
|
1289
1403
|
*
|
|
1290
1404
|
* Required API key permissions: collections. Write permissions also grant read access for the same resource.
|
|
1291
1405
|
*/
|
|
@@ -1739,9 +1853,9 @@ interface paths {
|
|
|
1739
1853
|
put?: never;
|
|
1740
1854
|
/**
|
|
1741
1855
|
* Revert pending publishing changes
|
|
1742
|
-
* @description Restores selected drafts to the reviewed publication snapshot. This can remove unpublished items and replace draft content. First review publishing.getChannelContent and pass its snapshotID. Use all: true or specific collectionIDs/entryIDs, never both. Requires write access to affected resources
|
|
1856
|
+
* @description Restores selected drafts to the reviewed publication snapshot. This can remove unpublished items and replace draft content. First review publishing.getChannelContent and pass its snapshotID. Use all: true or specific collectionIDs/entryIDs, never both. Requires read:publishing and entries, plus write access to affected resources.
|
|
1743
1857
|
*
|
|
1744
|
-
* Required API key permissions: read:publishing. Write permissions also grant read access for the same resource.
|
|
1858
|
+
* Required API key permissions: read:publishing, entries. Write permissions also grant read access for the same resource.
|
|
1745
1859
|
*/
|
|
1746
1860
|
post: operations["publishing.revertChanges"];
|
|
1747
1861
|
delete?: never;
|
|
@@ -2022,7 +2136,6 @@ interface components {
|
|
|
2022
2136
|
operationID: string;
|
|
2023
2137
|
/** @constant */
|
|
2024
2138
|
schemaVersion: 1;
|
|
2025
|
-
/** Format: date-time */
|
|
2026
2139
|
occurredAt: string;
|
|
2027
2140
|
workspaceID: string;
|
|
2028
2141
|
/** @default null */
|
|
@@ -2066,7 +2179,6 @@ interface components {
|
|
|
2066
2179
|
operationID: string;
|
|
2067
2180
|
/** @constant */
|
|
2068
2181
|
schemaVersion: 1;
|
|
2069
|
-
/** Format: date-time */
|
|
2070
2182
|
occurredAt: string;
|
|
2071
2183
|
workspaceID: string;
|
|
2072
2184
|
/** @default null */
|
|
@@ -2109,7 +2221,6 @@ interface components {
|
|
|
2109
2221
|
operationID: string;
|
|
2110
2222
|
/** @constant */
|
|
2111
2223
|
schemaVersion: 1;
|
|
2112
|
-
/** Format: date-time */
|
|
2113
2224
|
occurredAt: string;
|
|
2114
2225
|
workspaceID: string;
|
|
2115
2226
|
/** @default null */
|
|
@@ -2146,7 +2257,6 @@ interface components {
|
|
|
2146
2257
|
data: {
|
|
2147
2258
|
collectionID: string | null;
|
|
2148
2259
|
contentHash: string;
|
|
2149
|
-
/** Format: date-time */
|
|
2150
2260
|
savedAt: string;
|
|
2151
2261
|
};
|
|
2152
2262
|
} | {
|
|
@@ -2154,7 +2264,6 @@ interface components {
|
|
|
2154
2264
|
operationID: string;
|
|
2155
2265
|
/** @constant */
|
|
2156
2266
|
schemaVersion: 1;
|
|
2157
|
-
/** Format: date-time */
|
|
2158
2267
|
occurredAt: string;
|
|
2159
2268
|
workspaceID: string;
|
|
2160
2269
|
/** @default null */
|
|
@@ -2245,7 +2354,6 @@ interface components {
|
|
|
2245
2354
|
operationID: string;
|
|
2246
2355
|
/** @constant */
|
|
2247
2356
|
schemaVersion: 1;
|
|
2248
|
-
/** Format: date-time */
|
|
2249
2357
|
occurredAt: string;
|
|
2250
2358
|
workspaceID: string;
|
|
2251
2359
|
/** @default null */
|
|
@@ -2282,7 +2390,6 @@ interface components {
|
|
|
2282
2390
|
data: {
|
|
2283
2391
|
name: string;
|
|
2284
2392
|
collectionID: string | null;
|
|
2285
|
-
/** Format: date-time */
|
|
2286
2393
|
deletedAt: string;
|
|
2287
2394
|
};
|
|
2288
2395
|
} | {
|
|
@@ -2290,7 +2397,6 @@ interface components {
|
|
|
2290
2397
|
operationID: string;
|
|
2291
2398
|
/** @constant */
|
|
2292
2399
|
schemaVersion: 1;
|
|
2293
|
-
/** Format: date-time */
|
|
2294
2400
|
occurredAt: string;
|
|
2295
2401
|
workspaceID: string;
|
|
2296
2402
|
/** @default null */
|
|
@@ -2333,7 +2439,6 @@ interface components {
|
|
|
2333
2439
|
operationID: string;
|
|
2334
2440
|
/** @constant */
|
|
2335
2441
|
schemaVersion: 1;
|
|
2336
|
-
/** Format: date-time */
|
|
2337
2442
|
occurredAt: string;
|
|
2338
2443
|
workspaceID: string;
|
|
2339
2444
|
/** @default null */
|
|
@@ -2376,7 +2481,6 @@ interface components {
|
|
|
2376
2481
|
operationID: string;
|
|
2377
2482
|
/** @constant */
|
|
2378
2483
|
schemaVersion: 1;
|
|
2379
|
-
/** Format: date-time */
|
|
2380
2484
|
occurredAt: string;
|
|
2381
2485
|
workspaceID: string;
|
|
2382
2486
|
/** @default null */
|
|
@@ -2419,7 +2523,6 @@ interface components {
|
|
|
2419
2523
|
operationID: string;
|
|
2420
2524
|
/** @constant */
|
|
2421
2525
|
schemaVersion: 1;
|
|
2422
|
-
/** Format: date-time */
|
|
2423
2526
|
occurredAt: string;
|
|
2424
2527
|
workspaceID: string;
|
|
2425
2528
|
/** @default null */
|
|
@@ -2510,7 +2613,6 @@ interface components {
|
|
|
2510
2613
|
operationID: string;
|
|
2511
2614
|
/** @constant */
|
|
2512
2615
|
schemaVersion: 1;
|
|
2513
|
-
/** Format: date-time */
|
|
2514
2616
|
occurredAt: string;
|
|
2515
2617
|
workspaceID: string;
|
|
2516
2618
|
/** @default null */
|
|
@@ -2547,7 +2649,6 @@ interface components {
|
|
|
2547
2649
|
data: {
|
|
2548
2650
|
name: string;
|
|
2549
2651
|
parentID: string | null;
|
|
2550
|
-
/** Format: date-time */
|
|
2551
2652
|
deletedAt: string;
|
|
2552
2653
|
};
|
|
2553
2654
|
} | {
|
|
@@ -2555,7 +2656,6 @@ interface components {
|
|
|
2555
2656
|
operationID: string;
|
|
2556
2657
|
/** @constant */
|
|
2557
2658
|
schemaVersion: 1;
|
|
2558
|
-
/** Format: date-time */
|
|
2559
2659
|
occurredAt: string;
|
|
2560
2660
|
workspaceID: string;
|
|
2561
2661
|
/** @default null */
|
|
@@ -2598,7 +2698,6 @@ interface components {
|
|
|
2598
2698
|
operationID: string;
|
|
2599
2699
|
/** @constant */
|
|
2600
2700
|
schemaVersion: 1;
|
|
2601
|
-
/** Format: date-time */
|
|
2602
2701
|
occurredAt: string;
|
|
2603
2702
|
workspaceID: string;
|
|
2604
2703
|
/** @default null */
|
|
@@ -2643,7 +2742,6 @@ interface components {
|
|
|
2643
2742
|
operationID: string;
|
|
2644
2743
|
/** @constant */
|
|
2645
2744
|
schemaVersion: 1;
|
|
2646
|
-
/** Format: date-time */
|
|
2647
2745
|
occurredAt: string;
|
|
2648
2746
|
workspaceID: string;
|
|
2649
2747
|
/** @default null */
|
|
@@ -2687,7 +2785,6 @@ interface components {
|
|
|
2687
2785
|
operationID: string;
|
|
2688
2786
|
/** @constant */
|
|
2689
2787
|
schemaVersion: 1;
|
|
2690
|
-
/** Format: date-time */
|
|
2691
2788
|
occurredAt: string;
|
|
2692
2789
|
workspaceID: string;
|
|
2693
2790
|
/** @default null */
|
|
@@ -2730,7 +2827,6 @@ interface components {
|
|
|
2730
2827
|
WebhookEventName: "entry.created" | "entry.updated" | "entry.content_saved" | "entry.moved" | "entry.deleted" | "entry.restored" | "collection.created" | "collection.updated" | "collection.moved" | "collection.deleted" | "collection.restored" | "publishing.channel_advanced" | "publishing.channel_created" | "publishing.channel_deleted";
|
|
2731
2828
|
WebhookEndpoint: {
|
|
2732
2829
|
name: string;
|
|
2733
|
-
/** Format: uri */
|
|
2734
2830
|
url: string;
|
|
2735
2831
|
enabled: boolean;
|
|
2736
2832
|
eventTypes: components["schemas"]["WebhookEventName"][];
|
|
@@ -2758,9 +2854,7 @@ interface components {
|
|
|
2758
2854
|
workspaceID: string;
|
|
2759
2855
|
revision: number;
|
|
2760
2856
|
destinationRevision: number;
|
|
2761
|
-
/** Format: date-time */
|
|
2762
2857
|
createdAt: string;
|
|
2763
|
-
/** Format: date-time */
|
|
2764
2858
|
updatedAt: string;
|
|
2765
2859
|
disabledReason: ("manual" | "failures") | null;
|
|
2766
2860
|
health: {
|
|
@@ -2773,7 +2867,6 @@ interface components {
|
|
|
2773
2867
|
failedCount: number;
|
|
2774
2868
|
};
|
|
2775
2869
|
signing: {
|
|
2776
|
-
/** Format: date-time */
|
|
2777
2870
|
rotatedAt: string;
|
|
2778
2871
|
previousSecretExpiresAt: string | null;
|
|
2779
2872
|
};
|
|
@@ -2783,15 +2876,12 @@ interface components {
|
|
|
2783
2876
|
endpointID: string;
|
|
2784
2877
|
eventID: string;
|
|
2785
2878
|
type: components["schemas"]["WebhookEventName"];
|
|
2786
|
-
/** Format: date-time */
|
|
2787
2879
|
occurredAt: string;
|
|
2788
2880
|
test: boolean;
|
|
2789
2881
|
/** @enum {string} */
|
|
2790
2882
|
state: "pending" | "in_flight" | "succeeded" | "failed" | "cancelled";
|
|
2791
2883
|
selectedRevision: number;
|
|
2792
|
-
/** Format: date-time */
|
|
2793
2884
|
createdAt: string;
|
|
2794
|
-
/** Format: date-time */
|
|
2795
2885
|
expiresAt: string;
|
|
2796
2886
|
retentionDays: number;
|
|
2797
2887
|
attemptCount: number;
|
|
@@ -2809,9 +2899,7 @@ interface components {
|
|
|
2809
2899
|
destinationRevision: number;
|
|
2810
2900
|
/** @enum {string} */
|
|
2811
2901
|
state: "pending" | "in_flight" | "succeeded" | "failed" | "cancelled";
|
|
2812
|
-
/** Format: date-time */
|
|
2813
2902
|
createdAt: string;
|
|
2814
|
-
/** Format: date-time */
|
|
2815
2903
|
deadlineAt: string;
|
|
2816
2904
|
finishedAt: string | null;
|
|
2817
2905
|
nextAttemptAt: string | null;
|
|
@@ -2822,7 +2910,6 @@ interface components {
|
|
|
2822
2910
|
id: string;
|
|
2823
2911
|
runID: string;
|
|
2824
2912
|
number: number;
|
|
2825
|
-
/** Format: date-time */
|
|
2826
2913
|
startedAt: string;
|
|
2827
2914
|
finishedAt: string | null;
|
|
2828
2915
|
durationMs: number | null;
|
|
@@ -2831,7 +2918,6 @@ interface components {
|
|
|
2831
2918
|
httpStatus: number | null;
|
|
2832
2919
|
failureCategory: ("http_status" | "timeout" | "network" | "destination_policy" | "internal") | null;
|
|
2833
2920
|
lateResult: {
|
|
2834
|
-
/** Format: date-time */
|
|
2835
2921
|
receivedAt: string;
|
|
2836
2922
|
/** @enum {string} */
|
|
2837
2923
|
outcome: "succeeded" | "receiver_failure" | "platform_failure";
|
|
@@ -2919,6 +3005,8 @@ interface components {
|
|
|
2919
3005
|
userID: string;
|
|
2920
3006
|
/** @description ID of the member's latest active entry */
|
|
2921
3007
|
currentEntryID?: string;
|
|
3008
|
+
/** @description ID of the collection with the example content */
|
|
3009
|
+
exampleCollectionID?: string;
|
|
2922
3010
|
/** @description Permissions granted to the current member */
|
|
2923
3011
|
permissions: components["schemas"]["Permission"][];
|
|
2924
3012
|
/** @description Whether the current member has the system admin role */
|
|
@@ -2967,7 +3055,6 @@ interface components {
|
|
|
2967
3055
|
title: string;
|
|
2968
3056
|
snippet: string;
|
|
2969
3057
|
properties: components["schemas"]["SearchPropertyValue"][];
|
|
2970
|
-
/** Format: date-time */
|
|
2971
3058
|
updatedAt: string;
|
|
2972
3059
|
channel?: components["schemas"]["PublishingChannelCode"];
|
|
2973
3060
|
versionID?: string;
|
|
@@ -2986,7 +3073,6 @@ interface components {
|
|
|
2986
3073
|
title: string;
|
|
2987
3074
|
snippet: string;
|
|
2988
3075
|
properties: components["schemas"]["SearchPropertyValue"][];
|
|
2989
|
-
/** Format: date-time */
|
|
2990
3076
|
updatedAt: string;
|
|
2991
3077
|
channel: components["schemas"]["PublishingChannelCode"];
|
|
2992
3078
|
versionID: string;
|
|
@@ -3095,10 +3181,7 @@ interface components {
|
|
|
3095
3181
|
InstanceInfo: {
|
|
3096
3182
|
/** @description API contract version, not the server build version */
|
|
3097
3183
|
apiVersion: string;
|
|
3098
|
-
/**
|
|
3099
|
-
* Format: uri
|
|
3100
|
-
* @description URL of the web app; entries open at {appURL}/{workspaceID}/{entryID}
|
|
3101
|
-
*/
|
|
3184
|
+
/** @description URL of the web app; entries open at {appURL}/{workspaceID}/{entryID} */
|
|
3102
3185
|
appURL: string;
|
|
3103
3186
|
/** @description Configured availability; does not imply permission or current service health */
|
|
3104
3187
|
features: {
|
|
@@ -3258,10 +3341,7 @@ interface components {
|
|
|
3258
3341
|
id: string;
|
|
3259
3342
|
/** @description User's full name */
|
|
3260
3343
|
name?: string;
|
|
3261
|
-
/**
|
|
3262
|
-
* Format: email
|
|
3263
|
-
* @description Email address
|
|
3264
|
-
*/
|
|
3344
|
+
/** @description Email address */
|
|
3265
3345
|
email: string;
|
|
3266
3346
|
/** @description URL of the user's avatar image */
|
|
3267
3347
|
image?: string;
|
|
@@ -3316,15 +3396,9 @@ interface components {
|
|
|
3316
3396
|
sourceVersionID: string | null;
|
|
3317
3397
|
/** @description Memberships that contributed to the version */
|
|
3318
3398
|
contributorIDs: string[];
|
|
3319
|
-
/**
|
|
3320
|
-
* Format: date-time
|
|
3321
|
-
* @description Time when the version was created
|
|
3322
|
-
*/
|
|
3399
|
+
/** @description Time when the version was created */
|
|
3323
3400
|
createdAt: string;
|
|
3324
|
-
/**
|
|
3325
|
-
* Format: date-time
|
|
3326
|
-
* @description Time when the version name was last updated
|
|
3327
|
-
*/
|
|
3401
|
+
/** @description Time when the version name was last updated */
|
|
3328
3402
|
updatedAt: string;
|
|
3329
3403
|
schema: components["schemas"]["ContentSchemaMetadata"] | null;
|
|
3330
3404
|
/** @description ProseMirror JSON stored in the version */
|
|
@@ -3358,15 +3432,9 @@ interface components {
|
|
|
3358
3432
|
sourceVersionID: string | null;
|
|
3359
3433
|
/** @description Memberships that contributed to the version */
|
|
3360
3434
|
contributorIDs: string[];
|
|
3361
|
-
/**
|
|
3362
|
-
* Format: date-time
|
|
3363
|
-
* @description Time when the version was created
|
|
3364
|
-
*/
|
|
3435
|
+
/** @description Time when the version was created */
|
|
3365
3436
|
createdAt: string;
|
|
3366
|
-
/**
|
|
3367
|
-
* Format: date-time
|
|
3368
|
-
* @description Time when the version name was last updated
|
|
3369
|
-
*/
|
|
3437
|
+
/** @description Time when the version name was last updated */
|
|
3370
3438
|
updatedAt: string;
|
|
3371
3439
|
};
|
|
3372
3440
|
/** @enum {string} */
|
|
@@ -3391,15 +3459,9 @@ interface components {
|
|
|
3391
3459
|
/** @description Whether the draft differs from the active version */
|
|
3392
3460
|
hasUnappliedChanges: boolean;
|
|
3393
3461
|
activeVersion: components["schemas"]["SchemaVersionSummary"] | null;
|
|
3394
|
-
/**
|
|
3395
|
-
* Format: date-time
|
|
3396
|
-
* @description Time when the local schema was first created
|
|
3397
|
-
*/
|
|
3462
|
+
/** @description Time when the local schema was first created */
|
|
3398
3463
|
createdAt: string;
|
|
3399
|
-
/**
|
|
3400
|
-
* Format: date-time
|
|
3401
|
-
* @description Time when the local schema draft was last updated
|
|
3402
|
-
*/
|
|
3464
|
+
/** @description Time when the local schema draft was last updated */
|
|
3403
3465
|
updatedAt: string;
|
|
3404
3466
|
};
|
|
3405
3467
|
EffectiveCollectionSchema: {
|
|
@@ -3428,10 +3490,7 @@ interface components {
|
|
|
3428
3490
|
hash: string;
|
|
3429
3491
|
/** @description Whether the effective schema is fully inherited */
|
|
3430
3492
|
inherited: boolean;
|
|
3431
|
-
/**
|
|
3432
|
-
* Format: date-time
|
|
3433
|
-
* @description Time when the effective revision was created
|
|
3434
|
-
*/
|
|
3493
|
+
/** @description Time when the effective revision was created */
|
|
3435
3494
|
createdAt: string;
|
|
3436
3495
|
};
|
|
3437
3496
|
SchemaVersion: {
|
|
@@ -3460,15 +3519,9 @@ interface components {
|
|
|
3460
3519
|
appliedBy: string | null;
|
|
3461
3520
|
/** @description Memberships that contributed to the schema version */
|
|
3462
3521
|
contributorIDs: string[];
|
|
3463
|
-
/**
|
|
3464
|
-
* Format: date-time
|
|
3465
|
-
* @description Time when the schema version was created
|
|
3466
|
-
*/
|
|
3522
|
+
/** @description Time when the schema version was created */
|
|
3467
3523
|
createdAt: string;
|
|
3468
|
-
/**
|
|
3469
|
-
* Format: date-time
|
|
3470
|
-
* @description Time when the schema version name was last updated
|
|
3471
|
-
*/
|
|
3524
|
+
/** @description Time when the schema version name was last updated */
|
|
3472
3525
|
updatedAt: string;
|
|
3473
3526
|
/** @description Local schema definition stored in the version */
|
|
3474
3527
|
definition: {
|
|
@@ -3513,15 +3566,9 @@ interface components {
|
|
|
3513
3566
|
appliedBy: string | null;
|
|
3514
3567
|
/** @description Memberships that contributed to the schema version */
|
|
3515
3568
|
contributorIDs: string[];
|
|
3516
|
-
/**
|
|
3517
|
-
* Format: date-time
|
|
3518
|
-
* @description Time when the schema version was created
|
|
3519
|
-
*/
|
|
3569
|
+
/** @description Time when the schema version was created */
|
|
3520
3570
|
createdAt: string;
|
|
3521
|
-
/**
|
|
3522
|
-
* Format: date-time
|
|
3523
|
-
* @description Time when the schema version name was last updated
|
|
3524
|
-
*/
|
|
3571
|
+
/** @description Time when the schema version name was last updated */
|
|
3525
3572
|
updatedAt: string;
|
|
3526
3573
|
};
|
|
3527
3574
|
SchemaApplicationResult: {
|
|
@@ -3550,9 +3597,7 @@ interface components {
|
|
|
3550
3597
|
initiatedBy: string | null;
|
|
3551
3598
|
startedAt: string | null;
|
|
3552
3599
|
completedAt: string | null;
|
|
3553
|
-
/** Format: date-time */
|
|
3554
3600
|
createdAt: string;
|
|
3555
|
-
/** Format: date-time */
|
|
3556
3601
|
updatedAt: string;
|
|
3557
3602
|
};
|
|
3558
3603
|
/** @enum {string} */
|
|
@@ -3583,8 +3628,9 @@ interface components {
|
|
|
3583
3628
|
label: string;
|
|
3584
3629
|
/** @enum {string} */
|
|
3585
3630
|
type: "text" | "number" | "checkbox" | "date" | "url" | "select" | "multi-select";
|
|
3586
|
-
|
|
3631
|
+
initialValue: components["schemas"]["SchemaPropertyValue"];
|
|
3587
3632
|
options: string[];
|
|
3633
|
+
optional?: boolean;
|
|
3588
3634
|
};
|
|
3589
3635
|
SchemaPropertyValue: boolean | string | string[];
|
|
3590
3636
|
SchemaFragment: {
|
|
@@ -3593,7 +3639,8 @@ interface components {
|
|
|
3593
3639
|
kind: "fragment";
|
|
3594
3640
|
label: string;
|
|
3595
3641
|
allowedBlocks: components["schemas"]["SchemaBlockType"][];
|
|
3596
|
-
|
|
3642
|
+
initialContent: components["schemas"]["ContentNode"][];
|
|
3643
|
+
optional?: boolean;
|
|
3597
3644
|
};
|
|
3598
3645
|
/** @enum {string} */
|
|
3599
3646
|
SchemaBlockType: "heading" | "blockquote" | "bulletList" | "orderedList" | "taskList" | "horizontalRule" | "codeBlock" | "table" | "element" | "image";
|
|
@@ -3625,10 +3672,7 @@ interface components {
|
|
|
3625
3672
|
path: string;
|
|
3626
3673
|
slugPath: string;
|
|
3627
3674
|
schema: components["schemas"]["ContentSchemaMetadata"] | null;
|
|
3628
|
-
/**
|
|
3629
|
-
* Format: date-time
|
|
3630
|
-
* @description Time when the entry content was last updated
|
|
3631
|
-
*/
|
|
3675
|
+
/** @description Time when the entry content was last updated */
|
|
3632
3676
|
updatedAt: string;
|
|
3633
3677
|
/** @description Hash of the current content, comparable to version hashes */
|
|
3634
3678
|
hash: string;
|
|
@@ -3685,29 +3729,25 @@ interface components {
|
|
|
3685
3729
|
byteSize: number;
|
|
3686
3730
|
width: number;
|
|
3687
3731
|
height: number;
|
|
3688
|
-
/** Format: uri */
|
|
3689
3732
|
url: string;
|
|
3690
|
-
/** Format: date-time */
|
|
3691
3733
|
expiresAt: string;
|
|
3692
3734
|
};
|
|
3693
3735
|
/** @enum {string} */
|
|
3694
3736
|
AssetFileFormat: "jpeg" | "png" | "webp";
|
|
3695
3737
|
/** @enum {string} */
|
|
3696
|
-
AssetVariant: "thumbnail" | "display";
|
|
3738
|
+
AssetVariant: "thumbnail" | "display" | "source";
|
|
3697
3739
|
AssetSearchResult: {
|
|
3698
3740
|
assetID: string;
|
|
3699
3741
|
entryID: string;
|
|
3700
3742
|
entryName: string;
|
|
3701
3743
|
filename: string;
|
|
3702
3744
|
description: string;
|
|
3703
|
-
/** Format: uri */
|
|
3704
3745
|
thumbnailURL: string;
|
|
3705
3746
|
width: number;
|
|
3706
3747
|
height: number;
|
|
3707
3748
|
};
|
|
3708
3749
|
AssetUploadRegistration: {
|
|
3709
3750
|
assetID: string;
|
|
3710
|
-
/** Format: date-time */
|
|
3711
3751
|
expiresAt: string;
|
|
3712
3752
|
};
|
|
3713
3753
|
Membership: {
|
|
@@ -3727,10 +3767,7 @@ interface components {
|
|
|
3727
3767
|
id: string;
|
|
3728
3768
|
/** @description User's full name */
|
|
3729
3769
|
name?: string;
|
|
3730
|
-
/**
|
|
3731
|
-
* Format: email
|
|
3732
|
-
* @description Email address
|
|
3733
|
-
*/
|
|
3770
|
+
/** @description Email address */
|
|
3734
3771
|
email: string;
|
|
3735
3772
|
/** @description URL of the user's avatar image */
|
|
3736
3773
|
image?: string;
|
|
@@ -3739,10 +3776,7 @@ interface components {
|
|
|
3739
3776
|
Invite: {
|
|
3740
3777
|
/** @description ID of the invite */
|
|
3741
3778
|
id: string;
|
|
3742
|
-
/**
|
|
3743
|
-
* Format: email
|
|
3744
|
-
* @description Email address of the invited user
|
|
3745
|
-
*/
|
|
3779
|
+
/** @description Email address of the invited user */
|
|
3746
3780
|
email: string;
|
|
3747
3781
|
/** @description ID of the role to assign */
|
|
3748
3782
|
roleID: string;
|
|
@@ -3753,20 +3787,11 @@ interface components {
|
|
|
3753
3787
|
* @enum {string}
|
|
3754
3788
|
*/
|
|
3755
3789
|
status: "pending" | "accepted" | "expired";
|
|
3756
|
-
/**
|
|
3757
|
-
* Format: date-time
|
|
3758
|
-
* @description When the invite was created
|
|
3759
|
-
*/
|
|
3790
|
+
/** @description When the invite was created */
|
|
3760
3791
|
createdAt: string;
|
|
3761
|
-
/**
|
|
3762
|
-
* Format: date-time
|
|
3763
|
-
* @description When the invite expires
|
|
3764
|
-
*/
|
|
3792
|
+
/** @description When the invite expires */
|
|
3765
3793
|
expiresAt: string;
|
|
3766
|
-
/**
|
|
3767
|
-
* Format: uri
|
|
3768
|
-
* @description Signed URL for accepting the invitation
|
|
3769
|
-
*/
|
|
3794
|
+
/** @description Signed URL for accepting the invitation */
|
|
3770
3795
|
inviteLink: string;
|
|
3771
3796
|
/** @description ID of the workspace the invite belongs to */
|
|
3772
3797
|
workspaceID: string;
|
|
@@ -3774,10 +3799,7 @@ interface components {
|
|
|
3774
3799
|
MembershipInviteResult: {
|
|
3775
3800
|
/** @description ID of the invite */
|
|
3776
3801
|
inviteID: string;
|
|
3777
|
-
/**
|
|
3778
|
-
* Format: uri
|
|
3779
|
-
* @description Invite link that can be shared manually
|
|
3780
|
-
*/
|
|
3802
|
+
/** @description Invite link that can be shared manually */
|
|
3781
3803
|
inviteLink: string;
|
|
3782
3804
|
/**
|
|
3783
3805
|
* @description Whether the invite email was sent, must be shared manually, or failed
|
|
@@ -3825,7 +3847,6 @@ interface components {
|
|
|
3825
3847
|
width: number;
|
|
3826
3848
|
height: number;
|
|
3827
3849
|
byteSize: number;
|
|
3828
|
-
/** Format: uri */
|
|
3829
3850
|
url: string;
|
|
3830
3851
|
};
|
|
3831
3852
|
PublishedEntry: {
|
|
@@ -3868,15 +3889,9 @@ interface components {
|
|
|
3868
3889
|
name: string;
|
|
3869
3890
|
/** @description Whether the channel is built in */
|
|
3870
3891
|
builtIn: boolean;
|
|
3871
|
-
/**
|
|
3872
|
-
* Format: date-time
|
|
3873
|
-
* @description Time when the channel was created
|
|
3874
|
-
*/
|
|
3892
|
+
/** @description Time when the channel was created */
|
|
3875
3893
|
createdAt: string;
|
|
3876
|
-
/**
|
|
3877
|
-
* Format: date-time
|
|
3878
|
-
* @description Time when the channel was last updated
|
|
3879
|
-
*/
|
|
3894
|
+
/** @description Time when the channel was last updated */
|
|
3880
3895
|
updatedAt: string;
|
|
3881
3896
|
};
|
|
3882
3897
|
PublishingChannelListItem: {
|
|
@@ -3886,24 +3901,15 @@ interface components {
|
|
|
3886
3901
|
name: string;
|
|
3887
3902
|
/** @description Whether the channel is built in */
|
|
3888
3903
|
builtIn: boolean;
|
|
3889
|
-
/**
|
|
3890
|
-
* Format: date-time
|
|
3891
|
-
* @description Time when the channel was created
|
|
3892
|
-
*/
|
|
3904
|
+
/** @description Time when the channel was created */
|
|
3893
3905
|
createdAt: string;
|
|
3894
|
-
/**
|
|
3895
|
-
* Format: date-time
|
|
3896
|
-
* @description Time when the channel was last updated
|
|
3897
|
-
*/
|
|
3906
|
+
/** @description Time when the channel was last updated */
|
|
3898
3907
|
updatedAt: string;
|
|
3899
3908
|
assignmentCount?: number;
|
|
3900
3909
|
};
|
|
3901
3910
|
EntryPublication: {
|
|
3902
3911
|
channel: components["schemas"]["EntryPublicationChannel"];
|
|
3903
|
-
/**
|
|
3904
|
-
* Format: date-time
|
|
3905
|
-
* @description Time when the version was published
|
|
3906
|
-
*/
|
|
3912
|
+
/** @description Time when the version was published */
|
|
3907
3913
|
publishedAt: string;
|
|
3908
3914
|
version: components["schemas"]["EntryVersionSummary"];
|
|
3909
3915
|
};
|
|
@@ -4038,7 +4044,6 @@ interface components {
|
|
|
4038
4044
|
title: string;
|
|
4039
4045
|
snippet: string;
|
|
4040
4046
|
properties: components["schemas"]["SearchPropertyValue"][];
|
|
4041
|
-
/** Format: date-time */
|
|
4042
4047
|
updatedAt: string;
|
|
4043
4048
|
channel: components["schemas"]["PublishingChannelCode"];
|
|
4044
4049
|
versionID: string;
|
|
@@ -4055,7 +4060,6 @@ interface components {
|
|
|
4055
4060
|
title: string;
|
|
4056
4061
|
snippet: string;
|
|
4057
4062
|
properties: components["schemas"]["SearchPropertyValue"][];
|
|
4058
|
-
/** Format: date-time */
|
|
4059
4063
|
updatedAt: string;
|
|
4060
4064
|
channel?: components["schemas"]["PublishingChannelCode"];
|
|
4061
4065
|
versionID?: string;
|
|
@@ -4457,7 +4461,6 @@ interface operations {
|
|
|
4457
4461
|
"application/json": {
|
|
4458
4462
|
assetID: string;
|
|
4459
4463
|
entryID: string;
|
|
4460
|
-
/** Format: uri */
|
|
4461
4464
|
url: string;
|
|
4462
4465
|
/** @default false */
|
|
4463
4466
|
checkDuplicates?: boolean;
|
|
@@ -8536,10 +8539,7 @@ interface operations {
|
|
|
8536
8539
|
path: string;
|
|
8537
8540
|
slugPath: string;
|
|
8538
8541
|
schema: components["schemas"]["ContentSchemaMetadata"] | null;
|
|
8539
|
-
/**
|
|
8540
|
-
* Format: date-time
|
|
8541
|
-
* @description Time when the entry content was last updated
|
|
8542
|
-
*/
|
|
8542
|
+
/** @description Time when the entry content was last updated */
|
|
8543
8543
|
updatedAt: string;
|
|
8544
8544
|
/** @description Hash of the current content, comparable to version hashes */
|
|
8545
8545
|
hash: string;
|
|
@@ -9076,6 +9076,8 @@ interface operations {
|
|
|
9076
9076
|
/** @description Active version */
|
|
9077
9077
|
version: string;
|
|
9078
9078
|
workspaceID: string;
|
|
9079
|
+
/** @description The workspace's effective plan, e.g. free or pro; pro when the instance has no billing */
|
|
9080
|
+
workspacePlan: string;
|
|
9079
9081
|
/**
|
|
9080
9082
|
* @description Uninstalled extensions remain readable until their last lifecycle event expires
|
|
9081
9083
|
* @enum {string}
|
|
@@ -9307,6 +9309,12 @@ interface operations {
|
|
|
9307
9309
|
content: {
|
|
9308
9310
|
"application/json": {
|
|
9309
9311
|
token: string;
|
|
9312
|
+
checks?: {
|
|
9313
|
+
/** @description Collection to check; null for the top level */
|
|
9314
|
+
collectionID: string | null;
|
|
9315
|
+
/** @description Collection and entry actions that the member must be able to take */
|
|
9316
|
+
actions: (("collection:read" | "collection:create-child" | "collection:update" | "collection:move" | "collection:delete" | "collection:set-restricted" | "collection:manage-restricted-access" | "collection:set-publishing" | "publishing:publish-tree" | "publishing:unpublish-tree") | ("entry:create" | "entry:read" | "entry:update" | "entry:move" | "entry:delete" | "version:read" | "version:create" | "version:update" | "version:revert" | "publishing:read" | "publishing:publish" | "publishing:unpublish"))[];
|
|
9317
|
+
}[];
|
|
9310
9318
|
};
|
|
9311
9319
|
};
|
|
9312
9320
|
};
|
|
@@ -9319,6 +9327,8 @@ interface operations {
|
|
|
9319
9327
|
content: {
|
|
9320
9328
|
"application/json": {
|
|
9321
9329
|
workspaceID: string;
|
|
9330
|
+
/** @description The workspace's effective plan, e.g. free or pro; pro when the instance has no billing */
|
|
9331
|
+
workspacePlan: string;
|
|
9322
9332
|
/** @description The extension version the session was issued for */
|
|
9323
9333
|
version: string;
|
|
9324
9334
|
member: {
|
|
@@ -9334,6 +9344,14 @@ interface operations {
|
|
|
9334
9344
|
email?: string;
|
|
9335
9345
|
};
|
|
9336
9346
|
};
|
|
9347
|
+
/** @description Results of the requested checks, in their order */
|
|
9348
|
+
checks: {
|
|
9349
|
+
collectionID: string | null;
|
|
9350
|
+
/** @description Whether the member and the extension can take every action */
|
|
9351
|
+
allowed: boolean;
|
|
9352
|
+
/** @description Actions that are not allowed */
|
|
9353
|
+
denied: (("collection:read" | "collection:create-child" | "collection:update" | "collection:move" | "collection:delete" | "collection:set-restricted" | "collection:manage-restricted-access" | "collection:set-publishing" | "publishing:publish-tree" | "publishing:unpublish-tree") | ("entry:create" | "entry:read" | "entry:update" | "entry:move" | "entry:delete" | "version:read" | "version:create" | "version:update" | "version:revert" | "publishing:read" | "publishing:publish" | "publishing:unpublish"))[];
|
|
9354
|
+
}[];
|
|
9337
9355
|
};
|
|
9338
9356
|
};
|
|
9339
9357
|
};
|
|
@@ -9815,7 +9833,6 @@ interface operations {
|
|
|
9815
9833
|
operationID: string;
|
|
9816
9834
|
/** @constant */
|
|
9817
9835
|
schemaVersion: 1;
|
|
9818
|
-
/** Format: date-time */
|
|
9819
9836
|
occurredAt: string;
|
|
9820
9837
|
workspaceID: string;
|
|
9821
9838
|
/** @default null */
|
|
@@ -9859,7 +9876,6 @@ interface operations {
|
|
|
9859
9876
|
operationID: string;
|
|
9860
9877
|
/** @constant */
|
|
9861
9878
|
schemaVersion: 1;
|
|
9862
|
-
/** Format: date-time */
|
|
9863
9879
|
occurredAt: string;
|
|
9864
9880
|
workspaceID: string;
|
|
9865
9881
|
/** @default null */
|
|
@@ -9902,7 +9918,6 @@ interface operations {
|
|
|
9902
9918
|
operationID: string;
|
|
9903
9919
|
/** @constant */
|
|
9904
9920
|
schemaVersion: 1;
|
|
9905
|
-
/** Format: date-time */
|
|
9906
9921
|
occurredAt: string;
|
|
9907
9922
|
workspaceID: string;
|
|
9908
9923
|
/** @default null */
|
|
@@ -9939,7 +9954,6 @@ interface operations {
|
|
|
9939
9954
|
data: {
|
|
9940
9955
|
collectionID: string | null;
|
|
9941
9956
|
contentHash: string;
|
|
9942
|
-
/** Format: date-time */
|
|
9943
9957
|
savedAt: string;
|
|
9944
9958
|
};
|
|
9945
9959
|
} | {
|
|
@@ -9947,7 +9961,6 @@ interface operations {
|
|
|
9947
9961
|
operationID: string;
|
|
9948
9962
|
/** @constant */
|
|
9949
9963
|
schemaVersion: 1;
|
|
9950
|
-
/** Format: date-time */
|
|
9951
9964
|
occurredAt: string;
|
|
9952
9965
|
workspaceID: string;
|
|
9953
9966
|
/** @default null */
|
|
@@ -10038,7 +10051,6 @@ interface operations {
|
|
|
10038
10051
|
operationID: string;
|
|
10039
10052
|
/** @constant */
|
|
10040
10053
|
schemaVersion: 1;
|
|
10041
|
-
/** Format: date-time */
|
|
10042
10054
|
occurredAt: string;
|
|
10043
10055
|
workspaceID: string;
|
|
10044
10056
|
/** @default null */
|
|
@@ -10075,7 +10087,6 @@ interface operations {
|
|
|
10075
10087
|
data: {
|
|
10076
10088
|
name: string;
|
|
10077
10089
|
collectionID: string | null;
|
|
10078
|
-
/** Format: date-time */
|
|
10079
10090
|
deletedAt: string;
|
|
10080
10091
|
};
|
|
10081
10092
|
} | {
|
|
@@ -10083,7 +10094,6 @@ interface operations {
|
|
|
10083
10094
|
operationID: string;
|
|
10084
10095
|
/** @constant */
|
|
10085
10096
|
schemaVersion: 1;
|
|
10086
|
-
/** Format: date-time */
|
|
10087
10097
|
occurredAt: string;
|
|
10088
10098
|
workspaceID: string;
|
|
10089
10099
|
/** @default null */
|
|
@@ -10126,7 +10136,6 @@ interface operations {
|
|
|
10126
10136
|
operationID: string;
|
|
10127
10137
|
/** @constant */
|
|
10128
10138
|
schemaVersion: 1;
|
|
10129
|
-
/** Format: date-time */
|
|
10130
10139
|
occurredAt: string;
|
|
10131
10140
|
workspaceID: string;
|
|
10132
10141
|
/** @default null */
|
|
@@ -10169,7 +10178,6 @@ interface operations {
|
|
|
10169
10178
|
operationID: string;
|
|
10170
10179
|
/** @constant */
|
|
10171
10180
|
schemaVersion: 1;
|
|
10172
|
-
/** Format: date-time */
|
|
10173
10181
|
occurredAt: string;
|
|
10174
10182
|
workspaceID: string;
|
|
10175
10183
|
/** @default null */
|
|
@@ -10212,7 +10220,6 @@ interface operations {
|
|
|
10212
10220
|
operationID: string;
|
|
10213
10221
|
/** @constant */
|
|
10214
10222
|
schemaVersion: 1;
|
|
10215
|
-
/** Format: date-time */
|
|
10216
10223
|
occurredAt: string;
|
|
10217
10224
|
workspaceID: string;
|
|
10218
10225
|
/** @default null */
|
|
@@ -10303,7 +10310,6 @@ interface operations {
|
|
|
10303
10310
|
operationID: string;
|
|
10304
10311
|
/** @constant */
|
|
10305
10312
|
schemaVersion: 1;
|
|
10306
|
-
/** Format: date-time */
|
|
10307
10313
|
occurredAt: string;
|
|
10308
10314
|
workspaceID: string;
|
|
10309
10315
|
/** @default null */
|
|
@@ -10340,7 +10346,6 @@ interface operations {
|
|
|
10340
10346
|
data: {
|
|
10341
10347
|
name: string;
|
|
10342
10348
|
parentID: string | null;
|
|
10343
|
-
/** Format: date-time */
|
|
10344
10349
|
deletedAt: string;
|
|
10345
10350
|
};
|
|
10346
10351
|
} | {
|
|
@@ -10348,7 +10353,6 @@ interface operations {
|
|
|
10348
10353
|
operationID: string;
|
|
10349
10354
|
/** @constant */
|
|
10350
10355
|
schemaVersion: 1;
|
|
10351
|
-
/** Format: date-time */
|
|
10352
10356
|
occurredAt: string;
|
|
10353
10357
|
workspaceID: string;
|
|
10354
10358
|
/** @default null */
|
|
@@ -10391,7 +10395,6 @@ interface operations {
|
|
|
10391
10395
|
operationID: string;
|
|
10392
10396
|
/** @constant */
|
|
10393
10397
|
schemaVersion: 1;
|
|
10394
|
-
/** Format: date-time */
|
|
10395
10398
|
occurredAt: string;
|
|
10396
10399
|
workspaceID: string;
|
|
10397
10400
|
/** @default null */
|
|
@@ -10436,7 +10439,6 @@ interface operations {
|
|
|
10436
10439
|
operationID: string;
|
|
10437
10440
|
/** @constant */
|
|
10438
10441
|
schemaVersion: 1;
|
|
10439
|
-
/** Format: date-time */
|
|
10440
10442
|
occurredAt: string;
|
|
10441
10443
|
workspaceID: string;
|
|
10442
10444
|
/** @default null */
|
|
@@ -10480,7 +10482,6 @@ interface operations {
|
|
|
10480
10482
|
operationID: string;
|
|
10481
10483
|
/** @constant */
|
|
10482
10484
|
schemaVersion: 1;
|
|
10483
|
-
/** Format: date-time */
|
|
10484
10485
|
occurredAt: string;
|
|
10485
10486
|
workspaceID: string;
|
|
10486
10487
|
/** @default null */
|
|
@@ -10523,7 +10524,6 @@ interface operations {
|
|
|
10523
10524
|
operationID: string;
|
|
10524
10525
|
/** @constant */
|
|
10525
10526
|
schemaVersion: 1;
|
|
10526
|
-
/** Format: date-time */
|
|
10527
10527
|
occurredAt: string;
|
|
10528
10528
|
workspaceID: string;
|
|
10529
10529
|
/** @default null */
|
|
@@ -10565,7 +10565,6 @@ interface operations {
|
|
|
10565
10565
|
operationID: string;
|
|
10566
10566
|
/** @constant */
|
|
10567
10567
|
schemaVersion: 1;
|
|
10568
|
-
/** Format: date-time */
|
|
10569
10568
|
occurredAt: string;
|
|
10570
10569
|
workspaceID: string;
|
|
10571
10570
|
/** @default null */
|
|
@@ -10607,7 +10606,6 @@ interface operations {
|
|
|
10607
10606
|
operationID: string;
|
|
10608
10607
|
/** @constant */
|
|
10609
10608
|
schemaVersion: 1;
|
|
10610
|
-
/** Format: date-time */
|
|
10611
10609
|
occurredAt: string;
|
|
10612
10610
|
workspaceID: string;
|
|
10613
10611
|
/** @default null */
|
|
@@ -10651,7 +10649,6 @@ interface operations {
|
|
|
10651
10649
|
operationID: string;
|
|
10652
10650
|
/** @constant */
|
|
10653
10651
|
schemaVersion: 1;
|
|
10654
|
-
/** Format: date-time */
|
|
10655
10652
|
occurredAt: string;
|
|
10656
10653
|
workspaceID: string;
|
|
10657
10654
|
/** @default null */
|
|
@@ -10694,7 +10691,6 @@ interface operations {
|
|
|
10694
10691
|
operationID: string;
|
|
10695
10692
|
/** @constant */
|
|
10696
10693
|
schemaVersion: 1;
|
|
10697
|
-
/** Format: date-time */
|
|
10698
10694
|
occurredAt: string;
|
|
10699
10695
|
workspaceID: string;
|
|
10700
10696
|
/** @default null */
|
|
@@ -10738,7 +10734,6 @@ interface operations {
|
|
|
10738
10734
|
operationID: string;
|
|
10739
10735
|
/** @constant */
|
|
10740
10736
|
schemaVersion: 1;
|
|
10741
|
-
/** Format: date-time */
|
|
10742
10737
|
occurredAt: string;
|
|
10743
10738
|
workspaceID: string;
|
|
10744
10739
|
/** @default null */
|
|
@@ -11229,11 +11224,9 @@ interface operations {
|
|
|
11229
11224
|
};
|
|
11230
11225
|
};
|
|
11231
11226
|
};
|
|
11232
|
-
"extensions.
|
|
11227
|
+
"extensions.listSelfPublishableKeys": {
|
|
11233
11228
|
parameters: {
|
|
11234
|
-
query
|
|
11235
|
-
key: string;
|
|
11236
|
-
};
|
|
11229
|
+
query?: never;
|
|
11237
11230
|
header?: never;
|
|
11238
11231
|
path?: never;
|
|
11239
11232
|
cookie?: never;
|
|
@@ -11247,16 +11240,24 @@ interface operations {
|
|
|
11247
11240
|
};
|
|
11248
11241
|
content: {
|
|
11249
11242
|
"application/json": {
|
|
11250
|
-
|
|
11251
|
-
|
|
11252
|
-
|
|
11253
|
-
|
|
11254
|
-
|
|
11255
|
-
|
|
11256
|
-
|
|
11257
|
-
|
|
11258
|
-
|
|
11259
|
-
|
|
11243
|
+
data: {
|
|
11244
|
+
/** @description The ID of the API key */
|
|
11245
|
+
id: string;
|
|
11246
|
+
/** @description The name for the API key */
|
|
11247
|
+
name: string;
|
|
11248
|
+
/** @description The permissions of the API key */
|
|
11249
|
+
permissions: ("entries" | "read:entries" | "versions" | "read:versions" | "publishing" | "read:publishing" | "collections" | "read:collections" | "memberships" | "read:memberships" | "roles" | "read:roles" | "webhooks" | "read:webhooks" | "ai-answers")[];
|
|
11250
|
+
/** @description Publishable keys: the collections, with their descendants, that the key can read; none for all */
|
|
11251
|
+
collectionIDs: string[];
|
|
11252
|
+
/** @description Publishable keys: the browser origins that can use the key, with localhost */
|
|
11253
|
+
allowedOrigins: string[];
|
|
11254
|
+
/** @description The creation date */
|
|
11255
|
+
createdAt: string;
|
|
11256
|
+
/** @description The last update date */
|
|
11257
|
+
updatedAt: string;
|
|
11258
|
+
/** @description The raw key, which is public */
|
|
11259
|
+
value: string;
|
|
11260
|
+
}[];
|
|
11260
11261
|
};
|
|
11261
11262
|
};
|
|
11262
11263
|
};
|
|
@@ -11470,7 +11471,7 @@ interface operations {
|
|
|
11470
11471
|
};
|
|
11471
11472
|
};
|
|
11472
11473
|
};
|
|
11473
|
-
"extensions.
|
|
11474
|
+
"extensions.createSelfPublishableKey": {
|
|
11474
11475
|
parameters: {
|
|
11475
11476
|
query?: never;
|
|
11476
11477
|
header?: never;
|
|
@@ -11480,14 +11481,17 @@ interface operations {
|
|
|
11480
11481
|
requestBody: {
|
|
11481
11482
|
content: {
|
|
11482
11483
|
"application/json": {
|
|
11483
|
-
|
|
11484
|
-
|
|
11485
|
-
|
|
11486
|
-
|
|
11487
|
-
|
|
11488
|
-
|
|
11489
|
-
|
|
11490
|
-
|
|
11484
|
+
/** @description A name shown in API settings */
|
|
11485
|
+
name: string;
|
|
11486
|
+
/** @description Collections, with their descendants, that the key can read */
|
|
11487
|
+
collectionIDs: string[];
|
|
11488
|
+
/** @description Browser origins that can use the key, besides localhost */
|
|
11489
|
+
allowedOrigins: string[];
|
|
11490
|
+
/**
|
|
11491
|
+
* @description Whether the key can ask for AI answers; needs the extension's ai-answers permission
|
|
11492
|
+
* @default false
|
|
11493
|
+
*/
|
|
11494
|
+
answers?: boolean;
|
|
11491
11495
|
};
|
|
11492
11496
|
};
|
|
11493
11497
|
};
|
|
@@ -11499,9 +11503,22 @@ interface operations {
|
|
|
11499
11503
|
};
|
|
11500
11504
|
content: {
|
|
11501
11505
|
"application/json": {
|
|
11502
|
-
key
|
|
11503
|
-
|
|
11506
|
+
/** @description The ID of the API key */
|
|
11507
|
+
id: string;
|
|
11508
|
+
/** @description The name for the API key */
|
|
11509
|
+
name: string;
|
|
11510
|
+
/** @description The permissions of the API key */
|
|
11511
|
+
permissions: ("entries" | "read:entries" | "versions" | "read:versions" | "publishing" | "read:publishing" | "collections" | "read:collections" | "memberships" | "read:memberships" | "roles" | "read:roles" | "webhooks" | "read:webhooks" | "ai-answers")[];
|
|
11512
|
+
/** @description Publishable keys: the collections, with their descendants, that the key can read; none for all */
|
|
11513
|
+
collectionIDs: string[];
|
|
11514
|
+
/** @description Publishable keys: the browser origins that can use the key, with localhost */
|
|
11515
|
+
allowedOrigins: string[];
|
|
11516
|
+
/** @description The creation date */
|
|
11517
|
+
createdAt: string;
|
|
11518
|
+
/** @description The last update date */
|
|
11504
11519
|
updatedAt: string;
|
|
11520
|
+
/** @description The raw key, which is public */
|
|
11521
|
+
value: string;
|
|
11505
11522
|
};
|
|
11506
11523
|
};
|
|
11507
11524
|
};
|
|
@@ -11715,13 +11732,13 @@ interface operations {
|
|
|
11715
11732
|
};
|
|
11716
11733
|
};
|
|
11717
11734
|
};
|
|
11718
|
-
"extensions.
|
|
11735
|
+
"extensions.deleteSelfPublishableKey": {
|
|
11719
11736
|
parameters: {
|
|
11720
|
-
query
|
|
11721
|
-
key: string;
|
|
11722
|
-
};
|
|
11737
|
+
query?: never;
|
|
11723
11738
|
header?: never;
|
|
11724
|
-
path
|
|
11739
|
+
path: {
|
|
11740
|
+
keyID: string;
|
|
11741
|
+
};
|
|
11725
11742
|
cookie?: never;
|
|
11726
11743
|
};
|
|
11727
11744
|
requestBody?: never;
|
|
@@ -11947,18 +11964,29 @@ interface operations {
|
|
|
11947
11964
|
};
|
|
11948
11965
|
};
|
|
11949
11966
|
};
|
|
11950
|
-
"extensions.
|
|
11967
|
+
"extensions.updateSelfPublishableKey": {
|
|
11951
11968
|
parameters: {
|
|
11952
|
-
query?:
|
|
11953
|
-
prefix?: string;
|
|
11954
|
-
after?: string;
|
|
11955
|
-
limit?: number;
|
|
11956
|
-
};
|
|
11969
|
+
query?: never;
|
|
11957
11970
|
header?: never;
|
|
11958
|
-
path
|
|
11971
|
+
path: {
|
|
11972
|
+
keyID: string;
|
|
11973
|
+
};
|
|
11959
11974
|
cookie?: never;
|
|
11960
11975
|
};
|
|
11961
|
-
requestBody?:
|
|
11976
|
+
requestBody?: {
|
|
11977
|
+
content: {
|
|
11978
|
+
"application/json": {
|
|
11979
|
+
/** @description A name shown in API settings */
|
|
11980
|
+
name?: string;
|
|
11981
|
+
/** @description Collections, with their descendants, that the key can read */
|
|
11982
|
+
collectionIDs?: string[];
|
|
11983
|
+
/** @description Browser origins that can use the key, besides localhost */
|
|
11984
|
+
allowedOrigins?: string[];
|
|
11985
|
+
/** @description Whether the key can ask for AI answers; needs the extension's ai-answers permission */
|
|
11986
|
+
answers?: boolean;
|
|
11987
|
+
};
|
|
11988
|
+
};
|
|
11989
|
+
};
|
|
11962
11990
|
responses: {
|
|
11963
11991
|
/** @description OK */
|
|
11964
11992
|
200: {
|
|
@@ -11967,19 +11995,22 @@ interface operations {
|
|
|
11967
11995
|
};
|
|
11968
11996
|
content: {
|
|
11969
11997
|
"application/json": {
|
|
11970
|
-
|
|
11971
|
-
|
|
11972
|
-
|
|
11973
|
-
|
|
11974
|
-
|
|
11975
|
-
|
|
11976
|
-
|
|
11977
|
-
|
|
11978
|
-
|
|
11979
|
-
|
|
11980
|
-
|
|
11981
|
-
|
|
11982
|
-
|
|
11998
|
+
/** @description The ID of the API key */
|
|
11999
|
+
id: string;
|
|
12000
|
+
/** @description The name for the API key */
|
|
12001
|
+
name: string;
|
|
12002
|
+
/** @description The permissions of the API key */
|
|
12003
|
+
permissions: ("entries" | "read:entries" | "versions" | "read:versions" | "publishing" | "read:publishing" | "collections" | "read:collections" | "memberships" | "read:memberships" | "roles" | "read:roles" | "webhooks" | "read:webhooks" | "ai-answers")[];
|
|
12004
|
+
/** @description Publishable keys: the collections, with their descendants, that the key can read; none for all */
|
|
12005
|
+
collectionIDs: string[];
|
|
12006
|
+
/** @description Publishable keys: the browser origins that can use the key, with localhost */
|
|
12007
|
+
allowedOrigins: string[];
|
|
12008
|
+
/** @description The creation date */
|
|
12009
|
+
createdAt: string;
|
|
12010
|
+
/** @description The last update date */
|
|
12011
|
+
updatedAt: string;
|
|
12012
|
+
/** @description The raw key, which is public */
|
|
12013
|
+
value: string;
|
|
11983
12014
|
};
|
|
11984
12015
|
};
|
|
11985
12016
|
};
|
|
@@ -12193,40 +12224,16 @@ interface operations {
|
|
|
12193
12224
|
};
|
|
12194
12225
|
};
|
|
12195
12226
|
};
|
|
12196
|
-
"
|
|
12227
|
+
"extensions.getSelfStorageEntry": {
|
|
12197
12228
|
parameters: {
|
|
12198
|
-
query
|
|
12199
|
-
|
|
12200
|
-
/** @description Required for OAuth: ID of the workspace to access. API keys use their own workspace. */
|
|
12201
|
-
"x-workspace-id"?: string;
|
|
12229
|
+
query: {
|
|
12230
|
+
key: string;
|
|
12202
12231
|
};
|
|
12232
|
+
header?: never;
|
|
12203
12233
|
path?: never;
|
|
12204
12234
|
cookie?: never;
|
|
12205
12235
|
};
|
|
12206
|
-
requestBody
|
|
12207
|
-
content: {
|
|
12208
|
-
/**
|
|
12209
|
-
* @example {
|
|
12210
|
-
* "name": "Documentation",
|
|
12211
|
-
* "parentID": "coll_example"
|
|
12212
|
-
* }
|
|
12213
|
-
*/
|
|
12214
|
-
"application/json": {
|
|
12215
|
-
/** @description ID of the collection */
|
|
12216
|
-
id?: string;
|
|
12217
|
-
/** @description Name of the collection */
|
|
12218
|
-
name?: string;
|
|
12219
|
-
/** @description ID of the parent collection */
|
|
12220
|
-
parentID?: string;
|
|
12221
|
-
/** @description Name path of the parent collection */
|
|
12222
|
-
parentPath?: string;
|
|
12223
|
-
/** @description Slug path of the parent collection */
|
|
12224
|
-
parentSlugPath?: string;
|
|
12225
|
-
/** @description Whether to restrict access to the collection tree */
|
|
12226
|
-
restricted?: boolean;
|
|
12227
|
-
};
|
|
12228
|
-
};
|
|
12229
|
-
};
|
|
12236
|
+
requestBody?: never;
|
|
12230
12237
|
responses: {
|
|
12231
12238
|
/** @description OK */
|
|
12232
12239
|
200: {
|
|
@@ -12234,7 +12241,17 @@ interface operations {
|
|
|
12234
12241
|
[name: string]: unknown;
|
|
12235
12242
|
};
|
|
12236
12243
|
content: {
|
|
12237
|
-
"application/json":
|
|
12244
|
+
"application/json": {
|
|
12245
|
+
key: string;
|
|
12246
|
+
value: string | number | boolean | null | (string | number | boolean | null | (unknown | null)[] | {
|
|
12247
|
+
[key: string]: unknown;
|
|
12248
|
+
})[] | {
|
|
12249
|
+
[key: string]: string | number | boolean | null | (unknown | null)[] | {
|
|
12250
|
+
[key: string]: unknown;
|
|
12251
|
+
};
|
|
12252
|
+
};
|
|
12253
|
+
updatedAt: string;
|
|
12254
|
+
};
|
|
12238
12255
|
};
|
|
12239
12256
|
};
|
|
12240
12257
|
/** @description 400 */
|
|
@@ -12357,36 +12374,6 @@ interface operations {
|
|
|
12357
12374
|
/** @default Conflict */
|
|
12358
12375
|
message: string;
|
|
12359
12376
|
data?: components["schemas"]["ErrorData"];
|
|
12360
|
-
} | {
|
|
12361
|
-
/** @constant */
|
|
12362
|
-
defined: true;
|
|
12363
|
-
/** @constant */
|
|
12364
|
-
code: "CONTENT_NAME_CONFLICT";
|
|
12365
|
-
/** @constant */
|
|
12366
|
-
status: 409;
|
|
12367
|
-
/** @default CONTENT_NAME_CONFLICT */
|
|
12368
|
-
message: string;
|
|
12369
|
-
data: components["schemas"]["ContentNameConflictErrorData"];
|
|
12370
|
-
} | {
|
|
12371
|
-
/** @constant */
|
|
12372
|
-
defined: true;
|
|
12373
|
-
/** @constant */
|
|
12374
|
-
code: "SCHEMA_FIELD_KEY_CONFLICT";
|
|
12375
|
-
/** @constant */
|
|
12376
|
-
status: 409;
|
|
12377
|
-
/** @default SCHEMA_FIELD_KEY_CONFLICT */
|
|
12378
|
-
message: string;
|
|
12379
|
-
data: components["schemas"]["SchemaFieldKeyConflictErrorData"];
|
|
12380
|
-
} | {
|
|
12381
|
-
/** @constant */
|
|
12382
|
-
defined: true;
|
|
12383
|
-
/** @constant */
|
|
12384
|
-
code: "SCHEMA_MIGRATION_IN_PROGRESS";
|
|
12385
|
-
/** @constant */
|
|
12386
|
-
status: 409;
|
|
12387
|
-
/** @default A schema migration is in progress for this collection */
|
|
12388
|
-
message: string;
|
|
12389
|
-
data: components["schemas"]["SchemaMigrationErrorData"];
|
|
12390
12377
|
} | {
|
|
12391
12378
|
/** @constant */
|
|
12392
12379
|
defined: false;
|
|
@@ -12477,28 +12464,24 @@ interface operations {
|
|
|
12477
12464
|
};
|
|
12478
12465
|
};
|
|
12479
12466
|
};
|
|
12480
|
-
"
|
|
12467
|
+
"extensions.setSelfStorageEntry": {
|
|
12481
12468
|
parameters: {
|
|
12482
12469
|
query?: never;
|
|
12483
|
-
header?:
|
|
12484
|
-
/** @description Required for OAuth: ID of the workspace to access. API keys use their own workspace. */
|
|
12485
|
-
"x-workspace-id"?: string;
|
|
12486
|
-
};
|
|
12470
|
+
header?: never;
|
|
12487
12471
|
path?: never;
|
|
12488
12472
|
cookie?: never;
|
|
12489
12473
|
};
|
|
12490
12474
|
requestBody: {
|
|
12491
12475
|
content: {
|
|
12492
|
-
/**
|
|
12493
|
-
* @example {
|
|
12494
|
-
* "ids": [
|
|
12495
|
-
* "coll_example"
|
|
12496
|
-
* ]
|
|
12497
|
-
* }
|
|
12498
|
-
*/
|
|
12499
12476
|
"application/json": {
|
|
12500
|
-
|
|
12501
|
-
|
|
12477
|
+
key: string;
|
|
12478
|
+
value: string | number | boolean | null | (string | number | boolean | null | unknown[] | {
|
|
12479
|
+
[key: string]: unknown;
|
|
12480
|
+
})[] | {
|
|
12481
|
+
[key: string]: string | number | boolean | null | unknown[] | {
|
|
12482
|
+
[key: string]: unknown;
|
|
12483
|
+
};
|
|
12484
|
+
};
|
|
12502
12485
|
};
|
|
12503
12486
|
};
|
|
12504
12487
|
};
|
|
@@ -12509,7 +12492,10 @@ interface operations {
|
|
|
12509
12492
|
[name: string]: unknown;
|
|
12510
12493
|
};
|
|
12511
12494
|
content: {
|
|
12512
|
-
"application/json":
|
|
12495
|
+
"application/json": {
|
|
12496
|
+
key: string;
|
|
12497
|
+
updatedAt: string;
|
|
12498
|
+
};
|
|
12513
12499
|
};
|
|
12514
12500
|
};
|
|
12515
12501
|
/** @description 400 */
|
|
@@ -12632,26 +12618,6 @@ interface operations {
|
|
|
12632
12618
|
/** @default Conflict */
|
|
12633
12619
|
message: string;
|
|
12634
12620
|
data?: components["schemas"]["ErrorData"];
|
|
12635
|
-
} | {
|
|
12636
|
-
/** @constant */
|
|
12637
|
-
defined: true;
|
|
12638
|
-
/** @constant */
|
|
12639
|
-
code: "SCHEMA_FIELD_KEY_CONFLICT";
|
|
12640
|
-
/** @constant */
|
|
12641
|
-
status: 409;
|
|
12642
|
-
/** @default SCHEMA_FIELD_KEY_CONFLICT */
|
|
12643
|
-
message: string;
|
|
12644
|
-
data: components["schemas"]["SchemaFieldKeyConflictErrorData"];
|
|
12645
|
-
} | {
|
|
12646
|
-
/** @constant */
|
|
12647
|
-
defined: true;
|
|
12648
|
-
/** @constant */
|
|
12649
|
-
code: "SCHEMA_MIGRATION_IN_PROGRESS";
|
|
12650
|
-
/** @constant */
|
|
12651
|
-
status: 409;
|
|
12652
|
-
/** @default A schema migration is in progress for this collection */
|
|
12653
|
-
message: string;
|
|
12654
|
-
data: components["schemas"]["SchemaMigrationErrorData"];
|
|
12655
12621
|
} | {
|
|
12656
12622
|
/** @constant */
|
|
12657
12623
|
defined: false;
|
|
@@ -12742,34 +12708,16 @@ interface operations {
|
|
|
12742
12708
|
};
|
|
12743
12709
|
};
|
|
12744
12710
|
};
|
|
12745
|
-
"
|
|
12711
|
+
"extensions.deleteSelfStorageEntry": {
|
|
12746
12712
|
parameters: {
|
|
12747
|
-
query
|
|
12748
|
-
|
|
12749
|
-
/** @description Required for OAuth: ID of the workspace to access. API keys use their own workspace. */
|
|
12750
|
-
"x-workspace-id"?: string;
|
|
12751
|
-
};
|
|
12752
|
-
path: {
|
|
12753
|
-
/** @example coll_example */
|
|
12754
|
-
id: string;
|
|
12713
|
+
query: {
|
|
12714
|
+
key: string;
|
|
12755
12715
|
};
|
|
12716
|
+
header?: never;
|
|
12717
|
+
path?: never;
|
|
12756
12718
|
cookie?: never;
|
|
12757
12719
|
};
|
|
12758
|
-
requestBody?:
|
|
12759
|
-
content: {
|
|
12760
|
-
/**
|
|
12761
|
-
* @example {
|
|
12762
|
-
* "name": "Guides"
|
|
12763
|
-
* }
|
|
12764
|
-
*/
|
|
12765
|
-
"application/json": {
|
|
12766
|
-
/** @description New name of the collection */
|
|
12767
|
-
name?: string;
|
|
12768
|
-
/** @description Name the collection must still have */
|
|
12769
|
-
expectedName?: string;
|
|
12770
|
-
};
|
|
12771
|
-
};
|
|
12772
|
-
};
|
|
12720
|
+
requestBody?: never;
|
|
12773
12721
|
responses: {
|
|
12774
12722
|
/** @description OK */
|
|
12775
12723
|
200: {
|
|
@@ -12777,7 +12725,9 @@ interface operations {
|
|
|
12777
12725
|
[name: string]: unknown;
|
|
12778
12726
|
};
|
|
12779
12727
|
content: {
|
|
12780
|
-
"application/json":
|
|
12728
|
+
"application/json": {
|
|
12729
|
+
deleted: boolean;
|
|
12730
|
+
};
|
|
12781
12731
|
};
|
|
12782
12732
|
};
|
|
12783
12733
|
/** @description 400 */
|
|
@@ -12900,53 +12850,6 @@ interface operations {
|
|
|
12900
12850
|
/** @default Conflict */
|
|
12901
12851
|
message: string;
|
|
12902
12852
|
data?: components["schemas"]["ErrorData"];
|
|
12903
|
-
} | {
|
|
12904
|
-
/** @constant */
|
|
12905
|
-
defined: true;
|
|
12906
|
-
/** @constant */
|
|
12907
|
-
code: "CONTENT_PRECONDITION_FAILED";
|
|
12908
|
-
/** @constant */
|
|
12909
|
-
status: 409;
|
|
12910
|
-
/** @default CONTENT_PRECONDITION_FAILED */
|
|
12911
|
-
message: string;
|
|
12912
|
-
data: {
|
|
12913
|
-
/** @description Suggested next steps. Wording can change; use error codes and structured data for program logic. */
|
|
12914
|
-
hints?: string[];
|
|
12915
|
-
/** @description Expected field that didn't match */
|
|
12916
|
-
field: string;
|
|
12917
|
-
/** @description Current value of the field */
|
|
12918
|
-
current: string | null;
|
|
12919
|
-
};
|
|
12920
|
-
} | {
|
|
12921
|
-
/** @constant */
|
|
12922
|
-
defined: true;
|
|
12923
|
-
/** @constant */
|
|
12924
|
-
code: "CONTENT_NAME_CONFLICT";
|
|
12925
|
-
/** @constant */
|
|
12926
|
-
status: 409;
|
|
12927
|
-
/** @default CONTENT_NAME_CONFLICT */
|
|
12928
|
-
message: string;
|
|
12929
|
-
data: components["schemas"]["ContentNameConflictErrorData"];
|
|
12930
|
-
} | {
|
|
12931
|
-
/** @constant */
|
|
12932
|
-
defined: true;
|
|
12933
|
-
/** @constant */
|
|
12934
|
-
code: "SCHEMA_FIELD_KEY_CONFLICT";
|
|
12935
|
-
/** @constant */
|
|
12936
|
-
status: 409;
|
|
12937
|
-
/** @default SCHEMA_FIELD_KEY_CONFLICT */
|
|
12938
|
-
message: string;
|
|
12939
|
-
data: components["schemas"]["SchemaFieldKeyConflictErrorData"];
|
|
12940
|
-
} | {
|
|
12941
|
-
/** @constant */
|
|
12942
|
-
defined: true;
|
|
12943
|
-
/** @constant */
|
|
12944
|
-
code: "SCHEMA_MIGRATION_IN_PROGRESS";
|
|
12945
|
-
/** @constant */
|
|
12946
|
-
status: 409;
|
|
12947
|
-
/** @default A schema migration is in progress for this collection */
|
|
12948
|
-
message: string;
|
|
12949
|
-
data: components["schemas"]["SchemaMigrationErrorData"];
|
|
12950
12853
|
} | {
|
|
12951
12854
|
/** @constant */
|
|
12952
12855
|
defined: false;
|
|
@@ -13037,17 +12940,15 @@ interface operations {
|
|
|
13037
12940
|
};
|
|
13038
12941
|
};
|
|
13039
12942
|
};
|
|
13040
|
-
"
|
|
12943
|
+
"extensions.listSelfStorageEntries": {
|
|
13041
12944
|
parameters: {
|
|
13042
|
-
query?:
|
|
13043
|
-
|
|
13044
|
-
|
|
13045
|
-
|
|
13046
|
-
};
|
|
13047
|
-
path: {
|
|
13048
|
-
/** @example coll_example */
|
|
13049
|
-
id: string;
|
|
12945
|
+
query?: {
|
|
12946
|
+
prefix?: string;
|
|
12947
|
+
after?: string;
|
|
12948
|
+
limit?: number;
|
|
13050
12949
|
};
|
|
12950
|
+
header?: never;
|
|
12951
|
+
path?: never;
|
|
13051
12952
|
cookie?: never;
|
|
13052
12953
|
};
|
|
13053
12954
|
requestBody?: never;
|
|
@@ -13058,7 +12959,20 @@ interface operations {
|
|
|
13058
12959
|
[name: string]: unknown;
|
|
13059
12960
|
};
|
|
13060
12961
|
content: {
|
|
13061
|
-
"application/json":
|
|
12962
|
+
"application/json": {
|
|
12963
|
+
data: {
|
|
12964
|
+
key: string;
|
|
12965
|
+
value: string | number | boolean | null | (string | number | boolean | null | (unknown | null)[] | {
|
|
12966
|
+
[key: string]: unknown;
|
|
12967
|
+
})[] | {
|
|
12968
|
+
[key: string]: string | number | boolean | null | (unknown | null)[] | {
|
|
12969
|
+
[key: string]: unknown;
|
|
12970
|
+
};
|
|
12971
|
+
};
|
|
12972
|
+
updatedAt: string;
|
|
12973
|
+
}[];
|
|
12974
|
+
hasMore: boolean;
|
|
12975
|
+
};
|
|
13062
12976
|
};
|
|
13063
12977
|
};
|
|
13064
12978
|
/** @description 400 */
|
|
@@ -13181,26 +13095,6 @@ interface operations {
|
|
|
13181
13095
|
/** @default Conflict */
|
|
13182
13096
|
message: string;
|
|
13183
13097
|
data?: components["schemas"]["ErrorData"];
|
|
13184
|
-
} | {
|
|
13185
|
-
/** @constant */
|
|
13186
|
-
defined: true;
|
|
13187
|
-
/** @constant */
|
|
13188
|
-
code: "SCHEMA_FIELD_KEY_CONFLICT";
|
|
13189
|
-
/** @constant */
|
|
13190
|
-
status: 409;
|
|
13191
|
-
/** @default SCHEMA_FIELD_KEY_CONFLICT */
|
|
13192
|
-
message: string;
|
|
13193
|
-
data: components["schemas"]["SchemaFieldKeyConflictErrorData"];
|
|
13194
|
-
} | {
|
|
13195
|
-
/** @constant */
|
|
13196
|
-
defined: true;
|
|
13197
|
-
/** @constant */
|
|
13198
|
-
code: "SCHEMA_MIGRATION_IN_PROGRESS";
|
|
13199
|
-
/** @constant */
|
|
13200
|
-
status: 409;
|
|
13201
|
-
/** @default A schema migration is in progress for this collection */
|
|
13202
|
-
message: string;
|
|
13203
|
-
data: components["schemas"]["SchemaMigrationErrorData"];
|
|
13204
13098
|
} | {
|
|
13205
13099
|
/** @constant */
|
|
13206
13100
|
defined: false;
|
|
@@ -13291,45 +13185,17 @@ interface operations {
|
|
|
13291
13185
|
};
|
|
13292
13186
|
};
|
|
13293
13187
|
};
|
|
13294
|
-
"
|
|
13188
|
+
"extensions.listElements": {
|
|
13295
13189
|
parameters: {
|
|
13296
13190
|
query?: never;
|
|
13297
13191
|
header?: {
|
|
13298
13192
|
/** @description Required for OAuth: ID of the workspace to access. API keys use their own workspace. */
|
|
13299
13193
|
"x-workspace-id"?: string;
|
|
13300
13194
|
};
|
|
13301
|
-
path
|
|
13302
|
-
/** @example coll_example */
|
|
13303
|
-
id: string;
|
|
13304
|
-
};
|
|
13195
|
+
path?: never;
|
|
13305
13196
|
cookie?: never;
|
|
13306
13197
|
};
|
|
13307
|
-
requestBody?:
|
|
13308
|
-
content: {
|
|
13309
|
-
/**
|
|
13310
|
-
* @example {
|
|
13311
|
-
* "newParentID": "coll_parent"
|
|
13312
|
-
* }
|
|
13313
|
-
*/
|
|
13314
|
-
"application/json": {
|
|
13315
|
-
/** @description ID of the new parent collection, or null for the top level */
|
|
13316
|
-
newParentID?: string | null;
|
|
13317
|
-
/** @description Name path of the new parent collection; / is the top level */
|
|
13318
|
-
newParentPath?: string;
|
|
13319
|
-
/** @description Slug path of the new parent collection; / is the top level */
|
|
13320
|
-
newParentSlugPath?: string;
|
|
13321
|
-
/** @description ID of the parent that must still contain the collection, or null for the top level */
|
|
13322
|
-
expectedParentID?: string | null;
|
|
13323
|
-
/** @description New zero-based index in the parent collection's descendants array */
|
|
13324
|
-
index?: number;
|
|
13325
|
-
/**
|
|
13326
|
-
* @description Confirmation that a schema migration caused by the move can remove content
|
|
13327
|
-
* @default false
|
|
13328
|
-
*/
|
|
13329
|
-
confirmedDataLoss?: boolean;
|
|
13330
|
-
};
|
|
13331
|
-
};
|
|
13332
|
-
};
|
|
13198
|
+
requestBody?: never;
|
|
13333
13199
|
responses: {
|
|
13334
13200
|
/** @description OK */
|
|
13335
13201
|
200: {
|
|
@@ -13338,9 +13204,1464 @@ interface operations {
|
|
|
13338
13204
|
};
|
|
13339
13205
|
content: {
|
|
13340
13206
|
"application/json": {
|
|
13341
|
-
|
|
13342
|
-
|
|
13343
|
-
|
|
13207
|
+
element: string;
|
|
13208
|
+
name: string;
|
|
13209
|
+
description?: string;
|
|
13210
|
+
/** @description False for an element without content, written as <Name /> */
|
|
13211
|
+
content: boolean;
|
|
13212
|
+
/** @description The direct child blocks that its content accepts; without it, any blocks */
|
|
13213
|
+
accepts?: {
|
|
13214
|
+
elements?: string[];
|
|
13215
|
+
blocks?: string[];
|
|
13216
|
+
};
|
|
13217
|
+
/** @description The direct child blocks that its content doesn't accept, even if `accepts` lists them */
|
|
13218
|
+
rejects?: {
|
|
13219
|
+
elements?: string[];
|
|
13220
|
+
blocks?: string[];
|
|
13221
|
+
};
|
|
13222
|
+
/** @description The props, with their defaults, which a new element gets */
|
|
13223
|
+
props?: ({
|
|
13224
|
+
name: string;
|
|
13225
|
+
title?: string;
|
|
13226
|
+
description?: string;
|
|
13227
|
+
/** @constant */
|
|
13228
|
+
type: "string";
|
|
13229
|
+
enum?: string[];
|
|
13230
|
+
/** @enum {string} */
|
|
13231
|
+
control?: "input" | "textarea" | "icon" | "link" | "select" | "toggle";
|
|
13232
|
+
placeholder?: string;
|
|
13233
|
+
minLength?: number;
|
|
13234
|
+
maxLength?: number;
|
|
13235
|
+
default?: string;
|
|
13236
|
+
} | {
|
|
13237
|
+
name: string;
|
|
13238
|
+
title?: string;
|
|
13239
|
+
description?: string;
|
|
13240
|
+
/** @enum {string} */
|
|
13241
|
+
type: "number" | "integer";
|
|
13242
|
+
minimum?: number;
|
|
13243
|
+
maximum?: number;
|
|
13244
|
+
default?: number;
|
|
13245
|
+
} | {
|
|
13246
|
+
name: string;
|
|
13247
|
+
title?: string;
|
|
13248
|
+
description?: string;
|
|
13249
|
+
/** @constant */
|
|
13250
|
+
type: "boolean";
|
|
13251
|
+
default?: boolean;
|
|
13252
|
+
})[];
|
|
13253
|
+
/** @description The extension that renders it, e.g. andesine/pages */
|
|
13254
|
+
extension: string;
|
|
13255
|
+
/** @description Elements that belong inside this one, e.g. Tab in Tabs */
|
|
13256
|
+
children: {
|
|
13257
|
+
element: string;
|
|
13258
|
+
name?: string;
|
|
13259
|
+
description?: string;
|
|
13260
|
+
/** @description False for an element without content, written as <Name /> */
|
|
13261
|
+
content: boolean;
|
|
13262
|
+
/** @description The direct child blocks that its content accepts; without it, any blocks */
|
|
13263
|
+
accepts?: {
|
|
13264
|
+
elements?: string[];
|
|
13265
|
+
blocks?: string[];
|
|
13266
|
+
};
|
|
13267
|
+
/** @description The direct child blocks that its content doesn't accept, even if `accepts` lists them */
|
|
13268
|
+
rejects?: {
|
|
13269
|
+
elements?: string[];
|
|
13270
|
+
blocks?: string[];
|
|
13271
|
+
};
|
|
13272
|
+
/** @description The props, with their defaults, which a new element gets */
|
|
13273
|
+
props?: ({
|
|
13274
|
+
name: string;
|
|
13275
|
+
title?: string;
|
|
13276
|
+
description?: string;
|
|
13277
|
+
/** @constant */
|
|
13278
|
+
type: "string";
|
|
13279
|
+
enum?: string[];
|
|
13280
|
+
/** @enum {string} */
|
|
13281
|
+
control?: "input" | "textarea" | "icon" | "link" | "select" | "toggle";
|
|
13282
|
+
placeholder?: string;
|
|
13283
|
+
minLength?: number;
|
|
13284
|
+
maxLength?: number;
|
|
13285
|
+
default?: string;
|
|
13286
|
+
} | {
|
|
13287
|
+
name: string;
|
|
13288
|
+
title?: string;
|
|
13289
|
+
description?: string;
|
|
13290
|
+
/** @enum {string} */
|
|
13291
|
+
type: "number" | "integer";
|
|
13292
|
+
minimum?: number;
|
|
13293
|
+
maximum?: number;
|
|
13294
|
+
default?: number;
|
|
13295
|
+
} | {
|
|
13296
|
+
name: string;
|
|
13297
|
+
title?: string;
|
|
13298
|
+
description?: string;
|
|
13299
|
+
/** @constant */
|
|
13300
|
+
type: "boolean";
|
|
13301
|
+
default?: boolean;
|
|
13302
|
+
})[];
|
|
13303
|
+
}[];
|
|
13304
|
+
}[];
|
|
13305
|
+
};
|
|
13306
|
+
};
|
|
13307
|
+
/** @description 400 */
|
|
13308
|
+
400: {
|
|
13309
|
+
headers: {
|
|
13310
|
+
[name: string]: unknown;
|
|
13311
|
+
};
|
|
13312
|
+
content: {
|
|
13313
|
+
"application/json": {
|
|
13314
|
+
/** @constant */
|
|
13315
|
+
defined: true;
|
|
13316
|
+
/** @constant */
|
|
13317
|
+
code: "BAD_REQUEST";
|
|
13318
|
+
/** @constant */
|
|
13319
|
+
status: 400;
|
|
13320
|
+
/** @default Bad Request */
|
|
13321
|
+
message: string;
|
|
13322
|
+
data?: components["schemas"]["ValidationErrorData"];
|
|
13323
|
+
} | {
|
|
13324
|
+
/** @constant */
|
|
13325
|
+
defined: false;
|
|
13326
|
+
code: string;
|
|
13327
|
+
status: number;
|
|
13328
|
+
message: string;
|
|
13329
|
+
data?: unknown;
|
|
13330
|
+
};
|
|
13331
|
+
};
|
|
13332
|
+
};
|
|
13333
|
+
/** @description 401 */
|
|
13334
|
+
401: {
|
|
13335
|
+
headers: {
|
|
13336
|
+
[name: string]: unknown;
|
|
13337
|
+
};
|
|
13338
|
+
content: {
|
|
13339
|
+
"application/json": {
|
|
13340
|
+
/** @constant */
|
|
13341
|
+
defined: true;
|
|
13342
|
+
/** @constant */
|
|
13343
|
+
code: "UNAUTHORIZED";
|
|
13344
|
+
/** @constant */
|
|
13345
|
+
status: 401;
|
|
13346
|
+
/** @default Unauthorized */
|
|
13347
|
+
message: string;
|
|
13348
|
+
data?: components["schemas"]["ErrorData"];
|
|
13349
|
+
} | {
|
|
13350
|
+
/** @constant */
|
|
13351
|
+
defined: false;
|
|
13352
|
+
code: string;
|
|
13353
|
+
status: number;
|
|
13354
|
+
message: string;
|
|
13355
|
+
data?: unknown;
|
|
13356
|
+
};
|
|
13357
|
+
};
|
|
13358
|
+
};
|
|
13359
|
+
/** @description 403 */
|
|
13360
|
+
403: {
|
|
13361
|
+
headers: {
|
|
13362
|
+
[name: string]: unknown;
|
|
13363
|
+
};
|
|
13364
|
+
content: {
|
|
13365
|
+
"application/json": {
|
|
13366
|
+
/** @constant */
|
|
13367
|
+
defined: true;
|
|
13368
|
+
/** @constant */
|
|
13369
|
+
code: "FORBIDDEN";
|
|
13370
|
+
/** @constant */
|
|
13371
|
+
status: 403;
|
|
13372
|
+
/** @default Forbidden */
|
|
13373
|
+
message: string;
|
|
13374
|
+
data?: components["schemas"]["ForbiddenErrorData"];
|
|
13375
|
+
} | {
|
|
13376
|
+
/** @constant */
|
|
13377
|
+
defined: false;
|
|
13378
|
+
code: string;
|
|
13379
|
+
status: number;
|
|
13380
|
+
message: string;
|
|
13381
|
+
data?: unknown;
|
|
13382
|
+
};
|
|
13383
|
+
};
|
|
13384
|
+
};
|
|
13385
|
+
/** @description 404 */
|
|
13386
|
+
404: {
|
|
13387
|
+
headers: {
|
|
13388
|
+
[name: string]: unknown;
|
|
13389
|
+
};
|
|
13390
|
+
content: {
|
|
13391
|
+
"application/json": {
|
|
13392
|
+
/** @constant */
|
|
13393
|
+
defined: true;
|
|
13394
|
+
/** @constant */
|
|
13395
|
+
code: "NOT_FOUND";
|
|
13396
|
+
/** @constant */
|
|
13397
|
+
status: 404;
|
|
13398
|
+
/** @default Not Found */
|
|
13399
|
+
message: string;
|
|
13400
|
+
data?: components["schemas"]["ErrorData"];
|
|
13401
|
+
} | {
|
|
13402
|
+
/** @constant */
|
|
13403
|
+
defined: false;
|
|
13404
|
+
code: string;
|
|
13405
|
+
status: number;
|
|
13406
|
+
message: string;
|
|
13407
|
+
data?: unknown;
|
|
13408
|
+
};
|
|
13409
|
+
};
|
|
13410
|
+
};
|
|
13411
|
+
/** @description 409 */
|
|
13412
|
+
409: {
|
|
13413
|
+
headers: {
|
|
13414
|
+
[name: string]: unknown;
|
|
13415
|
+
};
|
|
13416
|
+
content: {
|
|
13417
|
+
"application/json": {
|
|
13418
|
+
/** @constant */
|
|
13419
|
+
defined: true;
|
|
13420
|
+
/** @constant */
|
|
13421
|
+
code: "CONFLICT";
|
|
13422
|
+
/** @constant */
|
|
13423
|
+
status: 409;
|
|
13424
|
+
/** @default Conflict */
|
|
13425
|
+
message: string;
|
|
13426
|
+
data?: components["schemas"]["ErrorData"];
|
|
13427
|
+
} | {
|
|
13428
|
+
/** @constant */
|
|
13429
|
+
defined: false;
|
|
13430
|
+
code: string;
|
|
13431
|
+
status: number;
|
|
13432
|
+
message: string;
|
|
13433
|
+
data?: unknown;
|
|
13434
|
+
};
|
|
13435
|
+
};
|
|
13436
|
+
};
|
|
13437
|
+
/** @description 429 */
|
|
13438
|
+
429: {
|
|
13439
|
+
headers: {
|
|
13440
|
+
[name: string]: unknown;
|
|
13441
|
+
};
|
|
13442
|
+
content: {
|
|
13443
|
+
"application/json": {
|
|
13444
|
+
/** @constant */
|
|
13445
|
+
defined: true;
|
|
13446
|
+
/** @constant */
|
|
13447
|
+
code: "TOO_MANY_REQUESTS";
|
|
13448
|
+
/** @constant */
|
|
13449
|
+
status: 429;
|
|
13450
|
+
/** @default Too Many Requests */
|
|
13451
|
+
message: string;
|
|
13452
|
+
data?: components["schemas"]["RateLimitErrorData"];
|
|
13453
|
+
} | {
|
|
13454
|
+
/** @constant */
|
|
13455
|
+
defined: false;
|
|
13456
|
+
code: string;
|
|
13457
|
+
status: number;
|
|
13458
|
+
message: string;
|
|
13459
|
+
data?: unknown;
|
|
13460
|
+
};
|
|
13461
|
+
};
|
|
13462
|
+
};
|
|
13463
|
+
/** @description 500 */
|
|
13464
|
+
500: {
|
|
13465
|
+
headers: {
|
|
13466
|
+
[name: string]: unknown;
|
|
13467
|
+
};
|
|
13468
|
+
content: {
|
|
13469
|
+
"application/json": {
|
|
13470
|
+
/** @constant */
|
|
13471
|
+
defined: true;
|
|
13472
|
+
/** @constant */
|
|
13473
|
+
code: "INTERNAL_SERVER_ERROR";
|
|
13474
|
+
/** @constant */
|
|
13475
|
+
status: 500;
|
|
13476
|
+
/** @default Internal Server Error */
|
|
13477
|
+
message: string;
|
|
13478
|
+
data?: components["schemas"]["ErrorData"];
|
|
13479
|
+
} | {
|
|
13480
|
+
/** @constant */
|
|
13481
|
+
defined: false;
|
|
13482
|
+
code: string;
|
|
13483
|
+
status: number;
|
|
13484
|
+
message: string;
|
|
13485
|
+
data?: unknown;
|
|
13486
|
+
};
|
|
13487
|
+
};
|
|
13488
|
+
};
|
|
13489
|
+
/** @description 503 */
|
|
13490
|
+
503: {
|
|
13491
|
+
headers: {
|
|
13492
|
+
[name: string]: unknown;
|
|
13493
|
+
};
|
|
13494
|
+
content: {
|
|
13495
|
+
"application/json": {
|
|
13496
|
+
/** @constant */
|
|
13497
|
+
defined: true;
|
|
13498
|
+
/** @constant */
|
|
13499
|
+
code: "SERVICE_UNAVAILABLE";
|
|
13500
|
+
/** @constant */
|
|
13501
|
+
status: 503;
|
|
13502
|
+
/** @default Service Unavailable */
|
|
13503
|
+
message: string;
|
|
13504
|
+
data?: components["schemas"]["ErrorData"];
|
|
13505
|
+
} | {
|
|
13506
|
+
/** @constant */
|
|
13507
|
+
defined: false;
|
|
13508
|
+
code: string;
|
|
13509
|
+
status: number;
|
|
13510
|
+
message: string;
|
|
13511
|
+
data?: unknown;
|
|
13512
|
+
};
|
|
13513
|
+
};
|
|
13514
|
+
};
|
|
13515
|
+
};
|
|
13516
|
+
};
|
|
13517
|
+
"collections.create": {
|
|
13518
|
+
parameters: {
|
|
13519
|
+
query?: never;
|
|
13520
|
+
header?: {
|
|
13521
|
+
/** @description Required for OAuth: ID of the workspace to access. API keys use their own workspace. */
|
|
13522
|
+
"x-workspace-id"?: string;
|
|
13523
|
+
};
|
|
13524
|
+
path?: never;
|
|
13525
|
+
cookie?: never;
|
|
13526
|
+
};
|
|
13527
|
+
requestBody: {
|
|
13528
|
+
content: {
|
|
13529
|
+
/**
|
|
13530
|
+
* @example {
|
|
13531
|
+
* "name": "Documentation",
|
|
13532
|
+
* "parentID": "coll_example"
|
|
13533
|
+
* }
|
|
13534
|
+
*/
|
|
13535
|
+
"application/json": {
|
|
13536
|
+
/** @description ID of the collection */
|
|
13537
|
+
id?: string;
|
|
13538
|
+
/** @description Name of the collection */
|
|
13539
|
+
name?: string;
|
|
13540
|
+
/** @description ID of the parent collection */
|
|
13541
|
+
parentID?: string;
|
|
13542
|
+
/** @description Name path of the parent collection */
|
|
13543
|
+
parentPath?: string;
|
|
13544
|
+
/** @description Slug path of the parent collection */
|
|
13545
|
+
parentSlugPath?: string;
|
|
13546
|
+
/** @description Whether to restrict access to the collection tree */
|
|
13547
|
+
restricted?: boolean;
|
|
13548
|
+
};
|
|
13549
|
+
};
|
|
13550
|
+
};
|
|
13551
|
+
responses: {
|
|
13552
|
+
/** @description OK */
|
|
13553
|
+
200: {
|
|
13554
|
+
headers: {
|
|
13555
|
+
[name: string]: unknown;
|
|
13556
|
+
};
|
|
13557
|
+
content: {
|
|
13558
|
+
"application/json": components["schemas"]["Collection"];
|
|
13559
|
+
};
|
|
13560
|
+
};
|
|
13561
|
+
/** @description 400 */
|
|
13562
|
+
400: {
|
|
13563
|
+
headers: {
|
|
13564
|
+
[name: string]: unknown;
|
|
13565
|
+
};
|
|
13566
|
+
content: {
|
|
13567
|
+
"application/json": {
|
|
13568
|
+
/** @constant */
|
|
13569
|
+
defined: true;
|
|
13570
|
+
/** @constant */
|
|
13571
|
+
code: "BAD_REQUEST";
|
|
13572
|
+
/** @constant */
|
|
13573
|
+
status: 400;
|
|
13574
|
+
/** @default Bad Request */
|
|
13575
|
+
message: string;
|
|
13576
|
+
data?: components["schemas"]["ValidationErrorData"];
|
|
13577
|
+
} | {
|
|
13578
|
+
/** @constant */
|
|
13579
|
+
defined: false;
|
|
13580
|
+
code: string;
|
|
13581
|
+
status: number;
|
|
13582
|
+
message: string;
|
|
13583
|
+
data?: unknown;
|
|
13584
|
+
};
|
|
13585
|
+
};
|
|
13586
|
+
};
|
|
13587
|
+
/** @description 401 */
|
|
13588
|
+
401: {
|
|
13589
|
+
headers: {
|
|
13590
|
+
[name: string]: unknown;
|
|
13591
|
+
};
|
|
13592
|
+
content: {
|
|
13593
|
+
"application/json": {
|
|
13594
|
+
/** @constant */
|
|
13595
|
+
defined: true;
|
|
13596
|
+
/** @constant */
|
|
13597
|
+
code: "UNAUTHORIZED";
|
|
13598
|
+
/** @constant */
|
|
13599
|
+
status: 401;
|
|
13600
|
+
/** @default Unauthorized */
|
|
13601
|
+
message: string;
|
|
13602
|
+
data?: components["schemas"]["ErrorData"];
|
|
13603
|
+
} | {
|
|
13604
|
+
/** @constant */
|
|
13605
|
+
defined: false;
|
|
13606
|
+
code: string;
|
|
13607
|
+
status: number;
|
|
13608
|
+
message: string;
|
|
13609
|
+
data?: unknown;
|
|
13610
|
+
};
|
|
13611
|
+
};
|
|
13612
|
+
};
|
|
13613
|
+
/** @description 403 */
|
|
13614
|
+
403: {
|
|
13615
|
+
headers: {
|
|
13616
|
+
[name: string]: unknown;
|
|
13617
|
+
};
|
|
13618
|
+
content: {
|
|
13619
|
+
"application/json": {
|
|
13620
|
+
/** @constant */
|
|
13621
|
+
defined: true;
|
|
13622
|
+
/** @constant */
|
|
13623
|
+
code: "FORBIDDEN";
|
|
13624
|
+
/** @constant */
|
|
13625
|
+
status: 403;
|
|
13626
|
+
/** @default Forbidden */
|
|
13627
|
+
message: string;
|
|
13628
|
+
data?: components["schemas"]["ForbiddenErrorData"];
|
|
13629
|
+
} | {
|
|
13630
|
+
/** @constant */
|
|
13631
|
+
defined: false;
|
|
13632
|
+
code: string;
|
|
13633
|
+
status: number;
|
|
13634
|
+
message: string;
|
|
13635
|
+
data?: unknown;
|
|
13636
|
+
};
|
|
13637
|
+
};
|
|
13638
|
+
};
|
|
13639
|
+
/** @description 404 */
|
|
13640
|
+
404: {
|
|
13641
|
+
headers: {
|
|
13642
|
+
[name: string]: unknown;
|
|
13643
|
+
};
|
|
13644
|
+
content: {
|
|
13645
|
+
"application/json": {
|
|
13646
|
+
/** @constant */
|
|
13647
|
+
defined: true;
|
|
13648
|
+
/** @constant */
|
|
13649
|
+
code: "NOT_FOUND";
|
|
13650
|
+
/** @constant */
|
|
13651
|
+
status: 404;
|
|
13652
|
+
/** @default Not Found */
|
|
13653
|
+
message: string;
|
|
13654
|
+
data?: components["schemas"]["ErrorData"];
|
|
13655
|
+
} | {
|
|
13656
|
+
/** @constant */
|
|
13657
|
+
defined: false;
|
|
13658
|
+
code: string;
|
|
13659
|
+
status: number;
|
|
13660
|
+
message: string;
|
|
13661
|
+
data?: unknown;
|
|
13662
|
+
};
|
|
13663
|
+
};
|
|
13664
|
+
};
|
|
13665
|
+
/** @description 409 */
|
|
13666
|
+
409: {
|
|
13667
|
+
headers: {
|
|
13668
|
+
[name: string]: unknown;
|
|
13669
|
+
};
|
|
13670
|
+
content: {
|
|
13671
|
+
"application/json": {
|
|
13672
|
+
/** @constant */
|
|
13673
|
+
defined: true;
|
|
13674
|
+
/** @constant */
|
|
13675
|
+
code: "CONFLICT";
|
|
13676
|
+
/** @constant */
|
|
13677
|
+
status: 409;
|
|
13678
|
+
/** @default Conflict */
|
|
13679
|
+
message: string;
|
|
13680
|
+
data?: components["schemas"]["ErrorData"];
|
|
13681
|
+
} | {
|
|
13682
|
+
/** @constant */
|
|
13683
|
+
defined: true;
|
|
13684
|
+
/** @constant */
|
|
13685
|
+
code: "CONTENT_NAME_CONFLICT";
|
|
13686
|
+
/** @constant */
|
|
13687
|
+
status: 409;
|
|
13688
|
+
/** @default CONTENT_NAME_CONFLICT */
|
|
13689
|
+
message: string;
|
|
13690
|
+
data: components["schemas"]["ContentNameConflictErrorData"];
|
|
13691
|
+
} | {
|
|
13692
|
+
/** @constant */
|
|
13693
|
+
defined: true;
|
|
13694
|
+
/** @constant */
|
|
13695
|
+
code: "SCHEMA_FIELD_KEY_CONFLICT";
|
|
13696
|
+
/** @constant */
|
|
13697
|
+
status: 409;
|
|
13698
|
+
/** @default SCHEMA_FIELD_KEY_CONFLICT */
|
|
13699
|
+
message: string;
|
|
13700
|
+
data: components["schemas"]["SchemaFieldKeyConflictErrorData"];
|
|
13701
|
+
} | {
|
|
13702
|
+
/** @constant */
|
|
13703
|
+
defined: true;
|
|
13704
|
+
/** @constant */
|
|
13705
|
+
code: "SCHEMA_MIGRATION_IN_PROGRESS";
|
|
13706
|
+
/** @constant */
|
|
13707
|
+
status: 409;
|
|
13708
|
+
/** @default A schema migration is in progress for this collection */
|
|
13709
|
+
message: string;
|
|
13710
|
+
data: components["schemas"]["SchemaMigrationErrorData"];
|
|
13711
|
+
} | {
|
|
13712
|
+
/** @constant */
|
|
13713
|
+
defined: false;
|
|
13714
|
+
code: string;
|
|
13715
|
+
status: number;
|
|
13716
|
+
message: string;
|
|
13717
|
+
data?: unknown;
|
|
13718
|
+
};
|
|
13719
|
+
};
|
|
13720
|
+
};
|
|
13721
|
+
/** @description 429 */
|
|
13722
|
+
429: {
|
|
13723
|
+
headers: {
|
|
13724
|
+
[name: string]: unknown;
|
|
13725
|
+
};
|
|
13726
|
+
content: {
|
|
13727
|
+
"application/json": {
|
|
13728
|
+
/** @constant */
|
|
13729
|
+
defined: true;
|
|
13730
|
+
/** @constant */
|
|
13731
|
+
code: "TOO_MANY_REQUESTS";
|
|
13732
|
+
/** @constant */
|
|
13733
|
+
status: 429;
|
|
13734
|
+
/** @default Too Many Requests */
|
|
13735
|
+
message: string;
|
|
13736
|
+
data?: components["schemas"]["RateLimitErrorData"];
|
|
13737
|
+
} | {
|
|
13738
|
+
/** @constant */
|
|
13739
|
+
defined: false;
|
|
13740
|
+
code: string;
|
|
13741
|
+
status: number;
|
|
13742
|
+
message: string;
|
|
13743
|
+
data?: unknown;
|
|
13744
|
+
};
|
|
13745
|
+
};
|
|
13746
|
+
};
|
|
13747
|
+
/** @description 500 */
|
|
13748
|
+
500: {
|
|
13749
|
+
headers: {
|
|
13750
|
+
[name: string]: unknown;
|
|
13751
|
+
};
|
|
13752
|
+
content: {
|
|
13753
|
+
"application/json": {
|
|
13754
|
+
/** @constant */
|
|
13755
|
+
defined: true;
|
|
13756
|
+
/** @constant */
|
|
13757
|
+
code: "INTERNAL_SERVER_ERROR";
|
|
13758
|
+
/** @constant */
|
|
13759
|
+
status: 500;
|
|
13760
|
+
/** @default Internal Server Error */
|
|
13761
|
+
message: string;
|
|
13762
|
+
data?: components["schemas"]["ErrorData"];
|
|
13763
|
+
} | {
|
|
13764
|
+
/** @constant */
|
|
13765
|
+
defined: false;
|
|
13766
|
+
code: string;
|
|
13767
|
+
status: number;
|
|
13768
|
+
message: string;
|
|
13769
|
+
data?: unknown;
|
|
13770
|
+
};
|
|
13771
|
+
};
|
|
13772
|
+
};
|
|
13773
|
+
/** @description 503 */
|
|
13774
|
+
503: {
|
|
13775
|
+
headers: {
|
|
13776
|
+
[name: string]: unknown;
|
|
13777
|
+
};
|
|
13778
|
+
content: {
|
|
13779
|
+
"application/json": {
|
|
13780
|
+
/** @constant */
|
|
13781
|
+
defined: true;
|
|
13782
|
+
/** @constant */
|
|
13783
|
+
code: "SERVICE_UNAVAILABLE";
|
|
13784
|
+
/** @constant */
|
|
13785
|
+
status: 503;
|
|
13786
|
+
/** @default Service Unavailable */
|
|
13787
|
+
message: string;
|
|
13788
|
+
data?: components["schemas"]["ErrorData"];
|
|
13789
|
+
} | {
|
|
13790
|
+
/** @constant */
|
|
13791
|
+
defined: false;
|
|
13792
|
+
code: string;
|
|
13793
|
+
status: number;
|
|
13794
|
+
message: string;
|
|
13795
|
+
data?: unknown;
|
|
13796
|
+
};
|
|
13797
|
+
};
|
|
13798
|
+
};
|
|
13799
|
+
};
|
|
13800
|
+
};
|
|
13801
|
+
"collections.bulkDelete": {
|
|
13802
|
+
parameters: {
|
|
13803
|
+
query?: never;
|
|
13804
|
+
header?: {
|
|
13805
|
+
/** @description Required for OAuth: ID of the workspace to access. API keys use their own workspace. */
|
|
13806
|
+
"x-workspace-id"?: string;
|
|
13807
|
+
};
|
|
13808
|
+
path?: never;
|
|
13809
|
+
cookie?: never;
|
|
13810
|
+
};
|
|
13811
|
+
requestBody: {
|
|
13812
|
+
content: {
|
|
13813
|
+
/**
|
|
13814
|
+
* @example {
|
|
13815
|
+
* "ids": [
|
|
13816
|
+
* "coll_example"
|
|
13817
|
+
* ]
|
|
13818
|
+
* }
|
|
13819
|
+
*/
|
|
13820
|
+
"application/json": {
|
|
13821
|
+
/** @description IDs of the collections to delete */
|
|
13822
|
+
ids: string[];
|
|
13823
|
+
};
|
|
13824
|
+
};
|
|
13825
|
+
};
|
|
13826
|
+
responses: {
|
|
13827
|
+
/** @description OK */
|
|
13828
|
+
200: {
|
|
13829
|
+
headers: {
|
|
13830
|
+
[name: string]: unknown;
|
|
13831
|
+
};
|
|
13832
|
+
content: {
|
|
13833
|
+
"application/json": never;
|
|
13834
|
+
};
|
|
13835
|
+
};
|
|
13836
|
+
/** @description 400 */
|
|
13837
|
+
400: {
|
|
13838
|
+
headers: {
|
|
13839
|
+
[name: string]: unknown;
|
|
13840
|
+
};
|
|
13841
|
+
content: {
|
|
13842
|
+
"application/json": {
|
|
13843
|
+
/** @constant */
|
|
13844
|
+
defined: true;
|
|
13845
|
+
/** @constant */
|
|
13846
|
+
code: "BAD_REQUEST";
|
|
13847
|
+
/** @constant */
|
|
13848
|
+
status: 400;
|
|
13849
|
+
/** @default Bad Request */
|
|
13850
|
+
message: string;
|
|
13851
|
+
data?: components["schemas"]["ValidationErrorData"];
|
|
13852
|
+
} | {
|
|
13853
|
+
/** @constant */
|
|
13854
|
+
defined: false;
|
|
13855
|
+
code: string;
|
|
13856
|
+
status: number;
|
|
13857
|
+
message: string;
|
|
13858
|
+
data?: unknown;
|
|
13859
|
+
};
|
|
13860
|
+
};
|
|
13861
|
+
};
|
|
13862
|
+
/** @description 401 */
|
|
13863
|
+
401: {
|
|
13864
|
+
headers: {
|
|
13865
|
+
[name: string]: unknown;
|
|
13866
|
+
};
|
|
13867
|
+
content: {
|
|
13868
|
+
"application/json": {
|
|
13869
|
+
/** @constant */
|
|
13870
|
+
defined: true;
|
|
13871
|
+
/** @constant */
|
|
13872
|
+
code: "UNAUTHORIZED";
|
|
13873
|
+
/** @constant */
|
|
13874
|
+
status: 401;
|
|
13875
|
+
/** @default Unauthorized */
|
|
13876
|
+
message: string;
|
|
13877
|
+
data?: components["schemas"]["ErrorData"];
|
|
13878
|
+
} | {
|
|
13879
|
+
/** @constant */
|
|
13880
|
+
defined: false;
|
|
13881
|
+
code: string;
|
|
13882
|
+
status: number;
|
|
13883
|
+
message: string;
|
|
13884
|
+
data?: unknown;
|
|
13885
|
+
};
|
|
13886
|
+
};
|
|
13887
|
+
};
|
|
13888
|
+
/** @description 403 */
|
|
13889
|
+
403: {
|
|
13890
|
+
headers: {
|
|
13891
|
+
[name: string]: unknown;
|
|
13892
|
+
};
|
|
13893
|
+
content: {
|
|
13894
|
+
"application/json": {
|
|
13895
|
+
/** @constant */
|
|
13896
|
+
defined: true;
|
|
13897
|
+
/** @constant */
|
|
13898
|
+
code: "FORBIDDEN";
|
|
13899
|
+
/** @constant */
|
|
13900
|
+
status: 403;
|
|
13901
|
+
/** @default Forbidden */
|
|
13902
|
+
message: string;
|
|
13903
|
+
data?: components["schemas"]["ForbiddenErrorData"];
|
|
13904
|
+
} | {
|
|
13905
|
+
/** @constant */
|
|
13906
|
+
defined: false;
|
|
13907
|
+
code: string;
|
|
13908
|
+
status: number;
|
|
13909
|
+
message: string;
|
|
13910
|
+
data?: unknown;
|
|
13911
|
+
};
|
|
13912
|
+
};
|
|
13913
|
+
};
|
|
13914
|
+
/** @description 404 */
|
|
13915
|
+
404: {
|
|
13916
|
+
headers: {
|
|
13917
|
+
[name: string]: unknown;
|
|
13918
|
+
};
|
|
13919
|
+
content: {
|
|
13920
|
+
"application/json": {
|
|
13921
|
+
/** @constant */
|
|
13922
|
+
defined: true;
|
|
13923
|
+
/** @constant */
|
|
13924
|
+
code: "NOT_FOUND";
|
|
13925
|
+
/** @constant */
|
|
13926
|
+
status: 404;
|
|
13927
|
+
/** @default Not Found */
|
|
13928
|
+
message: string;
|
|
13929
|
+
data?: components["schemas"]["ErrorData"];
|
|
13930
|
+
} | {
|
|
13931
|
+
/** @constant */
|
|
13932
|
+
defined: false;
|
|
13933
|
+
code: string;
|
|
13934
|
+
status: number;
|
|
13935
|
+
message: string;
|
|
13936
|
+
data?: unknown;
|
|
13937
|
+
};
|
|
13938
|
+
};
|
|
13939
|
+
};
|
|
13940
|
+
/** @description 409 */
|
|
13941
|
+
409: {
|
|
13942
|
+
headers: {
|
|
13943
|
+
[name: string]: unknown;
|
|
13944
|
+
};
|
|
13945
|
+
content: {
|
|
13946
|
+
"application/json": {
|
|
13947
|
+
/** @constant */
|
|
13948
|
+
defined: true;
|
|
13949
|
+
/** @constant */
|
|
13950
|
+
code: "CONFLICT";
|
|
13951
|
+
/** @constant */
|
|
13952
|
+
status: 409;
|
|
13953
|
+
/** @default Conflict */
|
|
13954
|
+
message: string;
|
|
13955
|
+
data?: components["schemas"]["ErrorData"];
|
|
13956
|
+
} | {
|
|
13957
|
+
/** @constant */
|
|
13958
|
+
defined: true;
|
|
13959
|
+
/** @constant */
|
|
13960
|
+
code: "SCHEMA_FIELD_KEY_CONFLICT";
|
|
13961
|
+
/** @constant */
|
|
13962
|
+
status: 409;
|
|
13963
|
+
/** @default SCHEMA_FIELD_KEY_CONFLICT */
|
|
13964
|
+
message: string;
|
|
13965
|
+
data: components["schemas"]["SchemaFieldKeyConflictErrorData"];
|
|
13966
|
+
} | {
|
|
13967
|
+
/** @constant */
|
|
13968
|
+
defined: true;
|
|
13969
|
+
/** @constant */
|
|
13970
|
+
code: "SCHEMA_MIGRATION_IN_PROGRESS";
|
|
13971
|
+
/** @constant */
|
|
13972
|
+
status: 409;
|
|
13973
|
+
/** @default A schema migration is in progress for this collection */
|
|
13974
|
+
message: string;
|
|
13975
|
+
data: components["schemas"]["SchemaMigrationErrorData"];
|
|
13976
|
+
} | {
|
|
13977
|
+
/** @constant */
|
|
13978
|
+
defined: false;
|
|
13979
|
+
code: string;
|
|
13980
|
+
status: number;
|
|
13981
|
+
message: string;
|
|
13982
|
+
data?: unknown;
|
|
13983
|
+
};
|
|
13984
|
+
};
|
|
13985
|
+
};
|
|
13986
|
+
/** @description 429 */
|
|
13987
|
+
429: {
|
|
13988
|
+
headers: {
|
|
13989
|
+
[name: string]: unknown;
|
|
13990
|
+
};
|
|
13991
|
+
content: {
|
|
13992
|
+
"application/json": {
|
|
13993
|
+
/** @constant */
|
|
13994
|
+
defined: true;
|
|
13995
|
+
/** @constant */
|
|
13996
|
+
code: "TOO_MANY_REQUESTS";
|
|
13997
|
+
/** @constant */
|
|
13998
|
+
status: 429;
|
|
13999
|
+
/** @default Too Many Requests */
|
|
14000
|
+
message: string;
|
|
14001
|
+
data?: components["schemas"]["RateLimitErrorData"];
|
|
14002
|
+
} | {
|
|
14003
|
+
/** @constant */
|
|
14004
|
+
defined: false;
|
|
14005
|
+
code: string;
|
|
14006
|
+
status: number;
|
|
14007
|
+
message: string;
|
|
14008
|
+
data?: unknown;
|
|
14009
|
+
};
|
|
14010
|
+
};
|
|
14011
|
+
};
|
|
14012
|
+
/** @description 500 */
|
|
14013
|
+
500: {
|
|
14014
|
+
headers: {
|
|
14015
|
+
[name: string]: unknown;
|
|
14016
|
+
};
|
|
14017
|
+
content: {
|
|
14018
|
+
"application/json": {
|
|
14019
|
+
/** @constant */
|
|
14020
|
+
defined: true;
|
|
14021
|
+
/** @constant */
|
|
14022
|
+
code: "INTERNAL_SERVER_ERROR";
|
|
14023
|
+
/** @constant */
|
|
14024
|
+
status: 500;
|
|
14025
|
+
/** @default Internal Server Error */
|
|
14026
|
+
message: string;
|
|
14027
|
+
data?: components["schemas"]["ErrorData"];
|
|
14028
|
+
} | {
|
|
14029
|
+
/** @constant */
|
|
14030
|
+
defined: false;
|
|
14031
|
+
code: string;
|
|
14032
|
+
status: number;
|
|
14033
|
+
message: string;
|
|
14034
|
+
data?: unknown;
|
|
14035
|
+
};
|
|
14036
|
+
};
|
|
14037
|
+
};
|
|
14038
|
+
/** @description 503 */
|
|
14039
|
+
503: {
|
|
14040
|
+
headers: {
|
|
14041
|
+
[name: string]: unknown;
|
|
14042
|
+
};
|
|
14043
|
+
content: {
|
|
14044
|
+
"application/json": {
|
|
14045
|
+
/** @constant */
|
|
14046
|
+
defined: true;
|
|
14047
|
+
/** @constant */
|
|
14048
|
+
code: "SERVICE_UNAVAILABLE";
|
|
14049
|
+
/** @constant */
|
|
14050
|
+
status: 503;
|
|
14051
|
+
/** @default Service Unavailable */
|
|
14052
|
+
message: string;
|
|
14053
|
+
data?: components["schemas"]["ErrorData"];
|
|
14054
|
+
} | {
|
|
14055
|
+
/** @constant */
|
|
14056
|
+
defined: false;
|
|
14057
|
+
code: string;
|
|
14058
|
+
status: number;
|
|
14059
|
+
message: string;
|
|
14060
|
+
data?: unknown;
|
|
14061
|
+
};
|
|
14062
|
+
};
|
|
14063
|
+
};
|
|
14064
|
+
};
|
|
14065
|
+
};
|
|
14066
|
+
"collections.update": {
|
|
14067
|
+
parameters: {
|
|
14068
|
+
query?: never;
|
|
14069
|
+
header?: {
|
|
14070
|
+
/** @description Required for OAuth: ID of the workspace to access. API keys use their own workspace. */
|
|
14071
|
+
"x-workspace-id"?: string;
|
|
14072
|
+
};
|
|
14073
|
+
path: {
|
|
14074
|
+
/** @example coll_example */
|
|
14075
|
+
id: string;
|
|
14076
|
+
};
|
|
14077
|
+
cookie?: never;
|
|
14078
|
+
};
|
|
14079
|
+
requestBody?: {
|
|
14080
|
+
content: {
|
|
14081
|
+
/**
|
|
14082
|
+
* @example {
|
|
14083
|
+
* "name": "Guides"
|
|
14084
|
+
* }
|
|
14085
|
+
*/
|
|
14086
|
+
"application/json": {
|
|
14087
|
+
/** @description New name of the collection */
|
|
14088
|
+
name?: string;
|
|
14089
|
+
/** @description Name the collection must still have */
|
|
14090
|
+
expectedName?: string;
|
|
14091
|
+
};
|
|
14092
|
+
};
|
|
14093
|
+
};
|
|
14094
|
+
responses: {
|
|
14095
|
+
/** @description OK */
|
|
14096
|
+
200: {
|
|
14097
|
+
headers: {
|
|
14098
|
+
[name: string]: unknown;
|
|
14099
|
+
};
|
|
14100
|
+
content: {
|
|
14101
|
+
"application/json": never;
|
|
14102
|
+
};
|
|
14103
|
+
};
|
|
14104
|
+
/** @description 400 */
|
|
14105
|
+
400: {
|
|
14106
|
+
headers: {
|
|
14107
|
+
[name: string]: unknown;
|
|
14108
|
+
};
|
|
14109
|
+
content: {
|
|
14110
|
+
"application/json": {
|
|
14111
|
+
/** @constant */
|
|
14112
|
+
defined: true;
|
|
14113
|
+
/** @constant */
|
|
14114
|
+
code: "BAD_REQUEST";
|
|
14115
|
+
/** @constant */
|
|
14116
|
+
status: 400;
|
|
14117
|
+
/** @default Bad Request */
|
|
14118
|
+
message: string;
|
|
14119
|
+
data?: components["schemas"]["ValidationErrorData"];
|
|
14120
|
+
} | {
|
|
14121
|
+
/** @constant */
|
|
14122
|
+
defined: false;
|
|
14123
|
+
code: string;
|
|
14124
|
+
status: number;
|
|
14125
|
+
message: string;
|
|
14126
|
+
data?: unknown;
|
|
14127
|
+
};
|
|
14128
|
+
};
|
|
14129
|
+
};
|
|
14130
|
+
/** @description 401 */
|
|
14131
|
+
401: {
|
|
14132
|
+
headers: {
|
|
14133
|
+
[name: string]: unknown;
|
|
14134
|
+
};
|
|
14135
|
+
content: {
|
|
14136
|
+
"application/json": {
|
|
14137
|
+
/** @constant */
|
|
14138
|
+
defined: true;
|
|
14139
|
+
/** @constant */
|
|
14140
|
+
code: "UNAUTHORIZED";
|
|
14141
|
+
/** @constant */
|
|
14142
|
+
status: 401;
|
|
14143
|
+
/** @default Unauthorized */
|
|
14144
|
+
message: string;
|
|
14145
|
+
data?: components["schemas"]["ErrorData"];
|
|
14146
|
+
} | {
|
|
14147
|
+
/** @constant */
|
|
14148
|
+
defined: false;
|
|
14149
|
+
code: string;
|
|
14150
|
+
status: number;
|
|
14151
|
+
message: string;
|
|
14152
|
+
data?: unknown;
|
|
14153
|
+
};
|
|
14154
|
+
};
|
|
14155
|
+
};
|
|
14156
|
+
/** @description 403 */
|
|
14157
|
+
403: {
|
|
14158
|
+
headers: {
|
|
14159
|
+
[name: string]: unknown;
|
|
14160
|
+
};
|
|
14161
|
+
content: {
|
|
14162
|
+
"application/json": {
|
|
14163
|
+
/** @constant */
|
|
14164
|
+
defined: true;
|
|
14165
|
+
/** @constant */
|
|
14166
|
+
code: "FORBIDDEN";
|
|
14167
|
+
/** @constant */
|
|
14168
|
+
status: 403;
|
|
14169
|
+
/** @default Forbidden */
|
|
14170
|
+
message: string;
|
|
14171
|
+
data?: components["schemas"]["ForbiddenErrorData"];
|
|
14172
|
+
} | {
|
|
14173
|
+
/** @constant */
|
|
14174
|
+
defined: false;
|
|
14175
|
+
code: string;
|
|
14176
|
+
status: number;
|
|
14177
|
+
message: string;
|
|
14178
|
+
data?: unknown;
|
|
14179
|
+
};
|
|
14180
|
+
};
|
|
14181
|
+
};
|
|
14182
|
+
/** @description 404 */
|
|
14183
|
+
404: {
|
|
14184
|
+
headers: {
|
|
14185
|
+
[name: string]: unknown;
|
|
14186
|
+
};
|
|
14187
|
+
content: {
|
|
14188
|
+
"application/json": {
|
|
14189
|
+
/** @constant */
|
|
14190
|
+
defined: true;
|
|
14191
|
+
/** @constant */
|
|
14192
|
+
code: "NOT_FOUND";
|
|
14193
|
+
/** @constant */
|
|
14194
|
+
status: 404;
|
|
14195
|
+
/** @default Not Found */
|
|
14196
|
+
message: string;
|
|
14197
|
+
data?: components["schemas"]["ErrorData"];
|
|
14198
|
+
} | {
|
|
14199
|
+
/** @constant */
|
|
14200
|
+
defined: false;
|
|
14201
|
+
code: string;
|
|
14202
|
+
status: number;
|
|
14203
|
+
message: string;
|
|
14204
|
+
data?: unknown;
|
|
14205
|
+
};
|
|
14206
|
+
};
|
|
14207
|
+
};
|
|
14208
|
+
/** @description 409 */
|
|
14209
|
+
409: {
|
|
14210
|
+
headers: {
|
|
14211
|
+
[name: string]: unknown;
|
|
14212
|
+
};
|
|
14213
|
+
content: {
|
|
14214
|
+
"application/json": {
|
|
14215
|
+
/** @constant */
|
|
14216
|
+
defined: true;
|
|
14217
|
+
/** @constant */
|
|
14218
|
+
code: "CONFLICT";
|
|
14219
|
+
/** @constant */
|
|
14220
|
+
status: 409;
|
|
14221
|
+
/** @default Conflict */
|
|
14222
|
+
message: string;
|
|
14223
|
+
data?: components["schemas"]["ErrorData"];
|
|
14224
|
+
} | {
|
|
14225
|
+
/** @constant */
|
|
14226
|
+
defined: true;
|
|
14227
|
+
/** @constant */
|
|
14228
|
+
code: "CONTENT_PRECONDITION_FAILED";
|
|
14229
|
+
/** @constant */
|
|
14230
|
+
status: 409;
|
|
14231
|
+
/** @default CONTENT_PRECONDITION_FAILED */
|
|
14232
|
+
message: string;
|
|
14233
|
+
data: {
|
|
14234
|
+
/** @description Suggested next steps. Wording can change; use error codes and structured data for program logic. */
|
|
14235
|
+
hints?: string[];
|
|
14236
|
+
/** @description Expected field that didn't match */
|
|
14237
|
+
field: string;
|
|
14238
|
+
/** @description Current value of the field */
|
|
14239
|
+
current: string | null;
|
|
14240
|
+
};
|
|
14241
|
+
} | {
|
|
14242
|
+
/** @constant */
|
|
14243
|
+
defined: true;
|
|
14244
|
+
/** @constant */
|
|
14245
|
+
code: "CONTENT_NAME_CONFLICT";
|
|
14246
|
+
/** @constant */
|
|
14247
|
+
status: 409;
|
|
14248
|
+
/** @default CONTENT_NAME_CONFLICT */
|
|
14249
|
+
message: string;
|
|
14250
|
+
data: components["schemas"]["ContentNameConflictErrorData"];
|
|
14251
|
+
} | {
|
|
14252
|
+
/** @constant */
|
|
14253
|
+
defined: true;
|
|
14254
|
+
/** @constant */
|
|
14255
|
+
code: "SCHEMA_FIELD_KEY_CONFLICT";
|
|
14256
|
+
/** @constant */
|
|
14257
|
+
status: 409;
|
|
14258
|
+
/** @default SCHEMA_FIELD_KEY_CONFLICT */
|
|
14259
|
+
message: string;
|
|
14260
|
+
data: components["schemas"]["SchemaFieldKeyConflictErrorData"];
|
|
14261
|
+
} | {
|
|
14262
|
+
/** @constant */
|
|
14263
|
+
defined: true;
|
|
14264
|
+
/** @constant */
|
|
14265
|
+
code: "SCHEMA_MIGRATION_IN_PROGRESS";
|
|
14266
|
+
/** @constant */
|
|
14267
|
+
status: 409;
|
|
14268
|
+
/** @default A schema migration is in progress for this collection */
|
|
14269
|
+
message: string;
|
|
14270
|
+
data: components["schemas"]["SchemaMigrationErrorData"];
|
|
14271
|
+
} | {
|
|
14272
|
+
/** @constant */
|
|
14273
|
+
defined: false;
|
|
14274
|
+
code: string;
|
|
14275
|
+
status: number;
|
|
14276
|
+
message: string;
|
|
14277
|
+
data?: unknown;
|
|
14278
|
+
};
|
|
14279
|
+
};
|
|
14280
|
+
};
|
|
14281
|
+
/** @description 429 */
|
|
14282
|
+
429: {
|
|
14283
|
+
headers: {
|
|
14284
|
+
[name: string]: unknown;
|
|
14285
|
+
};
|
|
14286
|
+
content: {
|
|
14287
|
+
"application/json": {
|
|
14288
|
+
/** @constant */
|
|
14289
|
+
defined: true;
|
|
14290
|
+
/** @constant */
|
|
14291
|
+
code: "TOO_MANY_REQUESTS";
|
|
14292
|
+
/** @constant */
|
|
14293
|
+
status: 429;
|
|
14294
|
+
/** @default Too Many Requests */
|
|
14295
|
+
message: string;
|
|
14296
|
+
data?: components["schemas"]["RateLimitErrorData"];
|
|
14297
|
+
} | {
|
|
14298
|
+
/** @constant */
|
|
14299
|
+
defined: false;
|
|
14300
|
+
code: string;
|
|
14301
|
+
status: number;
|
|
14302
|
+
message: string;
|
|
14303
|
+
data?: unknown;
|
|
14304
|
+
};
|
|
14305
|
+
};
|
|
14306
|
+
};
|
|
14307
|
+
/** @description 500 */
|
|
14308
|
+
500: {
|
|
14309
|
+
headers: {
|
|
14310
|
+
[name: string]: unknown;
|
|
14311
|
+
};
|
|
14312
|
+
content: {
|
|
14313
|
+
"application/json": {
|
|
14314
|
+
/** @constant */
|
|
14315
|
+
defined: true;
|
|
14316
|
+
/** @constant */
|
|
14317
|
+
code: "INTERNAL_SERVER_ERROR";
|
|
14318
|
+
/** @constant */
|
|
14319
|
+
status: 500;
|
|
14320
|
+
/** @default Internal Server Error */
|
|
14321
|
+
message: string;
|
|
14322
|
+
data?: components["schemas"]["ErrorData"];
|
|
14323
|
+
} | {
|
|
14324
|
+
/** @constant */
|
|
14325
|
+
defined: false;
|
|
14326
|
+
code: string;
|
|
14327
|
+
status: number;
|
|
14328
|
+
message: string;
|
|
14329
|
+
data?: unknown;
|
|
14330
|
+
};
|
|
14331
|
+
};
|
|
14332
|
+
};
|
|
14333
|
+
/** @description 503 */
|
|
14334
|
+
503: {
|
|
14335
|
+
headers: {
|
|
14336
|
+
[name: string]: unknown;
|
|
14337
|
+
};
|
|
14338
|
+
content: {
|
|
14339
|
+
"application/json": {
|
|
14340
|
+
/** @constant */
|
|
14341
|
+
defined: true;
|
|
14342
|
+
/** @constant */
|
|
14343
|
+
code: "SERVICE_UNAVAILABLE";
|
|
14344
|
+
/** @constant */
|
|
14345
|
+
status: 503;
|
|
14346
|
+
/** @default Service Unavailable */
|
|
14347
|
+
message: string;
|
|
14348
|
+
data?: components["schemas"]["ErrorData"];
|
|
14349
|
+
} | {
|
|
14350
|
+
/** @constant */
|
|
14351
|
+
defined: false;
|
|
14352
|
+
code: string;
|
|
14353
|
+
status: number;
|
|
14354
|
+
message: string;
|
|
14355
|
+
data?: unknown;
|
|
14356
|
+
};
|
|
14357
|
+
};
|
|
14358
|
+
};
|
|
14359
|
+
};
|
|
14360
|
+
};
|
|
14361
|
+
"collections.delete": {
|
|
14362
|
+
parameters: {
|
|
14363
|
+
query?: never;
|
|
14364
|
+
header?: {
|
|
14365
|
+
/** @description Required for OAuth: ID of the workspace to access. API keys use their own workspace. */
|
|
14366
|
+
"x-workspace-id"?: string;
|
|
14367
|
+
};
|
|
14368
|
+
path: {
|
|
14369
|
+
/** @example coll_example */
|
|
14370
|
+
id: string;
|
|
14371
|
+
};
|
|
14372
|
+
cookie?: never;
|
|
14373
|
+
};
|
|
14374
|
+
requestBody?: never;
|
|
14375
|
+
responses: {
|
|
14376
|
+
/** @description OK */
|
|
14377
|
+
200: {
|
|
14378
|
+
headers: {
|
|
14379
|
+
[name: string]: unknown;
|
|
14380
|
+
};
|
|
14381
|
+
content: {
|
|
14382
|
+
"application/json": never;
|
|
14383
|
+
};
|
|
14384
|
+
};
|
|
14385
|
+
/** @description 400 */
|
|
14386
|
+
400: {
|
|
14387
|
+
headers: {
|
|
14388
|
+
[name: string]: unknown;
|
|
14389
|
+
};
|
|
14390
|
+
content: {
|
|
14391
|
+
"application/json": {
|
|
14392
|
+
/** @constant */
|
|
14393
|
+
defined: true;
|
|
14394
|
+
/** @constant */
|
|
14395
|
+
code: "BAD_REQUEST";
|
|
14396
|
+
/** @constant */
|
|
14397
|
+
status: 400;
|
|
14398
|
+
/** @default Bad Request */
|
|
14399
|
+
message: string;
|
|
14400
|
+
data?: components["schemas"]["ValidationErrorData"];
|
|
14401
|
+
} | {
|
|
14402
|
+
/** @constant */
|
|
14403
|
+
defined: false;
|
|
14404
|
+
code: string;
|
|
14405
|
+
status: number;
|
|
14406
|
+
message: string;
|
|
14407
|
+
data?: unknown;
|
|
14408
|
+
};
|
|
14409
|
+
};
|
|
14410
|
+
};
|
|
14411
|
+
/** @description 401 */
|
|
14412
|
+
401: {
|
|
14413
|
+
headers: {
|
|
14414
|
+
[name: string]: unknown;
|
|
14415
|
+
};
|
|
14416
|
+
content: {
|
|
14417
|
+
"application/json": {
|
|
14418
|
+
/** @constant */
|
|
14419
|
+
defined: true;
|
|
14420
|
+
/** @constant */
|
|
14421
|
+
code: "UNAUTHORIZED";
|
|
14422
|
+
/** @constant */
|
|
14423
|
+
status: 401;
|
|
14424
|
+
/** @default Unauthorized */
|
|
14425
|
+
message: string;
|
|
14426
|
+
data?: components["schemas"]["ErrorData"];
|
|
14427
|
+
} | {
|
|
14428
|
+
/** @constant */
|
|
14429
|
+
defined: false;
|
|
14430
|
+
code: string;
|
|
14431
|
+
status: number;
|
|
14432
|
+
message: string;
|
|
14433
|
+
data?: unknown;
|
|
14434
|
+
};
|
|
14435
|
+
};
|
|
14436
|
+
};
|
|
14437
|
+
/** @description 403 */
|
|
14438
|
+
403: {
|
|
14439
|
+
headers: {
|
|
14440
|
+
[name: string]: unknown;
|
|
14441
|
+
};
|
|
14442
|
+
content: {
|
|
14443
|
+
"application/json": {
|
|
14444
|
+
/** @constant */
|
|
14445
|
+
defined: true;
|
|
14446
|
+
/** @constant */
|
|
14447
|
+
code: "FORBIDDEN";
|
|
14448
|
+
/** @constant */
|
|
14449
|
+
status: 403;
|
|
14450
|
+
/** @default Forbidden */
|
|
14451
|
+
message: string;
|
|
14452
|
+
data?: components["schemas"]["ForbiddenErrorData"];
|
|
14453
|
+
} | {
|
|
14454
|
+
/** @constant */
|
|
14455
|
+
defined: false;
|
|
14456
|
+
code: string;
|
|
14457
|
+
status: number;
|
|
14458
|
+
message: string;
|
|
14459
|
+
data?: unknown;
|
|
14460
|
+
};
|
|
14461
|
+
};
|
|
14462
|
+
};
|
|
14463
|
+
/** @description 404 */
|
|
14464
|
+
404: {
|
|
14465
|
+
headers: {
|
|
14466
|
+
[name: string]: unknown;
|
|
14467
|
+
};
|
|
14468
|
+
content: {
|
|
14469
|
+
"application/json": {
|
|
14470
|
+
/** @constant */
|
|
14471
|
+
defined: true;
|
|
14472
|
+
/** @constant */
|
|
14473
|
+
code: "NOT_FOUND";
|
|
14474
|
+
/** @constant */
|
|
14475
|
+
status: 404;
|
|
14476
|
+
/** @default Not Found */
|
|
14477
|
+
message: string;
|
|
14478
|
+
data?: components["schemas"]["ErrorData"];
|
|
14479
|
+
} | {
|
|
14480
|
+
/** @constant */
|
|
14481
|
+
defined: false;
|
|
14482
|
+
code: string;
|
|
14483
|
+
status: number;
|
|
14484
|
+
message: string;
|
|
14485
|
+
data?: unknown;
|
|
14486
|
+
};
|
|
14487
|
+
};
|
|
14488
|
+
};
|
|
14489
|
+
/** @description 409 */
|
|
14490
|
+
409: {
|
|
14491
|
+
headers: {
|
|
14492
|
+
[name: string]: unknown;
|
|
14493
|
+
};
|
|
14494
|
+
content: {
|
|
14495
|
+
"application/json": {
|
|
14496
|
+
/** @constant */
|
|
14497
|
+
defined: true;
|
|
14498
|
+
/** @constant */
|
|
14499
|
+
code: "CONFLICT";
|
|
14500
|
+
/** @constant */
|
|
14501
|
+
status: 409;
|
|
14502
|
+
/** @default Conflict */
|
|
14503
|
+
message: string;
|
|
14504
|
+
data?: components["schemas"]["ErrorData"];
|
|
14505
|
+
} | {
|
|
14506
|
+
/** @constant */
|
|
14507
|
+
defined: true;
|
|
14508
|
+
/** @constant */
|
|
14509
|
+
code: "SCHEMA_FIELD_KEY_CONFLICT";
|
|
14510
|
+
/** @constant */
|
|
14511
|
+
status: 409;
|
|
14512
|
+
/** @default SCHEMA_FIELD_KEY_CONFLICT */
|
|
14513
|
+
message: string;
|
|
14514
|
+
data: components["schemas"]["SchemaFieldKeyConflictErrorData"];
|
|
14515
|
+
} | {
|
|
14516
|
+
/** @constant */
|
|
14517
|
+
defined: true;
|
|
14518
|
+
/** @constant */
|
|
14519
|
+
code: "SCHEMA_MIGRATION_IN_PROGRESS";
|
|
14520
|
+
/** @constant */
|
|
14521
|
+
status: 409;
|
|
14522
|
+
/** @default A schema migration is in progress for this collection */
|
|
14523
|
+
message: string;
|
|
14524
|
+
data: components["schemas"]["SchemaMigrationErrorData"];
|
|
14525
|
+
} | {
|
|
14526
|
+
/** @constant */
|
|
14527
|
+
defined: false;
|
|
14528
|
+
code: string;
|
|
14529
|
+
status: number;
|
|
14530
|
+
message: string;
|
|
14531
|
+
data?: unknown;
|
|
14532
|
+
};
|
|
14533
|
+
};
|
|
14534
|
+
};
|
|
14535
|
+
/** @description 429 */
|
|
14536
|
+
429: {
|
|
14537
|
+
headers: {
|
|
14538
|
+
[name: string]: unknown;
|
|
14539
|
+
};
|
|
14540
|
+
content: {
|
|
14541
|
+
"application/json": {
|
|
14542
|
+
/** @constant */
|
|
14543
|
+
defined: true;
|
|
14544
|
+
/** @constant */
|
|
14545
|
+
code: "TOO_MANY_REQUESTS";
|
|
14546
|
+
/** @constant */
|
|
14547
|
+
status: 429;
|
|
14548
|
+
/** @default Too Many Requests */
|
|
14549
|
+
message: string;
|
|
14550
|
+
data?: components["schemas"]["RateLimitErrorData"];
|
|
14551
|
+
} | {
|
|
14552
|
+
/** @constant */
|
|
14553
|
+
defined: false;
|
|
14554
|
+
code: string;
|
|
14555
|
+
status: number;
|
|
14556
|
+
message: string;
|
|
14557
|
+
data?: unknown;
|
|
14558
|
+
};
|
|
14559
|
+
};
|
|
14560
|
+
};
|
|
14561
|
+
/** @description 500 */
|
|
14562
|
+
500: {
|
|
14563
|
+
headers: {
|
|
14564
|
+
[name: string]: unknown;
|
|
14565
|
+
};
|
|
14566
|
+
content: {
|
|
14567
|
+
"application/json": {
|
|
14568
|
+
/** @constant */
|
|
14569
|
+
defined: true;
|
|
14570
|
+
/** @constant */
|
|
14571
|
+
code: "INTERNAL_SERVER_ERROR";
|
|
14572
|
+
/** @constant */
|
|
14573
|
+
status: 500;
|
|
14574
|
+
/** @default Internal Server Error */
|
|
14575
|
+
message: string;
|
|
14576
|
+
data?: components["schemas"]["ErrorData"];
|
|
14577
|
+
} | {
|
|
14578
|
+
/** @constant */
|
|
14579
|
+
defined: false;
|
|
14580
|
+
code: string;
|
|
14581
|
+
status: number;
|
|
14582
|
+
message: string;
|
|
14583
|
+
data?: unknown;
|
|
14584
|
+
};
|
|
14585
|
+
};
|
|
14586
|
+
};
|
|
14587
|
+
/** @description 503 */
|
|
14588
|
+
503: {
|
|
14589
|
+
headers: {
|
|
14590
|
+
[name: string]: unknown;
|
|
14591
|
+
};
|
|
14592
|
+
content: {
|
|
14593
|
+
"application/json": {
|
|
14594
|
+
/** @constant */
|
|
14595
|
+
defined: true;
|
|
14596
|
+
/** @constant */
|
|
14597
|
+
code: "SERVICE_UNAVAILABLE";
|
|
14598
|
+
/** @constant */
|
|
14599
|
+
status: 503;
|
|
14600
|
+
/** @default Service Unavailable */
|
|
14601
|
+
message: string;
|
|
14602
|
+
data?: components["schemas"]["ErrorData"];
|
|
14603
|
+
} | {
|
|
14604
|
+
/** @constant */
|
|
14605
|
+
defined: false;
|
|
14606
|
+
code: string;
|
|
14607
|
+
status: number;
|
|
14608
|
+
message: string;
|
|
14609
|
+
data?: unknown;
|
|
14610
|
+
};
|
|
14611
|
+
};
|
|
14612
|
+
};
|
|
14613
|
+
};
|
|
14614
|
+
};
|
|
14615
|
+
"collections.move": {
|
|
14616
|
+
parameters: {
|
|
14617
|
+
query?: never;
|
|
14618
|
+
header?: {
|
|
14619
|
+
/** @description Required for OAuth: ID of the workspace to access. API keys use their own workspace. */
|
|
14620
|
+
"x-workspace-id"?: string;
|
|
14621
|
+
};
|
|
14622
|
+
path: {
|
|
14623
|
+
/** @example coll_example */
|
|
14624
|
+
id: string;
|
|
14625
|
+
};
|
|
14626
|
+
cookie?: never;
|
|
14627
|
+
};
|
|
14628
|
+
requestBody?: {
|
|
14629
|
+
content: {
|
|
14630
|
+
/**
|
|
14631
|
+
* @example {
|
|
14632
|
+
* "newParentID": "coll_parent"
|
|
14633
|
+
* }
|
|
14634
|
+
*/
|
|
14635
|
+
"application/json": {
|
|
14636
|
+
/** @description ID of the new parent collection, or null for the top level */
|
|
14637
|
+
newParentID?: string | null;
|
|
14638
|
+
/** @description Name path of the new parent collection; / is the top level */
|
|
14639
|
+
newParentPath?: string;
|
|
14640
|
+
/** @description Slug path of the new parent collection; / is the top level */
|
|
14641
|
+
newParentSlugPath?: string;
|
|
14642
|
+
/** @description ID of the parent that must still contain the collection, or null for the top level */
|
|
14643
|
+
expectedParentID?: string | null;
|
|
14644
|
+
/** @description New zero-based index in the parent collection's descendants array */
|
|
14645
|
+
index?: number;
|
|
14646
|
+
/**
|
|
14647
|
+
* @description Confirmation that a schema migration caused by the move can remove content
|
|
14648
|
+
* @default false
|
|
14649
|
+
*/
|
|
14650
|
+
confirmedDataLoss?: boolean;
|
|
14651
|
+
};
|
|
14652
|
+
};
|
|
14653
|
+
};
|
|
14654
|
+
responses: {
|
|
14655
|
+
/** @description OK */
|
|
14656
|
+
200: {
|
|
14657
|
+
headers: {
|
|
14658
|
+
[name: string]: unknown;
|
|
14659
|
+
};
|
|
14660
|
+
content: {
|
|
14661
|
+
"application/json": {
|
|
14662
|
+
migrationID: string | null;
|
|
14663
|
+
totalEntries: number;
|
|
14664
|
+
};
|
|
13344
14665
|
};
|
|
13345
14666
|
};
|
|
13346
14667
|
/** @description 400 */
|
|
@@ -13600,6 +14921,242 @@ interface operations {
|
|
|
13600
14921
|
};
|
|
13601
14922
|
};
|
|
13602
14923
|
};
|
|
14924
|
+
"collections.get": {
|
|
14925
|
+
parameters: {
|
|
14926
|
+
query?: {
|
|
14927
|
+
/** @example coll_example */
|
|
14928
|
+
collectionID?: string;
|
|
14929
|
+
collectionPath?: string;
|
|
14930
|
+
collectionSlugPath?: string;
|
|
14931
|
+
};
|
|
14932
|
+
header?: {
|
|
14933
|
+
/** @description Required for OAuth: ID of the workspace to access. API keys use their own workspace. */
|
|
14934
|
+
"x-workspace-id"?: string;
|
|
14935
|
+
};
|
|
14936
|
+
path?: never;
|
|
14937
|
+
cookie?: never;
|
|
14938
|
+
};
|
|
14939
|
+
requestBody?: never;
|
|
14940
|
+
responses: {
|
|
14941
|
+
/** @description OK */
|
|
14942
|
+
200: {
|
|
14943
|
+
headers: {
|
|
14944
|
+
[name: string]: unknown;
|
|
14945
|
+
};
|
|
14946
|
+
content: {
|
|
14947
|
+
"application/json": components["schemas"]["Collection"];
|
|
14948
|
+
};
|
|
14949
|
+
};
|
|
14950
|
+
/** @description 400 */
|
|
14951
|
+
400: {
|
|
14952
|
+
headers: {
|
|
14953
|
+
[name: string]: unknown;
|
|
14954
|
+
};
|
|
14955
|
+
content: {
|
|
14956
|
+
"application/json": {
|
|
14957
|
+
/** @constant */
|
|
14958
|
+
defined: true;
|
|
14959
|
+
/** @constant */
|
|
14960
|
+
code: "BAD_REQUEST";
|
|
14961
|
+
/** @constant */
|
|
14962
|
+
status: 400;
|
|
14963
|
+
/** @default Bad Request */
|
|
14964
|
+
message: string;
|
|
14965
|
+
data?: components["schemas"]["ValidationErrorData"];
|
|
14966
|
+
} | {
|
|
14967
|
+
/** @constant */
|
|
14968
|
+
defined: false;
|
|
14969
|
+
code: string;
|
|
14970
|
+
status: number;
|
|
14971
|
+
message: string;
|
|
14972
|
+
data?: unknown;
|
|
14973
|
+
};
|
|
14974
|
+
};
|
|
14975
|
+
};
|
|
14976
|
+
/** @description 401 */
|
|
14977
|
+
401: {
|
|
14978
|
+
headers: {
|
|
14979
|
+
[name: string]: unknown;
|
|
14980
|
+
};
|
|
14981
|
+
content: {
|
|
14982
|
+
"application/json": {
|
|
14983
|
+
/** @constant */
|
|
14984
|
+
defined: true;
|
|
14985
|
+
/** @constant */
|
|
14986
|
+
code: "UNAUTHORIZED";
|
|
14987
|
+
/** @constant */
|
|
14988
|
+
status: 401;
|
|
14989
|
+
/** @default Unauthorized */
|
|
14990
|
+
message: string;
|
|
14991
|
+
data?: components["schemas"]["ErrorData"];
|
|
14992
|
+
} | {
|
|
14993
|
+
/** @constant */
|
|
14994
|
+
defined: false;
|
|
14995
|
+
code: string;
|
|
14996
|
+
status: number;
|
|
14997
|
+
message: string;
|
|
14998
|
+
data?: unknown;
|
|
14999
|
+
};
|
|
15000
|
+
};
|
|
15001
|
+
};
|
|
15002
|
+
/** @description 403 */
|
|
15003
|
+
403: {
|
|
15004
|
+
headers: {
|
|
15005
|
+
[name: string]: unknown;
|
|
15006
|
+
};
|
|
15007
|
+
content: {
|
|
15008
|
+
"application/json": {
|
|
15009
|
+
/** @constant */
|
|
15010
|
+
defined: true;
|
|
15011
|
+
/** @constant */
|
|
15012
|
+
code: "FORBIDDEN";
|
|
15013
|
+
/** @constant */
|
|
15014
|
+
status: 403;
|
|
15015
|
+
/** @default Forbidden */
|
|
15016
|
+
message: string;
|
|
15017
|
+
data?: components["schemas"]["ForbiddenErrorData"];
|
|
15018
|
+
} | {
|
|
15019
|
+
/** @constant */
|
|
15020
|
+
defined: false;
|
|
15021
|
+
code: string;
|
|
15022
|
+
status: number;
|
|
15023
|
+
message: string;
|
|
15024
|
+
data?: unknown;
|
|
15025
|
+
};
|
|
15026
|
+
};
|
|
15027
|
+
};
|
|
15028
|
+
/** @description 404 */
|
|
15029
|
+
404: {
|
|
15030
|
+
headers: {
|
|
15031
|
+
[name: string]: unknown;
|
|
15032
|
+
};
|
|
15033
|
+
content: {
|
|
15034
|
+
"application/json": {
|
|
15035
|
+
/** @constant */
|
|
15036
|
+
defined: true;
|
|
15037
|
+
/** @constant */
|
|
15038
|
+
code: "NOT_FOUND";
|
|
15039
|
+
/** @constant */
|
|
15040
|
+
status: 404;
|
|
15041
|
+
/** @default Not Found */
|
|
15042
|
+
message: string;
|
|
15043
|
+
data?: components["schemas"]["ErrorData"];
|
|
15044
|
+
} | {
|
|
15045
|
+
/** @constant */
|
|
15046
|
+
defined: false;
|
|
15047
|
+
code: string;
|
|
15048
|
+
status: number;
|
|
15049
|
+
message: string;
|
|
15050
|
+
data?: unknown;
|
|
15051
|
+
};
|
|
15052
|
+
};
|
|
15053
|
+
};
|
|
15054
|
+
/** @description 409 */
|
|
15055
|
+
409: {
|
|
15056
|
+
headers: {
|
|
15057
|
+
[name: string]: unknown;
|
|
15058
|
+
};
|
|
15059
|
+
content: {
|
|
15060
|
+
"application/json": {
|
|
15061
|
+
/** @constant */
|
|
15062
|
+
defined: true;
|
|
15063
|
+
/** @constant */
|
|
15064
|
+
code: "CONFLICT";
|
|
15065
|
+
/** @constant */
|
|
15066
|
+
status: 409;
|
|
15067
|
+
/** @default Conflict */
|
|
15068
|
+
message: string;
|
|
15069
|
+
data?: components["schemas"]["ErrorData"];
|
|
15070
|
+
} | {
|
|
15071
|
+
/** @constant */
|
|
15072
|
+
defined: false;
|
|
15073
|
+
code: string;
|
|
15074
|
+
status: number;
|
|
15075
|
+
message: string;
|
|
15076
|
+
data?: unknown;
|
|
15077
|
+
};
|
|
15078
|
+
};
|
|
15079
|
+
};
|
|
15080
|
+
/** @description 429 */
|
|
15081
|
+
429: {
|
|
15082
|
+
headers: {
|
|
15083
|
+
[name: string]: unknown;
|
|
15084
|
+
};
|
|
15085
|
+
content: {
|
|
15086
|
+
"application/json": {
|
|
15087
|
+
/** @constant */
|
|
15088
|
+
defined: true;
|
|
15089
|
+
/** @constant */
|
|
15090
|
+
code: "TOO_MANY_REQUESTS";
|
|
15091
|
+
/** @constant */
|
|
15092
|
+
status: 429;
|
|
15093
|
+
/** @default Too Many Requests */
|
|
15094
|
+
message: string;
|
|
15095
|
+
data?: components["schemas"]["RateLimitErrorData"];
|
|
15096
|
+
} | {
|
|
15097
|
+
/** @constant */
|
|
15098
|
+
defined: false;
|
|
15099
|
+
code: string;
|
|
15100
|
+
status: number;
|
|
15101
|
+
message: string;
|
|
15102
|
+
data?: unknown;
|
|
15103
|
+
};
|
|
15104
|
+
};
|
|
15105
|
+
};
|
|
15106
|
+
/** @description 500 */
|
|
15107
|
+
500: {
|
|
15108
|
+
headers: {
|
|
15109
|
+
[name: string]: unknown;
|
|
15110
|
+
};
|
|
15111
|
+
content: {
|
|
15112
|
+
"application/json": {
|
|
15113
|
+
/** @constant */
|
|
15114
|
+
defined: true;
|
|
15115
|
+
/** @constant */
|
|
15116
|
+
code: "INTERNAL_SERVER_ERROR";
|
|
15117
|
+
/** @constant */
|
|
15118
|
+
status: 500;
|
|
15119
|
+
/** @default Internal Server Error */
|
|
15120
|
+
message: string;
|
|
15121
|
+
data?: components["schemas"]["ErrorData"];
|
|
15122
|
+
} | {
|
|
15123
|
+
/** @constant */
|
|
15124
|
+
defined: false;
|
|
15125
|
+
code: string;
|
|
15126
|
+
status: number;
|
|
15127
|
+
message: string;
|
|
15128
|
+
data?: unknown;
|
|
15129
|
+
};
|
|
15130
|
+
};
|
|
15131
|
+
};
|
|
15132
|
+
/** @description 503 */
|
|
15133
|
+
503: {
|
|
15134
|
+
headers: {
|
|
15135
|
+
[name: string]: unknown;
|
|
15136
|
+
};
|
|
15137
|
+
content: {
|
|
15138
|
+
"application/json": {
|
|
15139
|
+
/** @constant */
|
|
15140
|
+
defined: true;
|
|
15141
|
+
/** @constant */
|
|
15142
|
+
code: "SERVICE_UNAVAILABLE";
|
|
15143
|
+
/** @constant */
|
|
15144
|
+
status: 503;
|
|
15145
|
+
/** @default Service Unavailable */
|
|
15146
|
+
message: string;
|
|
15147
|
+
data?: components["schemas"]["ErrorData"];
|
|
15148
|
+
} | {
|
|
15149
|
+
/** @constant */
|
|
15150
|
+
defined: false;
|
|
15151
|
+
code: string;
|
|
15152
|
+
status: number;
|
|
15153
|
+
message: string;
|
|
15154
|
+
data?: unknown;
|
|
15155
|
+
};
|
|
15156
|
+
};
|
|
15157
|
+
};
|
|
15158
|
+
};
|
|
15159
|
+
};
|
|
13603
15160
|
"collections.list": {
|
|
13604
15161
|
parameters: {
|
|
13605
15162
|
query?: {
|
|
@@ -13852,7 +15409,7 @@ interface operations {
|
|
|
13852
15409
|
collectionPath?: string;
|
|
13853
15410
|
collectionSlugPath?: string;
|
|
13854
15411
|
/** @example published */
|
|
13855
|
-
channel?:
|
|
15412
|
+
channel?: components["schemas"]["PublishingChannelCode"];
|
|
13856
15413
|
snapshotID?: string;
|
|
13857
15414
|
};
|
|
13858
15415
|
header?: {
|
|
@@ -14099,7 +15656,7 @@ interface operations {
|
|
|
14099
15656
|
collectionPath?: string;
|
|
14100
15657
|
collectionSlugPath?: string;
|
|
14101
15658
|
/** @example published */
|
|
14102
|
-
channel?:
|
|
15659
|
+
channel?: components["schemas"]["PublishingChannelCode"];
|
|
14103
15660
|
snapshotID?: string;
|
|
14104
15661
|
descendants?: boolean;
|
|
14105
15662
|
includeContent?: boolean;
|
|
@@ -14357,7 +15914,7 @@ interface operations {
|
|
|
14357
15914
|
path?: string;
|
|
14358
15915
|
slugPath?: string;
|
|
14359
15916
|
/** @example published */
|
|
14360
|
-
channel?:
|
|
15917
|
+
channel?: components["schemas"]["PublishingChannelCode"];
|
|
14361
15918
|
snapshotID?: string;
|
|
14362
15919
|
};
|
|
14363
15920
|
header?: {
|
|
@@ -14612,7 +16169,7 @@ interface operations {
|
|
|
14612
16169
|
/** @example ast_example */
|
|
14613
16170
|
assetID: string;
|
|
14614
16171
|
/** @example display */
|
|
14615
|
-
variant: "thumbnail" | "display";
|
|
16172
|
+
variant: "thumbnail" | "display" | "source";
|
|
14616
16173
|
};
|
|
14617
16174
|
cookie?: never;
|
|
14618
16175
|
};
|
|
@@ -14849,7 +16406,7 @@ interface operations {
|
|
|
14849
16406
|
slugPath?: string;
|
|
14850
16407
|
expectedSchemaHash?: string;
|
|
14851
16408
|
/** @example published */
|
|
14852
|
-
channel?:
|
|
16409
|
+
channel?: components["schemas"]["PublishingChannelCode"];
|
|
14853
16410
|
snapshotID?: string;
|
|
14854
16411
|
contentFormat?: "json" | "mdx";
|
|
14855
16412
|
};
|
|
@@ -15120,7 +16677,7 @@ interface operations {
|
|
|
15120
16677
|
collectionPath?: string;
|
|
15121
16678
|
collectionSlugPath?: string;
|
|
15122
16679
|
/** @example published */
|
|
15123
|
-
channel?:
|
|
16680
|
+
channel?: components["schemas"]["PublishingChannelCode"];
|
|
15124
16681
|
snapshotID?: string;
|
|
15125
16682
|
};
|
|
15126
16683
|
header?: {
|
|
@@ -15613,7 +17170,6 @@ interface operations {
|
|
|
15613
17170
|
content: {
|
|
15614
17171
|
"application/json": {
|
|
15615
17172
|
name: string;
|
|
15616
|
-
/** Format: uri */
|
|
15617
17173
|
url: string;
|
|
15618
17174
|
/** @default true */
|
|
15619
17175
|
enabled?: boolean;
|
|
@@ -16114,7 +17670,6 @@ interface operations {
|
|
|
16114
17670
|
content: {
|
|
16115
17671
|
"application/json": {
|
|
16116
17672
|
name?: string;
|
|
16117
|
-
/** Format: uri */
|
|
16118
17673
|
url?: string;
|
|
16119
17674
|
enabled?: boolean;
|
|
16120
17675
|
eventTypes?: components["schemas"]["WebhookEventName"][];
|
|
@@ -21321,34 +22876,286 @@ interface operations {
|
|
|
21321
22876
|
};
|
|
21322
22877
|
};
|
|
21323
22878
|
};
|
|
21324
|
-
"search.askPublishedStream": {
|
|
22879
|
+
"search.askPublishedStream": {
|
|
22880
|
+
parameters: {
|
|
22881
|
+
query?: never;
|
|
22882
|
+
header?: {
|
|
22883
|
+
/** @description Required for OAuth: ID of the workspace to access. API keys use their own workspace. */
|
|
22884
|
+
"x-workspace-id"?: string;
|
|
22885
|
+
};
|
|
22886
|
+
path?: never;
|
|
22887
|
+
cookie?: never;
|
|
22888
|
+
};
|
|
22889
|
+
requestBody: {
|
|
22890
|
+
content: {
|
|
22891
|
+
"application/json": {
|
|
22892
|
+
question: string;
|
|
22893
|
+
collectionID?: string;
|
|
22894
|
+
/** @description Decoded content path, such as /Docs/Page or coll_ID/Page. Names are case-sensitive. Do not URL-encode names before passing them to the SDK. */
|
|
22895
|
+
collectionPath?: string;
|
|
22896
|
+
/** @description Decoded derived slug path, such as /docs/getting-started or coll_ID/getting-started. Use the returned slugPath without URL encoding. */
|
|
22897
|
+
collectionSlugPath?: string;
|
|
22898
|
+
/** @default [] */
|
|
22899
|
+
filters?: components["schemas"]["PropertyFilter"][];
|
|
22900
|
+
/** @default [] */
|
|
22901
|
+
history?: components["schemas"]["AnswerHistoryMessage"][];
|
|
22902
|
+
/** @description Publishing channel to search */
|
|
22903
|
+
channel: string;
|
|
22904
|
+
};
|
|
22905
|
+
};
|
|
22906
|
+
};
|
|
22907
|
+
responses: {
|
|
22908
|
+
/** @description OK */
|
|
22909
|
+
200: {
|
|
22910
|
+
headers: {
|
|
22911
|
+
[name: string]: unknown;
|
|
22912
|
+
};
|
|
22913
|
+
content: {
|
|
22914
|
+
"text/event-stream": {
|
|
22915
|
+
/** @constant */
|
|
22916
|
+
event: "message";
|
|
22917
|
+
data: components["schemas"]["PublishedAnswerEvent"];
|
|
22918
|
+
id?: string;
|
|
22919
|
+
retry?: number;
|
|
22920
|
+
} | {
|
|
22921
|
+
/** @constant */
|
|
22922
|
+
event: "done";
|
|
22923
|
+
data?: unknown;
|
|
22924
|
+
id?: string;
|
|
22925
|
+
retry?: number;
|
|
22926
|
+
} | {
|
|
22927
|
+
/** @constant */
|
|
22928
|
+
event: "error";
|
|
22929
|
+
data?: unknown;
|
|
22930
|
+
id?: string;
|
|
22931
|
+
retry?: number;
|
|
22932
|
+
};
|
|
22933
|
+
};
|
|
22934
|
+
};
|
|
22935
|
+
/** @description 400 */
|
|
22936
|
+
400: {
|
|
22937
|
+
headers: {
|
|
22938
|
+
[name: string]: unknown;
|
|
22939
|
+
};
|
|
22940
|
+
content: {
|
|
22941
|
+
"application/json": {
|
|
22942
|
+
/** @constant */
|
|
22943
|
+
defined: true;
|
|
22944
|
+
/** @constant */
|
|
22945
|
+
code: "BAD_REQUEST";
|
|
22946
|
+
/** @constant */
|
|
22947
|
+
status: 400;
|
|
22948
|
+
/** @default Bad Request */
|
|
22949
|
+
message: string;
|
|
22950
|
+
data?: components["schemas"]["ValidationErrorData"];
|
|
22951
|
+
} | {
|
|
22952
|
+
/** @constant */
|
|
22953
|
+
defined: false;
|
|
22954
|
+
code: string;
|
|
22955
|
+
status: number;
|
|
22956
|
+
message: string;
|
|
22957
|
+
data?: unknown;
|
|
22958
|
+
};
|
|
22959
|
+
};
|
|
22960
|
+
};
|
|
22961
|
+
/** @description 401 */
|
|
22962
|
+
401: {
|
|
22963
|
+
headers: {
|
|
22964
|
+
[name: string]: unknown;
|
|
22965
|
+
};
|
|
22966
|
+
content: {
|
|
22967
|
+
"application/json": {
|
|
22968
|
+
/** @constant */
|
|
22969
|
+
defined: true;
|
|
22970
|
+
/** @constant */
|
|
22971
|
+
code: "UNAUTHORIZED";
|
|
22972
|
+
/** @constant */
|
|
22973
|
+
status: 401;
|
|
22974
|
+
/** @default Unauthorized */
|
|
22975
|
+
message: string;
|
|
22976
|
+
data?: components["schemas"]["ErrorData"];
|
|
22977
|
+
} | {
|
|
22978
|
+
/** @constant */
|
|
22979
|
+
defined: false;
|
|
22980
|
+
code: string;
|
|
22981
|
+
status: number;
|
|
22982
|
+
message: string;
|
|
22983
|
+
data?: unknown;
|
|
22984
|
+
};
|
|
22985
|
+
};
|
|
22986
|
+
};
|
|
22987
|
+
/** @description 403 */
|
|
22988
|
+
403: {
|
|
22989
|
+
headers: {
|
|
22990
|
+
[name: string]: unknown;
|
|
22991
|
+
};
|
|
22992
|
+
content: {
|
|
22993
|
+
"application/json": {
|
|
22994
|
+
/** @constant */
|
|
22995
|
+
defined: true;
|
|
22996
|
+
/** @constant */
|
|
22997
|
+
code: "FORBIDDEN";
|
|
22998
|
+
/** @constant */
|
|
22999
|
+
status: 403;
|
|
23000
|
+
/** @default Forbidden */
|
|
23001
|
+
message: string;
|
|
23002
|
+
data?: components["schemas"]["ForbiddenErrorData"];
|
|
23003
|
+
} | {
|
|
23004
|
+
/** @constant */
|
|
23005
|
+
defined: false;
|
|
23006
|
+
code: string;
|
|
23007
|
+
status: number;
|
|
23008
|
+
message: string;
|
|
23009
|
+
data?: unknown;
|
|
23010
|
+
};
|
|
23011
|
+
};
|
|
23012
|
+
};
|
|
23013
|
+
/** @description 404 */
|
|
23014
|
+
404: {
|
|
23015
|
+
headers: {
|
|
23016
|
+
[name: string]: unknown;
|
|
23017
|
+
};
|
|
23018
|
+
content: {
|
|
23019
|
+
"application/json": {
|
|
23020
|
+
/** @constant */
|
|
23021
|
+
defined: true;
|
|
23022
|
+
/** @constant */
|
|
23023
|
+
code: "NOT_FOUND";
|
|
23024
|
+
/** @constant */
|
|
23025
|
+
status: 404;
|
|
23026
|
+
/** @default Not Found */
|
|
23027
|
+
message: string;
|
|
23028
|
+
data?: components["schemas"]["ErrorData"];
|
|
23029
|
+
} | {
|
|
23030
|
+
/** @constant */
|
|
23031
|
+
defined: false;
|
|
23032
|
+
code: string;
|
|
23033
|
+
status: number;
|
|
23034
|
+
message: string;
|
|
23035
|
+
data?: unknown;
|
|
23036
|
+
};
|
|
23037
|
+
};
|
|
23038
|
+
};
|
|
23039
|
+
/** @description 409 */
|
|
23040
|
+
409: {
|
|
23041
|
+
headers: {
|
|
23042
|
+
[name: string]: unknown;
|
|
23043
|
+
};
|
|
23044
|
+
content: {
|
|
23045
|
+
"application/json": {
|
|
23046
|
+
/** @constant */
|
|
23047
|
+
defined: true;
|
|
23048
|
+
/** @constant */
|
|
23049
|
+
code: "CONFLICT";
|
|
23050
|
+
/** @constant */
|
|
23051
|
+
status: 409;
|
|
23052
|
+
/** @default Conflict */
|
|
23053
|
+
message: string;
|
|
23054
|
+
data?: components["schemas"]["ErrorData"];
|
|
23055
|
+
} | {
|
|
23056
|
+
/** @constant */
|
|
23057
|
+
defined: false;
|
|
23058
|
+
code: string;
|
|
23059
|
+
status: number;
|
|
23060
|
+
message: string;
|
|
23061
|
+
data?: unknown;
|
|
23062
|
+
};
|
|
23063
|
+
};
|
|
23064
|
+
};
|
|
23065
|
+
/** @description 429 */
|
|
23066
|
+
429: {
|
|
23067
|
+
headers: {
|
|
23068
|
+
[name: string]: unknown;
|
|
23069
|
+
};
|
|
23070
|
+
content: {
|
|
23071
|
+
"application/json": {
|
|
23072
|
+
/** @constant */
|
|
23073
|
+
defined: true;
|
|
23074
|
+
/** @constant */
|
|
23075
|
+
code: "TOO_MANY_REQUESTS";
|
|
23076
|
+
/** @constant */
|
|
23077
|
+
status: 429;
|
|
23078
|
+
/** @default Too Many Requests */
|
|
23079
|
+
message: string;
|
|
23080
|
+
data?: components["schemas"]["RateLimitErrorData"];
|
|
23081
|
+
} | {
|
|
23082
|
+
/** @constant */
|
|
23083
|
+
defined: false;
|
|
23084
|
+
code: string;
|
|
23085
|
+
status: number;
|
|
23086
|
+
message: string;
|
|
23087
|
+
data?: unknown;
|
|
23088
|
+
};
|
|
23089
|
+
};
|
|
23090
|
+
};
|
|
23091
|
+
/** @description 500 */
|
|
23092
|
+
500: {
|
|
23093
|
+
headers: {
|
|
23094
|
+
[name: string]: unknown;
|
|
23095
|
+
};
|
|
23096
|
+
content: {
|
|
23097
|
+
"application/json": {
|
|
23098
|
+
/** @constant */
|
|
23099
|
+
defined: true;
|
|
23100
|
+
/** @constant */
|
|
23101
|
+
code: "INTERNAL_SERVER_ERROR";
|
|
23102
|
+
/** @constant */
|
|
23103
|
+
status: 500;
|
|
23104
|
+
/** @default Internal Server Error */
|
|
23105
|
+
message: string;
|
|
23106
|
+
data?: components["schemas"]["ErrorData"];
|
|
23107
|
+
} | {
|
|
23108
|
+
/** @constant */
|
|
23109
|
+
defined: false;
|
|
23110
|
+
code: string;
|
|
23111
|
+
status: number;
|
|
23112
|
+
message: string;
|
|
23113
|
+
data?: unknown;
|
|
23114
|
+
};
|
|
23115
|
+
};
|
|
23116
|
+
};
|
|
23117
|
+
/** @description 503 */
|
|
23118
|
+
503: {
|
|
23119
|
+
headers: {
|
|
23120
|
+
[name: string]: unknown;
|
|
23121
|
+
};
|
|
23122
|
+
content: {
|
|
23123
|
+
"application/json": {
|
|
23124
|
+
/** @constant */
|
|
23125
|
+
defined: true;
|
|
23126
|
+
/** @constant */
|
|
23127
|
+
code: "SERVICE_UNAVAILABLE";
|
|
23128
|
+
/** @constant */
|
|
23129
|
+
status: 503;
|
|
23130
|
+
/** @default Service Unavailable */
|
|
23131
|
+
message: string;
|
|
23132
|
+
data?: components["schemas"]["ErrorData"];
|
|
23133
|
+
} | {
|
|
23134
|
+
/** @constant */
|
|
23135
|
+
defined: false;
|
|
23136
|
+
code: string;
|
|
23137
|
+
status: number;
|
|
23138
|
+
message: string;
|
|
23139
|
+
data?: unknown;
|
|
23140
|
+
};
|
|
23141
|
+
};
|
|
23142
|
+
};
|
|
23143
|
+
};
|
|
23144
|
+
};
|
|
23145
|
+
"schemas.create": {
|
|
21325
23146
|
parameters: {
|
|
21326
23147
|
query?: never;
|
|
21327
23148
|
header?: {
|
|
21328
23149
|
/** @description Required for OAuth: ID of the workspace to access. API keys use their own workspace. */
|
|
21329
23150
|
"x-workspace-id"?: string;
|
|
21330
23151
|
};
|
|
21331
|
-
path
|
|
21332
|
-
|
|
21333
|
-
|
|
21334
|
-
requestBody: {
|
|
21335
|
-
content: {
|
|
21336
|
-
"application/json": {
|
|
21337
|
-
question: string;
|
|
21338
|
-
collectionID?: string;
|
|
21339
|
-
/** @description Decoded content path, such as /Docs/Page or coll_ID/Page. Names are case-sensitive. Do not URL-encode names before passing them to the SDK. */
|
|
21340
|
-
collectionPath?: string;
|
|
21341
|
-
/** @description Decoded derived slug path, such as /docs/getting-started or coll_ID/getting-started. Use the returned slugPath without URL encoding. */
|
|
21342
|
-
collectionSlugPath?: string;
|
|
21343
|
-
/** @default [] */
|
|
21344
|
-
filters?: components["schemas"]["PropertyFilter"][];
|
|
21345
|
-
/** @default [] */
|
|
21346
|
-
history?: components["schemas"]["AnswerHistoryMessage"][];
|
|
21347
|
-
/** @description Publishing channel to search */
|
|
21348
|
-
channel: string;
|
|
21349
|
-
};
|
|
23152
|
+
path: {
|
|
23153
|
+
/** @example coll_example */
|
|
23154
|
+
collectionID: string;
|
|
21350
23155
|
};
|
|
23156
|
+
cookie?: never;
|
|
21351
23157
|
};
|
|
23158
|
+
requestBody?: never;
|
|
21352
23159
|
responses: {
|
|
21353
23160
|
/** @description OK */
|
|
21354
23161
|
200: {
|
|
@@ -21356,25 +23163,7 @@ interface operations {
|
|
|
21356
23163
|
[name: string]: unknown;
|
|
21357
23164
|
};
|
|
21358
23165
|
content: {
|
|
21359
|
-
"
|
|
21360
|
-
/** @constant */
|
|
21361
|
-
event: "message";
|
|
21362
|
-
data: components["schemas"]["PublishedAnswerEvent"];
|
|
21363
|
-
id?: string;
|
|
21364
|
-
retry?: number;
|
|
21365
|
-
} | {
|
|
21366
|
-
/** @constant */
|
|
21367
|
-
event: "done";
|
|
21368
|
-
data?: unknown;
|
|
21369
|
-
id?: string;
|
|
21370
|
-
retry?: number;
|
|
21371
|
-
} | {
|
|
21372
|
-
/** @constant */
|
|
21373
|
-
event: "error";
|
|
21374
|
-
data?: unknown;
|
|
21375
|
-
id?: string;
|
|
21376
|
-
retry?: number;
|
|
21377
|
-
};
|
|
23166
|
+
"application/json": components["schemas"]["LocalCollectionSchema"];
|
|
21378
23167
|
};
|
|
21379
23168
|
};
|
|
21380
23169
|
/** @description 400 */
|
|
@@ -21497,6 +23286,26 @@ interface operations {
|
|
|
21497
23286
|
/** @default Conflict */
|
|
21498
23287
|
message: string;
|
|
21499
23288
|
data?: components["schemas"]["ErrorData"];
|
|
23289
|
+
} | {
|
|
23290
|
+
/** @constant */
|
|
23291
|
+
defined: true;
|
|
23292
|
+
/** @constant */
|
|
23293
|
+
code: "SCHEMA_FIELD_KEY_CONFLICT";
|
|
23294
|
+
/** @constant */
|
|
23295
|
+
status: 409;
|
|
23296
|
+
/** @default SCHEMA_FIELD_KEY_CONFLICT */
|
|
23297
|
+
message: string;
|
|
23298
|
+
data: components["schemas"]["SchemaFieldKeyConflictErrorData"];
|
|
23299
|
+
} | {
|
|
23300
|
+
/** @constant */
|
|
23301
|
+
defined: true;
|
|
23302
|
+
/** @constant */
|
|
23303
|
+
code: "SCHEMA_MIGRATION_IN_PROGRESS";
|
|
23304
|
+
/** @constant */
|
|
23305
|
+
status: 409;
|
|
23306
|
+
/** @default A schema migration is in progress for this collection */
|
|
23307
|
+
message: string;
|
|
23308
|
+
data: components["schemas"]["SchemaMigrationErrorData"];
|
|
21500
23309
|
} | {
|
|
21501
23310
|
/** @constant */
|
|
21502
23311
|
defined: false;
|
|
@@ -21587,7 +23396,7 @@ interface operations {
|
|
|
21587
23396
|
};
|
|
21588
23397
|
};
|
|
21589
23398
|
};
|
|
21590
|
-
"schemas.
|
|
23399
|
+
"schemas.delete": {
|
|
21591
23400
|
parameters: {
|
|
21592
23401
|
query?: never;
|
|
21593
23402
|
header?: {
|
|
@@ -21595,12 +23404,27 @@ interface operations {
|
|
|
21595
23404
|
"x-workspace-id"?: string;
|
|
21596
23405
|
};
|
|
21597
23406
|
path: {
|
|
21598
|
-
/** @example
|
|
21599
|
-
|
|
23407
|
+
/** @example sch_example */
|
|
23408
|
+
schemaID: string;
|
|
21600
23409
|
};
|
|
21601
23410
|
cookie?: never;
|
|
21602
23411
|
};
|
|
21603
|
-
requestBody?:
|
|
23412
|
+
requestBody?: {
|
|
23413
|
+
content: {
|
|
23414
|
+
/**
|
|
23415
|
+
* @example {
|
|
23416
|
+
* "confirmedDataLoss": false
|
|
23417
|
+
* }
|
|
23418
|
+
*/
|
|
23419
|
+
"application/json": {
|
|
23420
|
+
/**
|
|
23421
|
+
* @description Confirmation that an inherited-schema migration can remove entry content
|
|
23422
|
+
* @default false
|
|
23423
|
+
*/
|
|
23424
|
+
confirmedDataLoss?: boolean;
|
|
23425
|
+
};
|
|
23426
|
+
};
|
|
23427
|
+
};
|
|
21604
23428
|
responses: {
|
|
21605
23429
|
/** @description OK */
|
|
21606
23430
|
200: {
|
|
@@ -21608,7 +23432,11 @@ interface operations {
|
|
|
21608
23432
|
[name: string]: unknown;
|
|
21609
23433
|
};
|
|
21610
23434
|
content: {
|
|
21611
|
-
"application/json":
|
|
23435
|
+
"application/json": {
|
|
23436
|
+
migrationID: string | null;
|
|
23437
|
+
affectedCollectionIDs: string[];
|
|
23438
|
+
totalEntries: number;
|
|
23439
|
+
};
|
|
21612
23440
|
};
|
|
21613
23441
|
};
|
|
21614
23442
|
/** @description 400 */
|
|
@@ -21841,7 +23669,7 @@ interface operations {
|
|
|
21841
23669
|
};
|
|
21842
23670
|
};
|
|
21843
23671
|
};
|
|
21844
|
-
"schemas.
|
|
23672
|
+
"schemas.getRevision": {
|
|
21845
23673
|
parameters: {
|
|
21846
23674
|
query?: never;
|
|
21847
23675
|
header?: {
|
|
@@ -21849,27 +23677,12 @@ interface operations {
|
|
|
21849
23677
|
"x-workspace-id"?: string;
|
|
21850
23678
|
};
|
|
21851
23679
|
path: {
|
|
21852
|
-
/** @example
|
|
21853
|
-
|
|
23680
|
+
/** @example schr_example */
|
|
23681
|
+
revisionID: string;
|
|
21854
23682
|
};
|
|
21855
23683
|
cookie?: never;
|
|
21856
23684
|
};
|
|
21857
|
-
requestBody?:
|
|
21858
|
-
content: {
|
|
21859
|
-
/**
|
|
21860
|
-
* @example {
|
|
21861
|
-
* "confirmedDataLoss": false
|
|
21862
|
-
* }
|
|
21863
|
-
*/
|
|
21864
|
-
"application/json": {
|
|
21865
|
-
/**
|
|
21866
|
-
* @description Confirmation that an inherited-schema migration can remove entry content
|
|
21867
|
-
* @default false
|
|
21868
|
-
*/
|
|
21869
|
-
confirmedDataLoss?: boolean;
|
|
21870
|
-
};
|
|
21871
|
-
};
|
|
21872
|
-
};
|
|
23685
|
+
requestBody?: never;
|
|
21873
23686
|
responses: {
|
|
21874
23687
|
/** @description OK */
|
|
21875
23688
|
200: {
|
|
@@ -21877,11 +23690,7 @@ interface operations {
|
|
|
21877
23690
|
[name: string]: unknown;
|
|
21878
23691
|
};
|
|
21879
23692
|
content: {
|
|
21880
|
-
"application/json":
|
|
21881
|
-
migrationID: string | null;
|
|
21882
|
-
affectedCollectionIDs: string[];
|
|
21883
|
-
totalEntries: number;
|
|
21884
|
-
};
|
|
23693
|
+
"application/json": components["schemas"]["SchemaRevision"];
|
|
21885
23694
|
};
|
|
21886
23695
|
};
|
|
21887
23696
|
/** @description 400 */
|
|
@@ -22004,26 +23813,6 @@ interface operations {
|
|
|
22004
23813
|
/** @default Conflict */
|
|
22005
23814
|
message: string;
|
|
22006
23815
|
data?: components["schemas"]["ErrorData"];
|
|
22007
|
-
} | {
|
|
22008
|
-
/** @constant */
|
|
22009
|
-
defined: true;
|
|
22010
|
-
/** @constant */
|
|
22011
|
-
code: "SCHEMA_FIELD_KEY_CONFLICT";
|
|
22012
|
-
/** @constant */
|
|
22013
|
-
status: 409;
|
|
22014
|
-
/** @default SCHEMA_FIELD_KEY_CONFLICT */
|
|
22015
|
-
message: string;
|
|
22016
|
-
data: components["schemas"]["SchemaFieldKeyConflictErrorData"];
|
|
22017
|
-
} | {
|
|
22018
|
-
/** @constant */
|
|
22019
|
-
defined: true;
|
|
22020
|
-
/** @constant */
|
|
22021
|
-
code: "SCHEMA_MIGRATION_IN_PROGRESS";
|
|
22022
|
-
/** @constant */
|
|
22023
|
-
status: 409;
|
|
22024
|
-
/** @default A schema migration is in progress for this collection */
|
|
22025
|
-
message: string;
|
|
22026
|
-
data: components["schemas"]["SchemaMigrationErrorData"];
|
|
22027
23816
|
} | {
|
|
22028
23817
|
/** @constant */
|
|
22029
23818
|
defined: false;
|
|
@@ -22114,17 +23903,19 @@ interface operations {
|
|
|
22114
23903
|
};
|
|
22115
23904
|
};
|
|
22116
23905
|
};
|
|
22117
|
-
"schemas.
|
|
23906
|
+
"schemas.get": {
|
|
22118
23907
|
parameters: {
|
|
22119
|
-
query?:
|
|
23908
|
+
query?: {
|
|
23909
|
+
/** @example coll_example */
|
|
23910
|
+
collectionID?: string;
|
|
23911
|
+
collectionPath?: string;
|
|
23912
|
+
collectionSlugPath?: string;
|
|
23913
|
+
};
|
|
22120
23914
|
header?: {
|
|
22121
23915
|
/** @description Required for OAuth: ID of the workspace to access. API keys use their own workspace. */
|
|
22122
23916
|
"x-workspace-id"?: string;
|
|
22123
23917
|
};
|
|
22124
|
-
path
|
|
22125
|
-
/** @example schr_example */
|
|
22126
|
-
revisionID: string;
|
|
22127
|
-
};
|
|
23918
|
+
path?: never;
|
|
22128
23919
|
cookie?: never;
|
|
22129
23920
|
};
|
|
22130
23921
|
requestBody?: never;
|
|
@@ -22135,7 +23926,7 @@ interface operations {
|
|
|
22135
23926
|
[name: string]: unknown;
|
|
22136
23927
|
};
|
|
22137
23928
|
content: {
|
|
22138
|
-
"application/json": components["schemas"]["
|
|
23929
|
+
"application/json": components["schemas"]["CollectionSchema"];
|
|
22139
23930
|
};
|
|
22140
23931
|
};
|
|
22141
23932
|
/** @description 400 */
|
|
@@ -22348,22 +24139,58 @@ interface operations {
|
|
|
22348
24139
|
};
|
|
22349
24140
|
};
|
|
22350
24141
|
};
|
|
22351
|
-
"schemas.
|
|
24142
|
+
"schemas.updateDraft": {
|
|
22352
24143
|
parameters: {
|
|
22353
|
-
query?:
|
|
22354
|
-
/** @example coll_example */
|
|
22355
|
-
collectionID?: string;
|
|
22356
|
-
collectionPath?: string;
|
|
22357
|
-
collectionSlugPath?: string;
|
|
22358
|
-
};
|
|
24144
|
+
query?: never;
|
|
22359
24145
|
header?: {
|
|
22360
24146
|
/** @description Required for OAuth: ID of the workspace to access. API keys use their own workspace. */
|
|
22361
24147
|
"x-workspace-id"?: string;
|
|
22362
24148
|
};
|
|
22363
|
-
path
|
|
24149
|
+
path: {
|
|
24150
|
+
/** @example sch_example */
|
|
24151
|
+
schemaID: string;
|
|
24152
|
+
};
|
|
22364
24153
|
cookie?: never;
|
|
22365
24154
|
};
|
|
22366
|
-
requestBody
|
|
24155
|
+
requestBody: {
|
|
24156
|
+
content: {
|
|
24157
|
+
/**
|
|
24158
|
+
* @example {
|
|
24159
|
+
* "definition": {
|
|
24160
|
+
* "formatVersion": 1,
|
|
24161
|
+
* "fields": [
|
|
24162
|
+
* {
|
|
24163
|
+
* "id": "summary",
|
|
24164
|
+
* "kind": "property",
|
|
24165
|
+
* "label": "Summary",
|
|
24166
|
+
* "type": "text",
|
|
24167
|
+
* "initialValue": "",
|
|
24168
|
+
* "options": []
|
|
24169
|
+
* }
|
|
24170
|
+
* ]
|
|
24171
|
+
* }
|
|
24172
|
+
* }
|
|
24173
|
+
*/
|
|
24174
|
+
"application/json": {
|
|
24175
|
+
/** @description The draft's own fields */
|
|
24176
|
+
definition: {
|
|
24177
|
+
/** @constant */
|
|
24178
|
+
formatVersion: 1;
|
|
24179
|
+
fields: (components["schemas"]["SchemaProperty"] | {
|
|
24180
|
+
id: string;
|
|
24181
|
+
/** @constant */
|
|
24182
|
+
kind: "fragment";
|
|
24183
|
+
label: string;
|
|
24184
|
+
allowedBlocks: components["schemas"]["SchemaBlockType"][];
|
|
24185
|
+
initialContent: components["schemas"]["ContentNodeInput"][];
|
|
24186
|
+
optional?: boolean;
|
|
24187
|
+
})[];
|
|
24188
|
+
};
|
|
24189
|
+
/** @description Draft hash from schemas.get; the update fails if the draft changed since */
|
|
24190
|
+
expectedHash?: string;
|
|
24191
|
+
};
|
|
24192
|
+
};
|
|
24193
|
+
};
|
|
22367
24194
|
responses: {
|
|
22368
24195
|
/** @description OK */
|
|
22369
24196
|
200: {
|
|
@@ -22371,7 +24198,7 @@ interface operations {
|
|
|
22371
24198
|
[name: string]: unknown;
|
|
22372
24199
|
};
|
|
22373
24200
|
content: {
|
|
22374
|
-
"application/json": components["schemas"]["
|
|
24201
|
+
"application/json": components["schemas"]["LocalCollectionSchema"];
|
|
22375
24202
|
};
|
|
22376
24203
|
};
|
|
22377
24204
|
/** @description 400 */
|
|
@@ -22494,6 +24321,43 @@ interface operations {
|
|
|
22494
24321
|
/** @default Conflict */
|
|
22495
24322
|
message: string;
|
|
22496
24323
|
data?: components["schemas"]["ErrorData"];
|
|
24324
|
+
} | {
|
|
24325
|
+
/** @constant */
|
|
24326
|
+
defined: true;
|
|
24327
|
+
/** @constant */
|
|
24328
|
+
code: "SCHEMA_FIELD_KEY_CONFLICT";
|
|
24329
|
+
/** @constant */
|
|
24330
|
+
status: 409;
|
|
24331
|
+
/** @default SCHEMA_FIELD_KEY_CONFLICT */
|
|
24332
|
+
message: string;
|
|
24333
|
+
data: components["schemas"]["SchemaFieldKeyConflictErrorData"];
|
|
24334
|
+
} | {
|
|
24335
|
+
/** @constant */
|
|
24336
|
+
defined: true;
|
|
24337
|
+
/** @constant */
|
|
24338
|
+
code: "SCHEMA_MIGRATION_IN_PROGRESS";
|
|
24339
|
+
/** @constant */
|
|
24340
|
+
status: 409;
|
|
24341
|
+
/** @default A schema migration is in progress for this collection */
|
|
24342
|
+
message: string;
|
|
24343
|
+
data: components["schemas"]["SchemaMigrationErrorData"];
|
|
24344
|
+
} | {
|
|
24345
|
+
/** @constant */
|
|
24346
|
+
defined: true;
|
|
24347
|
+
/** @constant */
|
|
24348
|
+
code: "CONTENT_PRECONDITION_FAILED";
|
|
24349
|
+
/** @constant */
|
|
24350
|
+
status: 409;
|
|
24351
|
+
/** @default CONTENT_PRECONDITION_FAILED */
|
|
24352
|
+
message: string;
|
|
24353
|
+
data: {
|
|
24354
|
+
/** @description Suggested next steps. Wording can change; use error codes and structured data for program logic. */
|
|
24355
|
+
hints?: string[];
|
|
24356
|
+
/** @description Expected field that didn't match */
|
|
24357
|
+
field: string;
|
|
24358
|
+
/** @description Current value of the field */
|
|
24359
|
+
current: string | null;
|
|
24360
|
+
};
|
|
22497
24361
|
} | {
|
|
22498
24362
|
/** @constant */
|
|
22499
24363
|
defined: false;
|
|
@@ -22613,6 +24477,22 @@ interface operations {
|
|
|
22613
24477
|
confirmedDataLoss: true;
|
|
22614
24478
|
/** @description Optional version name */
|
|
22615
24479
|
name?: string;
|
|
24480
|
+
/** @description The fields to apply instead of the draft's; inherited fields stay as they are */
|
|
24481
|
+
definition?: {
|
|
24482
|
+
/** @constant */
|
|
24483
|
+
formatVersion: 1;
|
|
24484
|
+
fields: (components["schemas"]["SchemaProperty"] | {
|
|
24485
|
+
id: string;
|
|
24486
|
+
/** @constant */
|
|
24487
|
+
kind: "fragment";
|
|
24488
|
+
label: string;
|
|
24489
|
+
allowedBlocks: components["schemas"]["SchemaBlockType"][];
|
|
24490
|
+
initialContent: components["schemas"]["ContentNodeInput"][];
|
|
24491
|
+
optional?: boolean;
|
|
24492
|
+
})[];
|
|
24493
|
+
};
|
|
24494
|
+
/** @description Draft hash from schemas.get; the apply fails if the draft changed since */
|
|
24495
|
+
expectedHash?: string;
|
|
22616
24496
|
};
|
|
22617
24497
|
};
|
|
22618
24498
|
};
|
|
@@ -22766,6 +24646,23 @@ interface operations {
|
|
|
22766
24646
|
/** @default A schema migration is in progress for this collection */
|
|
22767
24647
|
message: string;
|
|
22768
24648
|
data: components["schemas"]["SchemaMigrationErrorData"];
|
|
24649
|
+
} | {
|
|
24650
|
+
/** @constant */
|
|
24651
|
+
defined: true;
|
|
24652
|
+
/** @constant */
|
|
24653
|
+
code: "CONTENT_PRECONDITION_FAILED";
|
|
24654
|
+
/** @constant */
|
|
24655
|
+
status: 409;
|
|
24656
|
+
/** @default CONTENT_PRECONDITION_FAILED */
|
|
24657
|
+
message: string;
|
|
24658
|
+
data: {
|
|
24659
|
+
/** @description Suggested next steps. Wording can change; use error codes and structured data for program logic. */
|
|
24660
|
+
hints?: string[];
|
|
24661
|
+
/** @description Expected field that didn't match */
|
|
24662
|
+
field: string;
|
|
24663
|
+
/** @description Current value of the field */
|
|
24664
|
+
current: string | null;
|
|
24665
|
+
};
|
|
22769
24666
|
} | {
|
|
22770
24667
|
/** @constant */
|
|
22771
24668
|
defined: false;
|
|
@@ -24833,10 +26730,7 @@ interface operations {
|
|
|
24833
26730
|
* }
|
|
24834
26731
|
*/
|
|
24835
26732
|
"application/json": {
|
|
24836
|
-
/**
|
|
24837
|
-
* Format: email
|
|
24838
|
-
* @description Email address of the user to invite
|
|
24839
|
-
*/
|
|
26733
|
+
/** @description Email address of the user to invite */
|
|
24840
26734
|
email: string;
|
|
24841
26735
|
/** @description ID of the role to assign */
|
|
24842
26736
|
roleID: string;
|
|
@@ -26576,7 +28470,7 @@ interface operations {
|
|
|
26576
28470
|
* @description Publishing channel, defaults to published
|
|
26577
28471
|
* @default published
|
|
26578
28472
|
*/
|
|
26579
|
-
channel?:
|
|
28473
|
+
channel?: components["schemas"]["PublishingChannelCode"];
|
|
26580
28474
|
/** @description Reject the mutation if the channel no longer points to this reviewed snapshot */
|
|
26581
28475
|
expectedSnapshotID?: string;
|
|
26582
28476
|
};
|
|
@@ -26857,7 +28751,7 @@ interface operations {
|
|
|
26857
28751
|
* @description Publishing channel, defaults to published
|
|
26858
28752
|
* @default published
|
|
26859
28753
|
*/
|
|
26860
|
-
channel?:
|
|
28754
|
+
channel?: components["schemas"]["PublishingChannelCode"];
|
|
26861
28755
|
/** @description Reject the mutation if the channel no longer points to this reviewed snapshot */
|
|
26862
28756
|
expectedSnapshotID?: string;
|
|
26863
28757
|
};
|
|
@@ -27413,7 +29307,7 @@ interface operations {
|
|
|
27413
29307
|
* @description Publishing channel, defaults to published
|
|
27414
29308
|
* @default published
|
|
27415
29309
|
*/
|
|
27416
|
-
channel?:
|
|
29310
|
+
channel?: components["schemas"]["PublishingChannelCode"];
|
|
27417
29311
|
/** @description Reject the mutation if the channel no longer points to this reviewed snapshot */
|
|
27418
29312
|
expectedSnapshotID?: string;
|
|
27419
29313
|
/** @description IDs of the collection trees to publish */
|
|
@@ -27696,7 +29590,7 @@ interface operations {
|
|
|
27696
29590
|
* @description Publishing channel, defaults to published
|
|
27697
29591
|
* @default published
|
|
27698
29592
|
*/
|
|
27699
|
-
channel?:
|
|
29593
|
+
channel?: components["schemas"]["PublishingChannelCode"];
|
|
27700
29594
|
/** @description Reject the mutation if the channel no longer points to this reviewed snapshot */
|
|
27701
29595
|
expectedSnapshotID?: string;
|
|
27702
29596
|
/** @description IDs of the collection trees to unpublish */
|
|
@@ -27969,7 +29863,7 @@ interface operations {
|
|
|
27969
29863
|
* @description Publishing channel, defaults to published
|
|
27970
29864
|
* @default published
|
|
27971
29865
|
*/
|
|
27972
|
-
channel?:
|
|
29866
|
+
channel?: components["schemas"]["PublishingChannelCode"];
|
|
27973
29867
|
/** @description Reject the mutation if the channel no longer points to this reviewed snapshot */
|
|
27974
29868
|
expectedSnapshotID?: string;
|
|
27975
29869
|
/** @description Existing version to publish */
|
|
@@ -28253,7 +30147,7 @@ interface operations {
|
|
|
28253
30147
|
* @description Publishing channel, defaults to published
|
|
28254
30148
|
* @default published
|
|
28255
30149
|
*/
|
|
28256
|
-
channel?:
|
|
30150
|
+
channel?: components["schemas"]["PublishingChannelCode"];
|
|
28257
30151
|
/** @description Reject the mutation if the channel no longer points to this reviewed snapshot */
|
|
28258
30152
|
expectedSnapshotID?: string;
|
|
28259
30153
|
/** @description Version expected to be assigned */
|
|
@@ -28528,7 +30422,7 @@ interface operations {
|
|
|
28528
30422
|
* @description Publishing channel, defaults to published
|
|
28529
30423
|
* @default published
|
|
28530
30424
|
*/
|
|
28531
|
-
channel?:
|
|
30425
|
+
channel?: components["schemas"]["PublishingChannelCode"];
|
|
28532
30426
|
/** @description Reject the mutation if the channel no longer points to this reviewed snapshot */
|
|
28533
30427
|
expectedSnapshotID?: string;
|
|
28534
30428
|
/** @description Entries and versions to publish */
|
|
@@ -28811,7 +30705,7 @@ interface operations {
|
|
|
28811
30705
|
* @description Publishing channel, defaults to published
|
|
28812
30706
|
* @default published
|
|
28813
30707
|
*/
|
|
28814
|
-
channel?:
|
|
30708
|
+
channel?: components["schemas"]["PublishingChannelCode"];
|
|
28815
30709
|
/** @description Reject the mutation if the channel no longer points to this reviewed snapshot */
|
|
28816
30710
|
expectedSnapshotID?: string;
|
|
28817
30711
|
/** @description IDs of the entries to unpublish */
|
|
@@ -29086,7 +30980,7 @@ interface operations {
|
|
|
29086
30980
|
* @description Publishing channel, defaults to published
|
|
29087
30981
|
* @default published
|
|
29088
30982
|
*/
|
|
29089
|
-
channel?:
|
|
30983
|
+
channel?: components["schemas"]["PublishingChannelCode"];
|
|
29090
30984
|
/** @description Whether to revert all pending changes */
|
|
29091
30985
|
all?: boolean;
|
|
29092
30986
|
/** @description Publishing root collection */
|
|
@@ -29384,7 +31278,7 @@ interface operations {
|
|
|
29384
31278
|
parameters: {
|
|
29385
31279
|
query?: {
|
|
29386
31280
|
/** @example published */
|
|
29387
|
-
channel?:
|
|
31281
|
+
channel?: components["schemas"]["PublishingChannelCode"];
|
|
29388
31282
|
expectedSchemaHash?: string;
|
|
29389
31283
|
snapshotID?: string;
|
|
29390
31284
|
};
|
|
@@ -30384,7 +32278,7 @@ interface operations {
|
|
|
30384
32278
|
};
|
|
30385
32279
|
path: {
|
|
30386
32280
|
/** @example published */
|
|
30387
|
-
channel:
|
|
32281
|
+
channel: components["schemas"]["PublishingChannelCode"];
|
|
30388
32282
|
};
|
|
30389
32283
|
cookie?: never;
|
|
30390
32284
|
};
|
|
@@ -31997,15 +33891,9 @@ interface operations {
|
|
|
31997
33891
|
sourceVersionID: string | null;
|
|
31998
33892
|
/** @description Memberships that contributed to the version */
|
|
31999
33893
|
contributorIDs: string[];
|
|
32000
|
-
/**
|
|
32001
|
-
* Format: date-time
|
|
32002
|
-
* @description Time when the version was created
|
|
32003
|
-
*/
|
|
33894
|
+
/** @description Time when the version was created */
|
|
32004
33895
|
createdAt: string;
|
|
32005
|
-
/**
|
|
32006
|
-
* Format: date-time
|
|
32007
|
-
* @description Time when the version name was last updated
|
|
32008
|
-
*/
|
|
33896
|
+
/** @description Time when the version name was last updated */
|
|
32009
33897
|
updatedAt: string;
|
|
32010
33898
|
schema: components["schemas"]["ContentSchemaMetadata"] | null;
|
|
32011
33899
|
/** @description ProseMirror JSON stored in the version */
|
|
@@ -33110,7 +34998,7 @@ interface operations {
|
|
|
33110
34998
|
* @default false
|
|
33111
34999
|
*/
|
|
33112
35000
|
includeTree?: boolean;
|
|
33113
|
-
channel?:
|
|
35001
|
+
channel?: components["schemas"]["PublishingChannelCode"];
|
|
33114
35002
|
snapshotID?: string;
|
|
33115
35003
|
};
|
|
33116
35004
|
};
|
|
@@ -33338,4 +35226,4 @@ interface operations {
|
|
|
33338
35226
|
}
|
|
33339
35227
|
//#endregion
|
|
33340
35228
|
export { InvitePendingErrorData as $, TextPropertyFilter as $t, ContentNodeInput as A, ResolvedSchemaField as At, EntryPropertyKind as B, SchemaFragment as Bt, Collection as C, PublishedVersion as Ct, ContentMarkInput as D, PublishingSnapshotErrorData as Dt, ContentMark as E, PublishingChannelListItem as Et, DatePropertyFilter as F, SchemaDefinition as Ft, EntryVersion as G, SchemaProperty as Gt, EntryPublication as H, SchemaMigrationContentLossEntry as Ht, EffectiveCollectionSchema as I, SchemaDraftDefinition as It, ForbiddenErrorData as J, SchemaVersion as Jt, EntryVersionSummary as K, SchemaPropertyValue as Kt, Entry as L, SchemaField as Lt, ContentSchemaIssue as M, Role as Mt, ContentSchemaMetadata as N, SchemaApplicationResult as Nt, ContentNameConflictErrorData as O, RateLimitErrorData as Ot, ContentSchemaMismatchErrorData as P, SchemaBlockType as Pt, InviteDeliveryResult as Q, SearchResults as Qt, EntryFragment as R, SchemaFieldKeyConflictErrorData as Rt, ChannelContentStatus as S, PublishedTree as St, ComparisonOperator as T, PublishingChannelCode as Tt, EntryPublicationChannel as U, SchemaMigrationErrorData as Ut, EntryPropertyValue as V, SchemaMigration as Vt, EntrySummary as W, SchemaMigrationStatus as Wt, InstanceInfo as X, SearchPropertyValue as Xt, Identity as Y, SchemaVersionSummary as Yt, Invite as Z, SearchResult as Zt, BaseRole as _, operations as _n, PublishedEntriesResult as _t, Asset as a, UserProfile as an, NumberPropertyFilter as at, ChannelContentCollection as b, PublishedEntrySummary as bt, AssetConflictErrorData as c, VersionReason as cn, PropertyFilter as ct, AssetSearchResult as d, WebhookEndpoint as dn, PublishedAnswerEvent as dt, TypeMetadata as en, InviteStatus as et, AssetStatus as f, WebhookEvent as fn, PublishedAnswerSource as ft, AssetVariant as g, components as gn, PublishedContent as gt, AssetValidationErrorData as h, WorkspaceListItem as hn, PublishedCollectionSummary as ht, AnswerSource as i, UnpublishedEntriesResult as in, MembershipInviteResult as it, ContentSchemaInvalidErrorData as j, RevertPublishingChangesResult as jt, ContentNode as k, ResolvedSchemaDefinition as kt, AssetFile as l, WebhookAttempt as ln, PublishEntryTarget as lt, AssetUploadRegistration as m, WebhookRun as mn, PublishedCollection as mt, AnswerEvent as n, TypeMetadataEntry as nn, Membership as nt, AssetAnalysis as o, ValidationErrorData as on, Pagination as ot, AssetStorageErrorData as p, WebhookEventName as pn, PublishedAsset as pt, ErrorData as q, SchemaRevision as qt, AnswerHistoryMessage as r, TypeMetadataTree as rn, MembershipExistsErrorData as rt, AssetAnalysisStatus as s, ValidationIssue as sn, Permission as st, Answer as t, TypeMetadataCollection as tn, LocalCollectionSchema as tt, AssetFileFormat as u, WebhookDelivery as un, PublishedAnswer as ut, BooleanPropertyFilter as v, paths as vn, PublishedEntry as vt, CollectionSchema as w, PublishingChannel as wt, ChannelContentEntry as x, PublishedSearchResult as xt, ChannelContent as y, PublishedEntryContent as yt, EntryProperty as z, SchemaFieldSource as zt };
|
|
33341
|
-
//# sourceMappingURL=schema-
|
|
35229
|
+
//# sourceMappingURL=schema-DBHoDzsT.d.ts.map
|