@geolens/sdk 1.19.1 → 1.21.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/README.md +20 -0
- package/dist/auth.d.ts.map +1 -1
- package/dist/auth.js +6 -0
- package/dist/auth.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 +162 -140
- package/dist/client/sdk.gen.d.ts.map +1 -1
- package/dist/client/sdk.gen.js +192 -139
- package/dist/client/sdk.gen.js.map +1 -1
- package/dist/client/types.gen.d.ts +679 -115
- package/dist/client/types.gen.d.ts.map +1 -1
- package/dist/fileReads.d.ts +37 -0
- package/dist/fileReads.d.ts.map +1 -0
- package/dist/fileReads.js +45 -0
- package/dist/fileReads.js.map +1 -0
- package/dist/index.d.ts +2 -6
- package/dist/index.d.ts.map +1 -1
- package/dist/index.js +10 -0
- package/dist/index.js.map +1 -1
- package/dist/redirects.d.ts +48 -0
- package/dist/redirects.d.ts.map +1 -0
- package/dist/redirects.js +127 -0
- package/dist/redirects.js.map +1 -0
- package/package.json +2 -2
package/dist/client/sdk.gen.js
CHANGED
|
@@ -154,11 +154,9 @@ export const exportAuditLogsAdminAuditLogsExportFormatGet = (options) => (option
|
|
|
154
154
|
* Pass ?force=true to delete all existing embeddings and regenerate from
|
|
155
155
|
* scratch (required after changing the embedding model or dimensions).
|
|
156
156
|
*
|
|
157
|
-
*
|
|
158
|
-
*
|
|
159
|
-
*
|
|
160
|
-
* the proxy never stopped the work, it only hid it. Returns the job id;
|
|
161
|
-
* poll ``GET /jobs/{job_id}`` for the outcome.
|
|
157
|
+
* The run happens on the job queue because a full regeneration can exceed
|
|
158
|
+
* request timeouts. This endpoint returns the job id; poll
|
|
159
|
+
* ``GET /jobs/{job_id}`` for the outcome.
|
|
162
160
|
*/
|
|
163
161
|
export const triggerBackfillAdminBackfillEmbeddingsPost = (options) => (options?.client ?? client).post({
|
|
164
162
|
security: [
|
|
@@ -330,7 +328,7 @@ export const getCatalogStatsAdminStatsGet = (options) => (options?.client ?? cli
|
|
|
330
328
|
/**
|
|
331
329
|
* List Users
|
|
332
330
|
*
|
|
333
|
-
* List
|
|
331
|
+
* List users with optional status, role, search, and sort filters (admin only).
|
|
334
332
|
*
|
|
335
333
|
* `sort` and `order` are closed enums, so an unrecognised value is refused
|
|
336
334
|
* with a 422 and never reaches the query.
|
|
@@ -536,21 +534,16 @@ export const rejectUserAdminUsersUserIdRejectPost = (options) => (options.client
|
|
|
536
534
|
*
|
|
537
535
|
* Set a user's password (admin only).
|
|
538
536
|
*
|
|
539
|
-
*
|
|
540
|
-
*
|
|
541
|
-
*
|
|
542
|
-
* manage_users is the whole authorization, and the audit row is what makes
|
|
543
|
-
* the action answerable for. The submitted value reaches the hash column and
|
|
544
|
-
* nowhere else: not the audit details, not a log line, not the response.
|
|
537
|
+
* The ``manage_users`` permission authorizes this recovery path, so no current
|
|
538
|
+
* password is required. The submitted password is stored only as a hash and
|
|
539
|
+
* is omitted from audit details, logs, and the response.
|
|
545
540
|
*
|
|
546
|
-
* 422 when the target signs in through an identity provider
|
|
547
|
-
*
|
|
548
|
-
* _raise_on_error mapping the sibling lifecycle routes use.
|
|
541
|
+
* Returns 422 when the target signs in through an identity provider and has
|
|
542
|
+
* no local password, or 404 when the user does not exist.
|
|
549
543
|
*
|
|
550
544
|
* Resetting your own password is permitted and ends every session the
|
|
551
545
|
* account holds, including the one making this request, because the reset
|
|
552
|
-
* revokes the account's credentials.
|
|
553
|
-
* POST /auth/change-password/ has for the caller who invokes it.
|
|
546
|
+
* revokes the account's credentials.
|
|
554
547
|
*/
|
|
555
548
|
export const resetUserPasswordAdminUsersUserIdResetPasswordPost = (options) => (options.client ?? client).post({
|
|
556
549
|
security: [
|
|
@@ -572,13 +565,10 @@ export const resetUserPasswordAdminUsersUserIdResetPasswordPost = (options) => (
|
|
|
572
565
|
/**
|
|
573
566
|
* Ai Availability Endpoint
|
|
574
567
|
*
|
|
575
|
-
* Report whether builder AI chat is usable
|
|
568
|
+
* Report whether builder AI chat is usable.
|
|
576
569
|
*
|
|
577
|
-
*
|
|
578
|
-
*
|
|
579
|
-
* rather than 503 when provider keys are missing, so the builder shows a safe
|
|
580
|
-
* disabled state without console-noise errors. A viewer (no ``use_ai_chat``)
|
|
581
|
-
* gets 403.
|
|
570
|
+
* Requires ``use_ai_chat``. Returns ``available=false`` when provider keys
|
|
571
|
+
* are missing and 403 when the caller lacks permission.
|
|
582
572
|
*/
|
|
583
573
|
export const aiAvailabilityEndpointAiAvailabilityGet = (options) => (options?.client ?? client).get({
|
|
584
574
|
security: [
|
|
@@ -805,15 +795,9 @@ export const generateMetadataSummaryAiMetadataSummaryPost = (options) => (option
|
|
|
805
795
|
* Surfaces the column-DDL events to dataset owners so they can detect
|
|
806
796
|
* editor-initiated schema changes.
|
|
807
797
|
*
|
|
808
|
-
*
|
|
809
|
-
*
|
|
810
|
-
*
|
|
811
|
-
* - Anyone else — including authenticated readers of a PUBLIC dataset: 404
|
|
812
|
-
* via check_dataset_write_access. fix(#458): the feed previously used
|
|
813
|
-
* check_dataset_access (read visibility), which let any logged-in user
|
|
814
|
-
* enumerate editor usernames/user_ids on public datasets, contradicting
|
|
815
|
-
* this owner-facing contract.
|
|
816
|
-
* - Anonymous: 401 (get_current_active_user dependency)
|
|
798
|
+
* Owners and administrators can read the feed. Other authenticated users
|
|
799
|
+
* receive 404, including readers of a public dataset, because the entries
|
|
800
|
+
* identify editors. Anonymous callers receive 401.
|
|
817
801
|
*
|
|
818
802
|
* The dataset 404-before-auth-query ordering ensures non-existent datasets
|
|
819
803
|
* return 404 without leaking audit log details.
|
|
@@ -969,21 +953,14 @@ export const loginAuthLoginPost = (options) => (options.client ?? client).post({
|
|
|
969
953
|
*
|
|
970
954
|
* Revoke all refresh tokens and bump token_version for the current user.
|
|
971
955
|
*
|
|
972
|
-
*
|
|
973
|
-
*
|
|
974
|
-
* are rejected on the next authenticated request — closing the
|
|
975
|
-
* "logout doesn't invalidate the access JWT" gap.
|
|
956
|
+
* Logout invalidates the access JWT used for this call and all other active
|
|
957
|
+
* browser sessions.
|
|
976
958
|
*
|
|
977
|
-
*
|
|
978
|
-
*
|
|
979
|
-
* must not revoke them. Security events (password change, role change) do.
|
|
959
|
+
* API keys remain valid because they are independent of browser sessions.
|
|
960
|
+
* Password and role changes still revoke them.
|
|
980
961
|
*
|
|
981
|
-
*
|
|
982
|
-
*
|
|
983
|
-
* after their 15-minute access token expired got a 401 here while their
|
|
984
|
-
* multi-day refresh cookie stayed valid — the UI reported a clean logout and
|
|
985
|
-
* the session survived it. CSRF is enforced on that path exactly as it is for
|
|
986
|
-
* /auth/refresh, since the cookie is then the credential.
|
|
962
|
+
* A refresh cookie can authenticate logout after the access token expires.
|
|
963
|
+
* Cookie-authenticated requests require CSRF validation.
|
|
987
964
|
*/
|
|
988
965
|
export const logoutAuthLogoutPost = (options) => (options?.client ?? client).post({
|
|
989
966
|
security: [
|
|
@@ -1002,6 +979,29 @@ export const logoutAuthLogoutPost = (options) => (options?.client ?? client).pos
|
|
|
1002
979
|
...options?.headers
|
|
1003
980
|
}
|
|
1004
981
|
});
|
|
982
|
+
/**
|
|
983
|
+
* Logout Current Session
|
|
984
|
+
*
|
|
985
|
+
* Revoke only the presented session's refresh-token family.
|
|
986
|
+
*
|
|
987
|
+
* Other devices and API keys survive. Access JWTs remain usable until their
|
|
988
|
+
* normal expiry; /logout/ still immediately revokes every access and refresh
|
|
989
|
+
* session. A valid signed access JWT with sid, a refresh body token, or a
|
|
990
|
+
* refresh cookie authorizes this operation. Legacy JWTs without sid must use
|
|
991
|
+
* the refresh credential. Cookie authorization requires double-submit CSRF.
|
|
992
|
+
*
|
|
993
|
+
* Bearer/body revocation does not change cookies, allowing a captured old
|
|
994
|
+
* session to be discarded safely after a newer login. Cookie authorization
|
|
995
|
+
* clears the browser's refresh and CSRF cookies.
|
|
996
|
+
*/
|
|
997
|
+
export const logoutCurrentSessionAuthLogoutSessionPost = (options) => (options?.client ?? client).post({
|
|
998
|
+
url: '/auth/logout/session/',
|
|
999
|
+
...options,
|
|
1000
|
+
headers: {
|
|
1001
|
+
'Content-Type': 'application/json',
|
|
1002
|
+
...options?.headers
|
|
1003
|
+
}
|
|
1004
|
+
});
|
|
1005
1005
|
/**
|
|
1006
1006
|
* Me
|
|
1007
1007
|
*
|
|
@@ -1478,8 +1478,8 @@ export const getCollectionItemFeatureCollectionsDatasetIdItemsFeatureIdGet = (op
|
|
|
1478
1478
|
*
|
|
1479
1479
|
* Queryable properties for one feature collection (OGC Features Part 3).
|
|
1480
1480
|
*
|
|
1481
|
-
*
|
|
1482
|
-
*
|
|
1481
|
+
* Derived from the live table schema rather than the stored column_info
|
|
1482
|
+
* snapshot, so the advertised set always matches what `filter=`
|
|
1483
1483
|
* on /items validates against. `additionalProperties: false` is what makes
|
|
1484
1484
|
* rejecting filters on unlisted properties spec-conformant.
|
|
1485
1485
|
*/
|
|
@@ -1570,7 +1570,7 @@ export const importConfigurationConfigOpsImportPost = (options) => (options.clie
|
|
|
1570
1570
|
/**
|
|
1571
1571
|
* Validate Configuration
|
|
1572
1572
|
*
|
|
1573
|
-
* Validate
|
|
1573
|
+
* Validate storage, cache, credential handoff, and enabled OIDC providers.
|
|
1574
1574
|
*
|
|
1575
1575
|
* Returns pass/fail with latency and error details for each service.
|
|
1576
1576
|
*/
|
|
@@ -2011,6 +2011,42 @@ export const getColumnValuesDatasetsDatasetIdColumnsColumnNameValuesGet = (optio
|
|
|
2011
2011
|
url: '/datasets/{dataset_id}/columns/{column_name}/values/',
|
|
2012
2012
|
...options
|
|
2013
2013
|
});
|
|
2014
|
+
/**
|
|
2015
|
+
* Get Pointcloud File
|
|
2016
|
+
*
|
|
2017
|
+
* Serve a published COPC point cloud's file, whole or by HTTP byte range.
|
|
2018
|
+
*
|
|
2019
|
+
* Point a client at the dataset's ``pointcloud.url``. The path names the
|
|
2020
|
+
* upload attempt, so a replaced file gets a new URL and the old one answers
|
|
2021
|
+
* 404. Header credentials (``X-Api-Key`` or ``Authorization``) or the
|
|
2022
|
+
* ``api_key`` query parameter authenticate the read, and any caller who can
|
|
2023
|
+
* view the dataset can read the file. The response carries a strong ETag and
|
|
2024
|
+
* honours ``Range``, ``If-Range``, ``If-Match`` and ``If-None-Match``; a
|
|
2025
|
+
* malformed byte range, or one naming no byte of the file, answers 416.
|
|
2026
|
+
* Each client may make 1200 reads a minute. A read of one byte range of up
|
|
2027
|
+
* to 16 MiB also draws its size on a budget of 1 GiB a minute, in 64 KiB
|
|
2028
|
+
* units; any other read of the file, such as one without ``Range``, counts
|
|
2029
|
+
* against a limit of 10 a minute instead. Past any of these the read answers
|
|
2030
|
+
* 429.
|
|
2031
|
+
* A page on any origin can read a public file without credentials. Through
|
|
2032
|
+
* the bundled web server it can also send header credentials; the API alone
|
|
2033
|
+
* accepts those only from the origins in ``CORS_ALLOWED_ORIGINS``. A
|
|
2034
|
+
* private, missing or replaced point cloud answers 404, and a storage
|
|
2035
|
+
* failure answers 502.
|
|
2036
|
+
*/
|
|
2037
|
+
export const getPointcloudFileDatasetsDatasetIdCopcAttemptIdNameCopcLazGet = (options) => (options.client ?? client).get({
|
|
2038
|
+
security: [
|
|
2039
|
+
{ scheme: 'bearer', type: 'http' },
|
|
2040
|
+
{ name: 'X-Api-Key', type: 'apiKey' },
|
|
2041
|
+
{
|
|
2042
|
+
in: 'query',
|
|
2043
|
+
name: 'api_key',
|
|
2044
|
+
type: 'apiKey'
|
|
2045
|
+
}
|
|
2046
|
+
],
|
|
2047
|
+
url: '/datasets/{dataset_id}/copc/{attempt_id}/{name}.copc.laz',
|
|
2048
|
+
...options
|
|
2049
|
+
});
|
|
2014
2050
|
/**
|
|
2015
2051
|
* Get Dcat Us3 Record
|
|
2016
2052
|
*
|
|
@@ -2088,8 +2124,12 @@ export const validateDcat3RecordDatasetsDatasetIdDcatValidationGet = (options) =
|
|
|
2088
2124
|
*
|
|
2089
2125
|
* Download the Cloud-Optimized GeoTIFF for a raster dataset.
|
|
2090
2126
|
*
|
|
2091
|
-
*
|
|
2092
|
-
*
|
|
2127
|
+
* On S3 storage with presigned downloads enabled, answers 302 to a
|
|
2128
|
+
* short-lived presigned URL (at most 5 minutes, and never past the expiry of
|
|
2129
|
+
* a ``?token=`` download token); otherwise streams the object with
|
|
2130
|
+
* Content-Type image/tiff. Even then, a GET carrying If-Match, or a resume
|
|
2131
|
+
* whose If-Range no longer matches, is streamed. A COG imported by reference
|
|
2132
|
+
* redirects to its origin.
|
|
2093
2133
|
* Accepts standard auth or ?token= JWT query parameter for browser downloads.
|
|
2094
2134
|
*
|
|
2095
2135
|
* ``user`` may be None when a no-sub anonymous
|
|
@@ -2139,23 +2179,15 @@ export const exportDatasetEndpointDatasetsDatasetIdExportGet = (options) => (opt
|
|
|
2139
2179
|
*
|
|
2140
2180
|
* Return up to 5,000 features as RFC 7946 GeoJSON with Z coordinates.
|
|
2141
2181
|
*
|
|
2142
|
-
*
|
|
2143
|
-
*
|
|
2144
|
-
* shared-map union now exposes embed-scoped private layers to embeds — so
|
|
2145
|
-
* this endpoint accepts the token as fallback authorization via the SAME
|
|
2146
|
-
* ``validate_embed_token_access`` capability check as tile serving.
|
|
2182
|
+
* ``X-Embed-Token`` authorizes private datasets in the token's scope through
|
|
2183
|
+
* the same capability check used for tile requests.
|
|
2147
2184
|
*
|
|
2148
|
-
*
|
|
2149
|
-
*
|
|
2150
|
-
*
|
|
2151
|
-
* 404 for anon and follow full RBAC for credentialed callers. This unblocks
|
|
2152
|
-
* client clustering for anonymous public-map viewers.
|
|
2185
|
+
* Anonymous callers can read public, published datasets. Private or
|
|
2186
|
+
* restricted datasets return 404 unless user or embed credentials authorize
|
|
2187
|
+
* access.
|
|
2153
2188
|
*
|
|
2154
|
-
*
|
|
2155
|
-
*
|
|
2156
|
-
* frontend's refresh-on-401 retry fires instead of a private layer
|
|
2157
|
-
* permanently failing as "not found". Truly credentialless requests keep the
|
|
2158
|
-
* anonymous public path.
|
|
2189
|
+
* Supplied credentials that are expired or revoked receive 401 so clients can
|
|
2190
|
+
* refresh them. Requests without credentials use the anonymous access path.
|
|
2159
2191
|
*/
|
|
2160
2192
|
export const getFeaturesGeojsonZEndpointDatasetsDatasetIdFeaturesGeojsonGet = (options) => (options.client ?? client).get({
|
|
2161
2193
|
security: [
|
|
@@ -2175,9 +2207,9 @@ export const getFeaturesGeojsonZEndpointDatasetsDatasetIdFeaturesGeojsonGet = (o
|
|
|
2175
2207
|
*
|
|
2176
2208
|
* Get paginated GeoJSON features for a dataset.
|
|
2177
2209
|
*
|
|
2178
|
-
*
|
|
2179
|
-
*
|
|
2180
|
-
*
|
|
2210
|
+
* Offset pagination can skip or duplicate rows during concurrent writes,
|
|
2211
|
+
* though feature ids remain stable because rows are ordered by the primary
|
|
2212
|
+
* key. Clients that need stable
|
|
2181
2213
|
* cursoring should use the OGC API Features endpoint, which supports keyset
|
|
2182
2214
|
* pagination via ``after_gid``.
|
|
2183
2215
|
*/
|
|
@@ -2220,6 +2252,11 @@ export const createFeatureDatasetsDatasetIdFeaturesPost = (options) => (options.
|
|
|
2220
2252
|
* Delete Single Feature
|
|
2221
2253
|
*
|
|
2222
2254
|
* Delete a feature by gid (hard delete).
|
|
2255
|
+
*
|
|
2256
|
+
* The X-GeoLens-Tile-Cache-Version response header carries the dataset's
|
|
2257
|
+
* tile_cache_version after the delete committed; a 204 response has no
|
|
2258
|
+
* body to carry it in, unlike the create, replace and patch endpoints,
|
|
2259
|
+
* which return it as a field of the written feature.
|
|
2223
2260
|
*/
|
|
2224
2261
|
export const deleteSingleFeatureDatasetsDatasetIdFeaturesGidDelete = (options) => (options.client ?? client).delete({
|
|
2225
2262
|
security: [
|
|
@@ -2415,20 +2452,19 @@ export const getQuicklookDatasetsDatasetIdQuicklookGet = (options) => (options.c
|
|
|
2415
2452
|
* complete, so a refresh that fails leaves the live table and its freshness
|
|
2416
2453
|
* exactly as they were.
|
|
2417
2454
|
*
|
|
2418
|
-
*
|
|
2419
|
-
*
|
|
2420
|
-
*
|
|
2455
|
+
* Different origin kinds use different execution strategies. A dataset
|
|
2456
|
+
* registered from an existing PostGIS table serves directly from its origin,
|
|
2457
|
+
* so refresh re-measures the
|
|
2421
2458
|
* live relation — recounting features, recomputing the extent, rebuilding
|
|
2422
2459
|
* the column schema snapshot and statistics. A dataset imported from a STAC
|
|
2423
|
-
* item
|
|
2460
|
+
* item points to an external COG, so its
|
|
2424
2461
|
* refresh re-reads the item document and follows the asset if the publisher
|
|
2425
2462
|
* moved it. Admission, the run row and the history they write are identical
|
|
2426
2463
|
* across all three.
|
|
2427
2464
|
*
|
|
2428
2465
|
* Refuses with 409 ``dataset_busy`` while another refresh or re-upload is
|
|
2429
|
-
* active for this dataset
|
|
2430
|
-
*
|
|
2431
|
-
* simultaneous clicks cannot both be admitted.
|
|
2466
|
+
* active for this dataset. A partial unique index prevents simultaneous
|
|
2467
|
+
* requests from both being admitted.
|
|
2432
2468
|
*/
|
|
2433
2469
|
export const refreshDatasetDatasetsDatasetIdRefreshPost = (options) => (options.client ?? client).post({
|
|
2434
2470
|
security: [
|
|
@@ -2450,24 +2486,11 @@ export const refreshDatasetDatasetsDatasetIdRefreshPost = (options) => (options.
|
|
|
2450
2486
|
/**
|
|
2451
2487
|
* List Dataset Refresh Runs
|
|
2452
2488
|
*
|
|
2453
|
-
*
|
|
2454
|
-
*
|
|
2455
|
-
* Durable across the `ingest_jobs` retention purge — that purge is why this
|
|
2456
|
-
* table exists rather than the jobs table serving as the record (#1219).
|
|
2457
|
-
*
|
|
2458
|
-
* Access follows Rule 1 on the read path, and ADR-002 Decision 4e adds field
|
|
2459
|
-
* redaction on top: a caller who is neither the dataset owner nor an admin
|
|
2460
|
-
* sees the timeline and outcomes but not who triggered each run, nor the
|
|
2461
|
-
* failure text, nor the schema diff. Without that, a PUBLIC dataset's
|
|
2462
|
-
* history enumerates its editors and leaks origin detail through error
|
|
2463
|
-
* strings. The redaction is tested against a NAMED signed-in third party as
|
|
2464
|
-
* well as an anonymous reader; a requester-scoped check that only exercises
|
|
2465
|
-
* the anonymous case reads as complete and is not.
|
|
2489
|
+
* Return durable refresh history for a dataset.
|
|
2466
2490
|
*
|
|
2467
|
-
*
|
|
2468
|
-
*
|
|
2469
|
-
*
|
|
2470
|
-
* one out among the three.
|
|
2491
|
+
* Readers can see the timeline and outcomes. Only the dataset owner and
|
|
2492
|
+
* admins can see actors, failure details, schema changes, and verification
|
|
2493
|
+
* source data.
|
|
2471
2494
|
*/
|
|
2472
2495
|
export const listDatasetRefreshRunsDatasetsDatasetIdRefreshRunsGet = (options) => (options.client ?? client).get({
|
|
2473
2496
|
security: [
|
|
@@ -2781,6 +2804,40 @@ export const setTargetStatusDatasetsDatasetIdTargetStatusPatch = (options) => (o
|
|
|
2781
2804
|
...options.headers
|
|
2782
2805
|
}
|
|
2783
2806
|
});
|
|
2807
|
+
/**
|
|
2808
|
+
* Get Tileset File
|
|
2809
|
+
*
|
|
2810
|
+
* Serve one file of a published 3D Tiles tileset.
|
|
2811
|
+
*
|
|
2812
|
+
* Point a client at the dataset's ``tileset.url``, this route's
|
|
2813
|
+
* ``tileset.json``; the relative URIs inside the tileset resolve to this
|
|
2814
|
+
* same route. Header credentials (``X-Api-Key`` or ``Authorization``)
|
|
2815
|
+
* authenticate every file of a private tileset. A query-string ``api_key``
|
|
2816
|
+
* authenticates only the request it is on, so the tileset's relative URIs
|
|
2817
|
+
* lose it unless the client carries it over, as CesiumJS does through
|
|
2818
|
+
* ``Resource`` query parameters. A browser page on any origin can read a
|
|
2819
|
+
* public tileset without credentials; one that sends credentials needs its
|
|
2820
|
+
* origin on the deployment's CORS allowlist (``CORS_ALLOWED_ORIGINS``).
|
|
2821
|
+
* Every file carries the published tileset's
|
|
2822
|
+
* ETag and asks the client to revalidate before each reuse. Once the caller
|
|
2823
|
+
* has access and the file exists, an ``If-None-Match`` naming the current
|
|
2824
|
+
* version answers 304 and an ``If-Match`` naming another answers 412. A
|
|
2825
|
+
* private or missing tileset and a missing file all answer 404, conditional
|
|
2826
|
+
* requests included, and a storage failure answers 502.
|
|
2827
|
+
*/
|
|
2828
|
+
export const getTilesetFileDatasetsDatasetIdTiles3dPathGet = (options) => (options.client ?? client).get({
|
|
2829
|
+
security: [
|
|
2830
|
+
{ scheme: 'bearer', type: 'http' },
|
|
2831
|
+
{ name: 'X-Api-Key', type: 'apiKey' },
|
|
2832
|
+
{
|
|
2833
|
+
in: 'query',
|
|
2834
|
+
name: 'api_key',
|
|
2835
|
+
type: 'apiKey'
|
|
2836
|
+
}
|
|
2837
|
+
],
|
|
2838
|
+
url: '/datasets/{dataset_id}/tiles3d/{path}',
|
|
2839
|
+
...options
|
|
2840
|
+
});
|
|
2784
2841
|
/**
|
|
2785
2842
|
* Validate Dataset
|
|
2786
2843
|
*
|
|
@@ -2809,12 +2866,10 @@ export const validateDatasetDatasetsDatasetIdValidateGet = (options) => (options
|
|
|
2809
2866
|
*
|
|
2810
2867
|
* Get paginated version history for a dataset.
|
|
2811
2868
|
*
|
|
2812
|
-
*
|
|
2813
|
-
* top follows the same owner-or-admin predicate as refresh-runs and dataset
|
|
2814
|
-
* reads — a caller who is neither the owner nor an admin gets the version
|
|
2869
|
+
* A caller who is neither the owner nor an administrator gets the version
|
|
2815
2870
|
* timeline (filenames, formats, feature counts) but not ``file_hash`` or
|
|
2816
|
-
* ``uploaded_by``.
|
|
2817
|
-
*
|
|
2871
|
+
* ``uploaded_by``. This prevents public version history from identifying
|
|
2872
|
+
* editors.
|
|
2818
2873
|
*/
|
|
2819
2874
|
export const getDatasetVersionsEndpointDatasetsDatasetIdVersionsGet = (options) => (options.client ?? client).get({
|
|
2820
2875
|
security: [
|
|
@@ -2955,7 +3010,9 @@ export const commitFanOutIngestCommitFanOutJobIdPost = (options) => (options.cli
|
|
|
2955
3010
|
* Commit a staged file for ingestion with user-supplied metadata.
|
|
2956
3011
|
*
|
|
2957
3012
|
* Stores user metadata on the job and queues the ingest task.
|
|
2958
|
-
* Only callable on jobs with status 'pending'.
|
|
3013
|
+
* Only callable on jobs with status 'pending'. A 3D Tiles tileset's unpacked
|
|
3014
|
+
* size and a point cloud's size are checked against the storage quota again
|
|
3015
|
+
* here.
|
|
2959
3016
|
*/
|
|
2960
3017
|
export const commitImportIngestCommitJobIdPost = (options) => (options.client ?? client).post({
|
|
2961
3018
|
security: [
|
|
@@ -3026,6 +3083,11 @@ export const applyManifestEndpointIngestManifestApplyPost = (options) => (option
|
|
|
3026
3083
|
*
|
|
3027
3084
|
* For vector files: returns columns, CRS, geometry type, feature count, sample rows.
|
|
3028
3085
|
* For raster files: returns band count, CRS, resolution, compliance status.
|
|
3086
|
+
* For a 3D Tiles tileset: returns its version, root geometric error, bounding
|
|
3087
|
+
* volume kind, extent and unpacked size, read from the archive's directory
|
|
3088
|
+
* and tileset.json without unpacking it.
|
|
3089
|
+
* For a COPC point cloud: returns its point count and format, CRS, extent,
|
|
3090
|
+
* elevation range and size, read from its header and hierarchy.
|
|
3029
3091
|
* Only callable on jobs with status 'pending'.
|
|
3030
3092
|
*/
|
|
3031
3093
|
export const previewFileIngestPreviewJobIdPost = (options) => (options.client ?? client).post({
|
|
@@ -3186,21 +3248,20 @@ export const completePresignedUploadIngestUploadPresignedJobIdCompletePost = (op
|
|
|
3186
3248
|
*
|
|
3187
3249
|
* Start importing a geospatial file from an HTTP(S) URL.
|
|
3188
3250
|
*
|
|
3189
|
-
*
|
|
3190
|
-
*
|
|
3191
|
-
*
|
|
3251
|
+
* The server fetches the file and sends the staged bytes through the same
|
|
3252
|
+
* preview and commit pipeline as a direct upload. With ``kind`` set to
|
|
3253
|
+
* ``tiles3d`` the URL names a 3D Tiles tileset archive, which the worker
|
|
3254
|
+
* checks as the upload door does before the job becomes previewable.
|
|
3192
3255
|
*
|
|
3193
|
-
*
|
|
3194
|
-
*
|
|
3256
|
+
* The download runs as a background job. This call validates the URL and
|
|
3257
|
+
* returns a job id immediately; poll ``GET /jobs/{job_id}`` and
|
|
3195
3258
|
* preview once the job reaches ``pending``. While the file is downloading
|
|
3196
3259
|
* the job reports status ``running`` with step ``downloading``.
|
|
3197
3260
|
*
|
|
3198
|
-
*
|
|
3199
|
-
*
|
|
3200
|
-
*
|
|
3201
|
-
*
|
|
3202
|
-
* content sniff as a direct upload, and GDAL only ever sees the staged
|
|
3203
|
-
* local file.
|
|
3261
|
+
* URL validation, connection-time IP pinning, and per-hop redirect checks
|
|
3262
|
+
* protect the download from SSRF. The worker enforces the size cap while
|
|
3263
|
+
* streaming, validates the staged file like a direct upload, and gives GDAL
|
|
3264
|
+
* only the local staged file.
|
|
3204
3265
|
*/
|
|
3205
3266
|
export const uploadFromUrlIngestUploadUrlPost = (options) => (options.client ?? client).post({
|
|
3206
3267
|
security: [
|
|
@@ -3383,22 +3444,14 @@ export const getJobStatusJobsJobIdGet = (options) => (options.client ?? client).
|
|
|
3383
3444
|
/**
|
|
3384
3445
|
* Cancel Job
|
|
3385
3446
|
*
|
|
3386
|
-
* Cancel a pending or running ingest job
|
|
3387
|
-
* other IngestJob-shaped run — feat(#1677)).
|
|
3447
|
+
* Cancel a pending or running ingest job.
|
|
3388
3448
|
*
|
|
3389
|
-
* The
|
|
3390
|
-
*
|
|
3391
|
-
*
|
|
3392
|
-
* never hears the abort still cannot install data afterwards, because every
|
|
3393
|
-
* finalize site runs its fenced job update inside the swap transaction and
|
|
3394
|
-
* ``require_ingest_job_update`` raises on the cancelled row, rolling the
|
|
3395
|
-
* swap back. The Procrastinate ``abort=True`` request afterwards is
|
|
3396
|
-
* best-effort acceleration only.
|
|
3449
|
+
* The database marks the job and any bound refresh run as cancelled before
|
|
3450
|
+
* requesting a queue abort. Transaction fencing prevents a worker from
|
|
3451
|
+
* installing data after cancellation even if it misses the abort request.
|
|
3397
3452
|
*
|
|
3398
|
-
*
|
|
3399
|
-
*
|
|
3400
|
-
* anyone with write access to the job's dataset, so a dataset's owner can
|
|
3401
|
-
* always unblock their own dataset from a run someone else started.
|
|
3453
|
+
* The job creator, a user with cross-user job permission, or anyone with
|
|
3454
|
+
* write access to the job's dataset may cancel it.
|
|
3402
3455
|
*/
|
|
3403
3456
|
export const cancelJobJobsJobIdCancelPost = (options) => (options.client ?? client).post({
|
|
3404
3457
|
security: [
|
|
@@ -3529,9 +3582,8 @@ export const renameColumnEndpointLayersDatasetIdColumnsColumnNameNamePatch = (op
|
|
|
3529
3582
|
*
|
|
3530
3583
|
* Count saved maps whose layer config references a column.
|
|
3531
3584
|
*
|
|
3532
|
-
*
|
|
3533
|
-
*
|
|
3534
|
-
* titles may belong to other users and are not exposed here.
|
|
3585
|
+
* The schema editor uses this count before a rename or drop. Map titles are
|
|
3586
|
+
* omitted because they may belong to other users.
|
|
3535
3587
|
*/
|
|
3536
3588
|
export const columnReferencesEndpointLayersDatasetIdColumnsColumnNameReferencesGet = (options) => (options.client ?? client).get({
|
|
3537
3589
|
security: [
|
|
@@ -3578,6 +3630,7 @@ export const alterColumnTypeEndpointLayersDatasetIdColumnsColumnNameTypePatch =
|
|
|
3578
3630
|
*
|
|
3579
3631
|
* Supports search (ILIKE on name+description), sort_by (name/created_at/updated_at),
|
|
3580
3632
|
* sort_dir (asc/desc), and visibility filter (private/internal/public).
|
|
3633
|
+
* owned_only restricts results to the caller's maps; anonymous callers get no maps.
|
|
3581
3634
|
*/
|
|
3582
3635
|
export const listMapsEndpointMapsGet = (options) => (options?.client ?? client).get({
|
|
3583
3636
|
security: [
|
|
@@ -3707,8 +3760,7 @@ export const importMapStyleEndpointMapsImportPost = (options) => (options.client
|
|
|
3707
3760
|
* empty, defaults to ``frame-ancestors 'self'``. The SecurityHeadersMiddleware
|
|
3708
3761
|
* respects this route-level CSP and skips emitting X-Frame-Options: DENY.
|
|
3709
3762
|
*
|
|
3710
|
-
*
|
|
3711
|
-
* token's scope authorizes, as a capability rather than a role.
|
|
3763
|
+
* ``X-Embed-Token`` grants access to layers in the token's scope.
|
|
3712
3764
|
*/
|
|
3713
3765
|
export const getSharedMapEndpointMapsSharedTokenGet = (options) => (options.client ?? client).get({
|
|
3714
3766
|
security: [
|
|
@@ -5400,11 +5452,11 @@ export const searchPostStacSearchPost = (options) => (options.client ?? client).
|
|
|
5400
5452
|
*
|
|
5401
5453
|
* A tile holding no features answers 204, and a repeat request whose
|
|
5402
5454
|
* ``If-None-Match`` matches answers 304. Where a deployment runs cold storage,
|
|
5403
|
-
* a dataset still being restored answers 202 with a job id to poll.
|
|
5404
|
-
*
|
|
5405
|
-
*
|
|
5406
|
-
* timeout,
|
|
5407
|
-
* failure serving the tile answers 503.
|
|
5455
|
+
* a dataset still being restored answers 202 with a job id to poll. Requests
|
|
5456
|
+
* answer 429 with ``Retry-After`` when the per-process capacity for uncached
|
|
5457
|
+
* renders is full, tile-pool acquisition times out, a tile query exceeds the
|
|
5458
|
+
* pool's per-command timeout, or the configured per-tenant concurrency limit
|
|
5459
|
+
* is exceeded. Any other failure serving the tile answers 503.
|
|
5408
5460
|
*/
|
|
5409
5461
|
export const clusterTileEndpointTilesClustersTablePathZXYPbfGet = (options) => (options.client ?? client).get({
|
|
5410
5462
|
security: [
|
|
@@ -5556,7 +5608,8 @@ export const getTileTokensBatchTilesTokensPost = (options) => (options.client ??
|
|
|
5556
5608
|
* public dataset that is not yet published is readable by its owner, by an
|
|
5557
5609
|
* admin, with an embed token, or with valid signature parameters, and answers
|
|
5558
5610
|
* 404 to other callers, so a refusal keeps its existence undisclosed. An
|
|
5559
|
-
* unknown table is 404 too
|
|
5611
|
+
* unknown table is 404 too, and so is a dataset without vector tiles, such as
|
|
5612
|
+
* a raster, once the caller is authorized to see it.
|
|
5560
5613
|
*
|
|
5561
5614
|
* A request that no capability authorized and that carried a credential which
|
|
5562
5615
|
* did not resolve is refused with 401 rather than served as an anonymous
|
|
@@ -5574,11 +5627,11 @@ export const getTileTokensBatchTilesTokensPost = (options) => (options.client ??
|
|
|
5574
5627
|
* A malformed table path or an out-of-range tile coordinate answers 400. A
|
|
5575
5628
|
* tile holding no features answers 204, and a repeat request whose
|
|
5576
5629
|
* ``If-None-Match`` matches answers 304. Where a deployment runs cold storage,
|
|
5577
|
-
* a dataset still being restored answers 202 with a job id to poll.
|
|
5578
|
-
*
|
|
5579
|
-
*
|
|
5580
|
-
* timeout,
|
|
5581
|
-
* failure serving the tile answers 503.
|
|
5630
|
+
* a dataset still being restored answers 202 with a job id to poll. Requests
|
|
5631
|
+
* answer 429 with ``Retry-After`` when the per-process capacity for uncached
|
|
5632
|
+
* renders is full, tile-pool acquisition times out, a tile query exceeds the
|
|
5633
|
+
* pool's per-command timeout, or the configured per-tenant concurrency limit
|
|
5634
|
+
* is exceeded. Any other failure serving the tile answers 503.
|
|
5582
5635
|
*/
|
|
5583
5636
|
export const tileEndpointTilesTablePathZXYPbfGet = (options) => (options.client ?? client).get({
|
|
5584
5637
|
security: [
|