@geolens/sdk 1.29.1 → 1.30.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/dist/client/client.gen.d.ts.map +1 -1
- package/dist/client/client.gen.js +1 -1
- package/dist/client/client.gen.js.map +1 -1
- package/dist/client/index.d.ts +2 -2
- package/dist/client/index.d.ts.map +1 -1
- package/dist/client/index.js +1 -1
- package/dist/client/index.js.map +1 -1
- package/dist/client/sdk.gen.d.ts +362 -327
- package/dist/client/sdk.gen.d.ts.map +1 -1
- package/dist/client/sdk.gen.js +361 -326
- package/dist/client/sdk.gen.js.map +1 -1
- package/dist/client/types.gen.d.ts +907 -22
- package/dist/client/types.gen.d.ts.map +1 -1
- package/package.json +1 -1
package/dist/client/sdk.gen.js
CHANGED
|
@@ -2,13 +2,13 @@
|
|
|
2
2
|
import { formDataBodySerializer, urlSearchParamsBodySerializer } from './client/index.js';
|
|
3
3
|
import { client } from './client.gen.js';
|
|
4
4
|
/**
|
|
5
|
-
*
|
|
5
|
+
* Get the OGC API landing page
|
|
6
6
|
*
|
|
7
7
|
* OGC API landing page -- entry point for machine clients.
|
|
8
8
|
*/
|
|
9
9
|
export const landingPageGet = (options) => (options?.client ?? client).get({ url: '/', ...options });
|
|
10
10
|
/**
|
|
11
|
-
* Get
|
|
11
|
+
* Get the AI feature status
|
|
12
12
|
*
|
|
13
13
|
* Return single-deployment AI status; no provider-routing policy controls (admin only).
|
|
14
14
|
*/
|
|
@@ -26,7 +26,7 @@ export const getAiStatusAdminAiStatusGet = (options) => (options?.client ?? clie
|
|
|
26
26
|
...options
|
|
27
27
|
});
|
|
28
28
|
/**
|
|
29
|
-
*
|
|
29
|
+
* Turn AI features on or off
|
|
30
30
|
*
|
|
31
31
|
* Toggle base AI features on/off at runtime; no provider-routing policy controls (admin only).
|
|
32
32
|
*/
|
|
@@ -48,7 +48,7 @@ export const updateAiStatusAdminAiStatusPatch = (options) => (options.client ??
|
|
|
48
48
|
}
|
|
49
49
|
});
|
|
50
50
|
/**
|
|
51
|
-
* List
|
|
51
|
+
* List all API keys
|
|
52
52
|
*
|
|
53
53
|
* List all API keys (admin only). Never returns the raw key.
|
|
54
54
|
*/
|
|
@@ -66,7 +66,7 @@ export const listApiKeysAdminApiKeysGet = (options) => (options?.client ?? clien
|
|
|
66
66
|
...options
|
|
67
67
|
});
|
|
68
68
|
/**
|
|
69
|
-
* Create
|
|
69
|
+
* Create an API key for a user
|
|
70
70
|
*
|
|
71
71
|
* Create an API key for a user (admin only).
|
|
72
72
|
*
|
|
@@ -83,7 +83,7 @@ export const createApiKeyAdminApiKeysPost = (options) => (options.client ?? clie
|
|
|
83
83
|
}
|
|
84
84
|
});
|
|
85
85
|
/**
|
|
86
|
-
* Revoke
|
|
86
|
+
* Revoke any API key
|
|
87
87
|
*
|
|
88
88
|
* Revoke (soft-delete) an API key (admin only).
|
|
89
89
|
*/
|
|
@@ -101,7 +101,7 @@ export const revokeApiKeyAdminApiKeysKeyIdDelete = (options) => (options.client
|
|
|
101
101
|
...options
|
|
102
102
|
});
|
|
103
103
|
/**
|
|
104
|
-
* List
|
|
104
|
+
* List audit log entries
|
|
105
105
|
*
|
|
106
106
|
* Query audit logs with optional filters and sort (admin only).
|
|
107
107
|
*
|
|
@@ -140,7 +140,7 @@ export const exportAuditLogsAdminAuditLogsExportFormatGet = (options) => (option
|
|
|
140
140
|
...options
|
|
141
141
|
});
|
|
142
142
|
/**
|
|
143
|
-
*
|
|
143
|
+
* Queue an embedding backfill
|
|
144
144
|
*
|
|
145
145
|
* Queue semantic-search embedding generation for records (admin only).
|
|
146
146
|
*
|
|
@@ -176,7 +176,7 @@ export const triggerBackfillAdminBackfillEmbeddingsPost = (options) => (options?
|
|
|
176
176
|
...options
|
|
177
177
|
});
|
|
178
178
|
/**
|
|
179
|
-
* List
|
|
179
|
+
* List embed tokens
|
|
180
180
|
*
|
|
181
181
|
* List basic embed-token inventory across maps; no quota or domain-policy controls (admin only).
|
|
182
182
|
*/
|
|
@@ -194,7 +194,7 @@ export const listAllEmbedTokensAdminEmbedTokensGet = (options) => (options?.clie
|
|
|
194
194
|
...options
|
|
195
195
|
});
|
|
196
196
|
/**
|
|
197
|
-
*
|
|
197
|
+
* Revoke several embed tokens
|
|
198
198
|
*
|
|
199
199
|
* Bulk-revoke basic embed tokens; no quota or domain-policy controls (admin only).
|
|
200
200
|
*/
|
|
@@ -216,7 +216,7 @@ export const bulkRevokeAdminEmbedTokensBulkRevokePost = (options) => (options.cl
|
|
|
216
216
|
}
|
|
217
217
|
});
|
|
218
218
|
/**
|
|
219
|
-
* Get
|
|
219
|
+
* Get embedding coverage
|
|
220
220
|
*
|
|
221
221
|
* Return embedding coverage and the state of the backfill runs (admin only).
|
|
222
222
|
*/
|
|
@@ -234,7 +234,7 @@ export const getEmbeddingStatsAdminEmbeddingStatsGet = (options) => (options?.cl
|
|
|
234
234
|
...options
|
|
235
235
|
});
|
|
236
236
|
/**
|
|
237
|
-
* List
|
|
237
|
+
* List sharing groups
|
|
238
238
|
*
|
|
239
239
|
* List sharing groups by name, with member counts (admin only).
|
|
240
240
|
*/
|
|
@@ -252,7 +252,7 @@ export const listGroupsAdminGroupsGet = (options) => (options?.client ?? client)
|
|
|
252
252
|
...options
|
|
253
253
|
});
|
|
254
254
|
/**
|
|
255
|
-
* Create
|
|
255
|
+
* Create a sharing group
|
|
256
256
|
*
|
|
257
257
|
* Create an empty sharing group (admin only). A duplicate name is 409.
|
|
258
258
|
*/
|
|
@@ -274,7 +274,7 @@ export const createGroupAdminGroupsPost = (options) => (options.client ?? client
|
|
|
274
274
|
}
|
|
275
275
|
});
|
|
276
276
|
/**
|
|
277
|
-
* Delete
|
|
277
|
+
* Delete a sharing group
|
|
278
278
|
*
|
|
279
279
|
* Delete a sharing group and all its memberships (admin only).
|
|
280
280
|
*
|
|
@@ -296,7 +296,7 @@ export const deleteGroupAdminGroupsGroupIdDelete = (options) => (options.client
|
|
|
296
296
|
...options
|
|
297
297
|
});
|
|
298
298
|
/**
|
|
299
|
-
* Get
|
|
299
|
+
* Get a sharing group
|
|
300
300
|
*
|
|
301
301
|
* Get one sharing group with its member count (admin only).
|
|
302
302
|
*/
|
|
@@ -314,7 +314,7 @@ export const getGroupAdminGroupsGroupIdGet = (options) => (options.client ?? cli
|
|
|
314
314
|
...options
|
|
315
315
|
});
|
|
316
316
|
/**
|
|
317
|
-
* Rename
|
|
317
|
+
* Rename a sharing group
|
|
318
318
|
*
|
|
319
319
|
* Rename a sharing group (admin only). A name already in use is 409.
|
|
320
320
|
*/
|
|
@@ -336,7 +336,7 @@ export const renameGroupAdminGroupsGroupIdPatch = (options) => (options.client ?
|
|
|
336
336
|
}
|
|
337
337
|
});
|
|
338
338
|
/**
|
|
339
|
-
* List
|
|
339
|
+
* List sharing group members
|
|
340
340
|
*
|
|
341
341
|
* List a sharing group's members by username (admin only).
|
|
342
342
|
*/
|
|
@@ -354,7 +354,7 @@ export const listGroupMembersAdminGroupsGroupIdMembersGet = (options) => (option
|
|
|
354
354
|
...options
|
|
355
355
|
});
|
|
356
356
|
/**
|
|
357
|
-
* Add
|
|
357
|
+
* Add users to a sharing group
|
|
358
358
|
*
|
|
359
359
|
* Add users to a sharing group (admin only).
|
|
360
360
|
*
|
|
@@ -380,7 +380,7 @@ export const addGroupMembersAdminGroupsGroupIdMembersPost = (options) => (option
|
|
|
380
380
|
}
|
|
381
381
|
});
|
|
382
382
|
/**
|
|
383
|
-
* Remove
|
|
383
|
+
* Remove a user from a sharing group
|
|
384
384
|
*
|
|
385
385
|
* Remove one user from a sharing group (admin only).
|
|
386
386
|
*
|
|
@@ -400,7 +400,7 @@ export const removeGroupMemberAdminGroupsGroupIdMembersUserIdDelete = (options)
|
|
|
400
400
|
...options
|
|
401
401
|
});
|
|
402
402
|
/**
|
|
403
|
-
* Get
|
|
403
|
+
* Get infrastructure status
|
|
404
404
|
*
|
|
405
405
|
* Return infrastructure configuration, live health status, and OIDC provider connectivity.
|
|
406
406
|
*/
|
|
@@ -418,7 +418,7 @@ export const getInfrastructureAdminInfrastructureGet = (options) => (options?.cl
|
|
|
418
418
|
...options
|
|
419
419
|
});
|
|
420
420
|
/**
|
|
421
|
-
* List
|
|
421
|
+
* List all ingest jobs
|
|
422
422
|
*
|
|
423
423
|
* List all ingestion jobs with optional status/user/search/sort filters (admin only).
|
|
424
424
|
*
|
|
@@ -439,7 +439,7 @@ export const listAdminJobsAdminJobsGet = (options) => (options?.client ?? client
|
|
|
439
439
|
...options
|
|
440
440
|
});
|
|
441
441
|
/**
|
|
442
|
-
* List
|
|
442
|
+
* List share tokens
|
|
443
443
|
*
|
|
444
444
|
* List basic share-token inventory with map info; no quotas or domain controls (admin only).
|
|
445
445
|
*
|
|
@@ -460,7 +460,7 @@ export const listShareTokensEndpointAdminShareTokensGet = (options) => (options?
|
|
|
460
460
|
...options
|
|
461
461
|
});
|
|
462
462
|
/**
|
|
463
|
-
*
|
|
463
|
+
* Revoke a share token
|
|
464
464
|
*
|
|
465
465
|
* Revoke a basic share token and cascade to its embed tokens; no quota controls (admin only).
|
|
466
466
|
*/
|
|
@@ -478,7 +478,7 @@ export const adminRevokeShareTokenAdminShareTokensTokenIdDelete = (options) => (
|
|
|
478
478
|
...options
|
|
479
479
|
});
|
|
480
480
|
/**
|
|
481
|
-
* Get
|
|
481
|
+
* Get catalog statistics
|
|
482
482
|
*
|
|
483
483
|
* Return catalog statistics: counts, storage, breakdowns (admin only).
|
|
484
484
|
*/
|
|
@@ -496,7 +496,7 @@ export const getCatalogStatsAdminStatsGet = (options) => (options?.client ?? cli
|
|
|
496
496
|
...options
|
|
497
497
|
});
|
|
498
498
|
/**
|
|
499
|
-
* List
|
|
499
|
+
* List users
|
|
500
500
|
*
|
|
501
501
|
* List users with optional status, role, search, and sort filters (admin only).
|
|
502
502
|
*
|
|
@@ -517,7 +517,7 @@ export const listUsersAdminUsersGet = (options) => (options?.client ?? client).g
|
|
|
517
517
|
...options
|
|
518
518
|
});
|
|
519
519
|
/**
|
|
520
|
-
* Create
|
|
520
|
+
* Create a user
|
|
521
521
|
*
|
|
522
522
|
* Create a new user with the specified role (admin only).
|
|
523
523
|
*/
|
|
@@ -561,7 +561,7 @@ export const exportUsersCsvAdminUsersExportCsvGet = (options) => (options?.clien
|
|
|
561
561
|
...options
|
|
562
562
|
});
|
|
563
563
|
/**
|
|
564
|
-
* List
|
|
564
|
+
* List usernames
|
|
565
565
|
*
|
|
566
566
|
* Return lightweight id+username list for filter dropdowns.
|
|
567
567
|
*
|
|
@@ -584,7 +584,7 @@ export const listUserNamesAdminUsersNamesGet = (options) => (options?.client ??
|
|
|
584
584
|
...options
|
|
585
585
|
});
|
|
586
586
|
/**
|
|
587
|
-
* Delete
|
|
587
|
+
* Delete a user
|
|
588
588
|
*
|
|
589
589
|
* Hard-delete a user (admin only). Returns 400 for self-deletion or last-admin.
|
|
590
590
|
*/
|
|
@@ -602,7 +602,7 @@ export const deleteUserAdminUsersUserIdDelete = (options) => (options.client ??
|
|
|
602
602
|
...options
|
|
603
603
|
});
|
|
604
604
|
/**
|
|
605
|
-
* Get
|
|
605
|
+
* Get a user
|
|
606
606
|
*
|
|
607
607
|
* Get a specific user by ID (admin only).
|
|
608
608
|
*/
|
|
@@ -620,7 +620,7 @@ export const getUserAdminUsersUserIdGet = (options) => (options.client ?? client
|
|
|
620
620
|
...options
|
|
621
621
|
});
|
|
622
622
|
/**
|
|
623
|
-
* Update
|
|
623
|
+
* Update a user
|
|
624
624
|
*
|
|
625
625
|
* Update a user's fields and/or role (admin only).
|
|
626
626
|
*/
|
|
@@ -642,7 +642,7 @@ export const updateUserAdminUsersUserIdPatch = (options) => (options.client ?? c
|
|
|
642
642
|
}
|
|
643
643
|
});
|
|
644
644
|
/**
|
|
645
|
-
* Approve
|
|
645
|
+
* Approve a pending user
|
|
646
646
|
*
|
|
647
647
|
* Approve a pending user with the specified role (admin only).
|
|
648
648
|
*/
|
|
@@ -664,7 +664,7 @@ export const approveUserAdminUsersUserIdApprovePost = (options) => (options.clie
|
|
|
664
664
|
}
|
|
665
665
|
});
|
|
666
666
|
/**
|
|
667
|
-
* Deactivate
|
|
667
|
+
* Deactivate a user
|
|
668
668
|
*
|
|
669
669
|
* Deactivate a user (admin only).
|
|
670
670
|
*/
|
|
@@ -682,7 +682,7 @@ export const deactivateUserAdminUsersUserIdDeactivatePost = (options) => (option
|
|
|
682
682
|
...options
|
|
683
683
|
});
|
|
684
684
|
/**
|
|
685
|
-
* Reject
|
|
685
|
+
* Reject a pending user
|
|
686
686
|
*
|
|
687
687
|
* Reject a pending user by hard-deleting them (admin only).
|
|
688
688
|
*/
|
|
@@ -700,7 +700,7 @@ export const rejectUserAdminUsersUserIdRejectPost = (options) => (options.client
|
|
|
700
700
|
...options
|
|
701
701
|
});
|
|
702
702
|
/**
|
|
703
|
-
* Reset
|
|
703
|
+
* Reset a user's password
|
|
704
704
|
*
|
|
705
705
|
* Set a user's password (admin only).
|
|
706
706
|
*
|
|
@@ -733,7 +733,7 @@ export const resetUserPasswordAdminUsersUserIdResetPasswordPost = (options) => (
|
|
|
733
733
|
}
|
|
734
734
|
});
|
|
735
735
|
/**
|
|
736
|
-
*
|
|
736
|
+
* Check whether AI chat is available
|
|
737
737
|
*
|
|
738
738
|
* Report whether builder AI chat is usable.
|
|
739
739
|
*
|
|
@@ -754,7 +754,7 @@ export const aiAvailabilityEndpointAiAvailabilityGet = (options) => (options?.cl
|
|
|
754
754
|
...options
|
|
755
755
|
});
|
|
756
756
|
/**
|
|
757
|
-
*
|
|
757
|
+
* Edit a map with AI chat
|
|
758
758
|
*
|
|
759
759
|
* Chat-based map editing: send a message and get back edit actions.
|
|
760
760
|
*/
|
|
@@ -776,7 +776,7 @@ export const chatEndpointAiChatPost = (options) => (options.client ?? client).po
|
|
|
776
776
|
}
|
|
777
777
|
});
|
|
778
778
|
/**
|
|
779
|
-
*
|
|
779
|
+
* Ask AI about a dataset
|
|
780
780
|
*
|
|
781
781
|
* Dataset-scoped AI chat: ask questions about a single dataset's data.
|
|
782
782
|
*
|
|
@@ -804,7 +804,7 @@ export const datasetChatStreamEndpointAiChatDatasetStreamPost = (options) => (op
|
|
|
804
804
|
}
|
|
805
805
|
});
|
|
806
806
|
/**
|
|
807
|
-
*
|
|
807
|
+
* Edit a map with AI chat as a stream
|
|
808
808
|
*
|
|
809
809
|
* Chat-based map editing with server-sent event streaming.
|
|
810
810
|
*/
|
|
@@ -826,7 +826,7 @@ export const chatStreamEndpointAiChatStreamPost = (options) => (options.client ?
|
|
|
826
826
|
}
|
|
827
827
|
});
|
|
828
828
|
/**
|
|
829
|
-
* Generate
|
|
829
|
+
* Generate a map from a prompt
|
|
830
830
|
*
|
|
831
831
|
* Generate a map from a natural language prompt using an LLM.
|
|
832
832
|
*/
|
|
@@ -848,7 +848,7 @@ export const generateMapEndpointAiGenerateMapPost = (options) => (options.client
|
|
|
848
848
|
}
|
|
849
849
|
});
|
|
850
850
|
/**
|
|
851
|
-
* Generate
|
|
851
|
+
* Generate a map from a prompt as a stream
|
|
852
852
|
*
|
|
853
853
|
* Generate a map from a natural language prompt with streaming progress events.
|
|
854
854
|
*/
|
|
@@ -870,7 +870,7 @@ export const generateMapStreamEndpointAiGenerateMapStreamPost = (options) => (op
|
|
|
870
870
|
}
|
|
871
871
|
});
|
|
872
872
|
/**
|
|
873
|
-
*
|
|
873
|
+
* Suggest dataset keywords with AI
|
|
874
874
|
*
|
|
875
875
|
* Generate AI-suggested keywords for a dataset.
|
|
876
876
|
*/
|
|
@@ -892,7 +892,7 @@ export const generateMetadataKeywordsAiMetadataKeywordsPost = (options) => (opti
|
|
|
892
892
|
}
|
|
893
893
|
});
|
|
894
894
|
/**
|
|
895
|
-
*
|
|
895
|
+
* Draft dataset lineage with AI
|
|
896
896
|
*
|
|
897
897
|
* Generate an AI-drafted lineage summary for a dataset.
|
|
898
898
|
*/
|
|
@@ -914,7 +914,7 @@ export const generateMetadataLineageAiMetadataLineagePost = (options) => (option
|
|
|
914
914
|
}
|
|
915
915
|
});
|
|
916
916
|
/**
|
|
917
|
-
*
|
|
917
|
+
* Draft a dataset quality statement with AI
|
|
918
918
|
*
|
|
919
919
|
* Generate an AI-drafted quality statement for a dataset.
|
|
920
920
|
*/
|
|
@@ -936,7 +936,7 @@ export const generateMetadataQualityStatementAiMetadataQualityStatementPost = (o
|
|
|
936
936
|
}
|
|
937
937
|
});
|
|
938
938
|
/**
|
|
939
|
-
*
|
|
939
|
+
* Draft a dataset summary with AI
|
|
940
940
|
*
|
|
941
941
|
* Generate an AI-drafted summary for a dataset.
|
|
942
942
|
*/
|
|
@@ -958,7 +958,7 @@ export const generateMetadataSummaryAiMetadataSummaryPost = (options) => (option
|
|
|
958
958
|
}
|
|
959
959
|
});
|
|
960
960
|
/**
|
|
961
|
-
*
|
|
961
|
+
* List a dataset's column change history
|
|
962
962
|
*
|
|
963
963
|
* Return the column-DDL audit history for a dataset.
|
|
964
964
|
*
|
|
@@ -987,7 +987,7 @@ export const getColumnDdlFeedAuditDatasetsDatasetIdColumnDdlGet = (options) => (
|
|
|
987
987
|
...options
|
|
988
988
|
});
|
|
989
989
|
/**
|
|
990
|
-
* List
|
|
990
|
+
* List your API keys
|
|
991
991
|
*
|
|
992
992
|
* List the current user's API keys.
|
|
993
993
|
*/
|
|
@@ -1005,7 +1005,7 @@ export const listMyApiKeysAuthApiKeysGet = (options) => (options?.client ?? clie
|
|
|
1005
1005
|
...options
|
|
1006
1006
|
});
|
|
1007
1007
|
/**
|
|
1008
|
-
* Create
|
|
1008
|
+
* Create an API key
|
|
1009
1009
|
*
|
|
1010
1010
|
* Create an API key for the current user.
|
|
1011
1011
|
*
|
|
@@ -1022,7 +1022,7 @@ export const createMyApiKeyAuthApiKeysPost = (options) => (options.client ?? cli
|
|
|
1022
1022
|
}
|
|
1023
1023
|
});
|
|
1024
1024
|
/**
|
|
1025
|
-
* Revoke
|
|
1025
|
+
* Revoke an API key
|
|
1026
1026
|
*
|
|
1027
1027
|
* Revoke (soft-delete) one of the current user's API keys.
|
|
1028
1028
|
*/
|
|
@@ -1040,7 +1040,7 @@ export const revokeMyApiKeyAuthApiKeysKeyIdDelete = (options) => (options.client
|
|
|
1040
1040
|
...options
|
|
1041
1041
|
});
|
|
1042
1042
|
/**
|
|
1043
|
-
* Change
|
|
1043
|
+
* Change your password
|
|
1044
1044
|
*
|
|
1045
1045
|
* Change the current user's password (requires current password).
|
|
1046
1046
|
*/
|
|
@@ -1062,13 +1062,13 @@ export const changePasswordAuthChangePasswordPost = (options) => (options.client
|
|
|
1062
1062
|
}
|
|
1063
1063
|
});
|
|
1064
1064
|
/**
|
|
1065
|
-
*
|
|
1065
|
+
* Get the public sign-in configuration
|
|
1066
1066
|
*
|
|
1067
1067
|
* Return public auth configuration (no authentication required).
|
|
1068
1068
|
*/
|
|
1069
1069
|
export const configAuthConfigGet = (options) => (options?.client ?? client).get({ url: '/auth/config/', ...options });
|
|
1070
1070
|
/**
|
|
1071
|
-
* Create
|
|
1071
|
+
* Create a download token for a dataset
|
|
1072
1072
|
*
|
|
1073
1073
|
* Mint a short-lived download-scoped JWT for a single dataset.
|
|
1074
1074
|
*
|
|
@@ -1094,7 +1094,7 @@ export const createDownloadTokenEndpointAuthDownloadTokenDatasetIdPost = (option
|
|
|
1094
1094
|
...options
|
|
1095
1095
|
});
|
|
1096
1096
|
/**
|
|
1097
|
-
*
|
|
1097
|
+
* Sign in with a username and password
|
|
1098
1098
|
*
|
|
1099
1099
|
* Authenticate with username and password, receive a JWT token.
|
|
1100
1100
|
*
|
|
@@ -1113,7 +1113,7 @@ export const loginAuthLoginPost = (options) => (options.client ?? client).post({
|
|
|
1113
1113
|
}
|
|
1114
1114
|
});
|
|
1115
1115
|
/**
|
|
1116
|
-
*
|
|
1116
|
+
* Sign out everywhere
|
|
1117
1117
|
*
|
|
1118
1118
|
* Revoke all refresh tokens and bump token_version for the current user.
|
|
1119
1119
|
*
|
|
@@ -1144,7 +1144,7 @@ export const logoutAuthLogoutPost = (options) => (options?.client ?? client).pos
|
|
|
1144
1144
|
}
|
|
1145
1145
|
});
|
|
1146
1146
|
/**
|
|
1147
|
-
*
|
|
1147
|
+
* Sign out of the current session
|
|
1148
1148
|
*
|
|
1149
1149
|
* Revoke only the presented session's refresh-token family.
|
|
1150
1150
|
*
|
|
@@ -1167,7 +1167,7 @@ export const logoutCurrentSessionAuthLogoutSessionPost = (options) => (options?.
|
|
|
1167
1167
|
}
|
|
1168
1168
|
});
|
|
1169
1169
|
/**
|
|
1170
|
-
*
|
|
1170
|
+
* Get the signed-in user
|
|
1171
1171
|
*
|
|
1172
1172
|
* Return the currently authenticated user's profile and roles.
|
|
1173
1173
|
*/
|
|
@@ -1185,7 +1185,7 @@ export const meAuthMeGet = (options) => (options?.client ?? client).get({
|
|
|
1185
1185
|
...options
|
|
1186
1186
|
});
|
|
1187
1187
|
/**
|
|
1188
|
-
*
|
|
1188
|
+
* Get the signed-in user's permissions
|
|
1189
1189
|
*
|
|
1190
1190
|
* Return the effective permissions for the currently authenticated user.
|
|
1191
1191
|
*/
|
|
@@ -1203,7 +1203,7 @@ export const mePermissionsAuthMePermissionsGet = (options) => (options?.client ?
|
|
|
1203
1203
|
...options
|
|
1204
1204
|
});
|
|
1205
1205
|
/**
|
|
1206
|
-
*
|
|
1206
|
+
* Get the signed-in user's quota usage
|
|
1207
1207
|
*
|
|
1208
1208
|
* Return the authenticated user's own storage and dataset quota usage.
|
|
1209
1209
|
*/
|
|
@@ -1221,7 +1221,7 @@ export const meUsageAuthMeUsageGet = (options) => (options?.client ?? client).ge
|
|
|
1221
1221
|
...options
|
|
1222
1222
|
});
|
|
1223
1223
|
/**
|
|
1224
|
-
* Exchange
|
|
1224
|
+
* Exchange a sign-in code for a session
|
|
1225
1225
|
*
|
|
1226
1226
|
* Exchange a single sign-on code for a browser session.
|
|
1227
1227
|
*
|
|
@@ -1244,13 +1244,13 @@ export const exchangeSignInCodeAuthOauthExchangePost = (options) => (options.cli
|
|
|
1244
1244
|
}
|
|
1245
1245
|
});
|
|
1246
1246
|
/**
|
|
1247
|
-
* List
|
|
1247
|
+
* List sign-in providers
|
|
1248
1248
|
*
|
|
1249
1249
|
* Return the list of enabled OAuth providers for the login page.
|
|
1250
1250
|
*/
|
|
1251
1251
|
export const listPublicProvidersAuthOauthProvidersGet = (options) => (options?.client ?? client).get({ url: '/auth/oauth/providers/', ...options });
|
|
1252
1252
|
/**
|
|
1253
|
-
*
|
|
1253
|
+
* Finish OAuth sign-in
|
|
1254
1254
|
*
|
|
1255
1255
|
* Handle IdP callback: exchange code, find/create user, redirect to frontend.
|
|
1256
1256
|
*
|
|
@@ -1262,7 +1262,7 @@ export const listPublicProvidersAuthOauthProvidersGet = (options) => (options?.c
|
|
|
1262
1262
|
*/
|
|
1263
1263
|
export const oauthCallbackAuthOauthProviderSlugCallbackGet = (options) => (options.client ?? client).get({ url: '/auth/oauth/{provider_slug}/callback', ...options });
|
|
1264
1264
|
/**
|
|
1265
|
-
*
|
|
1265
|
+
* Start OAuth sign-in
|
|
1266
1266
|
*
|
|
1267
1267
|
* Redirect user to the IdP authorization URL with PKCE parameters.
|
|
1268
1268
|
*
|
|
@@ -1274,7 +1274,7 @@ export const oauthCallbackAuthOauthProviderSlugCallbackGet = (options) => (optio
|
|
|
1274
1274
|
*/
|
|
1275
1275
|
export const oauthLoginAuthOauthProviderSlugLoginGet = (options) => (options.client ?? client).get({ url: '/auth/oauth/{provider_slug}/login', ...options });
|
|
1276
1276
|
/**
|
|
1277
|
-
* Refresh
|
|
1277
|
+
* Refresh the access token
|
|
1278
1278
|
*
|
|
1279
1279
|
* Exchange a valid refresh token for a new access + refresh token pair.
|
|
1280
1280
|
*
|
|
@@ -1300,7 +1300,7 @@ export const refreshAuthRefreshPost = (options) => (options?.client ?? client).p
|
|
|
1300
1300
|
}
|
|
1301
1301
|
});
|
|
1302
1302
|
/**
|
|
1303
|
-
* Register
|
|
1303
|
+
* Register an account
|
|
1304
1304
|
*
|
|
1305
1305
|
* Create a password account.
|
|
1306
1306
|
*
|
|
@@ -1323,10 +1323,13 @@ export const registerAuthRegisterPost = (options) => (options.client ?? client).
|
|
|
1323
1323
|
}
|
|
1324
1324
|
});
|
|
1325
1325
|
/**
|
|
1326
|
-
* Resend
|
|
1326
|
+
* Resend the verification email
|
|
1327
1327
|
*
|
|
1328
1328
|
* Re-issue and re-send a verification email.
|
|
1329
1329
|
*
|
|
1330
|
+
* Sends nothing unless self-registration is on and requires email
|
|
1331
|
+
* verification, since only then can the link activate an account.
|
|
1332
|
+
*
|
|
1330
1333
|
* Enumeration-safe: ALWAYS returns the same 200 body
|
|
1331
1334
|
* regardless of whether the email exists, is unknown, or is already verified.
|
|
1332
1335
|
* Send errors are logged server-side only and never branch the HTTP response.
|
|
@@ -1340,13 +1343,15 @@ export const resendVerificationAuthResendVerificationPost = (options) => (option
|
|
|
1340
1343
|
}
|
|
1341
1344
|
});
|
|
1342
1345
|
/**
|
|
1343
|
-
* Verify
|
|
1346
|
+
* Verify an email address
|
|
1344
1347
|
*
|
|
1345
|
-
* Redeem a verification token
|
|
1348
|
+
* Redeem a verification token, confirming the address.
|
|
1346
1349
|
*
|
|
1347
|
-
* A valid single-use expiring token
|
|
1348
|
-
*
|
|
1349
|
-
*
|
|
1350
|
+
* A valid single-use expiring token sets email_verified=True. While
|
|
1351
|
+
* self-registration is on and requires email verification, it also
|
|
1352
|
+
* activates a pending account with the default self-registration role.
|
|
1353
|
+
* Otherwise a pending account stays pending and the response carries
|
|
1354
|
+
* ``next_step="await_approval"``.
|
|
1350
1355
|
*
|
|
1351
1356
|
* Expired, unknown, and already-consumed tokens all return the same
|
|
1352
1357
|
* "Invalid or expired" error (enumeration-safe).
|
|
@@ -1360,7 +1365,7 @@ export const verifyEmailAuthVerifyEmailPost = (options) => (options.client ?? cl
|
|
|
1360
1365
|
}
|
|
1361
1366
|
});
|
|
1362
1367
|
/**
|
|
1363
|
-
* Get
|
|
1368
|
+
* Get server capabilities
|
|
1364
1369
|
*
|
|
1365
1370
|
* Describe what this server offers, for a client's first call.
|
|
1366
1371
|
*
|
|
@@ -1381,7 +1386,7 @@ export const getCapabilitiesCapabilitiesGet = (options) => (options?.client ?? c
|
|
|
1381
1386
|
...options
|
|
1382
1387
|
});
|
|
1383
1388
|
/**
|
|
1384
|
-
* List
|
|
1389
|
+
* List collections
|
|
1385
1390
|
*
|
|
1386
1391
|
* List all collections with dataset_count and extent computed per-user.
|
|
1387
1392
|
*/
|
|
@@ -1399,7 +1404,7 @@ export const listCollectionsEndpointCatalogCollectionsGet = (options) => (option
|
|
|
1399
1404
|
...options
|
|
1400
1405
|
});
|
|
1401
1406
|
/**
|
|
1402
|
-
* Create
|
|
1407
|
+
* Create a collection
|
|
1403
1408
|
*
|
|
1404
1409
|
* Create a new collection.
|
|
1405
1410
|
*/
|
|
@@ -1421,7 +1426,7 @@ export const createCollectionEndpointCatalogCollectionsPost = (options) => (opti
|
|
|
1421
1426
|
}
|
|
1422
1427
|
});
|
|
1423
1428
|
/**
|
|
1424
|
-
* Delete
|
|
1429
|
+
* Delete a collection
|
|
1425
1430
|
*
|
|
1426
1431
|
* Delete a collection. Owner or admin only.
|
|
1427
1432
|
*/
|
|
@@ -1439,7 +1444,7 @@ export const deleteCollectionEndpointCatalogCollectionsCollectionIdDelete = (opt
|
|
|
1439
1444
|
...options
|
|
1440
1445
|
});
|
|
1441
1446
|
/**
|
|
1442
|
-
* Get
|
|
1447
|
+
* Get a collection
|
|
1443
1448
|
*
|
|
1444
1449
|
* Get a single collection with dataset_count and extent.
|
|
1445
1450
|
*/
|
|
@@ -1457,7 +1462,7 @@ export const getCollectionEndpointCatalogCollectionsCollectionIdGet = (options)
|
|
|
1457
1462
|
...options
|
|
1458
1463
|
});
|
|
1459
1464
|
/**
|
|
1460
|
-
* Update
|
|
1465
|
+
* Update a collection
|
|
1461
1466
|
*
|
|
1462
1467
|
* Update a collection's name and/or description. Owner or admin only.
|
|
1463
1468
|
*/
|
|
@@ -1479,7 +1484,7 @@ export const updateCollectionEndpointCatalogCollectionsCollectionIdPatch = (opti
|
|
|
1479
1484
|
}
|
|
1480
1485
|
});
|
|
1481
1486
|
/**
|
|
1482
|
-
*
|
|
1487
|
+
* List a collection's datasets
|
|
1483
1488
|
*
|
|
1484
1489
|
* Get datasets in a collection with RBAC filtering.
|
|
1485
1490
|
*/
|
|
@@ -1497,7 +1502,7 @@ export const getCollectionDatasetsEndpointCatalogCollectionsCollectionIdDatasets
|
|
|
1497
1502
|
...options
|
|
1498
1503
|
});
|
|
1499
1504
|
/**
|
|
1500
|
-
* Add
|
|
1505
|
+
* Add datasets to a collection
|
|
1501
1506
|
*
|
|
1502
1507
|
* Add datasets to a collection. Collection owner or admin only.
|
|
1503
1508
|
*/
|
|
@@ -1519,7 +1524,7 @@ export const addDatasetsEndpointCatalogCollectionsCollectionIdDatasetsPost = (op
|
|
|
1519
1524
|
}
|
|
1520
1525
|
});
|
|
1521
1526
|
/**
|
|
1522
|
-
* Remove
|
|
1527
|
+
* Remove a dataset from a collection
|
|
1523
1528
|
*
|
|
1524
1529
|
* Remove a dataset from a collection. Collection owner or admin only.
|
|
1525
1530
|
*/
|
|
@@ -1537,7 +1542,7 @@ export const removeDatasetEndpointCatalogCollectionsCollectionIdDatasetsDatasetI
|
|
|
1537
1542
|
...options
|
|
1538
1543
|
});
|
|
1539
1544
|
/**
|
|
1540
|
-
* List
|
|
1545
|
+
* List OGC collections
|
|
1541
1546
|
*
|
|
1542
1547
|
* List available OGC collections (catalog + per-dataset feature collections).
|
|
1543
1548
|
*/
|
|
@@ -1555,7 +1560,7 @@ export const listCollectionsCollectionsGet = (options) => (options?.client ?? cl
|
|
|
1555
1560
|
...options
|
|
1556
1561
|
});
|
|
1557
1562
|
/**
|
|
1558
|
-
* Get
|
|
1563
|
+
* Get the datasets collection
|
|
1559
1564
|
*
|
|
1560
1565
|
* Get metadata for the datasets collection.
|
|
1561
1566
|
*/
|
|
@@ -1573,7 +1578,7 @@ export const getCollectionMetadataCollectionsDatasetsGet = (options) => (options
|
|
|
1573
1578
|
...options
|
|
1574
1579
|
});
|
|
1575
1580
|
/**
|
|
1576
|
-
*
|
|
1581
|
+
* List catalog records
|
|
1577
1582
|
*
|
|
1578
1583
|
* OGC API Records items endpoint -- mirrors /search/datasets.
|
|
1579
1584
|
*/
|
|
@@ -1596,7 +1601,7 @@ export const collectionItemsCollectionsDatasetsItemsGet = (options) => (options?
|
|
|
1596
1601
|
...options
|
|
1597
1602
|
});
|
|
1598
1603
|
/**
|
|
1599
|
-
* Get
|
|
1604
|
+
* Get a catalog record
|
|
1600
1605
|
*
|
|
1601
1606
|
* Get a single dataset as an OGC Record Feature.
|
|
1602
1607
|
*/
|
|
@@ -1614,25 +1619,25 @@ export const getCollectionItemCollectionsDatasetsItemsRecordIdGet = (options) =>
|
|
|
1614
1619
|
...options
|
|
1615
1620
|
});
|
|
1616
1621
|
/**
|
|
1617
|
-
* Get
|
|
1622
|
+
* Get the datasets collection queryables
|
|
1618
1623
|
*
|
|
1619
1624
|
* Queryable properties for the datasets collection (OGC API Features Part 3).
|
|
1620
1625
|
*/
|
|
1621
1626
|
export const getQueryablesCollectionsDatasetsQueryablesGet = (options) => (options?.client ?? client).get({ url: '/collections/datasets/queryables', ...options });
|
|
1622
1627
|
/**
|
|
1623
|
-
* Get
|
|
1628
|
+
* Get the catalog record schema
|
|
1624
1629
|
*
|
|
1625
1630
|
* JSON Schema describing a catalog record (OGC API Common Part 3).
|
|
1626
1631
|
*/
|
|
1627
1632
|
export const getRecordSchemaCollectionsDatasetsSchemaGet = (options) => (options?.client ?? client).get({ url: '/collections/datasets/schema', ...options });
|
|
1628
1633
|
/**
|
|
1629
|
-
* Get
|
|
1634
|
+
* Get the datasets collection sortables
|
|
1630
1635
|
*
|
|
1631
1636
|
* Sortable properties for the datasets collection (OGC API Records).
|
|
1632
1637
|
*/
|
|
1633
1638
|
export const getSortablesCollectionsDatasetsSortablesGet = (options) => (options?.client ?? client).get({ url: '/collections/datasets/sortables', ...options });
|
|
1634
1639
|
/**
|
|
1635
|
-
* Get
|
|
1640
|
+
* Get a dataset's OGC feature collection
|
|
1636
1641
|
*
|
|
1637
1642
|
* Per-dataset OGC collection metadata with extent, CRS, and items link.
|
|
1638
1643
|
*/
|
|
@@ -1650,7 +1655,7 @@ export const getDatasetCollectionCollectionsDatasetIdGet = (options) => (options
|
|
|
1650
1655
|
...options
|
|
1651
1656
|
});
|
|
1652
1657
|
/**
|
|
1653
|
-
*
|
|
1658
|
+
* List OGC features
|
|
1654
1659
|
*
|
|
1655
1660
|
* OGC API Features items endpoint -- returns GeoJSON FeatureCollection for a dataset.
|
|
1656
1661
|
*
|
|
@@ -1674,7 +1679,7 @@ export const getCollectionItemsCollectionsDatasetIdItemsGet = (options) => (opti
|
|
|
1674
1679
|
...options
|
|
1675
1680
|
});
|
|
1676
1681
|
/**
|
|
1677
|
-
* Get
|
|
1682
|
+
* Get an OGC feature
|
|
1678
1683
|
*
|
|
1679
1684
|
* OGC API Features single feature endpoint -- returns a GeoJSON Feature.
|
|
1680
1685
|
*/
|
|
@@ -1692,7 +1697,7 @@ export const getCollectionItemFeatureCollectionsDatasetIdItemsFeatureIdGet = (op
|
|
|
1692
1697
|
...options
|
|
1693
1698
|
});
|
|
1694
1699
|
/**
|
|
1695
|
-
* Get
|
|
1700
|
+
* Get a feature collection's queryables
|
|
1696
1701
|
*
|
|
1697
1702
|
* Queryable properties for one feature collection (OGC Features Part 3).
|
|
1698
1703
|
*
|
|
@@ -1715,7 +1720,7 @@ export const getCollectionQueryablesCollectionsDatasetIdQueryablesGet = (options
|
|
|
1715
1720
|
...options
|
|
1716
1721
|
});
|
|
1717
1722
|
/**
|
|
1718
|
-
*
|
|
1723
|
+
* Preview a configuration import
|
|
1719
1724
|
*
|
|
1720
1725
|
* Preview what an import would change without applying any modifications.
|
|
1721
1726
|
*/
|
|
@@ -1737,7 +1742,7 @@ export const dryRunConfigurationConfigOpsDryRunPost = (options) => (options.clie
|
|
|
1737
1742
|
}
|
|
1738
1743
|
});
|
|
1739
1744
|
/**
|
|
1740
|
-
* Export
|
|
1745
|
+
* Export the configuration
|
|
1741
1746
|
*
|
|
1742
1747
|
* Export full configuration as JSON (settings + OAuth providers, secrets redacted).
|
|
1743
1748
|
*
|
|
@@ -1761,7 +1766,7 @@ export const exportConfigurationConfigOpsExportGet = (options) => (options?.clie
|
|
|
1761
1766
|
...options
|
|
1762
1767
|
});
|
|
1763
1768
|
/**
|
|
1764
|
-
* Import
|
|
1769
|
+
* Import a configuration
|
|
1765
1770
|
*
|
|
1766
1771
|
* Import configuration in merge or overwrite mode.
|
|
1767
1772
|
*
|
|
@@ -1786,7 +1791,7 @@ export const importConfigurationConfigOpsImportPost = (options) => (options.clie
|
|
|
1786
1791
|
}
|
|
1787
1792
|
});
|
|
1788
1793
|
/**
|
|
1789
|
-
* Validate
|
|
1794
|
+
* Validate the configuration
|
|
1790
1795
|
*
|
|
1791
1796
|
* Validate storage, cache, credential handoff, and enabled OIDC providers.
|
|
1792
1797
|
*
|
|
@@ -1806,13 +1811,13 @@ export const validateConfigurationConfigOpsValidatePost = (options) => (options?
|
|
|
1806
1811
|
...options
|
|
1807
1812
|
});
|
|
1808
1813
|
/**
|
|
1809
|
-
*
|
|
1814
|
+
* Get the OGC conformance declaration
|
|
1810
1815
|
*
|
|
1811
1816
|
* OGC conformance declaration -- lists supported specification classes.
|
|
1812
1817
|
*/
|
|
1813
1818
|
export const conformanceConformanceGet = (options) => (options?.client ?? client).get({ url: '/conformance', ...options });
|
|
1814
1819
|
/**
|
|
1815
|
-
* List
|
|
1820
|
+
* List datasets
|
|
1816
1821
|
*
|
|
1817
1822
|
* List datasets with visibility filtering and pagination.
|
|
1818
1823
|
*/
|
|
@@ -1830,7 +1835,7 @@ export const listAllDatasetsDatasetsGet = (options) => (options?.client ?? clien
|
|
|
1830
1835
|
...options
|
|
1831
1836
|
});
|
|
1832
1837
|
/**
|
|
1833
|
-
*
|
|
1838
|
+
* Delete several datasets
|
|
1834
1839
|
*
|
|
1835
1840
|
* Delete multiple datasets in one request. Returns per-item results.
|
|
1836
1841
|
*/
|
|
@@ -1852,7 +1857,7 @@ export const bulkDeleteDatasetsEndpointDatasetsBulkDeletePost = (options) => (op
|
|
|
1852
1857
|
}
|
|
1853
1858
|
});
|
|
1854
1859
|
/**
|
|
1855
|
-
* Create
|
|
1860
|
+
* Create an empty dataset
|
|
1856
1861
|
*
|
|
1857
1862
|
* Create an empty dataset with user-defined columns.
|
|
1858
1863
|
*
|
|
@@ -1876,7 +1881,7 @@ export const createEmptyDatasetEndpointDatasetsCreatePost = (options) => (option
|
|
|
1876
1881
|
}
|
|
1877
1882
|
});
|
|
1878
1883
|
/**
|
|
1879
|
-
* Get
|
|
1884
|
+
* Get the DCAT-US 3 catalog
|
|
1880
1885
|
*
|
|
1881
1886
|
* DCAT-US Schema v3.0 catalog feed. Respects dataset visibility.
|
|
1882
1887
|
*/
|
|
@@ -1894,7 +1899,7 @@ export const getDcatUs3CatalogDatasetsDcatUs30Get = (options) => (options?.clien
|
|
|
1894
1899
|
...options
|
|
1895
1900
|
});
|
|
1896
1901
|
/**
|
|
1897
|
-
* Validate
|
|
1902
|
+
* Validate the DCAT-US 3 catalog
|
|
1898
1903
|
*
|
|
1899
1904
|
* Validate the visible DCAT-US Schema v3.0 catalog feed.
|
|
1900
1905
|
*/
|
|
@@ -1912,7 +1917,7 @@ export const validateDcatUs3CatalogDatasetsDcatUs30ValidationGet = (options) =>
|
|
|
1912
1917
|
...options
|
|
1913
1918
|
});
|
|
1914
1919
|
/**
|
|
1915
|
-
* Get
|
|
1920
|
+
* Get the DCAT 3 catalog
|
|
1916
1921
|
*
|
|
1917
1922
|
* DCAT 3 JSON-LD catalog feed. Respects dataset visibility.
|
|
1918
1923
|
*/
|
|
@@ -1930,7 +1935,7 @@ export const getDcatCatalogDatasetsDcatGet = (options) => (options?.client ?? cl
|
|
|
1930
1935
|
...options
|
|
1931
1936
|
});
|
|
1932
1937
|
/**
|
|
1933
|
-
* Validate
|
|
1938
|
+
* Validate the DCAT 3 catalog
|
|
1934
1939
|
*
|
|
1935
1940
|
* Validate the visible W3C DCAT 3 catalog feed.
|
|
1936
1941
|
*/
|
|
@@ -1948,7 +1953,7 @@ export const validateDcat3CatalogDatasetsDcatValidationGet = (options) => (optio
|
|
|
1948
1953
|
...options
|
|
1949
1954
|
});
|
|
1950
1955
|
/**
|
|
1951
|
-
* Get
|
|
1956
|
+
* Get the GeoDCAT-AP catalog
|
|
1952
1957
|
*
|
|
1953
1958
|
* GeoDCAT-AP 2.0.0 catalog feed. Respects dataset visibility.
|
|
1954
1959
|
*/
|
|
@@ -1966,7 +1971,7 @@ export const getGeodcatApCatalogDatasetsGeodcatApGet = (options) => (options?.cl
|
|
|
1966
1971
|
...options
|
|
1967
1972
|
});
|
|
1968
1973
|
/**
|
|
1969
|
-
* Validate
|
|
1974
|
+
* Validate the GeoDCAT-AP catalog
|
|
1970
1975
|
*
|
|
1971
1976
|
* Validate the visible GeoDCAT-AP 2.0.0 catalog feed.
|
|
1972
1977
|
*/
|
|
@@ -1984,7 +1989,7 @@ export const validateGeodcatApCatalogDatasetsGeodcatApValidationGet = (options)
|
|
|
1984
1989
|
...options
|
|
1985
1990
|
});
|
|
1986
1991
|
/**
|
|
1987
|
-
* Delete
|
|
1992
|
+
* Delete a dataset relationship
|
|
1988
1993
|
*
|
|
1989
1994
|
* Delete a FK relationship. Editor+ required.
|
|
1990
1995
|
*/
|
|
@@ -2002,7 +2007,7 @@ export const deleteDatasetRelationshipDatasetsRelationshipsRelationshipIdDelete
|
|
|
2002
2007
|
...options
|
|
2003
2008
|
});
|
|
2004
2009
|
/**
|
|
2005
|
-
* Delete
|
|
2010
|
+
* Delete a dataset
|
|
2006
2011
|
*
|
|
2007
2012
|
* Delete a dataset with cascade cleanup. Owner or admin only, requires confirm_title.
|
|
2008
2013
|
*/
|
|
@@ -2024,7 +2029,7 @@ export const deleteDatasetEndpointDatasetsDatasetIdDelete = (options) => (option
|
|
|
2024
2029
|
}
|
|
2025
2030
|
});
|
|
2026
2031
|
/**
|
|
2027
|
-
* Get
|
|
2032
|
+
* Get a dataset
|
|
2028
2033
|
*
|
|
2029
2034
|
* Get a single dataset by ID with visibility check.
|
|
2030
2035
|
*/
|
|
@@ -2042,7 +2047,7 @@ export const getSingleDatasetDatasetsDatasetIdGet = (options) => (options.client
|
|
|
2042
2047
|
...options
|
|
2043
2048
|
});
|
|
2044
2049
|
/**
|
|
2045
|
-
* Update
|
|
2050
|
+
* Update dataset metadata
|
|
2046
2051
|
*
|
|
2047
2052
|
* Update user-editable dataset metadata.
|
|
2048
2053
|
*/
|
|
@@ -2064,7 +2069,7 @@ export const updateDatasetMetadataDatasetsDatasetIdPatch = (options) => (options
|
|
|
2064
2069
|
}
|
|
2065
2070
|
});
|
|
2066
2071
|
/**
|
|
2067
|
-
*
|
|
2072
|
+
* Compute a dataset aggregate
|
|
2068
2073
|
*
|
|
2069
2074
|
* Compute one exact aggregate over a dataset's rows, for a widget.
|
|
2070
2075
|
*
|
|
@@ -2077,13 +2082,17 @@ export const updateDatasetMetadataDatasetsDatasetIdPatch = (options) => (options
|
|
|
2077
2082
|
* With ``bbox``, a view the planner expects to hold more than 500,000 rows
|
|
2078
2083
|
* is refused with 422 and the code ``too_wide`` rather than approximated. A
|
|
2079
2084
|
* ``bbox`` that contains the whole dataset is answered as the whole layer.
|
|
2085
|
+
* The ``rows`` operation lists features a page at a time, with each row's
|
|
2086
|
+
* ``bbox`` when the dataset has geometry, and never returns a geometry.
|
|
2080
2087
|
* Refusals carry a ``code`` in ``detail``: ``too_wide``, ``invalid_column``,
|
|
2081
|
-
* ``invalid_filter``, ``no_geometry``, ``query_timeout``,
|
|
2088
|
+
* ``invalid_cursor``, ``invalid_filter``, ``no_geometry``, ``query_timeout``,
|
|
2082
2089
|
* ``query_data_error``, ``result_too_large``, and with 429 ``query_busy``
|
|
2083
|
-
* (this caller already has two aggregates running) or ``query_at_capacity
|
|
2090
|
+
* (this caller already has two aggregates running) or ``query_at_capacity``,
|
|
2091
|
+
* and with 503 ``query_unavailable`` when the database could not serve the
|
|
2092
|
+
* query, for example under memory pressure.
|
|
2084
2093
|
*
|
|
2085
2094
|
* Clients should keep at most two requests in flight per caller and retry a
|
|
2086
|
-
* 429 after 200-400 ms with jitter
|
|
2095
|
+
* 429 after 200-400 ms with jitter, and a 503 after its ``Retry-After``.
|
|
2087
2096
|
*/
|
|
2088
2097
|
export const aggregateEndpointDatasetsDatasetIdAggregatePost = (options) => (options.client ?? client).post({
|
|
2089
2098
|
security: [
|
|
@@ -2103,7 +2112,7 @@ export const aggregateEndpointDatasetsDatasetIdAggregatePost = (options) => (opt
|
|
|
2103
2112
|
}
|
|
2104
2113
|
});
|
|
2105
2114
|
/**
|
|
2106
|
-
*
|
|
2115
|
+
* Save a spatial analysis as a dataset
|
|
2107
2116
|
*
|
|
2108
2117
|
* Materialize an analysis result as a new private dataset (async job).
|
|
2109
2118
|
*
|
|
@@ -2132,7 +2141,7 @@ export const analysisMaterializeEndpointDatasetsDatasetIdAnalysisMaterializePost
|
|
|
2132
2141
|
}
|
|
2133
2142
|
});
|
|
2134
2143
|
/**
|
|
2135
|
-
*
|
|
2144
|
+
* Preview a spatial analysis
|
|
2136
2145
|
*
|
|
2137
2146
|
* Run a parameterized PostGIS operation and return a GeoJSON preview.
|
|
2138
2147
|
*
|
|
@@ -2157,7 +2166,7 @@ export const analysisPreviewEndpointDatasetsDatasetIdAnalysisPreviewPost = (opti
|
|
|
2157
2166
|
}
|
|
2158
2167
|
});
|
|
2159
2168
|
/**
|
|
2160
|
-
* List
|
|
2169
|
+
* List a dataset's API keys
|
|
2161
2170
|
*
|
|
2162
2171
|
* List the active keys bound to this dataset, newest first.
|
|
2163
2172
|
*
|
|
@@ -2179,7 +2188,7 @@ export const listDatasetApiKeysDatasetsDatasetIdApiKeysGet = (options) => (optio
|
|
|
2179
2188
|
...options
|
|
2180
2189
|
});
|
|
2181
2190
|
/**
|
|
2182
|
-
* Create
|
|
2191
|
+
* Create a dataset API key
|
|
2183
2192
|
*
|
|
2184
2193
|
* Create a key that reaches only this dataset's features.
|
|
2185
2194
|
*
|
|
@@ -2207,7 +2216,7 @@ export const createDatasetApiKeyDatasetsDatasetIdApiKeysPost = (options) => (opt
|
|
|
2207
2216
|
}
|
|
2208
2217
|
});
|
|
2209
2218
|
/**
|
|
2210
|
-
* Revoke
|
|
2219
|
+
* Revoke a dataset API key
|
|
2211
2220
|
*
|
|
2212
2221
|
* Revoke a key bound to this dataset.
|
|
2213
2222
|
*
|
|
@@ -2230,7 +2239,7 @@ export const revokeDatasetApiKeyDatasetsDatasetIdApiKeysKeyIdDelete = (options)
|
|
|
2230
2239
|
...options
|
|
2231
2240
|
});
|
|
2232
2241
|
/**
|
|
2233
|
-
* List
|
|
2242
|
+
* List a dataset's attributes
|
|
2234
2243
|
*
|
|
2235
2244
|
* List all attribute metadata for a dataset.
|
|
2236
2245
|
*/
|
|
@@ -2248,7 +2257,7 @@ export const listAttributesEndpointDatasetsDatasetIdAttributesGet = (options) =>
|
|
|
2248
2257
|
...options
|
|
2249
2258
|
});
|
|
2250
2259
|
/**
|
|
2251
|
-
* Get
|
|
2260
|
+
* Get an attribute
|
|
2252
2261
|
*
|
|
2253
2262
|
* Get a single attribute metadata entry.
|
|
2254
2263
|
*/
|
|
@@ -2266,7 +2275,7 @@ export const getAttributeEndpointDatasetsDatasetIdAttributesAttributeIdGet = (op
|
|
|
2266
2275
|
...options
|
|
2267
2276
|
});
|
|
2268
2277
|
/**
|
|
2269
|
-
* Update
|
|
2278
|
+
* Update an attribute
|
|
2270
2279
|
*
|
|
2271
2280
|
* Update user-editable attribute metadata fields.
|
|
2272
2281
|
*/
|
|
@@ -2288,7 +2297,7 @@ export const updateAttributeEndpointDatasetsDatasetIdAttributesAttributeIdPatch
|
|
|
2288
2297
|
}
|
|
2289
2298
|
});
|
|
2290
2299
|
/**
|
|
2291
|
-
* Reset
|
|
2300
|
+
* Reset an attribute to its detected values
|
|
2292
2301
|
*
|
|
2293
2302
|
* Reset attribute metadata to auto-populated values, clearing user_modified_fields.
|
|
2294
2303
|
*/
|
|
@@ -2306,7 +2315,7 @@ export const resetAttributeEndpointDatasetsDatasetIdAttributesAttributeIdResetPo
|
|
|
2306
2315
|
...options
|
|
2307
2316
|
});
|
|
2308
2317
|
/**
|
|
2309
|
-
* Get
|
|
2318
|
+
* Get a numeric column's statistics
|
|
2310
2319
|
*
|
|
2311
2320
|
* Get statistics for a numeric dataset column (for graduated styling).
|
|
2312
2321
|
*/
|
|
@@ -2324,7 +2333,7 @@ export const getColumnStatsEndpointDatasetsDatasetIdColumnsColumnNameStatsGet =
|
|
|
2324
2333
|
...options
|
|
2325
2334
|
});
|
|
2326
2335
|
/**
|
|
2327
|
-
*
|
|
2336
|
+
* List a column's distinct values
|
|
2328
2337
|
*
|
|
2329
2338
|
* Get distinct values for a dataset column (for categorical styling).
|
|
2330
2339
|
*/
|
|
@@ -2342,7 +2351,7 @@ export const getColumnValuesDatasetsDatasetIdColumnsColumnNameValuesGet = (optio
|
|
|
2342
2351
|
...options
|
|
2343
2352
|
});
|
|
2344
2353
|
/**
|
|
2345
|
-
* Get
|
|
2354
|
+
* Get a COPC point cloud file
|
|
2346
2355
|
*
|
|
2347
2356
|
* Serve a published COPC point cloud's file, whole or by HTTP byte range.
|
|
2348
2357
|
*
|
|
@@ -2379,7 +2388,7 @@ export const getPointcloudFileDatasetsDatasetIdCopcAttemptIdNameCopcLazGet = (op
|
|
|
2379
2388
|
...options
|
|
2380
2389
|
});
|
|
2381
2390
|
/**
|
|
2382
|
-
* Get
|
|
2391
|
+
* Get a DCAT-US 3 record
|
|
2383
2392
|
*
|
|
2384
2393
|
* DCAT-US Schema v3.0 JSON-LD for a single dataset.
|
|
2385
2394
|
*/
|
|
@@ -2397,7 +2406,7 @@ export const getDcatUs3RecordDatasetsDatasetIdDcatUs30Get = (options) => (option
|
|
|
2397
2406
|
...options
|
|
2398
2407
|
});
|
|
2399
2408
|
/**
|
|
2400
|
-
* Validate
|
|
2409
|
+
* Validate a dataset as DCAT-US 3
|
|
2401
2410
|
*
|
|
2402
2411
|
* Validate a single dataset as DCAT-US Schema v3.0.
|
|
2403
2412
|
*/
|
|
@@ -2415,7 +2424,7 @@ export const validateDcatUs3RecordDatasetsDatasetIdDcatUs30ValidationGet = (opti
|
|
|
2415
2424
|
...options
|
|
2416
2425
|
});
|
|
2417
2426
|
/**
|
|
2418
|
-
* Get
|
|
2427
|
+
* Get a DCAT 3 record
|
|
2419
2428
|
*
|
|
2420
2429
|
* DCAT 3 JSON-LD for a single dataset.
|
|
2421
2430
|
*/
|
|
@@ -2433,7 +2442,7 @@ export const getDcatRecordDatasetsDatasetIdDcatGet = (options) => (options.clien
|
|
|
2433
2442
|
...options
|
|
2434
2443
|
});
|
|
2435
2444
|
/**
|
|
2436
|
-
* Validate
|
|
2445
|
+
* Validate a dataset as DCAT 3
|
|
2437
2446
|
*
|
|
2438
2447
|
* Validate a single dataset as W3C DCAT 3.
|
|
2439
2448
|
*/
|
|
@@ -2451,7 +2460,7 @@ export const validateDcat3RecordDatasetsDatasetIdDcatValidationGet = (options) =
|
|
|
2451
2460
|
...options
|
|
2452
2461
|
});
|
|
2453
2462
|
/**
|
|
2454
|
-
* Download
|
|
2463
|
+
* Download a raster as a Cloud-Optimized GeoTIFF
|
|
2455
2464
|
*
|
|
2456
2465
|
* Download the Cloud-Optimized GeoTIFF for a raster dataset.
|
|
2457
2466
|
*
|
|
@@ -2483,7 +2492,7 @@ export const downloadCogDatasetsDatasetIdDownloadCogGet = (options) => (options.
|
|
|
2483
2492
|
...options
|
|
2484
2493
|
});
|
|
2485
2494
|
/**
|
|
2486
|
-
* Export
|
|
2495
|
+
* Export a dataset
|
|
2487
2496
|
*
|
|
2488
2497
|
* Export a dataset as a downloadable file.
|
|
2489
2498
|
*
|
|
@@ -2506,7 +2515,7 @@ export const exportDatasetEndpointDatasetsDatasetIdExportGet = (options) => (opt
|
|
|
2506
2515
|
...options
|
|
2507
2516
|
});
|
|
2508
2517
|
/**
|
|
2509
|
-
* Get
|
|
2518
|
+
* Get features as GeoJSON with Z coordinates
|
|
2510
2519
|
*
|
|
2511
2520
|
* Return up to 5,000 features as RFC 7946 GeoJSON with Z coordinates.
|
|
2512
2521
|
*
|
|
@@ -2536,7 +2545,7 @@ export const getFeaturesGeojsonZEndpointDatasetsDatasetIdFeaturesGeojsonGet = (o
|
|
|
2536
2545
|
...options
|
|
2537
2546
|
});
|
|
2538
2547
|
/**
|
|
2539
|
-
* List
|
|
2548
|
+
* List features
|
|
2540
2549
|
*
|
|
2541
2550
|
* Get paginated GeoJSON features for a dataset.
|
|
2542
2551
|
*
|
|
@@ -2560,7 +2569,7 @@ export const listFeaturesDatasetsDatasetIdFeaturesGet = (options) => (options.cl
|
|
|
2560
2569
|
...options
|
|
2561
2570
|
});
|
|
2562
2571
|
/**
|
|
2563
|
-
* Create
|
|
2572
|
+
* Create a feature
|
|
2564
2573
|
*
|
|
2565
2574
|
* Insert a new GeoJSON feature into a dataset.
|
|
2566
2575
|
*
|
|
@@ -2618,7 +2627,7 @@ export const createFeatureDatasetsDatasetIdFeaturesPost = (options) => (options.
|
|
|
2618
2627
|
}
|
|
2619
2628
|
});
|
|
2620
2629
|
/**
|
|
2621
|
-
* Delete
|
|
2630
|
+
* Delete several features
|
|
2622
2631
|
*
|
|
2623
2632
|
* Delete up to 1,000 features by gid in one transaction (hard delete).
|
|
2624
2633
|
*
|
|
@@ -2646,7 +2655,7 @@ export const deleteFeaturesBatchDatasetsDatasetIdFeaturesDeletePost = (options)
|
|
|
2646
2655
|
}
|
|
2647
2656
|
});
|
|
2648
2657
|
/**
|
|
2649
|
-
*
|
|
2658
|
+
* Check a feature create without saving
|
|
2650
2659
|
*
|
|
2651
2660
|
* Check a feature create without writing it.
|
|
2652
2661
|
*
|
|
@@ -2684,7 +2693,7 @@ export const dryRunCreateFeatureDatasetsDatasetIdFeaturesDryRunPost = (options)
|
|
|
2684
2693
|
}
|
|
2685
2694
|
});
|
|
2686
2695
|
/**
|
|
2687
|
-
* Delete
|
|
2696
|
+
* Delete a feature
|
|
2688
2697
|
*
|
|
2689
2698
|
* Delete a feature by gid (hard delete).
|
|
2690
2699
|
*
|
|
@@ -2707,7 +2716,7 @@ export const deleteSingleFeatureDatasetsDatasetIdFeaturesGidDelete = (options) =
|
|
|
2707
2716
|
...options
|
|
2708
2717
|
});
|
|
2709
2718
|
/**
|
|
2710
|
-
* Get
|
|
2719
|
+
* Get a feature
|
|
2711
2720
|
*
|
|
2712
2721
|
* Get a single GeoJSON feature by gid.
|
|
2713
2722
|
*
|
|
@@ -2729,7 +2738,7 @@ export const getSingleFeatureDatasetsDatasetIdFeaturesGidGet = (options) => (opt
|
|
|
2729
2738
|
...options
|
|
2730
2739
|
});
|
|
2731
2740
|
/**
|
|
2732
|
-
*
|
|
2741
|
+
* Update a feature
|
|
2733
2742
|
*
|
|
2734
2743
|
* Partial update of a feature (PATCH semantics).
|
|
2735
2744
|
*/
|
|
@@ -2751,7 +2760,7 @@ export const patchSingleFeatureDatasetsDatasetIdFeaturesGidPatch = (options) =>
|
|
|
2751
2760
|
}
|
|
2752
2761
|
});
|
|
2753
2762
|
/**
|
|
2754
|
-
* Replace
|
|
2763
|
+
* Replace a feature
|
|
2755
2764
|
*
|
|
2756
2765
|
* Full replacement of a feature (PUT semantics).
|
|
2757
2766
|
*/
|
|
@@ -2773,7 +2782,7 @@ export const replaceSingleFeatureDatasetsDatasetIdFeaturesGidPut = (options) =>
|
|
|
2773
2782
|
}
|
|
2774
2783
|
});
|
|
2775
2784
|
/**
|
|
2776
|
-
*
|
|
2785
|
+
* List a feature's related records
|
|
2777
2786
|
*
|
|
2778
2787
|
* Get related records for a feature via FK relationship.
|
|
2779
2788
|
*/
|
|
@@ -2791,7 +2800,7 @@ export const getFeatureRelatedRecordsDatasetsDatasetIdFeaturesGidRelatedRelation
|
|
|
2791
2800
|
...options
|
|
2792
2801
|
});
|
|
2793
2802
|
/**
|
|
2794
|
-
* Get
|
|
2803
|
+
* Get a GeoDCAT-AP record
|
|
2795
2804
|
*
|
|
2796
2805
|
* GeoDCAT-AP 2.0.0 JSON-LD for a single dataset.
|
|
2797
2806
|
*/
|
|
@@ -2809,7 +2818,7 @@ export const getGeodcatApRecordDatasetsDatasetIdGeodcatApGet = (options) => (opt
|
|
|
2809
2818
|
...options
|
|
2810
2819
|
});
|
|
2811
2820
|
/**
|
|
2812
|
-
* Validate
|
|
2821
|
+
* Validate a dataset as GeoDCAT-AP
|
|
2813
2822
|
*
|
|
2814
2823
|
* Validate a single dataset as GeoDCAT-AP 2.0.0.
|
|
2815
2824
|
*/
|
|
@@ -2827,7 +2836,7 @@ export const validateGeodcatApRecordDatasetsDatasetIdGeodcatApValidationGet = (o
|
|
|
2827
2836
|
...options
|
|
2828
2837
|
});
|
|
2829
2838
|
/**
|
|
2830
|
-
* Set
|
|
2839
|
+
* Set the sharing groups for a dataset
|
|
2831
2840
|
*
|
|
2832
2841
|
* Share a dataset with exactly these sharing groups (owner or admin).
|
|
2833
2842
|
*
|
|
@@ -2856,7 +2865,7 @@ export const setDatasetGroupsEndpointDatasetsDatasetIdGroupsPut = (options) => (
|
|
|
2856
2865
|
}
|
|
2857
2866
|
});
|
|
2858
2867
|
/**
|
|
2859
|
-
*
|
|
2868
|
+
* List a dataset's audit history
|
|
2860
2869
|
*
|
|
2861
2870
|
* Get audit log history for a specific dataset.
|
|
2862
2871
|
*/
|
|
@@ -2874,7 +2883,7 @@ export const getDatasetHistoryDatasetsDatasetIdHistoryGet = (options) => (option
|
|
|
2874
2883
|
...options
|
|
2875
2884
|
});
|
|
2876
2885
|
/**
|
|
2877
|
-
*
|
|
2886
|
+
* List maps that use a dataset
|
|
2878
2887
|
*
|
|
2879
2888
|
* Return maps that contain this dataset, filtered by caller's RBAC visibility.
|
|
2880
2889
|
*/
|
|
@@ -2892,7 +2901,7 @@ export const datasetMapsDatasetsDatasetIdMapsGet = (options) => (options.client
|
|
|
2892
2901
|
...options
|
|
2893
2902
|
});
|
|
2894
2903
|
/**
|
|
2895
|
-
* Delete
|
|
2904
|
+
* Delete the previous version
|
|
2896
2905
|
*
|
|
2897
2906
|
* Delete the dataset's newest kept version, so it can no longer be restored.
|
|
2898
2907
|
*
|
|
@@ -2916,7 +2925,7 @@ export const deletePreviousVersionDatasetsDatasetIdPreviousVersionDelete = (opti
|
|
|
2916
2925
|
...options
|
|
2917
2926
|
});
|
|
2918
2927
|
/**
|
|
2919
|
-
* Restore
|
|
2928
|
+
* Restore the previous version
|
|
2920
2929
|
*
|
|
2921
2930
|
* Publish the dataset's newest kept version as its live data again.
|
|
2922
2931
|
*
|
|
@@ -2944,7 +2953,7 @@ export const restorePreviousVersionDatasetsDatasetIdPreviousVersionRestorePost =
|
|
|
2944
2953
|
}
|
|
2945
2954
|
});
|
|
2946
2955
|
/**
|
|
2947
|
-
* Delete
|
|
2956
|
+
* Delete a kept version
|
|
2948
2957
|
*
|
|
2949
2958
|
* Delete one of the dataset's kept previous versions, so it can no longer be restored.
|
|
2950
2959
|
*
|
|
@@ -2967,7 +2976,7 @@ export const deleteKeptVersionDatasetsDatasetIdPreviousVersionsVersionNumberDele
|
|
|
2967
2976
|
...options
|
|
2968
2977
|
});
|
|
2969
2978
|
/**
|
|
2970
|
-
* Restore
|
|
2979
|
+
* Restore a kept version
|
|
2971
2980
|
*
|
|
2972
2981
|
* Publish one of the dataset's kept previous versions as its live data again.
|
|
2973
2982
|
*
|
|
@@ -2997,7 +3006,7 @@ export const restoreKeptVersionDatasetsDatasetIdPreviousVersionsVersionNumberRes
|
|
|
2997
3006
|
...options
|
|
2998
3007
|
});
|
|
2999
3008
|
/**
|
|
3000
|
-
* Get
|
|
3009
|
+
* Get a dataset quicklook image
|
|
3001
3010
|
*
|
|
3002
3011
|
* Serve a quicklook PNG image for a dataset.
|
|
3003
3012
|
*/
|
|
@@ -3015,7 +3024,7 @@ export const getQuicklookDatasetsDatasetIdQuicklookGet = (options) => (options.c
|
|
|
3015
3024
|
...options
|
|
3016
3025
|
});
|
|
3017
3026
|
/**
|
|
3018
|
-
* Refresh
|
|
3027
|
+
* Refresh a dataset from its source
|
|
3019
3028
|
*
|
|
3020
3029
|
* Re-pull this dataset's data from the origin it was imported from.
|
|
3021
3030
|
*
|
|
@@ -3070,7 +3079,7 @@ export const refreshDatasetDatasetsDatasetIdRefreshPost = (options) => (options.
|
|
|
3070
3079
|
}
|
|
3071
3080
|
});
|
|
3072
3081
|
/**
|
|
3073
|
-
* List
|
|
3082
|
+
* List a dataset's refresh runs
|
|
3074
3083
|
*
|
|
3075
3084
|
* Return durable refresh history for a dataset.
|
|
3076
3085
|
*
|
|
@@ -3092,7 +3101,7 @@ export const listDatasetRefreshRunsDatasetsDatasetIdRefreshRunsGet = (options) =
|
|
|
3092
3101
|
...options
|
|
3093
3102
|
});
|
|
3094
3103
|
/**
|
|
3095
|
-
* List
|
|
3104
|
+
* List related datasets
|
|
3096
3105
|
*
|
|
3097
3106
|
* Return top-5 datasets similar to this one by embedding cosine similarity.
|
|
3098
3107
|
*/
|
|
@@ -3110,7 +3119,7 @@ export const listRelatedDatasetsDatasetsDatasetIdRelatedGet = (options) => (opti
|
|
|
3110
3119
|
...options
|
|
3111
3120
|
});
|
|
3112
3121
|
/**
|
|
3113
|
-
* List
|
|
3122
|
+
* List a dataset's relationships
|
|
3114
3123
|
*
|
|
3115
3124
|
* List FK relationships for a dataset.
|
|
3116
3125
|
*
|
|
@@ -3134,7 +3143,7 @@ export const listDatasetRelationshipsDatasetsDatasetIdRelationshipsGet = (option
|
|
|
3134
3143
|
...options
|
|
3135
3144
|
});
|
|
3136
3145
|
/**
|
|
3137
|
-
* Create
|
|
3146
|
+
* Create a dataset relationship
|
|
3138
3147
|
*
|
|
3139
3148
|
* Create a new FK relationship. Editor+ required.
|
|
3140
3149
|
*/
|
|
@@ -3156,7 +3165,7 @@ export const createDatasetRelationshipDatasetsDatasetIdRelationshipsPost = (opti
|
|
|
3156
3165
|
}
|
|
3157
3166
|
});
|
|
3158
3167
|
/**
|
|
3159
|
-
* Set
|
|
3168
|
+
* Set a dataset's row retention
|
|
3160
3169
|
*
|
|
3161
3170
|
* Set or clear how many days of rows a feature dataset keeps.
|
|
3162
3171
|
*
|
|
@@ -3185,7 +3194,7 @@ export const setDatasetRetentionDatasetsDatasetIdRetentionPut = (options) => (op
|
|
|
3185
3194
|
}
|
|
3186
3195
|
});
|
|
3187
3196
|
/**
|
|
3188
|
-
*
|
|
3197
|
+
* Stage a file to replace a dataset's data
|
|
3189
3198
|
*
|
|
3190
3199
|
* Upload a new file to replace the data in an existing dataset.
|
|
3191
3200
|
*/
|
|
@@ -3208,7 +3217,7 @@ export const reuploadDatasetDatasetsDatasetIdReuploadPost = (options) => (option
|
|
|
3208
3217
|
}
|
|
3209
3218
|
});
|
|
3210
3219
|
/**
|
|
3211
|
-
* Request
|
|
3220
|
+
* Request a presigned re-upload
|
|
3212
3221
|
*
|
|
3213
3222
|
* Request presigned URL(s) for direct-to-S3 reupload.
|
|
3214
3223
|
*/
|
|
@@ -3230,7 +3239,7 @@ export const requestPresignedReuploadDatasetsDatasetIdReuploadPresignedPost = (o
|
|
|
3230
3239
|
}
|
|
3231
3240
|
});
|
|
3232
3241
|
/**
|
|
3233
|
-
* Complete
|
|
3242
|
+
* Complete a presigned re-upload
|
|
3234
3243
|
*
|
|
3235
3244
|
* Notify that direct-to-S3 reupload is complete.
|
|
3236
3245
|
*/
|
|
@@ -3252,7 +3261,7 @@ export const completePresignedReuploadDatasetsDatasetIdReuploadPresignedJobIdCom
|
|
|
3252
3261
|
}
|
|
3253
3262
|
});
|
|
3254
3263
|
/**
|
|
3255
|
-
*
|
|
3264
|
+
* Preview a service layer for re-upload
|
|
3256
3265
|
*
|
|
3257
3266
|
* Preview a remote service layer for dataset re-upload.
|
|
3258
3267
|
*/
|
|
@@ -3274,7 +3283,7 @@ export const reuploadServicePreviewDatasetsDatasetIdReuploadServicePreviewPost =
|
|
|
3274
3283
|
}
|
|
3275
3284
|
});
|
|
3276
3285
|
/**
|
|
3277
|
-
*
|
|
3286
|
+
* Commit a re-upload
|
|
3278
3287
|
*
|
|
3279
3288
|
* Commit a re-upload, queuing the background swap task.
|
|
3280
3289
|
*/
|
|
@@ -3296,7 +3305,7 @@ export const reuploadCommitDatasetsDatasetIdReuploadJobIdCommitPost = (options)
|
|
|
3296
3305
|
}
|
|
3297
3306
|
});
|
|
3298
3307
|
/**
|
|
3299
|
-
*
|
|
3308
|
+
* Preview a re-upload
|
|
3300
3309
|
*
|
|
3301
3310
|
* Preview the schema diff between old dataset and new upload.
|
|
3302
3311
|
*
|
|
@@ -3324,7 +3333,7 @@ export const reuploadPreviewDatasetsDatasetIdReuploadJobIdPreviewPost = (options
|
|
|
3324
3333
|
}
|
|
3325
3334
|
});
|
|
3326
3335
|
/**
|
|
3327
|
-
*
|
|
3336
|
+
* List dataset rows
|
|
3328
3337
|
*
|
|
3329
3338
|
* Get keyset-paginated rows from a dataset's data table.
|
|
3330
3339
|
*
|
|
@@ -3333,13 +3342,20 @@ export const reuploadPreviewDatasetsDatasetIdReuploadJobIdPreviewPost = (options
|
|
|
3333
3342
|
* Supports column filtering via query params: ``filter[column_name]=value``.
|
|
3334
3343
|
* An optional CQL2-JSON ``filter`` expression ANDs with them.
|
|
3335
3344
|
*
|
|
3336
|
-
* Anonymous callers can read public, published datasets
|
|
3337
|
-
*
|
|
3338
|
-
*
|
|
3339
|
-
*
|
|
3340
|
-
*
|
|
3341
|
-
*
|
|
3342
|
-
*
|
|
3345
|
+
* Anonymous callers can read public, published datasets, and a signed-in
|
|
3346
|
+
* caller reads what their own permissions allow; an embed token that doesn't
|
|
3347
|
+
* cover the dataset changes neither. This route also answers an
|
|
3348
|
+
* ``X-Embed-Token`` for datasets in the token's scope while the token's map
|
|
3349
|
+
* has ``show_attribute_table`` on. That flag only decides whether viewers
|
|
3350
|
+
* offer the table: tiles, ``features.geojson`` and ``aggregate`` return the
|
|
3351
|
+
* same allowlisted values to the token either way. Any other caller gets 404.
|
|
3352
|
+
*
|
|
3353
|
+
* A request only the embed token authorizes reads only the columns in the
|
|
3354
|
+
* dataset's tile column allowlist, when it has one: any other column is
|
|
3355
|
+
* treated as one the table lacks, in the returned columns, ``sort``,
|
|
3356
|
+
* ``filter`` and ``filter[column]``. ``gid`` is kept even when the allowlist
|
|
3357
|
+
* leaves it out: it stays in the rows, in ``sortable_columns`` and, when the
|
|
3358
|
+
* stored metadata lists it, in ``columns``.
|
|
3343
3359
|
*/
|
|
3344
3360
|
export const getDatasetRowsEndpointDatasetsDatasetIdRowsGet = (options) => (options.client ?? client).get({
|
|
3345
3361
|
security: [
|
|
@@ -3355,7 +3371,7 @@ export const getDatasetRowsEndpointDatasetsDatasetIdRowsGet = (options) => (opti
|
|
|
3355
3371
|
...options
|
|
3356
3372
|
});
|
|
3357
3373
|
/**
|
|
3358
|
-
* Check
|
|
3374
|
+
* Check a dataset's source
|
|
3359
3375
|
*
|
|
3360
3376
|
* Contact this dataset's origin and record what came back.
|
|
3361
3377
|
*
|
|
@@ -3377,7 +3393,7 @@ export const checkSourceHealthDatasetsDatasetIdSourceHealthPost = (options) => (
|
|
|
3377
3393
|
...options
|
|
3378
3394
|
});
|
|
3379
3395
|
/**
|
|
3380
|
-
*
|
|
3396
|
+
* Change a dataset's publication status
|
|
3381
3397
|
*
|
|
3382
3398
|
* Transition a dataset's publication status following allowed paths.
|
|
3383
3399
|
*
|
|
@@ -3403,7 +3419,7 @@ export const updatePublicationStatusDatasetsDatasetIdStatusPatch = (options) =>
|
|
|
3403
3419
|
}
|
|
3404
3420
|
});
|
|
3405
3421
|
/**
|
|
3406
|
-
*
|
|
3422
|
+
* Move a dataset to a target publication status
|
|
3407
3423
|
*
|
|
3408
3424
|
* Walk the publication chain from current status to target in one request.
|
|
3409
3425
|
*
|
|
@@ -3430,7 +3446,7 @@ export const setTargetStatusDatasetsDatasetIdTargetStatusPatch = (options) => (o
|
|
|
3430
3446
|
}
|
|
3431
3447
|
});
|
|
3432
3448
|
/**
|
|
3433
|
-
* Get
|
|
3449
|
+
* Get a 3D Tiles file
|
|
3434
3450
|
*
|
|
3435
3451
|
* Serve one file of a published 3D Tiles tileset.
|
|
3436
3452
|
*
|
|
@@ -3464,7 +3480,7 @@ export const getTilesetFileDatasetsDatasetIdTiles3dPathGet = (options) => (optio
|
|
|
3464
3480
|
...options
|
|
3465
3481
|
});
|
|
3466
3482
|
/**
|
|
3467
|
-
*
|
|
3483
|
+
* Get a dataset's validation status
|
|
3468
3484
|
*
|
|
3469
3485
|
* Get validation status for a dataset. Shows hard errors and soft warnings.
|
|
3470
3486
|
*
|
|
@@ -3487,7 +3503,7 @@ export const validateDatasetDatasetsDatasetIdValidateGet = (options) => (options
|
|
|
3487
3503
|
...options
|
|
3488
3504
|
});
|
|
3489
3505
|
/**
|
|
3490
|
-
*
|
|
3506
|
+
* List a dataset's versions
|
|
3491
3507
|
*
|
|
3492
3508
|
* Get paginated version history for a dataset.
|
|
3493
3509
|
*
|
|
@@ -3510,7 +3526,7 @@ export const getDatasetVersionsEndpointDatasetsDatasetIdVersionsGet = (options)
|
|
|
3510
3526
|
...options
|
|
3511
3527
|
});
|
|
3512
3528
|
/**
|
|
3513
|
-
* List
|
|
3529
|
+
* List a VRT dataset's sources
|
|
3514
3530
|
*
|
|
3515
3531
|
* Return ordered list of COG sources for a VRT dataset.
|
|
3516
3532
|
*/
|
|
@@ -3528,7 +3544,7 @@ export const listVrtSourcesDatasetsDatasetIdVrtSourcesGet = (options) => (option
|
|
|
3528
3544
|
...options
|
|
3529
3545
|
});
|
|
3530
3546
|
/**
|
|
3531
|
-
* List
|
|
3547
|
+
* List a VRT dataset's generations
|
|
3532
3548
|
*
|
|
3533
3549
|
* Return paginated generation history for a VRT dataset.
|
|
3534
3550
|
*
|
|
@@ -3551,7 +3567,7 @@ export const listVrtGenerationsDatasetsDatasetIdVrtGenerationsGet = (options) =>
|
|
|
3551
3567
|
...options
|
|
3552
3568
|
});
|
|
3553
3569
|
/**
|
|
3554
|
-
* Regenerate
|
|
3570
|
+
* Regenerate a VRT dataset
|
|
3555
3571
|
*
|
|
3556
3572
|
* Trigger manual VRT regeneration with advisory lock to prevent concurrent rebuilds.
|
|
3557
3573
|
*/
|
|
@@ -3569,7 +3585,7 @@ export const regenerateVrtEndpointDatasetsDatasetIdVrtRegeneratePost = (options)
|
|
|
3569
3585
|
...options
|
|
3570
3586
|
});
|
|
3571
3587
|
/**
|
|
3572
|
-
* Get
|
|
3588
|
+
* Get a VRT dataset's status
|
|
3573
3589
|
*
|
|
3574
3590
|
* Return VRT dataset status, last generation time, source count, and per-source health.
|
|
3575
3591
|
*/
|
|
@@ -3587,7 +3603,7 @@ export const getVrtStatusDatasetsDatasetIdVrtStatusGet = (options) => (options.c
|
|
|
3587
3603
|
...options
|
|
3588
3604
|
});
|
|
3589
3605
|
/**
|
|
3590
|
-
* List
|
|
3606
|
+
* List the sharing groups you can share with
|
|
3591
3607
|
*
|
|
3592
3608
|
* List the sharing groups the caller may share with, by name.
|
|
3593
3609
|
*
|
|
@@ -3607,13 +3623,13 @@ export const listMyGroupsGroupsMineGet = (options) => (options?.client ?? client
|
|
|
3607
3623
|
...options
|
|
3608
3624
|
});
|
|
3609
3625
|
/**
|
|
3610
|
-
*
|
|
3626
|
+
* Check service health
|
|
3611
3627
|
*
|
|
3612
3628
|
* Health check endpoint for ALB, Docker, and Nginx.
|
|
3613
3629
|
*/
|
|
3614
3630
|
export const healthHealthGet = (options) => (options?.client ?? client).get({ url: '/health', ...options });
|
|
3615
3631
|
/**
|
|
3616
|
-
* Commit
|
|
3632
|
+
* Commit a staged file as one import per layer
|
|
3617
3633
|
*
|
|
3618
3634
|
* Convert a single pending IngestJob into N independent per-layer ingest tasks.
|
|
3619
3635
|
*
|
|
@@ -3650,7 +3666,7 @@ export const commitFanOutIngestCommitFanOutJobIdPost = (options) => (options.cli
|
|
|
3650
3666
|
}
|
|
3651
3667
|
});
|
|
3652
3668
|
/**
|
|
3653
|
-
* Commit
|
|
3669
|
+
* Commit a staged file for import
|
|
3654
3670
|
*
|
|
3655
3671
|
* Commit a staged file for ingestion with user-supplied metadata.
|
|
3656
3672
|
*
|
|
@@ -3677,7 +3693,7 @@ export const commitImportIngestCommitJobIdPost = (options) => (options.client ??
|
|
|
3677
3693
|
}
|
|
3678
3694
|
});
|
|
3679
3695
|
/**
|
|
3680
|
-
* Discover
|
|
3696
|
+
* Discover unregistered PostGIS tables
|
|
3681
3697
|
*
|
|
3682
3698
|
* Discover unregistered tables in the data schema.
|
|
3683
3699
|
*
|
|
@@ -3701,7 +3717,7 @@ export const discoverTablesIngestDiscoverGet = (options) => (options?.client ??
|
|
|
3701
3717
|
...options
|
|
3702
3718
|
});
|
|
3703
3719
|
/**
|
|
3704
|
-
* Apply
|
|
3720
|
+
* Apply an ingest manifest
|
|
3705
3721
|
*
|
|
3706
3722
|
* Apply a versioned manifest through the ingest service layer.
|
|
3707
3723
|
*/
|
|
@@ -3723,7 +3739,7 @@ export const applyManifestEndpointIngestManifestApplyPost = (options) => (option
|
|
|
3723
3739
|
}
|
|
3724
3740
|
});
|
|
3725
3741
|
/**
|
|
3726
|
-
* Preview
|
|
3742
|
+
* Preview a staged file
|
|
3727
3743
|
*
|
|
3728
3744
|
* Run preview on a staged file and return preview data.
|
|
3729
3745
|
*
|
|
@@ -3750,7 +3766,7 @@ export const previewFileIngestPreviewJobIdPost = (options) => (options.client ??
|
|
|
3750
3766
|
...options
|
|
3751
3767
|
});
|
|
3752
3768
|
/**
|
|
3753
|
-
* Register
|
|
3769
|
+
* Register a PostGIS table
|
|
3754
3770
|
*
|
|
3755
3771
|
* Register an existing PostGIS table as a dataset.
|
|
3756
3772
|
*
|
|
@@ -3775,7 +3791,7 @@ export const registerTableIngestRegisterPost = (options) => (options.client ?? c
|
|
|
3775
3791
|
}
|
|
3776
3792
|
});
|
|
3777
3793
|
/**
|
|
3778
|
-
*
|
|
3794
|
+
* Register several PostGIS tables
|
|
3779
3795
|
*
|
|
3780
3796
|
* Bulk-register multiple existing PostGIS tables as datasets.
|
|
3781
3797
|
*
|
|
@@ -3802,7 +3818,7 @@ export const bulkRegisterTablesIngestRegisterBulkPost = (options) => (options.cl
|
|
|
3802
3818
|
}
|
|
3803
3819
|
});
|
|
3804
3820
|
/**
|
|
3805
|
-
* Upload
|
|
3821
|
+
* Upload a file for staging
|
|
3806
3822
|
*
|
|
3807
3823
|
* Upload a geospatial file for staging.
|
|
3808
3824
|
*
|
|
@@ -3828,7 +3844,7 @@ export const uploadFileIngestUploadPost = (options) => (options.client ?? client
|
|
|
3828
3844
|
}
|
|
3829
3845
|
});
|
|
3830
3846
|
/**
|
|
3831
|
-
* Get
|
|
3847
|
+
* Get the upload configuration
|
|
3832
3848
|
*
|
|
3833
3849
|
* Return upload configuration including presigned upload availability.
|
|
3834
3850
|
*/
|
|
@@ -3846,7 +3862,7 @@ export const getUploadConfigIngestUploadConfigGet = (options) => (options?.clien
|
|
|
3846
3862
|
...options
|
|
3847
3863
|
});
|
|
3848
3864
|
/**
|
|
3849
|
-
* Request
|
|
3865
|
+
* Request a presigned upload
|
|
3850
3866
|
*
|
|
3851
3867
|
* Request presigned URL(s) for direct-to-S3 file upload.
|
|
3852
3868
|
*/
|
|
@@ -3868,7 +3884,7 @@ export const requestPresignedUploadIngestUploadPresignedPost = (options) => (opt
|
|
|
3868
3884
|
}
|
|
3869
3885
|
});
|
|
3870
3886
|
/**
|
|
3871
|
-
* Complete
|
|
3887
|
+
* Complete a presigned upload
|
|
3872
3888
|
*
|
|
3873
3889
|
* Notify that direct-to-S3 upload is complete.
|
|
3874
3890
|
*/
|
|
@@ -3890,7 +3906,7 @@ export const completePresignedUploadIngestUploadPresignedJobIdCompletePost = (op
|
|
|
3890
3906
|
}
|
|
3891
3907
|
});
|
|
3892
3908
|
/**
|
|
3893
|
-
*
|
|
3909
|
+
* Import a file from a URL
|
|
3894
3910
|
*
|
|
3895
3911
|
* Start importing a geospatial file from an HTTP(S) URL.
|
|
3896
3912
|
*
|
|
@@ -3927,7 +3943,7 @@ export const uploadFromUrlIngestUploadUrlPost = (options) => (options.client ??
|
|
|
3927
3943
|
}
|
|
3928
3944
|
});
|
|
3929
3945
|
/**
|
|
3930
|
-
* Create
|
|
3946
|
+
* Create a VRT dataset
|
|
3931
3947
|
*
|
|
3932
3948
|
* Create a VRT dataset by combining existing raster datasets.
|
|
3933
3949
|
*
|
|
@@ -3953,7 +3969,7 @@ export const createVrtIngestVrtCreatePost = (options) => (options.client ?? clie
|
|
|
3953
3969
|
}
|
|
3954
3970
|
});
|
|
3955
3971
|
/**
|
|
3956
|
-
* Add
|
|
3972
|
+
* Add a source to a VRT dataset
|
|
3957
3973
|
*
|
|
3958
3974
|
* Add a COG source to an existing VRT and trigger async regeneration.
|
|
3959
3975
|
*
|
|
@@ -3980,7 +3996,7 @@ export const addVrtSourceIngestVrtDatasetIdSourcesPost = (options) => (options.c
|
|
|
3980
3996
|
}
|
|
3981
3997
|
});
|
|
3982
3998
|
/**
|
|
3983
|
-
* Remove
|
|
3999
|
+
* Remove a source from a VRT dataset
|
|
3984
4000
|
*
|
|
3985
4001
|
* Remove a COG source from an existing VRT and trigger async regeneration.
|
|
3986
4002
|
*
|
|
@@ -4003,7 +4019,7 @@ export const removeVrtSourceIngestVrtDatasetIdSourcesSourceDatasetIdDelete = (op
|
|
|
4003
4019
|
...options
|
|
4004
4020
|
});
|
|
4005
4021
|
/**
|
|
4006
|
-
* Get
|
|
4022
|
+
* Get a dataset's latest ingest job
|
|
4007
4023
|
*
|
|
4008
4024
|
* Look up the most recent ingest job for a dataset.
|
|
4009
4025
|
*
|
|
@@ -4044,7 +4060,7 @@ export const getJobStatusByDatasetJobsByDatasetDatasetIdGet = (options) => (opti
|
|
|
4044
4060
|
...options
|
|
4045
4061
|
});
|
|
4046
4062
|
/**
|
|
4047
|
-
*
|
|
4063
|
+
* Fail stale ingest jobs
|
|
4048
4064
|
*
|
|
4049
4065
|
* Fail all stale jobs: pending >1h or running >1h.
|
|
4050
4066
|
*
|
|
@@ -4068,7 +4084,7 @@ export const cleanupStaleJobsJobsCleanupStalePost = (options) => (options?.clien
|
|
|
4068
4084
|
...options
|
|
4069
4085
|
});
|
|
4070
4086
|
/**
|
|
4071
|
-
* Get
|
|
4087
|
+
* Get the status of several ingest jobs
|
|
4072
4088
|
*
|
|
4073
4089
|
* Get the status of up to 100 ingestion jobs in one request.
|
|
4074
4090
|
*
|
|
@@ -4095,7 +4111,7 @@ export const getJobStatusesJobsStatusPost = (options) => (options.client ?? clie
|
|
|
4095
4111
|
}
|
|
4096
4112
|
});
|
|
4097
4113
|
/**
|
|
4098
|
-
* Get
|
|
4114
|
+
* Get an ingest job's status
|
|
4099
4115
|
*
|
|
4100
4116
|
* Get the status of an ingestion job.
|
|
4101
4117
|
*
|
|
@@ -4115,7 +4131,7 @@ export const getJobStatusJobsJobIdGet = (options) => (options.client ?? client).
|
|
|
4115
4131
|
...options
|
|
4116
4132
|
});
|
|
4117
4133
|
/**
|
|
4118
|
-
* Cancel
|
|
4134
|
+
* Cancel an ingest job
|
|
4119
4135
|
*
|
|
4120
4136
|
* Cancel a pending or running ingest job.
|
|
4121
4137
|
*
|
|
@@ -4140,7 +4156,7 @@ export const cancelJobJobsJobIdCancelPost = (options) => (options.client ?? clie
|
|
|
4140
4156
|
...options
|
|
4141
4157
|
});
|
|
4142
4158
|
/**
|
|
4143
|
-
* Retry
|
|
4159
|
+
* Retry a failed ingest job
|
|
4144
4160
|
*
|
|
4145
4161
|
* Retry a failed ingestion job by re-queuing.
|
|
4146
4162
|
*
|
|
@@ -4161,7 +4177,7 @@ export const retryJobJobsJobIdRetryPost = (options) => (options.client ?? client
|
|
|
4161
4177
|
...options
|
|
4162
4178
|
});
|
|
4163
4179
|
/**
|
|
4164
|
-
* Create
|
|
4180
|
+
* Create an empty layer
|
|
4165
4181
|
*
|
|
4166
4182
|
* Create a new empty spatial layer.
|
|
4167
4183
|
*
|
|
@@ -4189,7 +4205,7 @@ export const createLayerEndpointLayersPost = (options) => (options.client ?? cli
|
|
|
4189
4205
|
}
|
|
4190
4206
|
});
|
|
4191
4207
|
/**
|
|
4192
|
-
* Add
|
|
4208
|
+
* Add a column
|
|
4193
4209
|
*
|
|
4194
4210
|
* Add a column to an existing layer.
|
|
4195
4211
|
*/
|
|
@@ -4211,7 +4227,7 @@ export const addColumnEndpointLayersDatasetIdColumnsPost = (options) => (options
|
|
|
4211
4227
|
}
|
|
4212
4228
|
});
|
|
4213
4229
|
/**
|
|
4214
|
-
* Drop
|
|
4230
|
+
* Drop a column
|
|
4215
4231
|
*
|
|
4216
4232
|
* Remove a column from an existing layer.
|
|
4217
4233
|
*/
|
|
@@ -4229,7 +4245,7 @@ export const dropColumnEndpointLayersDatasetIdColumnsColumnNameDelete = (options
|
|
|
4229
4245
|
...options
|
|
4230
4246
|
});
|
|
4231
4247
|
/**
|
|
4232
|
-
* Rename
|
|
4248
|
+
* Rename a column
|
|
4233
4249
|
*
|
|
4234
4250
|
* Rename a column on an existing layer.
|
|
4235
4251
|
*/
|
|
@@ -4251,7 +4267,7 @@ export const renameColumnEndpointLayersDatasetIdColumnsColumnNameNamePatch = (op
|
|
|
4251
4267
|
}
|
|
4252
4268
|
});
|
|
4253
4269
|
/**
|
|
4254
|
-
*
|
|
4270
|
+
* Count maps that reference a column
|
|
4255
4271
|
*
|
|
4256
4272
|
* Count saved maps whose layer config references a column.
|
|
4257
4273
|
*
|
|
@@ -4272,7 +4288,7 @@ export const columnReferencesEndpointLayersDatasetIdColumnsColumnNameReferencesG
|
|
|
4272
4288
|
...options
|
|
4273
4289
|
});
|
|
4274
4290
|
/**
|
|
4275
|
-
*
|
|
4291
|
+
* Change a column's type
|
|
4276
4292
|
*
|
|
4277
4293
|
* Change a column's type on an existing layer.
|
|
4278
4294
|
*
|
|
@@ -4297,7 +4313,7 @@ export const alterColumnTypeEndpointLayersDatasetIdColumnsColumnNameTypePatch =
|
|
|
4297
4313
|
}
|
|
4298
4314
|
});
|
|
4299
4315
|
/**
|
|
4300
|
-
* List
|
|
4316
|
+
* List maps
|
|
4301
4317
|
*
|
|
4302
4318
|
* List maps. Admins see all; authenticated users see own + internal + public + restricted maps shared with their groups; anonymous see public only.
|
|
4303
4319
|
*
|
|
@@ -4319,7 +4335,7 @@ export const listMapsEndpointMapsGet = (options) => (options?.client ?? client).
|
|
|
4319
4335
|
...options
|
|
4320
4336
|
});
|
|
4321
4337
|
/**
|
|
4322
|
-
* Create
|
|
4338
|
+
* Create a map
|
|
4323
4339
|
*
|
|
4324
4340
|
* Create a new map.
|
|
4325
4341
|
*/
|
|
@@ -4341,7 +4357,7 @@ export const createMapEndpointMapsPost = (options) => (options.client ?? client)
|
|
|
4341
4357
|
}
|
|
4342
4358
|
});
|
|
4343
4359
|
/**
|
|
4344
|
-
* List
|
|
4360
|
+
* List map icons
|
|
4345
4361
|
*
|
|
4346
4362
|
* List reusable default and uploaded map icons.
|
|
4347
4363
|
*/
|
|
@@ -4359,7 +4375,7 @@ export const listMapIconsEndpointMapsIconsGet = (options) => (options?.client ??
|
|
|
4359
4375
|
...options
|
|
4360
4376
|
});
|
|
4361
4377
|
/**
|
|
4362
|
-
* Upload
|
|
4378
|
+
* Upload a map icon
|
|
4363
4379
|
*
|
|
4364
4380
|
* Upload a reusable SVG or PNG icon for symbol layers.
|
|
4365
4381
|
*/
|
|
@@ -4382,7 +4398,7 @@ export const uploadMapIconEndpointMapsIconsPost = (options) => (options.client ?
|
|
|
4382
4398
|
}
|
|
4383
4399
|
});
|
|
4384
4400
|
/**
|
|
4385
|
-
* Get
|
|
4401
|
+
* Get a map icon image
|
|
4386
4402
|
*
|
|
4387
4403
|
* Serve an uploaded or bundled icon asset by stable icon ID.
|
|
4388
4404
|
*
|
|
@@ -4395,7 +4411,7 @@ export const uploadMapIconEndpointMapsIconsPost = (options) => (options.client ?
|
|
|
4395
4411
|
*/
|
|
4396
4412
|
export const getMapIconAssetEndpointMapsIconsIconIdAssetGet = (options) => (options.client ?? client).get({ url: '/maps/icons/{icon_id}/asset', ...options });
|
|
4397
4413
|
/**
|
|
4398
|
-
* Import
|
|
4414
|
+
* Import a MapLibre style as a map
|
|
4399
4415
|
*
|
|
4400
4416
|
* Import a MapLibre style JSON document into a new GeoLens map.
|
|
4401
4417
|
*
|
|
@@ -4423,7 +4439,7 @@ export const importMapStyleEndpointMapsImportPost = (options) => (options.client
|
|
|
4423
4439
|
}
|
|
4424
4440
|
});
|
|
4425
4441
|
/**
|
|
4426
|
-
* Import
|
|
4442
|
+
* Import an ArcGIS web map
|
|
4427
4443
|
*
|
|
4428
4444
|
* Import an ArcGIS web map as a new GeoLens map.
|
|
4429
4445
|
*
|
|
@@ -4452,7 +4468,7 @@ export const importArcgisWebmapEndpointMapsImportArcgisWebmapPost = (options) =>
|
|
|
4452
4468
|
}
|
|
4453
4469
|
});
|
|
4454
4470
|
/**
|
|
4455
|
-
* Get
|
|
4471
|
+
* Get a shared map
|
|
4456
4472
|
*
|
|
4457
4473
|
* Get a shared map by token. Optionally authenticated for non-public layers.
|
|
4458
4474
|
*
|
|
@@ -4478,19 +4494,19 @@ export const getSharedMapEndpointMapsSharedTokenGet = (options) => (options.clie
|
|
|
4478
4494
|
...options
|
|
4479
4495
|
});
|
|
4480
4496
|
/**
|
|
4481
|
-
* Get
|
|
4497
|
+
* Get the GeoLens sprite index
|
|
4482
4498
|
*
|
|
4483
4499
|
* Serve the stable GeoLens sprite JSON index.
|
|
4484
4500
|
*/
|
|
4485
4501
|
export const getGeolensSpriteIndexEndpointMapsSpritesGeolensJsonGet = (options) => (options?.client ?? client).get({ url: '/maps/sprites/geolens.json', ...options });
|
|
4486
4502
|
/**
|
|
4487
|
-
* Get
|
|
4503
|
+
* Get the GeoLens sprite sheet
|
|
4488
4504
|
*
|
|
4489
4505
|
* Serve the generated GeoLens sprite sheet for stable icon IDs.
|
|
4490
4506
|
*/
|
|
4491
4507
|
export const getGeolensSpritePngEndpointMapsSpritesGeolensPngGet = (options) => (options?.client ?? client).get({ url: '/maps/sprites/geolens.png', ...options });
|
|
4492
4508
|
/**
|
|
4493
|
-
* Delete
|
|
4509
|
+
* Delete a map
|
|
4494
4510
|
*
|
|
4495
4511
|
* Delete a map. Only the owner or an admin can delete.
|
|
4496
4512
|
*/
|
|
@@ -4508,7 +4524,7 @@ export const deleteMapEndpointMapsMapIdDelete = (options) => (options.client ??
|
|
|
4508
4524
|
...options
|
|
4509
4525
|
});
|
|
4510
4526
|
/**
|
|
4511
|
-
* Get
|
|
4527
|
+
* Get a map
|
|
4512
4528
|
*
|
|
4513
4529
|
* Get a single map with its layers.
|
|
4514
4530
|
*/
|
|
@@ -4526,7 +4542,7 @@ export const getMapEndpointMapsMapIdGet = (options) => (options.client ?? client
|
|
|
4526
4542
|
...options
|
|
4527
4543
|
});
|
|
4528
4544
|
/**
|
|
4529
|
-
*
|
|
4545
|
+
* Transfer a map to another owner
|
|
4530
4546
|
*
|
|
4531
4547
|
* Transfer a map to another owner. Admin only.
|
|
4532
4548
|
*/
|
|
@@ -4548,7 +4564,7 @@ export const patchMapEndpointMapsMapIdPatch = (options) => (options.client ?? cl
|
|
|
4548
4564
|
}
|
|
4549
4565
|
});
|
|
4550
4566
|
/**
|
|
4551
|
-
* Update
|
|
4567
|
+
* Update a map
|
|
4552
4568
|
*
|
|
4553
4569
|
* Update a map's metadata and/or replace its layers.
|
|
4554
4570
|
*/
|
|
@@ -4570,7 +4586,7 @@ export const updateMapEndpointMapsMapIdPut = (options) => (options.client ?? cli
|
|
|
4570
4586
|
}
|
|
4571
4587
|
});
|
|
4572
4588
|
/**
|
|
4573
|
-
* Get
|
|
4589
|
+
* Get the caller's access to a map
|
|
4574
4590
|
*
|
|
4575
4591
|
* Return server-confirmed route access for the map viewer gate.
|
|
4576
4592
|
*/
|
|
@@ -4588,7 +4604,7 @@ export const getMapAccessEndpointMapsMapIdAccessGet = (options) => (options.clie
|
|
|
4588
4604
|
...options
|
|
4589
4605
|
});
|
|
4590
4606
|
/**
|
|
4591
|
-
* Duplicate
|
|
4607
|
+
* Duplicate a map
|
|
4592
4608
|
*
|
|
4593
4609
|
* Fork a map with RBAC-filtered layers. Any authenticated user can fork.
|
|
4594
4610
|
*/
|
|
@@ -4606,7 +4622,7 @@ export const duplicateMapEndpointMapsMapIdDuplicatePost = (options) => (options.
|
|
|
4606
4622
|
...options
|
|
4607
4623
|
});
|
|
4608
4624
|
/**
|
|
4609
|
-
* List
|
|
4625
|
+
* List a map's embed tokens
|
|
4610
4626
|
*
|
|
4611
4627
|
* List all embed tokens for a map.
|
|
4612
4628
|
*/
|
|
@@ -4624,7 +4640,7 @@ export const listEmbedTokensEndpointMapsMapIdEmbedTokensGet = (options) => (opti
|
|
|
4624
4640
|
...options
|
|
4625
4641
|
});
|
|
4626
4642
|
/**
|
|
4627
|
-
* Create
|
|
4643
|
+
* Create an embed token
|
|
4628
4644
|
*
|
|
4629
4645
|
* Create an embed token scoped to a map's current layers.
|
|
4630
4646
|
*
|
|
@@ -4649,7 +4665,7 @@ export const createEmbedTokenEndpointMapsMapIdEmbedTokensPost = (options) => (op
|
|
|
4649
4665
|
}
|
|
4650
4666
|
});
|
|
4651
4667
|
/**
|
|
4652
|
-
* Revoke
|
|
4668
|
+
* Revoke an embed token
|
|
4653
4669
|
*
|
|
4654
4670
|
* Revoke an embed token.
|
|
4655
4671
|
*/
|
|
@@ -4667,7 +4683,7 @@ export const revokeEmbedTokenEndpointMapsMapIdEmbedTokensTokenIdDelete = (option
|
|
|
4667
4683
|
...options
|
|
4668
4684
|
});
|
|
4669
4685
|
/**
|
|
4670
|
-
* Update
|
|
4686
|
+
* Update an embed token
|
|
4671
4687
|
*
|
|
4672
4688
|
* Update embed token allowed_origins.
|
|
4673
4689
|
*
|
|
@@ -4691,7 +4707,7 @@ export const updateEmbedTokenEndpointMapsMapIdEmbedTokensTokenIdPatch = (options
|
|
|
4691
4707
|
}
|
|
4692
4708
|
});
|
|
4693
4709
|
/**
|
|
4694
|
-
* Set
|
|
4710
|
+
* Set the sharing groups for a map
|
|
4695
4711
|
*
|
|
4696
4712
|
* Share a map with exactly these sharing groups (owner or admin).
|
|
4697
4713
|
*
|
|
@@ -4704,6 +4720,8 @@ export const updateEmbedTokenEndpointMapsMapIdEmbedTokensTokenIdPatch = (options
|
|
|
4704
4720
|
* 409 (`detail.code` `layers_hidden_from_groups`, the layers under
|
|
4705
4721
|
* `detail.layers`) when new groups can't read some layers; see `confirm`.
|
|
4706
4722
|
* A lock wait that times out also answers 409, without `detail.code`.
|
|
4723
|
+
* With `expected_updated_at`, a map changed since that value answers 409
|
|
4724
|
+
* with `detail.code` `stale_write` and nothing is written.
|
|
4707
4725
|
*/
|
|
4708
4726
|
export const setMapGroupsEndpointMapsMapIdGroupsPut = (options) => (options.client ?? client).put({
|
|
4709
4727
|
security: [
|
|
@@ -4723,7 +4741,7 @@ export const setMapGroupsEndpointMapsMapIdGroupsPut = (options) => (options.clie
|
|
|
4723
4741
|
}
|
|
4724
4742
|
});
|
|
4725
4743
|
/**
|
|
4726
|
-
*
|
|
4744
|
+
* List a map's edit history
|
|
4727
4745
|
*
|
|
4728
4746
|
* Return recent builder edit history for a map.
|
|
4729
4747
|
*/
|
|
@@ -4741,7 +4759,7 @@ export const getMapHistoryEndpointMapsMapIdHistoryGet = (options) => (options.cl
|
|
|
4741
4759
|
...options
|
|
4742
4760
|
});
|
|
4743
4761
|
/**
|
|
4744
|
-
*
|
|
4762
|
+
* Change a map's layers
|
|
4745
4763
|
*
|
|
4746
4764
|
* Apply incremental layer additions, patches, removals, and ordering.
|
|
4747
4765
|
*
|
|
@@ -4772,7 +4790,7 @@ export const patchMapLayersEndpointMapsMapIdLayersPatch = (options) => (options.
|
|
|
4772
4790
|
}
|
|
4773
4791
|
});
|
|
4774
4792
|
/**
|
|
4775
|
-
* Add
|
|
4793
|
+
* Add a layer to a map
|
|
4776
4794
|
*
|
|
4777
4795
|
* Add a layer to a map.
|
|
4778
4796
|
*
|
|
@@ -4803,7 +4821,7 @@ export const addLayerEndpointMapsMapIdLayersPost = (options) => (options.client
|
|
|
4803
4821
|
}
|
|
4804
4822
|
});
|
|
4805
4823
|
/**
|
|
4806
|
-
*
|
|
4824
|
+
* Remove several layers from a map
|
|
4807
4825
|
*
|
|
4808
4826
|
* Batch-delete multiple layers from a map in a single request.
|
|
4809
4827
|
*
|
|
@@ -4832,7 +4850,7 @@ export const bulkDeleteLayersEndpointMapsMapIdLayersBulkDeletePost = (options) =
|
|
|
4832
4850
|
}
|
|
4833
4851
|
});
|
|
4834
4852
|
/**
|
|
4835
|
-
* Remove
|
|
4853
|
+
* Remove a layer from a map
|
|
4836
4854
|
*
|
|
4837
4855
|
* Remove a layer from a map.
|
|
4838
4856
|
*/
|
|
@@ -4850,7 +4868,7 @@ export const removeLayerEndpointMapsMapIdLayersLayerIdDelete = (options) => (opt
|
|
|
4850
4868
|
...options
|
|
4851
4869
|
});
|
|
4852
4870
|
/**
|
|
4853
|
-
* Get
|
|
4871
|
+
* Get a map social card image
|
|
4854
4872
|
*
|
|
4855
4873
|
* Serve the OG social-card image from storage (visibility-checked).
|
|
4856
4874
|
*
|
|
@@ -4871,7 +4889,7 @@ export const getOgImageMapsMapIdOgImageGet = (options) => (options.client ?? cli
|
|
|
4871
4889
|
...options
|
|
4872
4890
|
});
|
|
4873
4891
|
/**
|
|
4874
|
-
* Upload
|
|
4892
|
+
* Upload a map social card image
|
|
4875
4893
|
*
|
|
4876
4894
|
* Upload a base64 OG social-card image (up to 750KB) for a map.
|
|
4877
4895
|
*
|
|
@@ -4904,7 +4922,7 @@ export const uploadOgImageMapsMapIdOgImagePut = (options) => (options.client ??
|
|
|
4904
4922
|
}
|
|
4905
4923
|
});
|
|
4906
4924
|
/**
|
|
4907
|
-
* Revoke
|
|
4925
|
+
* Revoke a map share token
|
|
4908
4926
|
*
|
|
4909
4927
|
* Revoke share token(s) for a map. Owner or admin only.
|
|
4910
4928
|
*/
|
|
@@ -4922,7 +4940,7 @@ export const revokeMapShareEndpointMapsMapIdShareDelete = (options) => (options.
|
|
|
4922
4940
|
...options
|
|
4923
4941
|
});
|
|
4924
4942
|
/**
|
|
4925
|
-
* Get
|
|
4943
|
+
* Get a map's share token
|
|
4926
4944
|
*
|
|
4927
4945
|
* Return the active share token for a map, or null if none exists.
|
|
4928
4946
|
*/
|
|
@@ -4940,7 +4958,7 @@ export const getMapShareTokenEndpointMapsMapIdShareGet = (options) => (options.c
|
|
|
4940
4958
|
...options
|
|
4941
4959
|
});
|
|
4942
4960
|
/**
|
|
4943
|
-
* Update
|
|
4961
|
+
* Update a map share token
|
|
4944
4962
|
*
|
|
4945
4963
|
* Update expiration on an existing share token. Owner or admin only.
|
|
4946
4964
|
*
|
|
@@ -4964,7 +4982,7 @@ export const updateMapShareTokenEndpointMapsMapIdSharePatch = (options) => (opti
|
|
|
4964
4982
|
}
|
|
4965
4983
|
});
|
|
4966
4984
|
/**
|
|
4967
|
-
*
|
|
4985
|
+
* Create a map share token
|
|
4968
4986
|
*
|
|
4969
4987
|
* Create or retrieve a share token for a public map.
|
|
4970
4988
|
*/
|
|
@@ -4986,7 +5004,7 @@ export const shareMapEndpointMapsMapIdSharePost = (options) => (options.client ?
|
|
|
4986
5004
|
}
|
|
4987
5005
|
});
|
|
4988
5006
|
/**
|
|
4989
|
-
* List
|
|
5007
|
+
* List stories that use a map
|
|
4990
5008
|
*
|
|
4991
5009
|
* List the stories whose scenes use this map (owner or admin).
|
|
4992
5010
|
*
|
|
@@ -5009,7 +5027,7 @@ export const listMapStoriesEndpointMapsMapIdStoriesGet = (options) => (options.c
|
|
|
5009
5027
|
...options
|
|
5010
5028
|
});
|
|
5011
5029
|
/**
|
|
5012
|
-
* Export
|
|
5030
|
+
* Export a map as a MapLibre style
|
|
5013
5031
|
*
|
|
5014
5032
|
* Export a saved map as a complete MapLibre style JSON document.
|
|
5015
5033
|
*/
|
|
@@ -5027,7 +5045,7 @@ export const exportMapStyleEndpointMapsMapIdStyleJsonGet = (options) => (options
|
|
|
5027
5045
|
...options
|
|
5028
5046
|
});
|
|
5029
5047
|
/**
|
|
5030
|
-
* Get
|
|
5048
|
+
* Get a map thumbnail
|
|
5031
5049
|
*
|
|
5032
5050
|
* Serve map thumbnail image from storage (visibility-checked).
|
|
5033
5051
|
*/
|
|
@@ -5045,7 +5063,7 @@ export const getThumbnailMapsMapIdThumbnailGet = (options) => (options.client ??
|
|
|
5045
5063
|
...options
|
|
5046
5064
|
});
|
|
5047
5065
|
/**
|
|
5048
|
-
* Upload
|
|
5066
|
+
* Upload a map thumbnail
|
|
5049
5067
|
*
|
|
5050
5068
|
* Upload a base64 thumbnail for a map.
|
|
5051
5069
|
*
|
|
@@ -5070,7 +5088,7 @@ export const uploadThumbnailMapsMapIdThumbnailPut = (options) => (options.client
|
|
|
5070
5088
|
}
|
|
5071
5089
|
});
|
|
5072
5090
|
/**
|
|
5073
|
-
*
|
|
5091
|
+
* Check which layers a map's audience cannot see
|
|
5074
5092
|
*
|
|
5075
5093
|
* Check which layers a map's audience can't see. Informational only.
|
|
5076
5094
|
*
|
|
@@ -5121,7 +5139,7 @@ export const sandboxQueryEndpointQueryPost = (options) => (options.client ?? cli
|
|
|
5121
5139
|
}
|
|
5122
5140
|
});
|
|
5123
5141
|
/**
|
|
5124
|
-
* List
|
|
5142
|
+
* List a record's contacts
|
|
5125
5143
|
*
|
|
5126
5144
|
* List all contacts for a record.
|
|
5127
5145
|
*/
|
|
@@ -5139,7 +5157,7 @@ export const listContactsEndpointRecordsRecordIdContactsGet = (options) => (opti
|
|
|
5139
5157
|
...options
|
|
5140
5158
|
});
|
|
5141
5159
|
/**
|
|
5142
|
-
*
|
|
5160
|
+
* Add a record contact
|
|
5143
5161
|
*
|
|
5144
5162
|
* Create a new contact for a record.
|
|
5145
5163
|
*/
|
|
@@ -5161,7 +5179,7 @@ export const createContactEndpointRecordsRecordIdContactsPost = (options) => (op
|
|
|
5161
5179
|
}
|
|
5162
5180
|
});
|
|
5163
5181
|
/**
|
|
5164
|
-
* Delete
|
|
5182
|
+
* Delete a record contact
|
|
5165
5183
|
*
|
|
5166
5184
|
* Delete a contact.
|
|
5167
5185
|
*/
|
|
@@ -5179,7 +5197,7 @@ export const deleteContactEndpointRecordsRecordIdContactsContactIdDelete = (opti
|
|
|
5179
5197
|
...options
|
|
5180
5198
|
});
|
|
5181
5199
|
/**
|
|
5182
|
-
* Update
|
|
5200
|
+
* Update a record contact
|
|
5183
5201
|
*
|
|
5184
5202
|
* Update a contact.
|
|
5185
5203
|
*/
|
|
@@ -5201,7 +5219,7 @@ export const updateContactEndpointRecordsRecordIdContactsContactIdPatch = (optio
|
|
|
5201
5219
|
}
|
|
5202
5220
|
});
|
|
5203
5221
|
/**
|
|
5204
|
-
* List
|
|
5222
|
+
* List a record's distributions
|
|
5205
5223
|
*
|
|
5206
5224
|
* List all distributions for a record.
|
|
5207
5225
|
*/
|
|
@@ -5219,7 +5237,7 @@ export const listDistributionsEndpointRecordsRecordIdDistributionsGet = (options
|
|
|
5219
5237
|
...options
|
|
5220
5238
|
});
|
|
5221
5239
|
/**
|
|
5222
|
-
*
|
|
5240
|
+
* Add a record distribution
|
|
5223
5241
|
*
|
|
5224
5242
|
* Create a manual distribution for a record.
|
|
5225
5243
|
*/
|
|
@@ -5241,7 +5259,7 @@ export const createDistributionEndpointRecordsRecordIdDistributionsPost = (optio
|
|
|
5241
5259
|
}
|
|
5242
5260
|
});
|
|
5243
5261
|
/**
|
|
5244
|
-
* Delete
|
|
5262
|
+
* Delete a record distribution
|
|
5245
5263
|
*
|
|
5246
5264
|
* Delete a distribution (manual only; auto-generated distributions are immutable).
|
|
5247
5265
|
*/
|
|
@@ -5259,7 +5277,7 @@ export const deleteDistributionEndpointRecordsRecordIdDistributionsDistributionI
|
|
|
5259
5277
|
...options
|
|
5260
5278
|
});
|
|
5261
5279
|
/**
|
|
5262
|
-
* Update
|
|
5280
|
+
* Update a record distribution
|
|
5263
5281
|
*
|
|
5264
5282
|
* Update a distribution (manual only; auto-generated distributions are immutable).
|
|
5265
5283
|
*/
|
|
@@ -5281,7 +5299,7 @@ export const updateDistributionEndpointRecordsRecordIdDistributionsDistributionI
|
|
|
5281
5299
|
}
|
|
5282
5300
|
});
|
|
5283
5301
|
/**
|
|
5284
|
-
* List
|
|
5302
|
+
* List a record's keywords
|
|
5285
5303
|
*
|
|
5286
5304
|
* List all keywords for a record, marking analysis-inherited ones.
|
|
5287
5305
|
*/
|
|
@@ -5299,7 +5317,7 @@ export const listKeywordsEndpointRecordsRecordIdKeywordsGet = (options) => (opti
|
|
|
5299
5317
|
...options
|
|
5300
5318
|
});
|
|
5301
5319
|
/**
|
|
5302
|
-
*
|
|
5320
|
+
* Add a record keyword
|
|
5303
5321
|
*
|
|
5304
5322
|
* Create a new keyword for a record.
|
|
5305
5323
|
*/
|
|
@@ -5321,7 +5339,7 @@ export const createKeywordEndpointRecordsRecordIdKeywordsPost = (options) => (op
|
|
|
5321
5339
|
}
|
|
5322
5340
|
});
|
|
5323
5341
|
/**
|
|
5324
|
-
* Delete
|
|
5342
|
+
* Delete a record keyword
|
|
5325
5343
|
*
|
|
5326
5344
|
* Delete a keyword.
|
|
5327
5345
|
*/
|
|
@@ -5339,7 +5357,7 @@ export const deleteKeywordEndpointRecordsRecordIdKeywordsKeywordIdDelete = (opti
|
|
|
5339
5357
|
...options
|
|
5340
5358
|
});
|
|
5341
5359
|
/**
|
|
5342
|
-
* List
|
|
5360
|
+
* List a record's translations
|
|
5343
5361
|
*
|
|
5344
5362
|
* List localized title/summary variants visible with the parent record.
|
|
5345
5363
|
*/
|
|
@@ -5357,7 +5375,7 @@ export const listTranslationsEndpointRecordsRecordIdTranslationsGet = (options)
|
|
|
5357
5375
|
...options
|
|
5358
5376
|
});
|
|
5359
5377
|
/**
|
|
5360
|
-
* Delete
|
|
5378
|
+
* Delete a record translation
|
|
5361
5379
|
*
|
|
5362
5380
|
* Delete one localized title/summary variant.
|
|
5363
5381
|
*/
|
|
@@ -5375,7 +5393,7 @@ export const deleteTranslationEndpointRecordsRecordIdTranslationsLanguageDelete
|
|
|
5375
5393
|
...options
|
|
5376
5394
|
});
|
|
5377
5395
|
/**
|
|
5378
|
-
*
|
|
5396
|
+
* Set a record translation
|
|
5379
5397
|
*
|
|
5380
5398
|
* Create or replace one localized title/summary variant.
|
|
5381
5399
|
*/
|
|
@@ -5397,7 +5415,7 @@ export const upsertTranslationEndpointRecordsRecordIdTranslationsLanguagePut = (
|
|
|
5397
5415
|
}
|
|
5398
5416
|
});
|
|
5399
5417
|
/**
|
|
5400
|
-
* Search
|
|
5418
|
+
* Search datasets
|
|
5401
5419
|
*
|
|
5402
5420
|
* Search datasets with text, spatial, and faceted filters.
|
|
5403
5421
|
*/
|
|
@@ -5415,7 +5433,7 @@ export const searchDatasetsEndpointSearchDatasetsGet = (options) => (options?.cl
|
|
|
5415
5433
|
...options
|
|
5416
5434
|
});
|
|
5417
5435
|
/**
|
|
5418
|
-
*
|
|
5436
|
+
* Get search facet counts
|
|
5419
5437
|
*
|
|
5420
5438
|
* Return record_type facet counts for the given filters.
|
|
5421
5439
|
*/
|
|
@@ -5433,7 +5451,7 @@ export const searchFacetsEndpointSearchFacetsGet = (options) => (options?.client
|
|
|
5433
5451
|
...options
|
|
5434
5452
|
});
|
|
5435
5453
|
/**
|
|
5436
|
-
* List
|
|
5454
|
+
* List saved searches
|
|
5437
5455
|
*
|
|
5438
5456
|
* List saved searches for the authenticated user.
|
|
5439
5457
|
*/
|
|
@@ -5451,7 +5469,7 @@ export const listSavedSearchesEndpointSearchSavedGet = (options) => (options?.cl
|
|
|
5451
5469
|
...options
|
|
5452
5470
|
});
|
|
5453
5471
|
/**
|
|
5454
|
-
*
|
|
5472
|
+
* Save a search
|
|
5455
5473
|
*
|
|
5456
5474
|
* Save a search query with a name for later reuse.
|
|
5457
5475
|
*/
|
|
@@ -5473,7 +5491,7 @@ export const createSavedSearchEndpointSearchSavedPost = (options) => (options.cl
|
|
|
5473
5491
|
}
|
|
5474
5492
|
});
|
|
5475
5493
|
/**
|
|
5476
|
-
* Delete
|
|
5494
|
+
* Delete a saved search
|
|
5477
5495
|
*
|
|
5478
5496
|
* Delete a saved search.
|
|
5479
5497
|
*/
|
|
@@ -5491,7 +5509,7 @@ export const deleteSavedSearchEndpointSearchSavedSearchIdDelete = (options) => (
|
|
|
5491
5509
|
...options
|
|
5492
5510
|
});
|
|
5493
5511
|
/**
|
|
5494
|
-
* Get
|
|
5512
|
+
* Get a saved search
|
|
5495
5513
|
*
|
|
5496
5514
|
* Get a single saved search by ID.
|
|
5497
5515
|
*/
|
|
@@ -5509,7 +5527,7 @@ export const getSavedSearchEndpointSearchSavedSearchIdGet = (options) => (option
|
|
|
5509
5527
|
...options
|
|
5510
5528
|
});
|
|
5511
5529
|
/**
|
|
5512
|
-
*
|
|
5530
|
+
* Sign in to an ArcGIS portal
|
|
5513
5531
|
*
|
|
5514
5532
|
* Sign in to an ArcGIS portal and return a short-lived token.
|
|
5515
5533
|
*
|
|
@@ -5541,7 +5559,7 @@ export const arcgisSigninServicesArcgisSigninPost = (options) => (options.client
|
|
|
5541
5559
|
}
|
|
5542
5560
|
});
|
|
5543
5561
|
/**
|
|
5544
|
-
* List
|
|
5562
|
+
* List connectors
|
|
5545
5563
|
*
|
|
5546
5564
|
* List persistent connectors supplied by an installed overlay.
|
|
5547
5565
|
*
|
|
@@ -5562,7 +5580,7 @@ export const listConnectorsEndpointServicesConnectorsGet = (options) => (options
|
|
|
5562
5580
|
...options
|
|
5563
5581
|
});
|
|
5564
5582
|
/**
|
|
5565
|
-
* Discover
|
|
5583
|
+
* Discover connector resources
|
|
5566
5584
|
*
|
|
5567
5585
|
* Validate connector config and discover non-secret source resources.
|
|
5568
5586
|
*/
|
|
@@ -5584,7 +5602,7 @@ export const discoverConnectorResourcesEndpointServicesConnectorsConnectorNameDi
|
|
|
5584
5602
|
}
|
|
5585
5603
|
});
|
|
5586
5604
|
/**
|
|
5587
|
-
*
|
|
5605
|
+
* Start a connector ingest
|
|
5588
5606
|
*
|
|
5589
5607
|
* Dispatch an overlay-owned ingest and return its opaque job id.
|
|
5590
5608
|
*/
|
|
@@ -5606,7 +5624,7 @@ export const dispatchConnectorIngestEndpointServicesConnectorsConnectorNameInges
|
|
|
5606
5624
|
}
|
|
5607
5625
|
});
|
|
5608
5626
|
/**
|
|
5609
|
-
* Preview
|
|
5627
|
+
* Preview a remote service layer
|
|
5610
5628
|
*
|
|
5611
5629
|
* Preview a selected remote layer via ogrinfo and create a pending IngestJob.
|
|
5612
5630
|
*
|
|
@@ -5632,7 +5650,7 @@ export const previewServiceLayerServicesPreviewPost = (options) => (options.clie
|
|
|
5632
5650
|
}
|
|
5633
5651
|
});
|
|
5634
5652
|
/**
|
|
5635
|
-
* Probe
|
|
5653
|
+
* Probe a remote service URL
|
|
5636
5654
|
*
|
|
5637
5655
|
* Probe a remote service URL to detect its type and list available layers.
|
|
5638
5656
|
*
|
|
@@ -5657,7 +5675,7 @@ export const probeServiceUrlServicesProbePost = (options) => (options.client ??
|
|
|
5657
5675
|
}
|
|
5658
5676
|
});
|
|
5659
5677
|
/**
|
|
5660
|
-
*
|
|
5678
|
+
* Look up STAC asset sizes
|
|
5661
5679
|
*
|
|
5662
5680
|
* Look up the size of data assets whose item publishes no ``file:size``.
|
|
5663
5681
|
*
|
|
@@ -5682,7 +5700,7 @@ export const stacAssetSizesServicesStacAssetSizesPost = (options) => (options.cl
|
|
|
5682
5700
|
}
|
|
5683
5701
|
});
|
|
5684
5702
|
/**
|
|
5685
|
-
*
|
|
5703
|
+
* List collections in a STAC API
|
|
5686
5704
|
*
|
|
5687
5705
|
* List collections from a connected STAC API.
|
|
5688
5706
|
*
|
|
@@ -5706,7 +5724,7 @@ export const stacCollectionsServicesStacCollectionsPost = (options) => (options.
|
|
|
5706
5724
|
}
|
|
5707
5725
|
});
|
|
5708
5726
|
/**
|
|
5709
|
-
*
|
|
5727
|
+
* Connect to a STAC API
|
|
5710
5728
|
*
|
|
5711
5729
|
* Connect to a STAC API and validate the endpoint.
|
|
5712
5730
|
*
|
|
@@ -5730,7 +5748,7 @@ export const stacConnectServicesStacConnectPost = (options) => (options.client ?
|
|
|
5730
5748
|
}
|
|
5731
5749
|
});
|
|
5732
5750
|
/**
|
|
5733
|
-
*
|
|
5751
|
+
* Import STAC items as datasets
|
|
5734
5752
|
*
|
|
5735
5753
|
* Import selected STAC items as raster datasets.
|
|
5736
5754
|
*
|
|
@@ -5756,7 +5774,7 @@ export const stacImportServicesStacImportPost = (options) => (options.client ??
|
|
|
5756
5774
|
}
|
|
5757
5775
|
});
|
|
5758
5776
|
/**
|
|
5759
|
-
*
|
|
5777
|
+
* Search items in a STAC API
|
|
5760
5778
|
*
|
|
5761
5779
|
* Search items in a STAC API with spatial/temporal filters.
|
|
5762
5780
|
*
|
|
@@ -5780,7 +5798,7 @@ export const stacSearchServicesStacSearchPost = (options) => (options.client ??
|
|
|
5780
5798
|
}
|
|
5781
5799
|
});
|
|
5782
5800
|
/**
|
|
5783
|
-
* Update
|
|
5801
|
+
* Update settings
|
|
5784
5802
|
*
|
|
5785
5803
|
* Update one or more settings (admin only). Returns updated settings.
|
|
5786
5804
|
*/
|
|
@@ -5802,7 +5820,7 @@ export const updateSettingsSettingsPut = (options) => (options.client ?? client)
|
|
|
5802
5820
|
}
|
|
5803
5821
|
});
|
|
5804
5822
|
/**
|
|
5805
|
-
* Get
|
|
5823
|
+
* Get all settings
|
|
5806
5824
|
*
|
|
5807
5825
|
* Return all settings grouped by tab with source indicators (admin only).
|
|
5808
5826
|
*/
|
|
@@ -5820,7 +5838,7 @@ export const getAllSettingsSettingsAllGet = (options) => (options?.client ?? cli
|
|
|
5820
5838
|
...options
|
|
5821
5839
|
});
|
|
5822
5840
|
/**
|
|
5823
|
-
* Get
|
|
5841
|
+
* Get LLM provider key status
|
|
5824
5842
|
*
|
|
5825
5843
|
* Return which LLM providers are configured (without exposing values).
|
|
5826
5844
|
*/
|
|
@@ -5838,7 +5856,7 @@ export const getApiKeyStatusSettingsApiKeyStatusGet = (options) => (options?.cli
|
|
|
5838
5856
|
...options
|
|
5839
5857
|
});
|
|
5840
5858
|
/**
|
|
5841
|
-
* Get
|
|
5859
|
+
* Get basemaps
|
|
5842
5860
|
*
|
|
5843
5861
|
* Return the configured basemap list (public, no auth required).
|
|
5844
5862
|
*
|
|
@@ -5856,7 +5874,7 @@ export const getApiKeyStatusSettingsApiKeyStatusGet = (options) => (options?.cli
|
|
|
5856
5874
|
*/
|
|
5857
5875
|
export const getBasemapsSettingsBasemapsGet = (options) => (options?.client ?? client).get({ url: '/settings/basemaps/', ...options });
|
|
5858
5876
|
/**
|
|
5859
|
-
* Get
|
|
5877
|
+
* Get branding
|
|
5860
5878
|
*
|
|
5861
5879
|
* Return branding configuration (public, no auth required).
|
|
5862
5880
|
*
|
|
@@ -5867,13 +5885,13 @@ export const getBasemapsSettingsBasemapsGet = (options) => (options?.client ?? c
|
|
|
5867
5885
|
*/
|
|
5868
5886
|
export const getBrandingSettingsBrandingGet = (options) => (options?.client ?? client).get({ url: '/settings/branding/', ...options });
|
|
5869
5887
|
/**
|
|
5870
|
-
* Get
|
|
5888
|
+
* Get the configuration mode
|
|
5871
5889
|
*
|
|
5872
5890
|
* Return whether the app is in env-only config mode (public, no auth).
|
|
5873
5891
|
*/
|
|
5874
5892
|
export const getConfigModeSettingsConfigModeGet = (options) => (options?.client ?? client).get({ url: '/settings/config-mode/', ...options });
|
|
5875
5893
|
/**
|
|
5876
|
-
* Detect
|
|
5894
|
+
* Detect embedding dimensions
|
|
5877
5895
|
*
|
|
5878
5896
|
* Probe the configured embedding model and return its output dimensions.
|
|
5879
5897
|
*/
|
|
@@ -5897,7 +5915,7 @@ export const detectEmbeddingDimsSettingsDetectEmbeddingDimsPost = (options) => (
|
|
|
5897
5915
|
*/
|
|
5898
5916
|
export const editionInfoSettingsEditionGet = (options) => (options?.client ?? client).get({ url: '/settings/edition/', ...options });
|
|
5899
5917
|
/**
|
|
5900
|
-
* Get
|
|
5918
|
+
* Get enabled plugins
|
|
5901
5919
|
*
|
|
5902
5920
|
* Return enabled plugin IDs. null = no restriction (all shown), [] = none, [...ids] = only those.
|
|
5903
5921
|
*/
|
|
@@ -5926,19 +5944,19 @@ export const getEnterpriseOnlyTabsSettingsEnterpriseTabsGet = (options) => (opti
|
|
|
5926
5944
|
...options
|
|
5927
5945
|
});
|
|
5928
5946
|
/**
|
|
5929
|
-
* Get
|
|
5947
|
+
* Get feature flags
|
|
5930
5948
|
*
|
|
5931
5949
|
* Return public feature flags (no auth required).
|
|
5932
5950
|
*/
|
|
5933
5951
|
export const getFeatureFlagsSettingsFeatureFlagsGet = (options) => (options?.client ?? client).get({ url: '/settings/feature-flags/', ...options });
|
|
5934
5952
|
/**
|
|
5935
|
-
* Get
|
|
5953
|
+
* Get map defaults
|
|
5936
5954
|
*
|
|
5937
5955
|
* Return the default map center and zoom (public, no auth required).
|
|
5938
5956
|
*/
|
|
5939
5957
|
export const getMapDefaultsSettingsMapDefaultsGet = (options) => (options?.client ?? client).get({ url: '/settings/map-defaults/', ...options });
|
|
5940
5958
|
/**
|
|
5941
|
-
* Get
|
|
5959
|
+
* Get notification channel status
|
|
5942
5960
|
*
|
|
5943
5961
|
* Return which notification channels are configured (booleans only — no secrets).
|
|
5944
5962
|
*
|
|
@@ -5960,7 +5978,7 @@ export const getNotificationStatusSettingsNotificationsStatusGet = (options) =>
|
|
|
5960
5978
|
...options
|
|
5961
5979
|
});
|
|
5962
5980
|
/**
|
|
5963
|
-
* Send
|
|
5981
|
+
* Send a test notification
|
|
5964
5982
|
*
|
|
5965
5983
|
* Send a canned test notification through each configured channel (admin only).
|
|
5966
5984
|
*
|
|
@@ -5986,7 +6004,7 @@ export const sendTestNotificationSettingsNotificationsTestPost = (options) => (o
|
|
|
5986
6004
|
...options
|
|
5987
6005
|
});
|
|
5988
6006
|
/**
|
|
5989
|
-
* List
|
|
6007
|
+
* List OAuth providers
|
|
5990
6008
|
*
|
|
5991
6009
|
* List all OAuth providers (admin only).
|
|
5992
6010
|
*/
|
|
@@ -6004,7 +6022,7 @@ export const listOauthProvidersSettingsOauthProvidersGet = (options) => (options
|
|
|
6004
6022
|
...options
|
|
6005
6023
|
});
|
|
6006
6024
|
/**
|
|
6007
|
-
* Create
|
|
6025
|
+
* Create an OAuth provider
|
|
6008
6026
|
*
|
|
6009
6027
|
* Create a new OAuth or SAML provider (admin only).
|
|
6010
6028
|
*
|
|
@@ -6030,7 +6048,7 @@ export const createOauthProviderSettingsOauthProvidersPost = (options) => (optio
|
|
|
6030
6048
|
}
|
|
6031
6049
|
});
|
|
6032
6050
|
/**
|
|
6033
|
-
* Delete
|
|
6051
|
+
* Delete an OAuth provider
|
|
6034
6052
|
*
|
|
6035
6053
|
* Delete an OAuth or SAML provider (admin only).
|
|
6036
6054
|
*
|
|
@@ -6052,7 +6070,7 @@ export const deleteOauthProviderSettingsOauthProvidersProviderIdDelete = (option
|
|
|
6052
6070
|
...options
|
|
6053
6071
|
});
|
|
6054
6072
|
/**
|
|
6055
|
-
* Update
|
|
6073
|
+
* Update an OAuth provider
|
|
6056
6074
|
*
|
|
6057
6075
|
* Update an existing OAuth or SAML provider (admin only).
|
|
6058
6076
|
*
|
|
@@ -6079,7 +6097,7 @@ export const updateOauthProviderSettingsOauthProvidersProviderIdPut = (options)
|
|
|
6079
6097
|
}
|
|
6080
6098
|
});
|
|
6081
6099
|
/**
|
|
6082
|
-
* Reset
|
|
6100
|
+
* Reset settings to defaults
|
|
6083
6101
|
*
|
|
6084
6102
|
* Reset one or more settings to their defaults (admin only). Returns updated settings.
|
|
6085
6103
|
*/
|
|
@@ -6101,31 +6119,31 @@ export const resetSettingsSettingsResetPost = (options) => (options.client ?? cl
|
|
|
6101
6119
|
}
|
|
6102
6120
|
});
|
|
6103
6121
|
/**
|
|
6104
|
-
* Get
|
|
6122
|
+
* Get tile configuration
|
|
6105
6123
|
*
|
|
6106
6124
|
* Return tile delivery configuration (public, no auth required).
|
|
6107
6125
|
*/
|
|
6108
6126
|
export const getTileConfigSettingsTileConfigGet = (options) => (options?.client ?? client).get({ url: '/settings/tile-config/', ...options });
|
|
6109
6127
|
/**
|
|
6110
|
-
*
|
|
6128
|
+
* Get the STAC landing page
|
|
6111
6129
|
*
|
|
6112
6130
|
* STAC Catalog landing page.
|
|
6113
6131
|
*/
|
|
6114
6132
|
export const landingPageStacGet = (options) => (options?.client ?? client).get({ url: '/stac/', ...options });
|
|
6115
6133
|
/**
|
|
6116
|
-
*
|
|
6134
|
+
* List STAC collections
|
|
6117
6135
|
*
|
|
6118
6136
|
* List all STAC Collections.
|
|
6119
6137
|
*/
|
|
6120
6138
|
export const getCollectionsStacCollectionsGet = (options) => (options?.client ?? client).get({ url: '/stac/collections', ...options });
|
|
6121
6139
|
/**
|
|
6122
|
-
* Get
|
|
6140
|
+
* Get a STAC collection
|
|
6123
6141
|
*
|
|
6124
6142
|
* Get a single STAC Collection.
|
|
6125
6143
|
*/
|
|
6126
6144
|
export const getCollectionStacCollectionsCollectionIdGet = (options) => (options.client ?? client).get({ url: '/stac/collections/{collection_id}', ...options });
|
|
6127
6145
|
/**
|
|
6128
|
-
*
|
|
6146
|
+
* List STAC items in a collection
|
|
6129
6147
|
*
|
|
6130
6148
|
* List STAC Items within a collection.
|
|
6131
6149
|
*/
|
|
@@ -6143,7 +6161,7 @@ export const getCollectionItemsStacCollectionsCollectionIdItemsGet = (options) =
|
|
|
6143
6161
|
...options
|
|
6144
6162
|
});
|
|
6145
6163
|
/**
|
|
6146
|
-
* Get
|
|
6164
|
+
* Get a STAC item in a collection
|
|
6147
6165
|
*
|
|
6148
6166
|
* Get a single STAC Item within a collection.
|
|
6149
6167
|
*/
|
|
@@ -6161,13 +6179,13 @@ export const getCollectionItemStacCollectionsCollectionIdItemsItemIdGet = (optio
|
|
|
6161
6179
|
...options
|
|
6162
6180
|
});
|
|
6163
6181
|
/**
|
|
6164
|
-
*
|
|
6182
|
+
* Get the STAC conformance classes
|
|
6165
6183
|
*
|
|
6166
6184
|
* STAC API conformance classes.
|
|
6167
6185
|
*/
|
|
6168
6186
|
export const conformanceStacConformanceGet = (options) => (options?.client ?? client).get({ url: '/stac/conformance', ...options });
|
|
6169
6187
|
/**
|
|
6170
|
-
* Get
|
|
6188
|
+
* Get a STAC item
|
|
6171
6189
|
*
|
|
6172
6190
|
* Get a single STAC Item by dataset ID.
|
|
6173
6191
|
*/
|
|
@@ -6185,7 +6203,7 @@ export const getItemStacItemsItemIdGet = (options) => (options.client ?? client)
|
|
|
6185
6203
|
...options
|
|
6186
6204
|
});
|
|
6187
6205
|
/**
|
|
6188
|
-
* Search
|
|
6206
|
+
* Search STAC items with GET
|
|
6189
6207
|
*
|
|
6190
6208
|
* STAC Item Search (GET).
|
|
6191
6209
|
*/
|
|
@@ -6203,7 +6221,7 @@ export const searchGetStacSearchGet = (options) => (options?.client ?? client).g
|
|
|
6203
6221
|
...options
|
|
6204
6222
|
});
|
|
6205
6223
|
/**
|
|
6206
|
-
* Search
|
|
6224
|
+
* Search STAC items with POST
|
|
6207
6225
|
*
|
|
6208
6226
|
* STAC Item Search (POST with JSON body).
|
|
6209
6227
|
*/
|
|
@@ -6225,7 +6243,7 @@ export const searchPostStacSearchPost = (options) => (options.client ?? client).
|
|
|
6225
6243
|
}
|
|
6226
6244
|
});
|
|
6227
6245
|
/**
|
|
6228
|
-
* List
|
|
6246
|
+
* List stories
|
|
6229
6247
|
*
|
|
6230
6248
|
* List the stories the caller may read, most recently updated first.
|
|
6231
6249
|
*
|
|
@@ -6246,7 +6264,7 @@ export const listStoriesEndpointStoriesGet = (options) => (options?.client ?? cl
|
|
|
6246
6264
|
...options
|
|
6247
6265
|
});
|
|
6248
6266
|
/**
|
|
6249
|
-
* Create
|
|
6267
|
+
* Create a story
|
|
6250
6268
|
*
|
|
6251
6269
|
* Create a private, unpublished story with an empty draft.
|
|
6252
6270
|
*/
|
|
@@ -6268,7 +6286,16 @@ export const createStoryEndpointStoriesPost = (options) => (options.client ?? cl
|
|
|
6268
6286
|
}
|
|
6269
6287
|
});
|
|
6270
6288
|
/**
|
|
6271
|
-
*
|
|
6289
|
+
* List hosts a story may embed
|
|
6290
|
+
*
|
|
6291
|
+
* The hosts story embed and video blocks may frame (public, no auth required).
|
|
6292
|
+
*
|
|
6293
|
+
* An admin sets them in `story_frame_hosts`. Empty means neither block can
|
|
6294
|
+
* be added, and none is shown to readers.
|
|
6295
|
+
*/
|
|
6296
|
+
export const storyFrameHostsEndpointStoriesFrameHostsGet = (options) => (options?.client ?? client).get({ url: '/stories/frame-hosts/', ...options });
|
|
6297
|
+
/**
|
|
6298
|
+
* Delete a story
|
|
6272
6299
|
*
|
|
6273
6300
|
* Delete a story and its images (owner or admin). The maps it uses are
|
|
6274
6301
|
* untouched.
|
|
@@ -6287,7 +6314,7 @@ export const deleteStoryEndpointStoriesStoryIdDelete = (options) => (options.cli
|
|
|
6287
6314
|
...options
|
|
6288
6315
|
});
|
|
6289
6316
|
/**
|
|
6290
|
-
* Get
|
|
6317
|
+
* Get a story
|
|
6291
6318
|
*
|
|
6292
6319
|
* Read a story's published document.
|
|
6293
6320
|
*
|
|
@@ -6309,7 +6336,7 @@ export const getStoryEndpointStoriesStoryIdGet = (options) => (options.client ??
|
|
|
6309
6336
|
...options
|
|
6310
6337
|
});
|
|
6311
6338
|
/**
|
|
6312
|
-
* Update
|
|
6339
|
+
* Update a story
|
|
6313
6340
|
*
|
|
6314
6341
|
* Change a story's title, summary, visibility or cover (owner or admin).
|
|
6315
6342
|
*
|
|
@@ -6336,7 +6363,7 @@ export const updateStoryEndpointStoriesStoryIdPatch = (options) => (options.clie
|
|
|
6336
6363
|
}
|
|
6337
6364
|
});
|
|
6338
6365
|
/**
|
|
6339
|
-
* Upload
|
|
6366
|
+
* Upload a story image
|
|
6340
6367
|
*
|
|
6341
6368
|
* Upload an image, the multipart part `file`, for the story's blocks or
|
|
6342
6369
|
* cover (owner or admin).
|
|
@@ -6366,7 +6393,7 @@ export const uploadStoryAssetEndpointStoriesStoryIdAssetsPost = (options) => (op
|
|
|
6366
6393
|
}
|
|
6367
6394
|
});
|
|
6368
6395
|
/**
|
|
6369
|
-
* Get
|
|
6396
|
+
* Get a story image
|
|
6370
6397
|
*
|
|
6371
6398
|
* Serve one of the story's images, as WebP unless `variant` says otherwise.
|
|
6372
6399
|
*
|
|
@@ -6387,7 +6414,7 @@ export const getStoryAssetEndpointStoriesStoryIdAssetsAssetIdGet = (options) =>
|
|
|
6387
6414
|
...options
|
|
6388
6415
|
});
|
|
6389
6416
|
/**
|
|
6390
|
-
* Discard
|
|
6417
|
+
* Discard a story draft
|
|
6391
6418
|
*
|
|
6392
6419
|
* Revert the draft to the published document, or to an empty one for a
|
|
6393
6420
|
* story never published (owner or admin).
|
|
@@ -6413,7 +6440,7 @@ export const discardStoryDraftEndpointStoriesStoryIdDiscardPost = (options) => (
|
|
|
6413
6440
|
}
|
|
6414
6441
|
});
|
|
6415
6442
|
/**
|
|
6416
|
-
* Get
|
|
6443
|
+
* Get a story draft
|
|
6417
6444
|
*
|
|
6418
6445
|
* Read the draft with its revision (owner or admin).
|
|
6419
6446
|
*
|
|
@@ -6435,16 +6462,18 @@ export const getStoryDraftEndpointStoriesStoryIdDraftGet = (options) => (options
|
|
|
6435
6462
|
...options
|
|
6436
6463
|
});
|
|
6437
6464
|
/**
|
|
6438
|
-
* Save
|
|
6465
|
+
* Save a story draft
|
|
6439
6466
|
*
|
|
6440
6467
|
* Replace the whole draft (owner or admin). Readers keep the published
|
|
6441
6468
|
* document until Publish.
|
|
6442
6469
|
*
|
|
6443
6470
|
* `revision` must match the stored draft's, or 409 `stale_revision`. 422
|
|
6444
6471
|
* for an unknown or invalid block, for a scene on a map you can't read
|
|
6445
|
-
* (`detail.code` `story_maps_not_found`),
|
|
6446
|
-
* image this story doesn't have (`story_assets_not_found`)
|
|
6447
|
-
*
|
|
6472
|
+
* (`detail.code` `story_maps_not_found`), for an image block naming an
|
|
6473
|
+
* image this story doesn't have (`story_assets_not_found`), or for an
|
|
6474
|
+
* embed or video block whose host isn't approved
|
|
6475
|
+
* (`story_frame_host_not_allowed`, the blocks under `detail.blocks`). Blocks
|
|
6476
|
+
* you can't see and scenes sent back with `scene_hidden` are kept as stored.
|
|
6448
6477
|
*/
|
|
6449
6478
|
export const saveStoryDraftEndpointStoriesStoryIdDraftPut = (options) => (options.client ?? client).put({
|
|
6450
6479
|
security: [
|
|
@@ -6464,7 +6493,7 @@ export const saveStoryDraftEndpointStoriesStoryIdDraftPut = (options) => (option
|
|
|
6464
6493
|
}
|
|
6465
6494
|
});
|
|
6466
6495
|
/**
|
|
6467
|
-
* Duplicate
|
|
6496
|
+
* Duplicate a story
|
|
6468
6497
|
*
|
|
6469
6498
|
* Copy a story you can read into a new private draft you own.
|
|
6470
6499
|
*
|
|
@@ -6486,7 +6515,7 @@ export const duplicateStoryEndpointStoriesStoryIdDuplicatePost = (options) => (o
|
|
|
6486
6515
|
...options
|
|
6487
6516
|
});
|
|
6488
6517
|
/**
|
|
6489
|
-
* Set
|
|
6518
|
+
* Set the sharing groups for a story
|
|
6490
6519
|
*
|
|
6491
6520
|
* Share a story with exactly these sharing groups (owner or admin).
|
|
6492
6521
|
*
|
|
@@ -6519,7 +6548,7 @@ export const setStoryGroupsEndpointStoriesStoryIdGroupsPut = (options) => (optio
|
|
|
6519
6548
|
}
|
|
6520
6549
|
});
|
|
6521
6550
|
/**
|
|
6522
|
-
* Publish
|
|
6551
|
+
* Publish a story
|
|
6523
6552
|
*
|
|
6524
6553
|
* Publish the draft (owner or admin): readers get it from now on.
|
|
6525
6554
|
*
|
|
@@ -6528,6 +6557,8 @@ export const setStoryGroupsEndpointStoriesStoryIdGroupsPut = (options) => (optio
|
|
|
6528
6557
|
* everyone the story's visibility reaches: `detail.maps` names the ones you
|
|
6529
6558
|
* can read and `detail.unreadable_maps` counts the rest. For a restricted
|
|
6530
6559
|
* story, a map only some of its groups lack is `can_share`; see `confirm`.
|
|
6560
|
+
* 422 `story_frame_host_not_allowed` when an embed or video block frames a
|
|
6561
|
+
* host that isn't approved now; `detail.blocks` names each one.
|
|
6531
6562
|
*/
|
|
6532
6563
|
export const publishStoryEndpointStoriesStoryIdPublishPost = (options) => (options.client ?? client).post({
|
|
6533
6564
|
security: [
|
|
@@ -6547,7 +6578,7 @@ export const publishStoryEndpointStoriesStoryIdPublishPost = (options) => (optio
|
|
|
6547
6578
|
}
|
|
6548
6579
|
});
|
|
6549
6580
|
/**
|
|
6550
|
-
*
|
|
6581
|
+
* Get a clustered vector tile
|
|
6551
6582
|
*
|
|
6552
6583
|
* Serve a server-side clustered vector tile for a point dataset.
|
|
6553
6584
|
*
|
|
@@ -6583,7 +6614,9 @@ export const publishStoryEndpointStoriesStoryIdPublishPost = (options) => (optio
|
|
|
6583
6614
|
* a malformed table path or an out-of-range tile coordinate.
|
|
6584
6615
|
*
|
|
6585
6616
|
* A tile holding no features answers 204, and a repeat request whose
|
|
6586
|
-
* ``If-None-Match`` matches answers 304.
|
|
6617
|
+
* ``If-None-Match`` matches answers 304. When more than 100,000 points fall
|
|
6618
|
+
* in or next to the tile, or it would hold more than 50,000 features, it
|
|
6619
|
+
* holds a fixed sample and carries ``X-GeoLens-Tile-Sampled: true``. Where a deployment runs cold storage,
|
|
6587
6620
|
* a dataset still being restored answers 202 with a job id to poll. Requests
|
|
6588
6621
|
* answer 429 with ``Retry-After`` when the per-process capacity for uncached
|
|
6589
6622
|
* renders stays full for a short wait, tile-pool acquisition times out, or the
|
|
@@ -6605,7 +6638,7 @@ export const clusterTileEndpointTilesClustersTablePathZXYPbfGet = (options) => (
|
|
|
6605
6638
|
...options
|
|
6606
6639
|
});
|
|
6607
6640
|
/**
|
|
6608
|
-
*
|
|
6641
|
+
* Get a raster tile
|
|
6609
6642
|
*
|
|
6610
6643
|
* Render one raster tile and return the image.
|
|
6611
6644
|
*
|
|
@@ -6666,7 +6699,7 @@ export const rasterTileProxyTilesRasterProxyDatasetIdZXYFmtGet = (options) => (o
|
|
|
6666
6699
|
...options
|
|
6667
6700
|
});
|
|
6668
6701
|
/**
|
|
6669
|
-
*
|
|
6702
|
+
* Create a tile token
|
|
6670
6703
|
*
|
|
6671
6704
|
* Generate a tile token for a dataset.
|
|
6672
6705
|
*
|
|
@@ -6693,7 +6726,7 @@ export const getTileTokenTilesTokenDatasetIdGet = (options) => (options.client ?
|
|
|
6693
6726
|
...options
|
|
6694
6727
|
});
|
|
6695
6728
|
/**
|
|
6696
|
-
*
|
|
6729
|
+
* Create tile tokens for several datasets
|
|
6697
6730
|
*
|
|
6698
6731
|
* Generate tile tokens for up to 50 datasets in one request.
|
|
6699
6732
|
*
|
|
@@ -6734,7 +6767,7 @@ export const getTileTokensBatchTilesTokensPost = (options) => (options.client ??
|
|
|
6734
6767
|
}
|
|
6735
6768
|
});
|
|
6736
6769
|
/**
|
|
6737
|
-
*
|
|
6770
|
+
* Get a vector tile
|
|
6738
6771
|
*
|
|
6739
6772
|
* Serve a vector tile as gzipped MVT binary.
|
|
6740
6773
|
*
|
|
@@ -6769,7 +6802,9 @@ export const getTileTokensBatchTilesTokensPost = (options) => (options.client ??
|
|
|
6769
6802
|
*
|
|
6770
6803
|
* A malformed table path or an out-of-range tile coordinate answers 400. A
|
|
6771
6804
|
* tile holding no features answers 204, and a repeat request whose
|
|
6772
|
-
* ``If-None-Match`` matches answers 304.
|
|
6805
|
+
* ``If-None-Match`` matches answers 304. When the tile holds more than 50,000
|
|
6806
|
+
* features, it carries a fixed sample of them spread across the tile and
|
|
6807
|
+
* ``X-GeoLens-Tile-Sampled: true``. Where a deployment runs cold storage,
|
|
6773
6808
|
* a dataset still being restored answers 202 with a job id to poll. Requests
|
|
6774
6809
|
* answer 429 with ``Retry-After`` when the per-process capacity for uncached
|
|
6775
6810
|
* renders stays full for a short wait, tile-pool acquisition times out, or the
|