{"openapi":"3.1.0","info":{"title":"GFW DATA API","description":"Use GFW DATA API to explore, manage and access data.","version":"0.3.0","x-logo":{"url":"/static/gfw-data-api.png"}},"paths":{"/auth/sign-up":{"post":{"tags":["Authentication"],"summary":"Sign Up","operationId":"sign_up_auth_sign_up_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SignUpRequestIn"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/auth/token":{"post":{"tags":["Authentication"],"summary":"Get Token","description":"Get access token from RW API.","operationId":"get_token_auth_token_post","requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"$ref":"#/components/schemas/Body_get_token_auth_token_post"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/auth/apikey":{"post":{"tags":["Authentication"],"summary":"Create Api Key","description":"Request a new API key.\n\nDefault keys are valid for one year","operationId":"create_api_key_auth_apikey_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/APIKeyRequestIn"}}},"required":true},"responses":{"201":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"OAuth2PasswordBearer":[]}]}},"/auth/apikey/{api_key}":{"get":{"tags":["Authentication"],"summary":"Get Api Key","description":"Get details for a specific API Key.\n\nUser must own API Key or must be Admin to see details.","operationId":"get_api_key_auth_apikey__api_key__get","parameters":[{"description":"API Key","required":true,"schema":{"type":"string","format":"uuid","title":"Api Key","description":"API Key"},"name":"api_key","in":"path"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"OAuth2PasswordBearer":[]}]},"delete":{"tags":["Authentication"],"summary":"Delete Api Key","description":"Delete existing API key.\n\nAPI Key must belong to user.","operationId":"delete_api_key_auth_apikey__api_key__delete","parameters":[{"description":"Api Key to delete. Must be owned by authenticated user.","required":true,"schema":{"type":"string","format":"uuid","title":"Api Key","description":"Api Key to delete. Must be owned by authenticated user."},"name":"api_key","in":"path"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"OAuth2PasswordBearer":[]}]}},"/auth/apikeys":{"get":{"tags":["Authentication"],"summary":"Get Api Keys","description":"Request a new API key.\n\nDefault keys are valid for one year","operationId":"get_api_keys_auth_apikeys_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}}},"security":[{"OAuth2PasswordBearer":[]}]}},"/auth/apikey/{api_key}/validate":{"get":{"tags":["Authentication"],"summary":"Validate Api Key","description":"Check if a given API key is valid.","operationId":"validate_api_key_auth_apikey__api_key__validate_get","parameters":[{"description":"Api Key to validate. Must be owned by authenticated user.","required":true,"schema":{"type":"string","format":"uuid","title":"Api Key","description":"Api Key to validate. Must be owned by authenticated user."},"name":"api_key","in":"path"},{"description":"Origin used with API Key","required":false,"schema":{"type":"string","title":"Origin","description":"Origin used with API Key"},"name":"origin","in":"query"},{"description":"Referrer of call used with API Key","required":false,"schema":{"type":"string","title":"Referrer","description":"Referrer of call used with API Key"},"name":"referrer","in":"query"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"OAuth2PasswordBearer":[]}]}},"/datasets":{"get":{"tags":["Datasets"],"summary":"Get Datasets","description":"Get list of all datasets.\n\nWill attempt to paginate if `page[size]` or `page[number]` is\nprovided. Otherwise, it will attempt to return the entire list of\ndatasets in the response.","operationId":"get_datasets_datasets_get","parameters":[{"description":"The page number.","required":false,"schema":{"type":"integer","minimum":1.0,"title":"Page[Number]","description":"The page number."},"name":"page[number]","in":"query"},{"description":"The number of datasets per page. Default is `10`.","required":false,"schema":{"type":"integer","minimum":1.0,"title":"Page[Size]","description":"The number of datasets per page. Default is `10`."},"name":"page[size]","in":"query"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"anyOf":[{"$ref":"#/components/schemas/PaginatedDatasetsResponse"},{"$ref":"#/components/schemas/DatasetsResponse"}],"title":"Response Get Datasets Datasets Get"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/dataset/{dataset}":{"get":{"tags":["Datasets"],"summary":"Get Dataset","description":"Get basic metadata and available versions for a given dataset.","operationId":"get_dataset_dataset__dataset__get","parameters":[{"required":true,"schema":{"type":"string","pattern":"^[a-z][a-z0-9_-]{2,}$","title":"Dataset"},"name":"dataset","in":"path"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DatasetResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"put":{"tags":["Datasets"],"summary":"Create Dataset","description":"Create a dataset. A “dataset” is largely a metadata concept: it\nrepresents a data product that may have multiple versions or file formats\nover time. The user that creates a dataset using this operation becomes the\nowner of the dataset, which provides the user with the privileges to do\nfurther write operations on the dataset, including creating and modifying\nversions and assets.\n\nThis operation requires a `MANAGER` or an `ADMIN` user role.","operationId":"create_dataset_dataset__dataset__put","parameters":[{"required":true,"schema":{"type":"string","pattern":"^[a-z][a-z0-9_-]{2,}$","title":"Dataset"},"name":"dataset","in":"path"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DatasetCreateIn"}}},"required":true},"responses":{"201":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DatasetResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"OAuth2PasswordBearer":[]}]},"delete":{"tags":["Datasets"],"summary":"Delete Dataset","description":"Delete a dataset.\n\nBy the time users are allowed to delete datasets, there should be no\nversions and assets left. So only thing beside deleting the dataset\nrow is to drop the schema in the database.\n\nOnly the dataset owner or a user with `ADMIN` user role can do this operation.","operationId":"delete_dataset_dataset__dataset__delete","parameters":[{"required":true,"schema":{"type":"string","pattern":"^[a-z][a-z0-9_-]{2,}$","title":"Dataset"},"name":"dataset","in":"path"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DatasetResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"OAuth2PasswordBearer":[]}]},"patch":{"tags":["Datasets"],"summary":"Update Dataset","description":"Update metadata, accessibility or ownership of a dataset.\n\nIndividual fields of the metadata can be modified, without affecting other\nexisting fields.","operationId":"update_dataset_dataset__dataset__patch","parameters":[{"required":true,"schema":{"type":"string","pattern":"^[a-z][a-z0-9_-]{2,}$","title":"Dataset"},"name":"dataset","in":"path"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DatasetUpdateIn"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DatasetResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"OAuth2PasswordBearer":[]}]}},"/dataset/{dataset}/{version}":{"get":{"tags":["Versions"],"summary":"Get Version","description":"Get basic metadata for a given version. The list of assets only includes\nsaved (non-pending and non-failed) assets and is sorted by\nthe creation time of each asset.","operationId":"get_version_dataset__dataset___version__get","parameters":[{"required":true,"schema":{"type":"string","pattern":"^[a-z][a-z0-9_-]{2,}$","title":"Dataset"},"name":"dataset","in":"path"},{"required":true,"schema":{"type":"string","pattern":"^v\\d{1,8}(\\.\\d{1,3}){0,2}?$|^latest$","title":"Dataset version"},"name":"version","in":"path"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/VersionResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"put":{"tags":["Versions"],"summary":"Add New Version","description":"Create a version for a given dataset by uploading the tabular, vector,\nor raster asset.\n\nOnly the dataset's owner or a user with `ADMIN` user role can do\nthis operation.","operationId":"add_new_version_dataset__dataset___version__put","parameters":[{"required":true,"schema":{"type":"string","pattern":"^[a-z][a-z0-9_-]{2,}$","title":"Dataset"},"name":"dataset","in":"path"},{"required":true,"schema":{"type":"string","pattern":"^v\\d{1,8}(\\.\\d{1,3}){0,2}?$|^latest$","title":"Dataset version"},"name":"version","in":"path"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/VersionCreateIn"}}},"required":true},"responses":{"202":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/VersionResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"OAuth2PasswordBearer":[]}]},"delete":{"tags":["Versions"],"summary":"Delete Version","description":"Delete a version.\n\nOnly delete version if it is not tagged as `latest` or if it is the\nonly version associated with dataset. All associated, managed assets\nwill be deleted in consequence.\n\nOnly the dataset's owner or a user with `ADMIN` user role can do this operation.","operationId":"delete_version_dataset__dataset___version__delete","parameters":[{"required":true,"schema":{"type":"string","pattern":"^[a-z][a-z0-9_-]{2,}$","title":"Dataset"},"name":"dataset","in":"path"},{"required":true,"schema":{"type":"string","pattern":"^v\\d{1,8}(\\.\\d{1,3}){0,2}?$|^latest$","title":"Dataset version"},"name":"version","in":"path"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/VersionResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"OAuth2PasswordBearer":[]}]},"patch":{"tags":["Versions"],"summary":"Update Version","description":"Partially update a version of a given dataset.\n\nUpdate metadata or change latest tag.\n\nOnly the dataset's owner or a user with `ADMIN` user role can do this operation.","operationId":"update_version_dataset__dataset___version__patch","parameters":[{"required":true,"schema":{"type":"string","pattern":"^[a-z][a-z0-9_-]{2,}$","title":"Dataset"},"name":"dataset","in":"path"},{"required":true,"schema":{"type":"string","pattern":"^v\\d{1,8}(\\.\\d{1,3}){0,2}?$|^latest$","title":"Dataset version"},"name":"version","in":"path"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/VersionUpdateIn"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/VersionResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"OAuth2PasswordBearer":[]}]}},"/dataset/{dataset}/{version}/append":{"post":{"tags":["Versions"],"summary":"Append To Version","description":"Append new data to an existing (geo)database table.\n\nSchema of input file must match or be a subset of previous input\nfiles.\n\nOnly the dataset's owner or a user with `ADMIN` user role can do this operation.","operationId":"append_to_version_dataset__dataset___version__append_post","parameters":[{"required":true,"schema":{"type":"string","pattern":"^[a-z][a-z0-9_-]{2,}$","title":"Dataset"},"name":"dataset","in":"path"},{"required":true,"schema":{"type":"string","pattern":"^v\\d{1,8}(\\.\\d{1,3}){0,2}?$|^latest$","title":"Dataset version"},"name":"version","in":"path"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/VersionAppendIn"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/VersionResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"OAuth2PasswordBearer":[]}]}},"/dataset/{dataset}/{version}/change_log":{"get":{"tags":["Versions"],"summary":"Get Change Log","operationId":"get_change_log_dataset__dataset___version__change_log_get","parameters":[{"required":true,"schema":{"type":"string","pattern":"^[a-z][a-z0-9_-]{2,}$","title":"Dataset"},"name":"dataset","in":"path"},{"required":true,"schema":{"type":"string","pattern":"^v\\d{1,8}(\\.\\d{1,3}){0,2}?$|^latest$","title":"Dataset version"},"name":"version","in":"path"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ChangeLogResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/dataset/{dataset}/{version}/creation_options":{"get":{"tags":["Versions"],"summary":"Get Creation Options","operationId":"get_creation_options_dataset__dataset___version__creation_options_get","parameters":[{"required":true,"schema":{"type":"string","pattern":"^[a-z][a-z0-9_-]{2,}$","title":"Dataset"},"name":"dataset","in":"path"},{"required":true,"schema":{"type":"string","pattern":"^v\\d{1,8}(\\.\\d{1,3}){0,2}?$|^latest$","title":"Dataset version"},"name":"version","in":"path"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreationOptionsResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/dataset/{dataset}/{version}/extent":{"get":{"tags":["Versions"],"summary":"Get Extent","operationId":"get_extent_dataset__dataset___version__extent_get","parameters":[{"required":true,"schema":{"type":"string","pattern":"^[a-z][a-z0-9_-]{2,}$","title":"Dataset"},"name":"dataset","in":"path"},{"required":true,"schema":{"type":"string","pattern":"^v\\d{1,8}(\\.\\d{1,3}){0,2}?$|^latest$","title":"Dataset version"},"name":"version","in":"path"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExtentResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/dataset/{dataset}/{version}/stats":{"get":{"tags":["Versions"],"summary":"Get Stats","description":"Retrieve Asset Statistics.","operationId":"get_stats_dataset__dataset___version__stats_get","parameters":[{"required":true,"schema":{"type":"string","pattern":"^[a-z][a-z0-9_-]{2,}$","title":"Dataset"},"name":"dataset","in":"path"},{"required":true,"schema":{"type":"string","pattern":"^v\\d{1,8}(\\.\\d{1,3}){0,2}?$|^latest$","title":"Dataset version"},"name":"version","in":"path"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StatsResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/dataset/{dataset}/{version}/fields":{"get":{"tags":["Versions"],"summary":"Get Fields","description":"Get the fields of a version.  For a version with a vector default asset,\nthese are the fields (attributes) of the features of the base vector dataset.\n\nFor a version with a raster default asset, the fields are all the raster\ntile sets that use the same grid as the raster default asset.  Also\nincluded are some fields with special meaning such as 'area__ha',\n'latitude', and 'longitude'.","operationId":"get_fields_dataset__dataset___version__fields_get","parameters":[{"required":true,"schema":{"type":"string","pattern":"^[a-z][a-z0-9_-]{2,}$","title":"Dataset"},"name":"dataset","in":"path"},{"required":true,"schema":{"type":"string","pattern":"^v\\d{1,8}(\\.\\d{1,3}){0,2}?$|^latest$","title":"Dataset version"},"name":"version","in":"path"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"anyOf":[{"$ref":"#/components/schemas/FieldsMetadataResponse"},{"$ref":"#/components/schemas/RasterBandsMetadataResponse"}],"title":"Response Get Fields Dataset  Dataset   Version  Fields Get"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/dataset/{dataset}/{version}/metadata":{"get":{"tags":["Versions"],"summary":"Get Metadata","description":"Get metadata record for a dataset version.","operationId":"get_metadata_dataset__dataset___version__metadata_get","parameters":[{"required":true,"schema":{"type":"string","pattern":"^[a-z][a-z0-9_-]{2,}$","title":"Dataset"},"name":"dataset","in":"path"},{"required":true,"schema":{"type":"string","pattern":"^v\\d{1,8}(\\.\\d{1,3}){0,2}?$|^latest$","title":"Dataset version"},"name":"version","in":"path"},{"description":"Whether to include dataset metadata.","required":false,"schema":{"type":"boolean","title":"Include Dataset Metadata","description":"Whether to include dataset metadata.","default":false},"name":"include_dataset_metadata","in":"query"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"anyOf":[{"$ref":"#/components/schemas/VersionMetadataWithParentResponse"},{"$ref":"#/components/schemas/VersionMetadataResponse"}],"title":"Response Get Metadata Dataset  Dataset   Version  Metadata Get"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"post":{"tags":["Versions"],"summary":"Create Metadata","description":"Create a metadata record for a dataset version.\n\nOnly the dataset's owner or a user with `ADMIN` user role can do\nthis operation.","operationId":"create_metadata_dataset__dataset___version__metadata_post","parameters":[{"required":true,"schema":{"type":"string","pattern":"^[a-z][a-z0-9_-]{2,}$","title":"Dataset"},"name":"dataset","in":"path"},{"required":true,"schema":{"type":"string","pattern":"^v\\d{1,8}(\\.\\d{1,3}){0,2}?$|^latest$","title":"Dataset version"},"name":"version","in":"path"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/VersionMetadataIn"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/VersionMetadataResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"OAuth2PasswordBearer":[]}]},"delete":{"tags":["Versions"],"summary":"Delete Metadata","description":"Delete metadata record for a dataset version.\n\nOnly the dataset's owner or a user with `ADMIN` user role can do\nthis operation.","operationId":"delete_metadata_dataset__dataset___version__metadata_delete","parameters":[{"required":true,"schema":{"type":"string","pattern":"^[a-z][a-z0-9_-]{2,}$","title":"Dataset"},"name":"dataset","in":"path"},{"required":true,"schema":{"type":"string","pattern":"^v\\d{1,8}(\\.\\d{1,3}){0,2}?$|^latest$","title":"Dataset version"},"name":"version","in":"path"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/VersionMetadataResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"OAuth2PasswordBearer":[]}]},"patch":{"tags":["Versions"],"summary":"Update Metadata","description":"Update metadata record for a dataset version.\n\nOnly the dataset's owner or a user with `ADMIN` user role can do\nthis operation.","operationId":"update_metadata_dataset__dataset___version__metadata_patch","parameters":[{"required":true,"schema":{"type":"string","pattern":"^[a-z][a-z0-9_-]{2,}$","title":"Dataset"},"name":"dataset","in":"path"},{"required":true,"schema":{"type":"string","pattern":"^v\\d{1,8}(\\.\\d{1,3}){0,2}?$|^latest$","title":"Dataset version"},"name":"version","in":"path"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/VersionMetadataUpdate"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/VersionMetadataResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"OAuth2PasswordBearer":[]}]}},"/dataset/nasa_viirs_fire_alerts/{version}/features":{"get":{"tags":["Versions"],"summary":"Get Nasa Viirs Fire Alerts Features","description":"Retrieve list of features for a given spatial location.\n\nSearch radius various decreases for higher zoom levels.","operationId":"get_nasa_viirs_fire_alerts_features_dataset_nasa_viirs_fire_alerts__version__features_get","parameters":[{"required":true,"schema":{"type":"string","pattern":"^v\\d{1,8}(\\.\\d{1,3}){0,2}?$|^latest$","title":"Dataset version"},"name":"version","in":"path"},{"required":true,"schema":{"type":"number","maximum":90.0,"minimum":-90.0,"title":"Latitude"},"name":"lat","in":"query"},{"required":true,"schema":{"type":"number","maximum":180.0,"minimum":-180.0,"title":"Longitude"},"name":"lng","in":"query"},{"required":true,"schema":{"type":"integer","maximum":22.0,"minimum":0.0,"title":"Zoom level"},"name":"z","in":"query"},{"description":"Only show alerts for given date and after","required":false,"schema":{"type":"string","pattern":"^\\d{4}(\\-(0?[1-9]|1[012])\\-(0?[1-9]|[12][0-9]|3[01]))?$","title":"Start Date","description":"Only show alerts for given date and after","default":"2026-07-10"},"name":"start_date","in":"query"},{"description":"Only show alerts until given date. End date cannot be in the future.","required":false,"schema":{"type":"string","pattern":"^\\d{4}(\\-(0?[1-9]|1[012])\\-(0?[1-9]|[12][0-9]|3[01]))?$","title":"End Date","description":"Only show alerts until given date. End date cannot be in the future.","default":"2026-07-17"},"name":"end_date","in":"query"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/dataset/{dataset}/{version}/features":{"get":{"tags":["Versions"],"summary":"Get Features","description":"Retrieve list of features for a given spatial location.\n\nSearch radius various decreases for higher zoom levels.","operationId":"get_features_dataset__dataset___version__features_get","parameters":[{"required":true,"schema":{"type":"string","pattern":"^[a-z][a-z0-9_-]{2,}$","title":"Dataset"},"name":"dataset","in":"path"},{"required":true,"schema":{"type":"string","pattern":"^v\\d{1,8}(\\.\\d{1,3}){0,2}?$|^latest$","title":"Dataset version"},"name":"version","in":"path"},{"required":true,"schema":{"type":"number","maximum":90.0,"minimum":-90.0,"title":"Latitude"},"name":"lat","in":"query"},{"required":true,"schema":{"type":"number","maximum":180.0,"minimum":-180.0,"title":"Longitude"},"name":"lng","in":"query"},{"required":true,"schema":{"type":"integer","maximum":22.0,"minimum":0.0,"title":"Zoom level"},"name":"z","in":"query"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/dataset/{dataset}/{version}/geostore/{geostore_id}":{"get":{"tags":["Geostore"],"summary":"Get Geostore By Version","description":"Retrieve GeoJSON representation for a given geostore ID of a dataset\nversion.\n\nObtain geostore ID from feature attributes.","operationId":"get_geostore_by_version_dataset__dataset___version__geostore__geostore_id__get","parameters":[{"required":true,"schema":{"type":"string","format":"uuid","title":"geostore_id"},"name":"geostore_id","in":"path"},{"required":true,"schema":{"type":"string","pattern":"^[a-z][a-z0-9_-]{2,}$","title":"Dataset"},"name":"dataset","in":"path"},{"required":true,"schema":{"type":"string","pattern":"^v\\d{1,8}(\\.\\d{1,3}){0,2}?$|^latest$","title":"Dataset version"},"name":"version","in":"path"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GeostoreResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/dataset/{dataset}/{version}/assets":{"get":{"tags":["Versions"],"summary":"Get Version Assets","description":"Get all assets for a given dataset version (including pending/failed assets).\nThe list of assets is sorted by the creation time of each asset.\n\nWill attempt to paginate if `page[size]` or `page[number]` is\nprovided. Otherwise, it will attempt to return the entire list of\nassets in the response.","operationId":"get_version_assets_dataset__dataset___version__assets_get","parameters":[{"required":true,"schema":{"type":"string","pattern":"^[a-z][a-z0-9_-]{2,}$","title":"Dataset"},"name":"dataset","in":"path"},{"required":true,"schema":{"type":"string","pattern":"^v\\d{1,8}(\\.\\d{1,3}){0,2}?$|^latest$","title":"Dataset version"},"name":"version","in":"path"},{"required":false,"schema":{"allOf":[{"$ref":"#/components/schemas/AssetType"}],"title":"Filter by Asset Type"},"name":"asset_type","in":"query"},{"required":false,"schema":{"type":"string","title":"Asset Uri"},"name":"asset_uri","in":"query"},{"required":false,"schema":{"type":"boolean","title":"Is Latest"},"name":"is_latest","in":"query"},{"required":false,"schema":{"type":"boolean","title":"Is Default"},"name":"is_default","in":"query"},{"description":"The page number.","required":false,"schema":{"type":"integer","minimum":1.0,"title":"Page[Number]","description":"The page number."},"name":"page[number]","in":"query"},{"description":"The number of assets per page. Default is `10`.","required":false,"schema":{"type":"integer","minimum":1.0,"title":"Page[Size]","description":"The number of assets per page. Default is `10`."},"name":"page[size]","in":"query"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"anyOf":[{"$ref":"#/components/schemas/PaginatedAssetsResponse"},{"$ref":"#/components/schemas/AssetsResponse"}],"title":"Response Get Version Assets Dataset  Dataset   Version  Assets Get"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"post":{"tags":["Assets"],"summary":"Add New Asset","description":"Add a new asset to a dataset version. Managed assets will be generated\nby the API itself. In that case, the Asset URI is read only and will be set\nautomatically.\n\nIf the asset is not managed, you need to specify an Asset URI to\nlink to.\n\nOnly the dataset's owner or a user with `ADMIN` user role can do this operation.","operationId":"add_new_asset_dataset__dataset___version__assets_post","parameters":[{"required":true,"schema":{"type":"string","pattern":"^[a-z][a-z0-9_-]{2,}$","title":"Dataset"},"name":"dataset","in":"path"},{"required":true,"schema":{"type":"string","pattern":"^v\\d{1,8}(\\.\\d{1,3}){0,2}?$|^latest$","title":"Dataset version"},"name":"version","in":"path"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AssetCreateIn"}}},"required":true},"responses":{"202":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AssetResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"OAuth2PasswordBearer":[]}]}},"/dataset/{dataset}/{version}/query":{"get":{"tags":["Query"],"summary":"Query Dataset","description":"Execute a READ-ONLY SQL query on the given dataset version (if\nimplemented) and return response in JSON format.\n\nAdding a geostore ID to the query will apply a spatial filter to the\nquery, only returning results for features intersecting with the\ngeostore geometry. For vector datasets, this filter will not clip\nfeature geometries to the geostore boundaries. Hence any spatial\ntransformation such as area calculations will be applied on the\nentire feature geometry, including areas outside the geostore\nboundaries.\n\nThis path is deprecated and will permanently redirect to\n/query/json.","operationId":"query_dataset_dataset__dataset___version__query_get","parameters":[{"required":true,"schema":{"type":"string","pattern":"^[a-z][a-z0-9_-]{2,}$","title":"Dataset"},"name":"dataset","in":"path"},{"required":true,"schema":{"type":"string","pattern":"^v\\d{1,8}(\\.\\d{1,3}){0,2}?$|^latest$","title":"Dataset version"},"name":"version","in":"path"}],"responses":{"308":{"description":"Successful Response"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"deprecated":true},"post":{"tags":["Query"],"summary":"Query Dataset Post","description":"Execute a READ-ONLY SQL query on the given dataset version (if\nimplemented).\n\nThis path is deprecated and will permanently redirect to\n/query/json.","operationId":"query_dataset_post_dataset__dataset___version__query_post","parameters":[{"required":true,"schema":{"type":"string","pattern":"^[a-z][a-z0-9_-]{2,}$","title":"Dataset"},"name":"dataset","in":"path"},{"required":true,"schema":{"type":"string","pattern":"^v\\d{1,8}(\\.\\d{1,3}){0,2}?$|^latest$","title":"Dataset version"},"name":"version","in":"path"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryRequestIn"}}},"required":true},"responses":{"308":{"description":"Successful Response"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"deprecated":true}},"/dataset/{dataset}/{version}/query/json":{"get":{"tags":["Query"],"summary":"Query Dataset Json","description":"Execute a READ-ONLY SQL query on the given dataset version (if\nimplemented) and return response in JSON format.\n\nAdding a geostore ID or directly-specified geometry to the query\nwill apply a spatial filter to the query, only returning results for\nfeatures intersecting with the geostore geometry. For vector\ndatasets, this filter will not clip feature geometries to the\ngeostore boundaries. Hence any spatial transformation such as area\ncalculations will be applied on the entire feature geometry,\nincluding areas outside the geostore boundaries.\n\nA geostore ID or geometry must be specified for a query to a raster-\nonly dataset.\n\nGET to /dataset/{dataset}/{version}/fields will show fields that can\nbe used in the query. For raster-only datasets, fields for other\nraster datasets that use the same grid are listed and can be\nreferenced. There are also several reserved fields with special\nmeaning that can be used, including \"area__ha\", \"latitude\", and\n\"longitude\".","operationId":"query_dataset_json_dataset__dataset___version__query_json_get","parameters":[{"required":true,"schema":{"type":"string","pattern":"^[a-z][a-z0-9_-]{2,}$","title":"Dataset"},"name":"dataset","in":"path"},{"required":true,"schema":{"type":"string","pattern":"^v\\d{1,8}(\\.\\d{1,3}){0,2}?$|^latest$","title":"Dataset version"},"name":"version","in":"path"},{"description":"SQL query.","required":true,"schema":{"type":"string","title":"Sql","description":"SQL query."},"name":"sql","in":"query"},{"description":"Geostore ID. The geostore must represent a Polygon or MultiPolygon.","required":false,"schema":{"type":"string","format":"uuid","title":"Geostore Id","description":"Geostore ID. The geostore must represent a Polygon or MultiPolygon."},"name":"geostore_id","in":"query"},{"description":"Service to search first for geostore.","required":false,"schema":{"allOf":[{"$ref":"#/components/schemas/GeostoreOrigin"}],"description":"Service to search first for geostore.","default":"gfw"},"name":"geostore_origin","in":"query"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"string"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"OAuth2PasswordBearer":[]},{"APIKeyOriginQuery":[]},{"APIKeyOriginHeader":[]}]},"post":{"tags":["Query"],"summary":"Query Dataset Json Post","description":"Execute a READ-ONLY SQL query on the given dataset version (if\nimplemented).","operationId":"query_dataset_json_post_dataset__dataset___version__query_json_post","parameters":[{"required":true,"schema":{"type":"string","pattern":"^[a-z][a-z0-9_-]{2,}$","title":"Dataset"},"name":"dataset","in":"path"},{"required":true,"schema":{"type":"string","pattern":"^v\\d{1,8}(\\.\\d{1,3}){0,2}?$|^latest$","title":"Dataset version"},"name":"version","in":"path"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryRequestIn"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"string"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"OAuth2PasswordBearer":[]},{"APIKeyOriginQuery":[]},{"APIKeyOriginHeader":[]}]}},"/dataset/{dataset}/{version}/query/csv":{"get":{"tags":["Query"],"summary":"Query Dataset Csv","description":"Execute a READ-ONLY SQL query on the given dataset version (if\nimplemented) and return response in CSV format.\n\nAdding a geostore ID to the query will apply a spatial filter to the\nquery, only returning results for features intersecting with the\ngeostore geometry. For vector datasets, this filter will not clip\nfeature geometries to the geostore boundaries. Hence any spatial\ntransformation such as area calculations will be applied on the\nentire feature geometry, including areas outside the geostore\nboundaries.","operationId":"query_dataset_csv_dataset__dataset___version__query_csv_get","parameters":[{"required":true,"schema":{"type":"string","pattern":"^[a-z][a-z0-9_-]{2,}$","title":"Dataset"},"name":"dataset","in":"path"},{"required":true,"schema":{"type":"string","pattern":"^v\\d{1,8}(\\.\\d{1,3}){0,2}?$|^latest$","title":"Dataset version"},"name":"version","in":"path"},{"description":"SQL query.","required":true,"schema":{"type":"string","title":"Sql","description":"SQL query."},"name":"sql","in":"query"},{"description":"Geostore ID. The geostore must represent a Polygon or MultiPolygon.","required":false,"schema":{"type":"string","format":"uuid","title":"Geostore Id","description":"Geostore ID. The geostore must represent a Polygon or MultiPolygon."},"name":"geostore_id","in":"query"},{"description":"Service to search first for geostore.","required":false,"schema":{"allOf":[{"$ref":"#/components/schemas/GeostoreOrigin"}],"description":"Service to search first for geostore.","default":"gfw"},"name":"geostore_origin","in":"query"},{"description":"Delimiter to use for CSV file.","required":false,"schema":{"allOf":[{"$ref":"#/components/schemas/Delimiters"}],"description":"Delimiter to use for CSV file.","default":","},"name":"delimiter","in":"query"}],"responses":{"200":{"description":"Successful Response","content":{"text/csv":{"schema":{"type":"string"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"OAuth2PasswordBearer":[]},{"APIKeyOriginQuery":[]},{"APIKeyOriginHeader":[]}]},"post":{"tags":["Query"],"summary":"Query Dataset Csv Post","description":"Execute a READ-ONLY SQL query on the given dataset version (if\nimplemented).","operationId":"query_dataset_csv_post_dataset__dataset___version__query_csv_post","parameters":[{"required":true,"schema":{"type":"string","pattern":"^[a-z][a-z0-9_-]{2,}$","title":"Dataset"},"name":"dataset","in":"path"},{"required":true,"schema":{"type":"string","pattern":"^v\\d{1,8}(\\.\\d{1,3}){0,2}?$|^latest$","title":"Dataset version"},"name":"version","in":"path"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CsvQueryRequestIn"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"text/csv":{"schema":{"type":"string"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"OAuth2PasswordBearer":[]},{"APIKeyOriginQuery":[]},{"APIKeyOriginHeader":[]}]}},"/dataset/{dataset}/{version}/query/batch":{"post":{"tags":["Query"],"summary":"Query Dataset List Post","description":"Execute a READ-ONLY SQL query on the specified raster-based dataset\nversion for a potentially large list of features. The features may be\nspecified by an inline GeoJson feature collection, or a list of\nResourceWatch geostore IDs, or the URI of vector file that is in any of a\nvariety of formats supported by GeoPandas, include GeoJson and CSV format.\nFor CSV files, the geometry column should be named \"WKT\" (not \"WKB\") and\nthe geometry values should be in WKB format.\n\nThe specified sql query will be run on each individual feature, and\nso may take a while. Therefore, the results of this query include a\njob_id. The user should then periodically query the specified job\nvia the /job/{job_id} api. When the \"data.status\" indicates\n\"success\" or \"partial_success\", then the successful results will be\navailable at the specified \"data.download_link\". When the\n\"data.status\" indicates \"partial_success\" or \"failed\", then failed\nresults (likely because of improper geometries) will be available at\n\"data.failed_geometries_link\". If the \"data.status\" indicates\n\"error\", then there will be no results available (nothing was able\nto complete, possible because of an infrastructure problem).\n\nLimitations\n\n- The request payload must be under 256 KB. This limit does not apply\nto features provided in a file referenced using the `uri`\nfield—use this option to include larger geometry data via an external\nfile.\n\n- There is currently a five-minute time limit on the entire list\nquery, but up to 100 individual feature queries proceed in parallel,\nso lists with several thousands of features can potentially be\nprocessed within that time limit.","operationId":"query_dataset_list_post_dataset__dataset___version__query_batch_post","parameters":[{"required":true,"schema":{"type":"string","pattern":"^[a-z][a-z0-9_-]{2,}$","title":"Dataset"},"name":"dataset","in":"path"},{"required":true,"schema":{"type":"string","pattern":"^v\\d{1,8}(\\.\\d{1,3}){0,2}?$|^latest$","title":"Dataset version"},"name":"version","in":"path"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryBatchRequestIn"}}},"required":true},"responses":{"202":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserJobResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"APIKeyOriginQuery":[]},{"APIKeyOriginHeader":[]}]}},"/dataset/{dataset}/{version}/download/json":{"get":{"tags":["Download"],"summary":"Download Json","description":"Execute a READ-ONLY SQL query on the given dataset version (if\nimplemented).\n\nReturn results as downloadable JSON file. This endpoint only works\nfor datasets with (geo-)database tables.","operationId":"download_json_dataset__dataset___version__download_json_get","parameters":[{"required":true,"schema":{"type":"string","pattern":"^[a-z][a-z0-9_-]{2,}$","title":"Dataset"},"name":"dataset","in":"path"},{"required":true,"schema":{"type":"string","pattern":"^v\\d{1,8}(\\.\\d{1,3}){0,2}?$|^latest$","title":"Dataset version"},"name":"version","in":"path"},{"description":"SQL query.","required":true,"schema":{"type":"string","title":"Sql","description":"SQL query."},"name":"sql","in":"query"},{"description":"Geostore ID. The geostore must represent a Polygon or MultiPolygon.","required":false,"schema":{"type":"string","format":"uuid","title":"Geostore Id","description":"Geostore ID. The geostore must represent a Polygon or MultiPolygon."},"name":"geostore_id","in":"query"},{"description":"Service to search first for geostore.","required":false,"schema":{"allOf":[{"$ref":"#/components/schemas/GeostoreOrigin"}],"description":"Service to search first for geostore.","default":"gfw"},"name":"geostore_origin","in":"query"},{"description":"Name of export file.","required":false,"schema":{"type":"string","title":"Filename","description":"Name of export file.","default":"export.json"},"name":"filename","in":"query"}],"responses":{"200":{"description":"Successful Response","content":{"text/csv":{"schema":{"type":"string"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"post":{"tags":["Download"],"summary":"Download Json Post","description":"Execute a READ-ONLY SQL query on the given dataset version (if\nimplemented).\n\nReturn results as downloadable JSON file. This endpoint only works\nfor datasets with (geo-)database tables.","operationId":"download_json_post_dataset__dataset___version__download_json_post","parameters":[{"required":true,"schema":{"type":"string","pattern":"^[a-z][a-z0-9_-]{2,}$","title":"Dataset"},"name":"dataset","in":"path"},{"required":true,"schema":{"type":"string","pattern":"^v\\d{1,8}(\\.\\d{1,3}){0,2}?$|^latest$","title":"Dataset version"},"name":"version","in":"path"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DownloadJSONIn"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"text/csv":{"schema":{"type":"string"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/dataset/{dataset}/{version}/download/csv":{"get":{"tags":["Download"],"summary":"Download Csv","description":"Execute a READ-ONLY SQL query on the given dataset version (if\nimplemented).\n\nReturn results as downloadable CSV file. This endpoint only works\nfor datasets with (geo-)database tables.","operationId":"download_csv_dataset__dataset___version__download_csv_get","parameters":[{"required":true,"schema":{"type":"string","pattern":"^[a-z][a-z0-9_-]{2,}$","title":"Dataset"},"name":"dataset","in":"path"},{"required":true,"schema":{"type":"string","pattern":"^v\\d{1,8}(\\.\\d{1,3}){0,2}?$|^latest$","title":"Dataset version"},"name":"version","in":"path"},{"description":"SQL query.","required":true,"schema":{"type":"string","title":"Sql","description":"SQL query."},"name":"sql","in":"query"},{"description":"Geostore ID. The geostore must represent a Polygon or MultiPolygon.","required":false,"schema":{"type":"string","format":"uuid","title":"Geostore Id","description":"Geostore ID. The geostore must represent a Polygon or MultiPolygon."},"name":"geostore_id","in":"query"},{"description":"Service to search first for geostore.","required":false,"schema":{"allOf":[{"$ref":"#/components/schemas/GeostoreOrigin"}],"description":"Service to search first for geostore.","default":"gfw"},"name":"geostore_origin","in":"query"},{"description":"Name of export file.","required":false,"schema":{"type":"string","title":"Filename","description":"Name of export file.","default":"export.csv"},"name":"filename","in":"query"},{"description":"Delimiter to use for CSV file.","required":false,"schema":{"allOf":[{"$ref":"#/components/schemas/Delimiters"}],"description":"Delimiter to use for CSV file.","default":","},"name":"delimiter","in":"query"}],"responses":{"200":{"description":"Successful Response","content":{"text/csv":{"schema":{"type":"string"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"post":{"tags":["Download"],"summary":"Download Csv Post","description":"Execute a READ-ONLY SQL query on the given dataset version (if\nimplemented).\n\nReturn results as downloadable CSV file. This endpoint only works\nfor datasets with (geo-)database tables.","operationId":"download_csv_post_dataset__dataset___version__download_csv_post","parameters":[{"required":true,"schema":{"type":"string","pattern":"^[a-z][a-z0-9_-]{2,}$","title":"Dataset"},"name":"dataset","in":"path"},{"required":true,"schema":{"type":"string","pattern":"^v\\d{1,8}(\\.\\d{1,3}){0,2}?$|^latest$","title":"Dataset version"},"name":"version","in":"path"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DownloadCSVIn"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"text/csv":{"schema":{"type":"string"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/dataset/{dataset}/{version}/download_by_aoi/csv":{"get":{"tags":["Download"],"summary":"Download By Aoi Csv","description":"Execute a READ-ONLY SQL query on the given dataset version (if\nimplemented) for a given AOI, and return as a CSV file.","operationId":"download_by_aoi_csv_dataset__dataset___version__download_by_aoi_csv_get","parameters":[{"required":true,"schema":{"type":"string","pattern":"^[a-z][a-z0-9_-]{2,}$","title":"Dataset"},"name":"dataset","in":"path"},{"required":true,"schema":{"type":"string","pattern":"^v\\d{1,8}(\\.\\d{1,3}){0,2}?$|^latest$","title":"Dataset version"},"name":"version","in":"path"},{"description":"SQL query.","required":true,"schema":{"type":"string","title":"Sql","description":"SQL query."},"name":"sql","in":"query"},{"description":"Name of export file.","required":false,"schema":{"type":"string","title":"Filename","description":"Name of export file.","default":"export.csv"},"name":"filename","in":"query"},{"description":"Delimiter to use for CSV file.","required":false,"schema":{"allOf":[{"$ref":"#/components/schemas/Delimiters"}],"description":"Delimiter to use for CSV file.","default":","},"name":"delimiter","in":"query"},{"description":"The Area of Interest","required":true,"style":"deepObject","explode":true,"schema":{"oneOf":[{"$ref":"#/components/schemas/GeostoreAreaOfInterest"},{"$ref":"#/components/schemas/AdminAreaOfInterest"},{"$ref":"#/components/schemas/Global"},{"$ref":"#/components/schemas/WdpaAreaOfInterest"}]},"examples":{"Geostore Area Of Interest":{"summary":"Geostore Area Of Interest","description":"Custom area","value":{"type":"geostore","geostore_id":"637d378f-93a9-4364-bfa8-95b6afd28c3a"}},"Admin Area Of Interest":{"summary":"Admin Area Of Interest","description":"Administrative Boundary","value":{"type":"admin","country":"BRA","region":"12","subregion":"2"}},"Global":{"summary":"Global Extent","description":"Full spatial extent of dataset","value":{"type":"global"}},"WDPA Area Of Interest":{"summary":"WDPA Area Of Interest","description":"World Database on Protected Areas (WDPA) Boundary","value":{"type":"protected_area","wdpa_id":"123"}}},"name":"aoi","in":"query"}],"responses":{"200":{"description":"Successful Response","content":{"text/csv":{"schema":{"type":"string"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/dataset/{dataset}/{version}/download_by_aoi/json":{"get":{"tags":["Download"],"summary":"Download By Aoi Json","description":"Execute a READ-ONLY SQL query on the given dataset version (if\nimplemented) for a given AOI, and returns it as JSON file.","operationId":"download_by_aoi_json_dataset__dataset___version__download_by_aoi_json_get","parameters":[{"required":true,"schema":{"type":"string","pattern":"^[a-z][a-z0-9_-]{2,}$","title":"Dataset"},"name":"dataset","in":"path"},{"required":true,"schema":{"type":"string","pattern":"^v\\d{1,8}(\\.\\d{1,3}){0,2}?$|^latest$","title":"Dataset version"},"name":"version","in":"path"},{"description":"SQL query.","required":true,"schema":{"type":"string","title":"Sql","description":"SQL query."},"name":"sql","in":"query"},{"description":"Name of export file.","required":false,"schema":{"type":"string","title":"Filename","description":"Name of export file.","default":"export.json"},"name":"filename","in":"query"},{"description":"The Area of Interest","required":true,"style":"deepObject","explode":true,"schema":{"oneOf":[{"$ref":"#/components/schemas/GeostoreAreaOfInterest"},{"$ref":"#/components/schemas/AdminAreaOfInterest"},{"$ref":"#/components/schemas/Global"},{"$ref":"#/components/schemas/WdpaAreaOfInterest"}]},"examples":{"Geostore Area Of Interest":{"summary":"Geostore Area Of Interest","description":"Custom area","value":{"type":"geostore","geostore_id":"637d378f-93a9-4364-bfa8-95b6afd28c3a"}},"Admin Area Of Interest":{"summary":"Admin Area Of Interest","description":"Administrative Boundary","value":{"type":"admin","country":"BRA","region":"12","subregion":"2"}},"Global":{"summary":"Global Extent","description":"Full spatial extent of dataset","value":{"type":"global"}},"WDPA Area Of Interest":{"summary":"WDPA Area Of Interest","description":"World Database on Protected Areas (WDPA) Boundary","value":{"type":"protected_area","wdpa_id":"123"}}},"name":"aoi","in":"query"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"string"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/dataset/{dataset}/{version}/download/geotiff":{"get":{"tags":["Download"],"summary":"Download Geotiff","description":"Download geotiff raster tile.","operationId":"download_geotiff_dataset__dataset___version__download_geotiff_get","parameters":[{"required":true,"schema":{"type":"string","pattern":"^[a-z][a-z0-9_-]{2,}$","title":"Dataset"},"name":"dataset","in":"path"},{"required":true,"schema":{"type":"string","pattern":"^v\\d{1,8}(\\.\\d{1,3}){0,2}?$|^latest$","title":"Dataset version"},"name":"version","in":"path"},{"description":"Grid size of tile to download.","required":true,"schema":{"allOf":[{"$ref":"#/components/schemas/Grid"}],"description":"Grid size of tile to download."},"name":"grid","in":"query"},{"description":"Tile ID of tile to download.","required":true,"schema":{"type":"string","title":"Tile Id","description":"Tile ID of tile to download."},"name":"tile_id","in":"query"},{"description":"Pixel meaning of tile to download.","required":true,"schema":{"type":"string","title":"Pixel Meaning","description":"Pixel meaning of tile to download."},"name":"pixel_meaning","in":"query"}],"responses":{"307":{"description":"Successful Response"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/dataset/{dataset}/{version}/download/shp":{"get":{"tags":["Download"],"summary":"Download Shapefile","description":"Download ESRI Shapefile.\n\nResponse will return a temporary redirect to download URL.","operationId":"download_shapefile_dataset__dataset___version__download_shp_get","parameters":[{"required":true,"schema":{"type":"string","pattern":"^[a-z][a-z0-9_-]{2,}$","title":"Dataset"},"name":"dataset","in":"path"},{"required":true,"schema":{"type":"string","pattern":"^v\\d{1,8}(\\.\\d{1,3}){0,2}?$|^latest$","title":"Dataset version"},"name":"version","in":"path"}],"responses":{"307":{"description":"Successful Response"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/dataset/{dataset}/{version}/download/gpkg":{"get":{"tags":["Download"],"summary":"Download Geopackage","description":"Download Geopackage.\n\nResponse will return a temporary redirect to download URL.","operationId":"download_geopackage_dataset__dataset___version__download_gpkg_get","parameters":[{"required":true,"schema":{"type":"string","pattern":"^[a-z][a-z0-9_-]{2,}$","title":"Dataset"},"name":"dataset","in":"path"},{"required":true,"schema":{"type":"string","pattern":"^v\\d{1,8}(\\.\\d{1,3}){0,2}?$|^latest$","title":"Dataset version"},"name":"version","in":"path"}],"responses":{"307":{"description":"Successful Response"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/assets":{"get":{"tags":["Assets"],"summary":"Get Assets","description":"Get all assets for a given dataset version.\n\nWill attempt to paginate if `page[size]` or `page[number]` is\nprovided. Otherwise, it will attempt to return the entire list of\nassets in the response.","operationId":"get_assets_assets_get","parameters":[{"required":false,"schema":{"type":"string","pattern":"^[a-z][a-z0-9_-]{2,}$","title":"Dataset"},"name":"dataset","in":"query"},{"required":false,"schema":{"type":"string","pattern":"^v\\d{1,8}(\\.\\d{1,3}){0,2}?$|^latest$","title":"Version"},"name":"version","in":"query"},{"required":false,"schema":{"allOf":[{"$ref":"#/components/schemas/AssetType"}],"title":"Filter by Asset Type"},"name":"asset_type","in":"query"},{"required":false,"schema":{"type":"string","title":"Asset Uri"},"name":"asset_uri","in":"query"},{"required":false,"schema":{"type":"boolean","title":"Is Latest"},"name":"is_latest","in":"query"},{"required":false,"schema":{"type":"boolean","title":"Is Default"},"name":"is_default","in":"query"},{"description":"The page number.","required":false,"schema":{"type":"integer","minimum":1.0,"title":"Page[Number]","description":"The page number."},"name":"page[number]","in":"query"},{"description":"The number of assets per page. Default is `10`.","required":false,"schema":{"type":"integer","minimum":1.0,"title":"Page[Size]","description":"The number of assets per page. Default is `10`."},"name":"page[size]","in":"query"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"anyOf":[{"$ref":"#/components/schemas/PaginatedAssetsResponse"},{"$ref":"#/components/schemas/AssetsResponse"}],"title":"Response Get Assets Assets Get"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/asset/{asset_id}":{"get":{"tags":["Assets"],"summary":"Get Asset","description":"Get a specific asset.  This provides information on the asset, including\nthe asset id, the asset status, the asset URI, and creation & last update\ntimes.","operationId":"get_asset_asset__asset_id__get","parameters":[{"required":true,"schema":{"type":"string","format":"uuid","title":"Asset Id"},"name":"asset_id","in":"path"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AssetResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"delete":{"tags":["Assets"],"summary":"Delete Asset","description":"Delete selected asset.\n\nFor managed assets, all resources will be deleted. For non-managed\nassets, only the link will be deleted.\n\nOnly the dataset's owner or a user with `ADMIN` user role can do this operation.","operationId":"delete_asset_asset__asset_id__delete","parameters":[{"required":true,"schema":{"type":"string","format":"uuid","title":"Asset Id"},"name":"asset_id","in":"path"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AssetResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"OAuth2PasswordBearer":[]}]},"patch":{"tags":["Assets"],"summary":"Update Asset","description":"Update Asset metadata.\n\nOnly the dataset's owner or a user with `ADMIN` user role can do\nthis operation.","operationId":"update_asset_asset__asset_id__patch","parameters":[{"required":true,"schema":{"type":"string","format":"uuid","title":"Asset Id"},"name":"asset_id","in":"path"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AssetUpdateIn"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AssetResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"OAuth2PasswordBearer":[]}]}},"/asset/{asset_id}/tasks":{"get":{"tags":["Assets"],"summary":"Get Tasks","description":"Get all Tasks for selected asset.\n\nWill attempt to paginate if `page[size]` or `page[number]` is\nprovided. Otherwise, it will attempt to return the entire list of\ntasks in the response.","operationId":"get_tasks_asset__asset_id__tasks_get","parameters":[{"required":true,"schema":{"type":"string","format":"uuid","title":"Asset Id"},"name":"asset_id","in":"path"},{"description":"The page number.","required":false,"schema":{"type":"integer","minimum":1.0,"title":"Page[Number]","description":"The page number."},"name":"page[number]","in":"query"},{"description":"The number of tasks per page. Default is `10`.","required":false,"schema":{"type":"integer","minimum":1.0,"title":"Page[Size]","description":"The number of tasks per page. Default is `10`."},"name":"page[size]","in":"query"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"anyOf":[{"$ref":"#/components/schemas/PaginatedTasksResponse"},{"$ref":"#/components/schemas/TasksResponse"}],"title":"Response Get Tasks Asset  Asset Id  Tasks Get"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/asset/{asset_id}/change_log":{"get":{"tags":["Assets"],"summary":"Get Change Log","operationId":"get_change_log_asset__asset_id__change_log_get","parameters":[{"required":true,"schema":{"type":"string","format":"uuid","title":"Asset Id"},"name":"asset_id","in":"path"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ChangeLogResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/asset/{asset_id}/creation_options":{"get":{"tags":["Assets"],"summary":"Get Creation Options","operationId":"get_creation_options_asset__asset_id__creation_options_get","parameters":[{"required":true,"schema":{"type":"string","format":"uuid","title":"Asset Id"},"name":"asset_id","in":"path"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreationOptionsResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/asset/{asset_id}/extent":{"get":{"tags":["Assets"],"summary":"Get Extent","operationId":"get_extent_asset__asset_id__extent_get","parameters":[{"required":true,"schema":{"type":"string","format":"uuid","title":"Asset Id"},"name":"asset_id","in":"path"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExtentResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/asset/{asset_id}/tiles_info":{"get":{"tags":["Assets"],"summary":"Get Tiles Info","operationId":"get_tiles_info_asset__asset_id__tiles_info_get","parameters":[{"required":true,"schema":{"type":"string","format":"uuid","title":"Asset Id"},"name":"asset_id","in":"path"}],"responses":{"307":{"description":"Successful Response"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/asset/{asset_id}/stats":{"get":{"tags":["Assets"],"summary":"Get Stats","operationId":"get_stats_asset__asset_id__stats_get","parameters":[{"required":true,"schema":{"type":"string","format":"uuid","title":"Asset Id"},"name":"asset_id","in":"path"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StatsResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/asset/{asset_id}/fields":{"get":{"tags":["Assets"],"summary":"Get Fields","operationId":"get_fields_asset__asset_id__fields_get","parameters":[{"required":true,"schema":{"type":"string","format":"uuid","title":"Asset Id"},"name":"asset_id","in":"path"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FieldsMetadataResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/asset/{asset_id}/fields/{field_name}":{"get":{"tags":["Assets"],"summary":"Get Field Metadata","operationId":"get_field_metadata_asset__asset_id__fields__field_name__get","parameters":[{"required":true,"schema":{"type":"string","format":"uuid","title":"Asset Id"},"name":"asset_id","in":"path"},{"required":true,"schema":{"type":"string","title":"Field Name"},"name":"field_name","in":"path"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FieldMetadataResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"patch":{"tags":["Assets"],"summary":"Update Field Metadata","description":"Update the field metadata for an asset.\n\nOnly the dataset's owner or a user with `ADMIN` user role can do\nthis operation.","operationId":"update_field_metadata_asset__asset_id__fields__field_name__patch","parameters":[{"required":true,"schema":{"type":"string","format":"uuid","title":"Asset Id"},"name":"asset_id","in":"path"},{"required":true,"schema":{"type":"string","title":"Field Name"},"name":"field_name","in":"path"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FieldMetadataUpdate"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FieldMetadataResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"OAuth2PasswordBearer":[]}]}},"/asset/{asset_id}/metadata":{"get":{"tags":["Assets"],"summary":"Get Metadata","operationId":"get_metadata_asset__asset_id__metadata_get","parameters":[{"required":true,"schema":{"type":"string","format":"uuid","title":"Asset Id"},"name":"asset_id","in":"path"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AssetMetadataResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"post":{"tags":["Assets"],"summary":"Create Metadata","description":"Create metadata record for an asset.\n\nOnly the dataset's owner or a user with `ADMIN` user role can do\nthis operation.","operationId":"create_metadata_asset__asset_id__metadata_post","parameters":[{"required":true,"schema":{"type":"string","format":"uuid","title":"Asset Id"},"name":"asset_id","in":"path"}],"requestBody":{"content":{"application/json":{"schema":{"anyOf":[{"$ref":"#/components/schemas/DatabaseTableMetadata"},{"$ref":"#/components/schemas/StaticVectorTileCacheMetadata"},{"$ref":"#/components/schemas/DynamicVectorTileCacheMetadata"},{"$ref":"#/components/schemas/RasterTileCacheMetadata"},{"$ref":"#/components/schemas/RasterTileSetMetadata"},{"$ref":"#/components/schemas/VectorFileMetadata"}],"title":"Request"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AssetMetadataResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"delete":{"tags":["Assets"],"summary":"Delete Metadata","description":"Delete an asset's metadata record.\n\nOnly the dataset's owner or a user with `ADMIN` user role can do\nthis operation.","operationId":"delete_metadata_asset__asset_id__metadata_delete","parameters":[{"required":true,"schema":{"type":"string","format":"uuid","title":"Asset Id"},"name":"asset_id","in":"path"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AssetMetadataResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"OAuth2PasswordBearer":[]}]},"patch":{"tags":["Assets"],"summary":"Update Metadata","description":"Update metadata record for an asset.\n\nOnly the dataset's owner or a user with `ADMIN` user role can do\nthis operation.","operationId":"update_metadata_asset__asset_id__metadata_patch","parameters":[{"required":true,"schema":{"type":"string","format":"uuid","title":"Asset Id"},"name":"asset_id","in":"path"}],"requestBody":{"content":{"application/json":{"schema":{"anyOf":[{"$ref":"#/components/schemas/DynamicVectorTileCacheMetadata"},{"$ref":"#/components/schemas/RasterTileSetMetadataUpdate"},{"$ref":"#/components/schemas/StaticVectorTileCacheMetadataUpdate"}],"title":"Request"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AssetMetadataResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"OAuth2PasswordBearer":[]}]}},"/geostore/":{"post":{"tags":["Geostore"],"summary":"Add New Geostore","description":"Add geostore feature to user area of geostore.\n\nIf request follows RW style forward to RW, otherwise create in Data\nAPI","operationId":"add_new_geostore_geostore__post","parameters":[{"required":false,"schema":{"type":"string","title":"X-Api-Key"},"name":"x-api-key","in":"header"}],"requestBody":{"content":{"application/json":{"schema":{"anyOf":[{"$ref":"#/components/schemas/GeostoreIn"},{"$ref":"#/components/schemas/RWGeostoreIn"}],"title":"Request"}}},"required":true},"responses":{"201":{"description":"Successful Response","content":{"application/json":{"schema":{"anyOf":[{"$ref":"#/components/schemas/GeostoreResponse"},{"$ref":"#/components/schemas/AdminGeostoreResponse"}],"title":"Response Add New Geostore Geostore  Post"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/geostore/{geostore_id}":{"get":{"tags":["Geostore"],"summary":"Get Any Geostore","description":"Retrieve GeoJSON representation for a given geostore ID of any dataset.\n\nIf the provided ID is in UUID style, get from the GFW Data API.\nOtherwise, forward request to RW API.","operationId":"get_any_geostore_geostore__geostore_id__get","parameters":[{"required":true,"schema":{"type":"string","title":"geostore_id"},"name":"geostore_id","in":"path"},{"required":false,"schema":{"type":"string","title":"X-Api-Key"},"name":"x-api-key","in":"header"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"anyOf":[{"$ref":"#/components/schemas/GeostoreResponse"},{"$ref":"#/components/schemas/AdminGeostoreResponse"}],"title":"Response Get Any Geostore Geostore  Geostore Id  Get"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/task/{task_id}":{"get":{"tags":["Tasks"],"summary":"Get Task","description":"Get single tasks by task ID.","operationId":"get_task_task__task_id__get","parameters":[{"required":true,"schema":{"type":"string","format":"uuid","title":"Task Id"},"name":"task_id","in":"path"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TaskResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"put":{"tags":["Tasks"],"summary":"Create Task","description":"Create a task.","operationId":"create_task_task__task_id__put","parameters":[{"required":true,"schema":{"type":"string","format":"uuid","title":"Task Id"},"name":"task_id","in":"path"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TaskCreateIn"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TaskResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"OAuth2PasswordBearer":[]}]},"patch":{"tags":["Tasks"],"summary":"Update Task","description":"Update the status of a task.\n\nIf the task has errored, or all tasks are complete, propagate status\nto asset and version rows.","operationId":"update_task_task__task_id__patch","parameters":[{"required":true,"schema":{"type":"string","format":"uuid","title":"Task Id"},"name":"task_id","in":"path"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TaskUpdateIn"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TaskResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"OAuth2PasswordBearer":[]}]}},"/analysis/zonal/{geostore_id}":{"get":{"tags":["Analysis"],"summary":"Zonal Statistics Get","description":"Calculate zonal statistics on any registered raster layers in a\ngeostore.","operationId":"zonal_statistics_get_analysis_zonal__geostore_id__get","parameters":[{"required":true,"schema":{"type":"string","format":"uuid","title":"Geostore ID"},"name":"geostore_id","in":"path"},{"required":false,"schema":{"allOf":[{"$ref":"#/components/schemas/GeostoreOrigin"}],"title":"Service to search first for geostore.","default":"gfw"},"name":"geostore_origin","in":"query"},{"required":true,"schema":{"items":{"$ref":"#/components/schemas/RasterLayer"},"type":"array","title":"Sum Layers"},"name":"sum","in":"query"},{"required":false,"schema":{"items":{"$ref":"#/components/schemas/RasterLayer"},"type":"array","title":"Group By Layers","default":[]},"name":"group_by","in":"query"},{"required":false,"schema":{"items":{"$ref":"#/components/schemas/RasterLayer"},"type":"array","title":"Filter Layers","default":[]},"name":"filters","in":"query"},{"description":"Must be either year or YYYY-MM-DD date format.","required":false,"schema":{"type":"string","pattern":"^\\d{4}(\\-(0?[1-9]|1[012])\\-(0?[1-9]|[12][0-9]|3[01]))?$","title":"Start Date","description":"Must be either year or YYYY-MM-DD date format."},"name":"start_date","in":"query"},{"description":"Must be either year or YYYY-MM-DD date format.","required":false,"schema":{"type":"string","pattern":"^\\d{4}(\\-(0?[1-9]|1[012])\\-(0?[1-9]|[12][0-9]|3[01]))?$","title":"End Date","description":"Must be either year or YYYY-MM-DD date format."},"name":"end_date","in":"query"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"deprecated":true,"security":[{"APIKeyOriginQuery":[]},{"APIKeyOriginHeader":[]}]}},"/analysis/zonal":{"post":{"tags":["Analysis"],"summary":"Zonal Statistics Post","operationId":"zonal_statistics_post_analysis_zonal_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ZonalAnalysisRequestIn"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"deprecated":true,"security":[{"APIKeyOriginQuery":[]},{"APIKeyOriginHeader":[]}]}},"/job/{job_id}":{"get":{"tags":["Jobs"],"summary":"Get Job","description":"Get job status.\n\nJobs expire after 90 days.","operationId":"get_job_job__job_id__get","parameters":[{"required":true,"schema":{"type":"string","format":"uuid","title":"Job Id"},"name":"job_id","in":"path"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserJobResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/ping":{"get":{"tags":["Health"],"summary":"Ping","description":"Simple uptime check.","operationId":"ping_ping_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"}}}}}}},"/v0/land/tree_cover_loss_by_driver":{"get":{"tags":["Beta Land"],"summary":"Tree Cover Loss By Driver Search","description":"Search if a resource exists for a given geostore and canopy cover.","operationId":"tree_cover_loss_by_driver_search_v0_land_tree_cover_loss_by_driver_get","security":[{"APIKeyOriginQuery":[]},{"APIKeyOriginHeader":[]}],"parameters":[{"name":"canopy_cover","in":"query","required":false,"schema":{"title":"Canopy cover percent","default":30,"type":"integer"}},{"name":"aoi","in":"query","required":true,"style":"deepObject","explode":true,"examples":{"Geostore Area Of Interest":{"summary":"Geostore Area Of Interest","description":"Custom area","value":{"type":"geostore","geostore_id":"637d378f-93a9-4364-bfa8-95b6afd28c3a"}},"Admin Area Of Interest":{"summary":"Admin Area Of Interest","description":"Administrative Boundary","value":{"type":"admin","country":"BRA","region":"12","subregion":"2"}}},"description":"The Area of Interest","schema":{"oneOf":[{"$ref":"#/components/schemas/GeostoreAreaOfInterest"},{"$ref":"#/components/schemas/AdminAreaOfInterest"},{"$ref":"#/components/schemas/Global"}]}},{"name":"dataset_version","in":"query","required":false,"style":"deepObject","explode":true,"schema":{"type":"object","additionalProperties":{"type":"string"}},"example":{"umd_tree_cover_loss":"v1.11","tsc_tree_cover_loss_drivers":"v2023"},"description":["Pass dataset version overrides as bracketed query parameters."]}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DataMartResourceLinkResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"post":{"tags":["Beta Land"],"summary":"Tree Cover Loss By Driver Post","description":"Create new tree cover loss by drivers resource for a given geostore and\ncanopy cover.","operationId":"tree_cover_loss_by_driver_post_v0_land_tree_cover_loss_by_driver_post","security":[{"APIKeyOriginQuery":[]},{"APIKeyOriginHeader":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TreeCoverLossByDriverIn"}}}},"responses":{"202":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DataMartResourceLinkResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v0/land/tree_cover_loss_by_driver/{resource_id}":{"get":{"tags":["Beta Land"],"summary":"Tree Cover Loss By Driver Get","description":"Retrieve a tree cover loss by drivers resource.","operationId":"tree_cover_loss_by_driver_get_v0_land_tree_cover_loss_by_driver__resource_id__get","parameters":[{"required":true,"schema":{"type":"string","format":"uuid","title":"Tree cover loss by driver ID"},"name":"resource_id","in":"path"}],"responses":{"200":{"description":"Returns either JSON or CSV representation based on the Accept header. CSV representation will only return tree cover loss year, driver, and area.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TreeCoverLossByDriverResponse"}},"text/csv":{"example":"\"umd_tree_cover_loss__year\",\"tsc_tree_cover_loss_drivers__driver\",\"area__ha\"\r\n\"2001\",\"Permanent agriculture\",10.0\r\n\"2001\",\"Hard commodities\",12.0\r\n\"2001\",\"Shifting cultivation\",7.0\r\n\"2001\",\"Forest management\",93.4\r\n\"2001\",\"Wildfires\",42.0\r\n\"2001\",\"Settlements and infrastructure\",13.562\r\n\"2001\",\"Other natural disturbances\",6.0\r\n"}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"APIKeyOriginQuery":[]},{"APIKeyOriginHeader":[]}]},"delete":{"tags":["Beta Land"],"summary":"Delete Tree Cover Loss by Driver Analysis","description":"Only analysis resources with 'failed' status can be removed. This operation permanently deletes the resource.","operationId":"tree_cover_loss_by_driver_delete_v0_land_tree_cover_loss_by_driver__resource_id__delete","parameters":[{"description":"UUID of the **failed** analysis resource to delete","required":true,"schema":{"type":"string","format":"uuid","title":"Tree cover loss by driver analysis resource ID","description":"UUID of the **failed** analysis resource to delete"},"example":"123e4567-e89b-12d3-a456-426614174000","name":"resource_id","in":"path"}],"responses":{"204":{"description":"Analysis resource successfully deleted"},"400":{"description":"Analysis resource cannot be deleted because it's not in 'failed' status"},"404":{"description":"Analysis resource not found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"APIKeyOriginQuery":[]},{"APIKeyOriginHeader":[]}]}}},"components":{"schemas":{"APIKeyRequestIn":{"properties":{"alias":{"type":"string","title":"Alias","description":"Nickname for API Key"},"organization":{"type":"string","title":"Organization","description":"Name of organization or website"},"email":{"type":"string","format":"email","title":"Email","description":"Email address of POC"},"domains":{"items":{"type":"string","pattern":"^(\\*\\.)?([\\w-]+\\.)+[\\w-]+$|^(localhost)$"},"type":"array","pattern":"^(\\*\\.)?([\\w-]+\\.)+[\\w-]+$|^(localhost)$","title":"Domains","description":"List of domains which can be used this API key.\n        If no domain is listed, the key will be set by default to the lowest rate\n        limiting tier. <br/>\n        When making request using the API key, make sure you add the correct `origin`\n        header matching a domain in this allowlist.<br/><br/>\n        You can use wildcards for subdomains such as `*.yourdomain.com`.<br/>\n        **Our validation method for wildcards will allow only subdomains.**<br/><br/>\n        Make sure you also add `yourdomain.com` if you use root without any subdomains.<br/>\n        `www.yourdomain.com` and `yourdomain.com` are two different domains in terms\n        of security.<br/>\n        Include `www.` if required.<br/><br/>\n        **Do not** include port numbers in the domain names. `localhost`~:3000~<br/><br/>\n        A `domains` example for local development might look like this:<br/>\n        `[\"www.yourdomain.com\", \"*.yourdomain.com\", \"yourdomain.com\", \"localhost\"]`","default":[]},"never_expires":{"type":"boolean","title":"Never Expires","description":"Set API Key to never expire, only `admin` users can set this to `true`","default":false}},"additionalProperties":false,"type":"object","required":["alias","organization","email"],"title":"APIKeyRequestIn"},"Adm0BoundaryInfo":{"properties":{"use":{"type":"object","title":"Use"},"simplifyThresh":{"type":"number","title":"Simplifythresh"},"gadm":{"type":"string","title":"Gadm"},"name":{"type":"string","title":"Name"},"iso":{"type":"string","title":"Iso"}},"additionalProperties":false,"type":"object","required":["use","gadm","name","iso"],"title":"Adm0BoundaryInfo"},"Adm1BoundaryInfo":{"properties":{"use":{"type":"object","title":"Use"},"simplifyThresh":{"type":"number","title":"Simplifythresh"},"gadm":{"type":"string","title":"Gadm"},"name":{"type":"string","title":"Name"},"iso":{"type":"string","title":"Iso"},"id1":{"type":"integer","title":"Id1"}},"additionalProperties":false,"type":"object","required":["use","gadm","name","iso","id1"],"title":"Adm1BoundaryInfo"},"Adm2BoundaryInfo":{"properties":{"use":{"type":"object","title":"Use"},"simplifyThresh":{"type":"number","title":"Simplifythresh"},"gadm":{"type":"string","title":"Gadm"},"name":{"type":"string","title":"Name"},"iso":{"type":"string","title":"Iso"},"id1":{"type":"integer","title":"Id1"},"id2":{"type":"integer","title":"Id2"}},"additionalProperties":false,"type":"object","required":["use","gadm","name","iso","id1","id2"],"title":"Adm2BoundaryInfo"},"AdminAreaOfInterest":{"properties":{"type":{"type":"string","enum":["admin"],"title":"Type","default":"admin"},"country":{"type":"string","title":"ISO Country Code"},"region":{"type":"string","title":"Region"},"subregion":{"type":"string","title":"Subregion"},"provider":{"type":"string","title":"Administrative Boundary Provider","default":"gadm"},"version":{"type":"string","title":"Administrative Boundary Version","default":"4.1"},"simplify":{"type":"number","title":"Simplification factor for geometry"}},"additionalProperties":false,"type":"object","required":["country"],"title":"AdminAreaOfInterest"},"AdminGeostore":{"properties":{"type":{"type":"string","enum":["geoStore"],"title":"Type"},"id":{"type":"string","title":"Id"},"attributes":{"$ref":"#/components/schemas/AdminGeostoreAttributes"}},"additionalProperties":false,"type":"object","required":["type","id","attributes"],"title":"AdminGeostore"},"AdminGeostoreAttributes":{"properties":{"geojson":{"$ref":"#/components/schemas/FeatureCollection"},"hash":{"type":"string","title":"Hash"},"provider":{"type":"object","title":"Provider"},"areaHa":{"type":"number","title":"Areaha"},"bbox":{"items":{"type":"number"},"type":"array","title":"Bbox"},"lock":{"type":"boolean","title":"Lock"},"info":{"anyOf":[{"$ref":"#/components/schemas/Adm2BoundaryInfo"},{"$ref":"#/components/schemas/Adm1BoundaryInfo"},{"$ref":"#/components/schemas/Adm0BoundaryInfo"},{"$ref":"#/components/schemas/CreateGeostoreResponseInfo"},{"$ref":"#/components/schemas/LandUseInfo"},{"$ref":"#/components/schemas/WDPAInfo"}],"title":"Info"}},"additionalProperties":false,"type":"object","required":["geojson","hash","provider","areaHa","bbox","lock","info"],"title":"AdminGeostoreAttributes"},"AdminGeostoreResponse":{"properties":{"data":{"$ref":"#/components/schemas/AdminGeostore"},"status":{"type":"string","title":"Status","default":"success"}},"additionalProperties":false,"type":"object","required":["data"],"title":"AdminGeostoreResponse"},"AnalysisStatus":{"type":"string","enum":["saved","pending","failed"],"title":"AnalysisStatus","description":"An enumeration."},"Asset":{"properties":{"created_on":{"type":"string","format":"date-time","title":"Created On"},"updated_on":{"type":"string","format":"date-time","title":"Updated On"},"asset_id":{"type":"string","format":"uuid","title":"Asset Id"},"dataset":{"type":"string","title":"Dataset"},"version":{"type":"string","title":"Version"},"asset_type":{"$ref":"#/components/schemas/AssetType"},"asset_uri":{"type":"string","title":"Asset Uri"},"status":{"allOf":[{"$ref":"#/components/schemas/AssetStatus"}],"default":"pending"},"is_managed":{"type":"boolean","title":"Is Managed"},"is_downloadable":{"type":"boolean","title":"Is Downloadable"},"metadata":{"anyOf":[{"$ref":"#/components/schemas/DatabaseTableMetadataOut"},{"$ref":"#/components/schemas/StaticVectorTileCacheMetadataOut"},{"$ref":"#/components/schemas/DynamicVectorTileCacheMetadataOut"},{"$ref":"#/components/schemas/RasterTileCacheMetadataOut"},{"$ref":"#/components/schemas/RasterTileSetMetadataOut"},{"$ref":"#/components/schemas/VectorFileMetadataOut"},{"$ref":"#/components/schemas/BaseModel"}],"title":"Metadata"}},"type":"object","required":["created_on","updated_on","asset_id","dataset","version","asset_type","asset_uri","is_managed","is_downloadable"],"title":"Asset"},"AssetCreateIn":{"properties":{"asset_type":{"$ref":"#/components/schemas/AssetType"},"asset_uri":{"type":"string","title":"Asset Uri"},"is_managed":{"type":"boolean","title":"Is Managed","default":true},"is_downloadable":{"type":"boolean","title":"Is Downloadable","description":"Flag to specify if assets associated with version can be downloaded.If not set, value will default to settings of underlying version."},"creation_options":{"anyOf":[{"$ref":"#/components/schemas/TableAssetCreationOptions"},{"$ref":"#/components/schemas/COGCreationOptions"},{"$ref":"#/components/schemas/RasterTileCacheCreationOptions"},{"$ref":"#/components/schemas/StaticVectorTileCacheCreationOptions"},{"$ref":"#/components/schemas/StaticVectorFileCreationOptions"},{"$ref":"#/components/schemas/StaticVector1x1CreationOptions"},{"$ref":"#/components/schemas/DynamicVectorTileCacheCreationOptions"},{"$ref":"#/components/schemas/RasterTileSetAssetCreationOptions"}],"title":"Creation Options"},"metadata":{"anyOf":[{"$ref":"#/components/schemas/DatabaseTableMetadata"},{"$ref":"#/components/schemas/StaticVectorTileCacheMetadata"},{"$ref":"#/components/schemas/DynamicVectorTileCacheMetadata"},{"$ref":"#/components/schemas/RasterTileCacheMetadata"},{"$ref":"#/components/schemas/RasterTileSetMetadata"},{"$ref":"#/components/schemas/VectorFileMetadata"}],"title":"Metadata"}},"additionalProperties":false,"type":"object","required":["asset_type","creation_options"],"title":"AssetCreateIn"},"AssetMetadataResponse":{"properties":{"data":{"anyOf":[{"$ref":"#/components/schemas/DatabaseTableMetadataOut"},{"$ref":"#/components/schemas/StaticVectorTileCacheMetadataOut"},{"$ref":"#/components/schemas/DynamicVectorTileCacheMetadataOut"},{"$ref":"#/components/schemas/RasterTileCacheMetadataOut"},{"$ref":"#/components/schemas/RasterTileSetMetadataOut"},{"$ref":"#/components/schemas/VectorFileMetadataOut"}],"title":"Data"},"status":{"type":"string","title":"Status","default":"success"}},"additionalProperties":false,"type":"object","required":["data"],"title":"AssetMetadataResponse"},"AssetResponse":{"properties":{"data":{"$ref":"#/components/schemas/Asset"},"status":{"type":"string","title":"Status","default":"success"}},"additionalProperties":false,"type":"object","required":["data"],"title":"AssetResponse"},"AssetStatus":{"type":"string","enum":["saved","pending","failed"],"title":"AssetStatus","description":"An enumeration."},"AssetType":{"type":"string","enum":["Dynamic vector tile cache","Static vector tile cache","Raster tile cache","Raster tile set","Database table","Geo database table","ESRI Shapefile","Geopackage","ndjson","csv","tsv","1x1 grid","COG"],"title":"AssetType","description":"An enumeration."},"AssetUpdateIn":{"properties":{"is_downloadable":{"type":"boolean","title":"Is Downloadable","description":"Flag to specify if assets associated with version can be downloaded.If not set, value will default to settings of underlying version."},"metadata":{"anyOf":[{"$ref":"#/components/schemas/DatabaseTableMetadata"},{"$ref":"#/components/schemas/StaticVectorTileCacheMetadata"},{"$ref":"#/components/schemas/DynamicVectorTileCacheMetadata"},{"$ref":"#/components/schemas/RasterTileCacheMetadata"},{"$ref":"#/components/schemas/RasterTileSetMetadata"},{"$ref":"#/components/schemas/VectorFileMetadata"}],"title":"Metadata"}},"additionalProperties":false,"type":"object","title":"AssetUpdateIn"},"AssetsResponse":{"properties":{"data":{"items":{"$ref":"#/components/schemas/Asset"},"type":"array","title":"Data"},"status":{"type":"string","title":"Status","default":"success"}},"additionalProperties":false,"type":"object","required":["data"],"title":"AssetsResponse"},"BandStats":{"properties":{"min":{"type":"number","title":"Min","description":"Minimum pixel value."},"max":{"type":"number","title":"Max","description":"Maximum pixel value."},"mean":{"type":"number","title":"Mean","description":"Mean pixel value."},"histogram":{"allOf":[{"$ref":"#/components/schemas/Histogram"}],"title":"Histogram","description":"Histogram."}},"additionalProperties":false,"type":"object","required":["min","max","mean"],"title":"BandStats"},"BaseModel":{"properties":{},"type":"object","title":"BaseModel"},"Body_get_token_auth_token_post":{"properties":{"grant_type":{"type":"string","pattern":"^password$","title":"Grant Type"},"username":{"type":"string","title":"Username"},"password":{"type":"string","format":"password","title":"Password"},"scope":{"type":"string","title":"Scope","default":""},"client_id":{"type":"string","title":"Client Id"},"client_secret":{"type":"string","format":"password","title":"Client Secret"}},"type":"object","required":["username","password"],"title":"Body_get_token_auth_token_post"},"COGCreationOptions":{"properties":{"implementation":{"type":"string","title":"Implementation","description":"Name space to use for COG. This will be part of the URI and will allow creation of multiple COGs per version.","default":"default"},"source_asset_id":{"type":"string","title":"Source Asset Id","description":"Raster tile set asset ID to use as source. Must be an asset of the same version"},"resampling":{"allOf":[{"$ref":"#/components/schemas/ResamplingMethod"}],"description":"Resampling method used to downsample overviews","default":"average"},"block_size":{"allOf":[{"$ref":"#/components/schemas/TileBlockSize"}],"description":"Block size to tile COG with.","default":512},"compute_stats":{"type":"boolean","title":"Compute Stats","default":false},"export_to_gee":{"type":"boolean","title":"Export To Gee","description":"Option to export COG to a Google Cloud Storage at gs://data-api-gee-assets/{dataset}/{implementation}.","default":false},"no_data":{"anyOf":[{"items":{"anyOf":[{"type":"integer"},{"$ref":"#/components/schemas/NonNumericFloat"}]},"type":"array"},{"type":"integer"},{"$ref":"#/components/schemas/NonNumericFloat"}],"title":"No Data","description":"Used to specify a specific nodata value in the gdal_translate call that creates the COG"}},"additionalProperties":false,"type":"object","required":["source_asset_id"],"title":"COGCreationOptions"},"ChangeLog":{"properties":{"date_time":{"type":"string","format":"date-time","title":"Date Time"},"status":{"$ref":"#/components/schemas/ChangeLogStatus"},"message":{"type":"string","title":"Message"},"detail":{"type":"string","title":"Detail"}},"additionalProperties":false,"type":"object","required":["date_time","status","message"],"title":"ChangeLog"},"ChangeLogResponse":{"properties":{"data":{"items":{"$ref":"#/components/schemas/ChangeLog"},"type":"array","title":"Data"},"status":{"type":"string","title":"Status","default":"success"}},"additionalProperties":false,"type":"object","required":["data"],"title":"ChangeLogResponse"},"ChangeLogStatus":{"type":"string","enum":["success","failed","pending"],"title":"ChangeLogStatus","description":"An enumeration."},"ColorMapType":{"type":"string","enum":["discrete","discrete_intensity","gradient","gradient_intensity","date_conf_intensity","date_conf_intensity_multi_8","date_conf_intensity_multi_16","year_intensity","value_intensity"],"title":"ColorMapType","description":"An enumeration."},"Constraint":{"properties":{"constraint_type":{"$ref":"#/components/schemas/ConstraintType"},"column_names":{"items":{"type":"string","pattern":"^[a-z][a-zA-Z0-9_-]{2,}$"},"type":"array","pattern":"^[a-z][a-zA-Z0-9_-]{2,}$","maxItems":32,"minItems":1,"title":"Column Names","description":"Columns included in the constraint"}},"additionalProperties":false,"type":"object","required":["constraint_type","column_names"],"title":"Constraint"},"ConstraintType":{"type":"string","enum":["unique"],"title":"ConstraintType","description":"Constraint type"},"ContentDateRange":{"properties":{"start_date":{"type":"string","format":"date","title":"Start Date","description":"Beginning date covered by data"},"end_date":{"type":"string","format":"date","title":"End Date","description":"End date covered by data"}},"additionalProperties":false,"type":"object","title":"ContentDateRange"},"CreateGeostoreResponseInfo":{"properties":{"use":{"type":"object","title":"Use"}},"additionalProperties":false,"type":"object","required":["use"],"title":"CreateGeostoreResponseInfo"},"CreationOptionsResponse":{"properties":{"data":{"anyOf":[{"$ref":"#/components/schemas/TableSourceCreationOptions"},{"$ref":"#/components/schemas/RasterTileSetSourceCreationOptions"},{"$ref":"#/components/schemas/VectorSourceCreationOptions"},{"$ref":"#/components/schemas/TableAssetCreationOptions"},{"$ref":"#/components/schemas/COGCreationOptions"},{"$ref":"#/components/schemas/RasterTileCacheCreationOptions"},{"$ref":"#/components/schemas/StaticVectorTileCacheCreationOptions"},{"$ref":"#/components/schemas/StaticVectorFileCreationOptions"},{"$ref":"#/components/schemas/StaticVector1x1CreationOptions"},{"$ref":"#/components/schemas/DynamicVectorTileCacheCreationOptions"},{"$ref":"#/components/schemas/RasterTileSetAssetCreationOptions"}],"title":"Data"},"status":{"type":"string","title":"Status","default":"success"}},"additionalProperties":false,"type":"object","required":["data"],"title":"CreationOptionsResponse"},"CsvQueryRequestIn":{"properties":{"geometry":{"$ref":"#/components/schemas/Geometry"},"sql":{"type":"string","title":"Sql"},"delimiter":{"allOf":[{"$ref":"#/components/schemas/Delimiters"}],"default":","}},"additionalProperties":false,"type":"object","required":["sql"],"title":"CsvQueryRequestIn"},"DataMartResourceLink":{"properties":{"link":{"type":"string","title":"Link"}},"additionalProperties":false,"type":"object","required":["link"],"title":"DataMartResourceLink"},"DataMartResourceLinkResponse":{"properties":{"data":{"$ref":"#/components/schemas/DataMartResourceLink"},"status":{"type":"string","title":"Status","default":"success"}},"additionalProperties":false,"type":"object","required":["data"],"title":"DataMartResourceLinkResponse"},"DataMartSource":{"properties":{"dataset":{"type":"string","title":"Dataset"},"version":{"type":"string","title":"Version"}},"additionalProperties":false,"type":"object","required":["dataset","version"],"title":"DataMartSource"},"DataType":{"type":"string","enum":["boolean","uint8","int8","uint16","int16","uint32","int32","float16","half","float32","single","float64","double"],"title":"DataType","description":"An enumeration."},"DatabaseTableMetadata":{"properties":{"tags":{"items":{"type":"string"},"type":"array","title":"Tags"},"fields":{"items":{"$ref":"#/components/schemas/FieldMetadata"},"type":"array","title":"Fields"}},"additionalProperties":false,"type":"object","title":"DatabaseTableMetadata"},"DatabaseTableMetadataOut":{"properties":{"tags":{"items":{"type":"string"},"type":"array","title":"Tags"},"fields":{"items":{"$ref":"#/components/schemas/FieldMetadataOut"},"type":"array","title":"Fields"},"id":{"type":"string","format":"uuid","title":"Id"}},"additionalProperties":false,"type":"object","required":["id"],"title":"DatabaseTableMetadataOut"},"Dataset":{"properties":{"created_on":{"type":"string","format":"date-time","title":"Created On"},"updated_on":{"type":"string","format":"date-time","title":"Updated On"},"dataset":{"type":"string","title":"Dataset"},"is_downloadable":{"type":"boolean","title":"Is Downloadable"},"metadata":{"anyOf":[{"$ref":"#/components/schemas/DatasetMetadataOut"},{"$ref":"#/components/schemas/BaseModel"}],"title":"Metadata"},"versions":{"items":{"type":"string"},"type":"array","title":"Versions","default":[]}},"type":"object","required":["created_on","updated_on","dataset","is_downloadable"],"title":"Dataset"},"DatasetCreateIn":{"properties":{"is_downloadable":{"type":"boolean","title":"Is Downloadable","description":"Flag to specify if assets associated with dataset can be downloaded.All associated versions and assets will inherit this value. Value can be overridden at version  or asset level.","default":true},"metadata":{"$ref":"#/components/schemas/DatasetMetadata"}},"additionalProperties":false,"type":"object","required":["metadata"],"title":"DatasetCreateIn"},"DatasetMetadata":{"properties":{"spatial_resolution":{"anyOf":[{"type":"integer"},{"type":"number"}],"title":"Spatial Resolution"},"resolution_description":{"type":"string","title":"Resolution Description"},"geographic_coverage":{"type":"string","title":"Geographic Coverage"},"update_frequency":{"type":"string","title":"Update Frequency"},"scale":{"type":"string","title":"Scale"},"citation":{"type":"string","title":"Citation"},"title":{"type":"string","title":"Title"},"subtitle":{"type":"string","title":"Subtitle"},"source":{"type":"string","title":"Source"},"license":{"type":"string","title":"License"},"data_language":{"type":"string","title":"Data Language"},"overview":{"type":"string","title":"Overview"},"function":{"type":"string","title":"Function"},"cautions":{"type":"string","title":"Cautions"},"key_restrictions":{"type":"string","title":"Key Restrictions"},"tags":{"items":{"type":"string"},"type":"array","title":"Tags"},"why_added":{"type":"string","title":"Why Added"},"learn_more":{"type":"string","title":"Learn More"}},"type":"object","title":"DatasetMetadata","examples":[{"title":"Deforestation alerts (GLAD-S2)","subtitle":"Sentinel-2 based deforestation alerts","source":"Global Land Analysis and Discovery (GLAD), University of Maryland","license":"[CC BY 4.0](https://creativecommons.org/licenses/by/4.0/)","data_language":"en","overview":"This data set is a forest loss alert product developed by the Global Land Analysis and Discovery lab at the University of Maryland. GLAD-S2 alerts utilize data from the European Space Agency's Sentinel-2 mission, which provides optical imagery at a 10m spatial resolution with a 5-day revisit time. The shorter revisit time, when compared to GLAD Landsat alerts, reduces the time to detect forest loss and between the initial detection of forest loss and classification as high confidence. This is particularly advantageous in wet and tropical regions, where persistent cloud cover may delay detections for weeks to months. GLAD-S2 alerts are available for primary forests in the Amazon basin from January 1st 2019 to present, updated daily. New Sentinel-2 images are analyzed as soon as they are acquired. Cloud, shadow, and water are filtered out of each new image, and a forest loss algorithm is applied to all remaining clear land observations. The algorithm relies on the spectral data in each new image in combination with spectral metrics from a baseline period of the previous two years. Alerts become high confidence when at least two of four subsequent observations are flagged as forest loss (this corresponds to 'high', 'medium', and 'low' confidence loss on the GLAD app linked below). The alert date represents the date of forest loss detection. Users can choose to display only high confidence alerts on the map, but keep in mind this will filter out the most recent detections of forest loss. Additionally, forest loss will not be detected again on pixels with high confidence alerts. Alerts that have not become high confidence within 180 days are removed from the data set.","function":"Identifies areas of primary forest loss  in near real time using Sentinel-2 imagery","citation":"Pickens, A.H., Hansen, M.C., Adusei, B., and Potapov P. 2020. Sentinel-2 Forest Loss Alert. Global Land Analysis and Discovery (GLAD), University of Maryland.","cautions":"Results are masked to only within the primary forest mask of [Turubanova et al (2018)](https://iopscience.iop.org/article/10.1088/1748-9326/aacd1c) in the Amazon river basin, with 2001-2018 forest loss from [Hansen et al. (2013)](https://science.sciencemag.org/content/342/6160/850) removed. Alerts that have been detected in two out of four consecutive images are classified as high confidence. Pixels with high confidence alerts cannot be alerted again. The accuracy of this product has not been assessed","tags":["Forest Change"],"learn_more":"https://glad.earthengine.app/view/s2-forest-alerts"}]},"DatasetMetadataOut":{"properties":{"created_on":{"type":"string","format":"date-time","title":"Created On"},"updated_on":{"type":"string","format":"date-time","title":"Updated On"},"spatial_resolution":{"anyOf":[{"type":"integer"},{"type":"number"}],"title":"Spatial Resolution"},"resolution_description":{"type":"string","title":"Resolution Description"},"geographic_coverage":{"type":"string","title":"Geographic Coverage"},"update_frequency":{"type":"string","title":"Update Frequency"},"scale":{"type":"string","title":"Scale"},"citation":{"type":"string","title":"Citation"},"title":{"type":"string","title":"Title"},"subtitle":{"type":"string","title":"Subtitle"},"source":{"type":"string","title":"Source"},"license":{"type":"string","title":"License"},"data_language":{"type":"string","title":"Data Language"},"overview":{"type":"string","title":"Overview"},"function":{"type":"string","title":"Function"},"cautions":{"type":"string","title":"Cautions"},"key_restrictions":{"type":"string","title":"Key Restrictions"},"tags":{"items":{"type":"string"},"type":"array","title":"Tags"},"why_added":{"type":"string","title":"Why Added"},"learn_more":{"type":"string","title":"Learn More"},"id":{"type":"string","format":"uuid","title":"Id"}},"type":"object","required":["created_on","updated_on","id"],"title":"DatasetMetadataOut","examples":[{"title":"Deforestation alerts (GLAD-S2)","subtitle":"Sentinel-2 based deforestation alerts","source":"Global Land Analysis and Discovery (GLAD), University of Maryland","license":"[CC BY 4.0](https://creativecommons.org/licenses/by/4.0/)","data_language":"en","overview":"This data set is a forest loss alert product developed by the Global Land Analysis and Discovery lab at the University of Maryland. GLAD-S2 alerts utilize data from the European Space Agency's Sentinel-2 mission, which provides optical imagery at a 10m spatial resolution with a 5-day revisit time. The shorter revisit time, when compared to GLAD Landsat alerts, reduces the time to detect forest loss and between the initial detection of forest loss and classification as high confidence. This is particularly advantageous in wet and tropical regions, where persistent cloud cover may delay detections for weeks to months. GLAD-S2 alerts are available for primary forests in the Amazon basin from January 1st 2019 to present, updated daily. New Sentinel-2 images are analyzed as soon as they are acquired. Cloud, shadow, and water are filtered out of each new image, and a forest loss algorithm is applied to all remaining clear land observations. The algorithm relies on the spectral data in each new image in combination with spectral metrics from a baseline period of the previous two years. Alerts become high confidence when at least two of four subsequent observations are flagged as forest loss (this corresponds to 'high', 'medium', and 'low' confidence loss on the GLAD app linked below). The alert date represents the date of forest loss detection. Users can choose to display only high confidence alerts on the map, but keep in mind this will filter out the most recent detections of forest loss. Additionally, forest loss will not be detected again on pixels with high confidence alerts. Alerts that have not become high confidence within 180 days are removed from the data set.","function":"Identifies areas of primary forest loss  in near real time using Sentinel-2 imagery","citation":"Pickens, A.H., Hansen, M.C., Adusei, B., and Potapov P. 2020. Sentinel-2 Forest Loss Alert. Global Land Analysis and Discovery (GLAD), University of Maryland.","cautions":"Results are masked to only within the primary forest mask of [Turubanova et al (2018)](https://iopscience.iop.org/article/10.1088/1748-9326/aacd1c) in the Amazon river basin, with 2001-2018 forest loss from [Hansen et al. (2013)](https://science.sciencemag.org/content/342/6160/850) removed. Alerts that have been detected in two out of four consecutive images are classified as high confidence. Pixels with high confidence alerts cannot be alerted again. The accuracy of this product has not been assessed","tags":["Forest Change"],"learn_more":"https://glad.earthengine.app/view/s2-forest-alerts"}]},"DatasetMetadataUpdate":{"properties":{"spatial_resolution":{"anyOf":[{"type":"integer"},{"type":"number"}],"title":"Spatial Resolution"},"resolution_description":{"type":"string","title":"Resolution Description"},"geographic_coverage":{"type":"string","title":"Geographic Coverage"},"update_frequency":{"type":"string","title":"Update Frequency"},"scale":{"type":"string","title":"Scale"},"citation":{"type":"string","title":"Citation"},"title":{"type":"string","title":"Title"},"subtitle":{"type":"string","title":"Subtitle"},"source":{"type":"string","title":"Source"},"license":{"type":"string","title":"License"},"data_language":{"type":"string","title":"Data Language"},"overview":{"type":"string","title":"Overview"},"function":{"type":"string","title":"Function"},"cautions":{"type":"string","title":"Cautions"},"key_restrictions":{"type":"string","title":"Key Restrictions"},"tags":{"items":{"type":"string"},"type":"array","title":"Tags"},"why_added":{"type":"string","title":"Why Added"},"learn_more":{"type":"string","title":"Learn More"}},"type":"object","title":"DatasetMetadataUpdate","examples":[{"title":"Deforestation alerts (GLAD-S2)","subtitle":"Sentinel-2 based deforestation alerts","source":"Global Land Analysis and Discovery (GLAD), University of Maryland","license":"[CC BY 4.0](https://creativecommons.org/licenses/by/4.0/)","data_language":"en","overview":"This data set is a forest loss alert product developed by the Global Land Analysis and Discovery lab at the University of Maryland. GLAD-S2 alerts utilize data from the European Space Agency's Sentinel-2 mission, which provides optical imagery at a 10m spatial resolution with a 5-day revisit time. The shorter revisit time, when compared to GLAD Landsat alerts, reduces the time to detect forest loss and between the initial detection of forest loss and classification as high confidence. This is particularly advantageous in wet and tropical regions, where persistent cloud cover may delay detections for weeks to months. GLAD-S2 alerts are available for primary forests in the Amazon basin from January 1st 2019 to present, updated daily. New Sentinel-2 images are analyzed as soon as they are acquired. Cloud, shadow, and water are filtered out of each new image, and a forest loss algorithm is applied to all remaining clear land observations. The algorithm relies on the spectral data in each new image in combination with spectral metrics from a baseline period of the previous two years. Alerts become high confidence when at least two of four subsequent observations are flagged as forest loss (this corresponds to 'high', 'medium', and 'low' confidence loss on the GLAD app linked below). The alert date represents the date of forest loss detection. Users can choose to display only high confidence alerts on the map, but keep in mind this will filter out the most recent detections of forest loss. Additionally, forest loss will not be detected again on pixels with high confidence alerts. Alerts that have not become high confidence within 180 days are removed from the data set.","function":"Identifies areas of primary forest loss  in near real time using Sentinel-2 imagery","citation":"Pickens, A.H., Hansen, M.C., Adusei, B., and Potapov P. 2020. Sentinel-2 Forest Loss Alert. Global Land Analysis and Discovery (GLAD), University of Maryland.","cautions":"Results are masked to only within the primary forest mask of [Turubanova et al (2018)](https://iopscience.iop.org/article/10.1088/1748-9326/aacd1c) in the Amazon river basin, with 2001-2018 forest loss from [Hansen et al. (2013)](https://science.sciencemag.org/content/342/6160/850) removed. Alerts that have been detected in two out of four consecutive images are classified as high confidence. Pixels with high confidence alerts cannot be alerted again. The accuracy of this product has not been assessed","tags":["Forest Change"],"learn_more":"https://glad.earthengine.app/view/s2-forest-alerts"}]},"DatasetResponse":{"properties":{"data":{"$ref":"#/components/schemas/Dataset"},"status":{"type":"string","title":"Status","default":"success"}},"additionalProperties":false,"type":"object","required":["data"],"title":"DatasetResponse"},"DatasetUpdateIn":{"properties":{"is_downloadable":{"type":"boolean","title":"Is Downloadable"},"metadata":{"$ref":"#/components/schemas/DatasetMetadataUpdate"},"owner_id":{"type":"string","title":"Owner Id"}},"additionalProperties":false,"type":"object","title":"DatasetUpdateIn"},"DatasetsResponse":{"properties":{"data":{"items":{"$ref":"#/components/schemas/Dataset"},"type":"array","title":"Data"},"status":{"type":"string","title":"Status","default":"success"}},"additionalProperties":false,"type":"object","required":["data"],"title":"DatasetsResponse"},"DateFieldStats":{"properties":{"name":{"type":"string","title":"Name","description":"Field name"},"data_type":{"$ref":"#/components/schemas/PGDateType"},"min":{"type":"string","format":"date","title":"Min","description":"Minimum value in column."},"max":{"type":"string","format":"date","title":"Max","description":"Maximum value in column."}},"additionalProperties":false,"type":"object","required":["name","data_type","min","max"],"title":"DateFieldStats"},"Delimiters":{"type":"string","enum":[",","\t","|",";"],"title":"Delimiters","description":"Delimiter used to separate columns in input text file"},"DownloadCSVIn":{"properties":{"sql":{"type":"string","title":"Sql","description":"SQL query."},"geometry":{"allOf":[{"$ref":"#/components/schemas/Geometry"}],"title":"Geometry","description":"A geojson geometry to be used as spatial filter."},"filename":{"type":"string","title":"Filename","description":"Name of export file.","default":"export.csv"},"delimiter":{"allOf":[{"$ref":"#/components/schemas/Delimiters"}],"description":"Delimiter to use for CSV file.","default":","}},"additionalProperties":false,"type":"object","required":["sql"],"title":"DownloadCSVIn"},"DownloadJSONIn":{"properties":{"sql":{"type":"string","title":"Sql","description":"SQL query."},"geometry":{"allOf":[{"$ref":"#/components/schemas/Geometry"}],"title":"Geometry","description":"A geojson geometry to be used as spatial filter."},"filename":{"type":"string","title":"Filename","description":"Name of export file.","default":"export.json"}},"additionalProperties":false,"type":"object","required":["sql"],"title":"DownloadJSONIn"},"DynamicVectorTileCacheCreationOptions":{"properties":{"min_zoom":{"type":"integer","maximum":22.0,"minimum":0.0,"title":"Min Zoom","description":"Minimum zoom level of tile cache","default":0},"max_zoom":{"type":"integer","maximum":22.0,"minimum":0.0,"title":"Max Zoom","description":"Maximum zoom level of tile cache","default":14},"timeout_sec":{"type":"integer","title":"Timeout Sec","description":"Maximum run time for associated AWS Batch jobs, in seconds"},"field_attributes":{"items":{"type":"object"},"type":"array","title":"Field Attributes","description":"Field attributes to include in vector tiles. If left blank, all fields marked as `is_feature_info` will be included."}},"additionalProperties":false,"type":"object","title":"DynamicVectorTileCacheCreationOptions"},"DynamicVectorTileCacheMetadata":{"properties":{"tags":{"items":{"type":"string"},"type":"array","title":"Tags"},"min_zoom":{"type":"integer","title":"Min Zoom","default":0},"max_zoom":{"type":"integer","title":"Max Zoom","default":22},"fields":{"items":{"$ref":"#/components/schemas/FieldMetadata"},"type":"array","title":"Fields"}},"additionalProperties":false,"type":"object","title":"DynamicVectorTileCacheMetadata"},"DynamicVectorTileCacheMetadataOut":{"properties":{"tags":{"items":{"type":"string"},"type":"array","title":"Tags"},"min_zoom":{"type":"integer","title":"Min Zoom","default":0},"max_zoom":{"type":"integer","title":"Max Zoom","default":22},"fields":{"items":{"$ref":"#/components/schemas/FieldMetadataOut"},"type":"array","title":"Fields"},"id":{"type":"string","format":"uuid","title":"Id"}},"additionalProperties":false,"type":"object","required":["id"],"title":"DynamicVectorTileCacheMetadataOut"},"Extent":{"properties":{"features":{"items":{"$ref":"#/components/schemas/Feature"},"type":"array","title":"Features"},"crs":{"type":"object","title":"Crs"},"type":{"type":"string","title":"Type"}},"additionalProperties":false,"type":"object","required":["features","type"],"title":"Extent"},"ExtentResponse":{"properties":{"data":{"$ref":"#/components/schemas/Extent"},"status":{"type":"string","title":"Status","default":"success"}},"additionalProperties":false,"type":"object","title":"ExtentResponse"},"Feature":{"properties":{"properties":{"type":"object","title":"Properties"},"type":{"type":"string","title":"Type"},"geometry":{"$ref":"#/components/schemas/Geometry"}},"additionalProperties":false,"type":"object","required":["type"],"title":"Feature"},"FeatureCollection":{"properties":{"features":{"items":{"$ref":"#/components/schemas/Feature"},"type":"array","title":"Features"},"crs":{"type":"object","title":"Crs"},"type":{"type":"string","title":"Type"}},"additionalProperties":false,"type":"object","required":["features","type"],"title":"FeatureCollection"},"FieldMetadata":{"properties":{"name":{"type":"string","title":"Name"},"alias":{"type":"string","title":"Alias"},"description":{"type":"string","title":"Description"},"data_type":{"$ref":"#/components/schemas/PGType"},"unit":{"type":"string","title":"Unit"},"is_feature_info":{"type":"boolean","title":"Is Feature Info","default":true},"is_filter":{"type":"boolean","title":"Is Filter","default":true}},"additionalProperties":false,"type":"object","required":["name","data_type"],"title":"FieldMetadata"},"FieldMetadataOut":{"properties":{"name":{"type":"string","title":"Name"},"alias":{"type":"string","title":"Alias"},"description":{"type":"string","title":"Description"},"data_type":{"$ref":"#/components/schemas/PGType"},"unit":{"type":"string","title":"Unit"},"is_feature_info":{"type":"boolean","title":"Is Feature Info","default":true},"is_filter":{"type":"boolean","title":"Is Filter","default":true}},"additionalProperties":false,"type":"object","required":["name","data_type"],"title":"FieldMetadataOut"},"FieldMetadataResponse":{"properties":{"data":{"$ref":"#/components/schemas/FieldMetadataOut"},"status":{"type":"string","title":"Status","default":"success"}},"additionalProperties":false,"type":"object","required":["data"],"title":"FieldMetadataResponse"},"FieldMetadataUpdate":{"properties":{"alias":{"type":"string","title":"Alias"},"description":{"type":"string","title":"Description"},"unit":{"type":"string","title":"Unit"},"is_feature_info":{"type":"boolean","title":"Is Feature Info"},"is_filter":{"type":"boolean","title":"Is Filter"}},"additionalProperties":false,"type":"object","title":"FieldMetadataUpdate"},"FieldType":{"properties":{"name":{"type":"string","pattern":"^[a-z][a-zA-Z0-9_-]{2,}$","title":"Name","description":"Name of field"},"data_type":{"allOf":[{"$ref":"#/components/schemas/PGType"}],"description":"Type of field (PostgreSQL data type)."}},"additionalProperties":false,"type":"object","required":["name","data_type"],"title":"FieldType"},"FieldsMetadataResponse":{"properties":{"data":{"items":{"$ref":"#/components/schemas/FieldMetadataOut"},"type":"array","title":"Data"},"status":{"type":"string","title":"Status","default":"success"}},"additionalProperties":false,"type":"object","required":["data"],"title":"FieldsMetadataResponse"},"Geometry":{"properties":{"type":{"type":"string","title":"Type"},"coordinates":{"items":{},"type":"array","title":"Coordinates"}},"additionalProperties":false,"type":"object","required":["type","coordinates"],"title":"Geometry"},"GeometryFieldStats":{"properties":{"name":{"type":"string","title":"Name","description":"Field name"},"data_type":{"$ref":"#/components/schemas/PGGeometryType"},"geometry_types":{"items":{"type":"string"},"type":"array","title":"Geometry Types","description":"Geometry types contained in dataset"},"crs":{"type":"string","title":"Crs","description":"Coordinate reference system."},"extent":{"allOf":[{"$ref":"#/components/schemas/FeatureCollection"}],"title":"Extent","description":"GeoJSON representation of feature extent."}},"additionalProperties":false,"type":"object","required":["name","data_type","geometry_types","crs","extent"],"title":"GeometryFieldStats"},"Geostore":{"properties":{"created_on":{"type":"string","format":"date-time","title":"Created On"},"updated_on":{"type":"string","format":"date-time","title":"Updated On"},"gfw_geostore_id":{"type":"string","format":"uuid","title":"Gfw Geostore Id"},"gfw_geojson":{"$ref":"#/components/schemas/Geometry"},"gfw_area__ha":{"type":"number","title":"Gfw Area  Ha"},"gfw_bbox":{"items":{"type":"number"},"type":"array","title":"Gfw Bbox"}},"type":"object","required":["created_on","updated_on","gfw_geostore_id","gfw_geojson","gfw_area__ha","gfw_bbox"],"title":"Geostore"},"GeostoreAreaOfInterest":{"properties":{"type":{"type":"string","enum":["geostore"],"title":"Type","default":"geostore"},"geostore_id":{"type":"string","format":"uuid","title":"Geostore ID"}},"additionalProperties":false,"type":"object","required":["geostore_id"],"title":"GeostoreAreaOfInterest"},"GeostoreIn":{"properties":{"geometry":{"$ref":"#/components/schemas/Geometry"}},"additionalProperties":false,"type":"object","required":["geometry"],"title":"GeostoreIn"},"GeostoreOrigin":{"type":"string","enum":["gfw","rw"],"title":"GeostoreOrigin","description":"An enumeration."},"GeostoreResponse":{"properties":{"data":{"$ref":"#/components/schemas/Geostore"},"status":{"type":"string","title":"Status","default":"success"}},"additionalProperties":false,"type":"object","required":["data"],"title":"GeostoreResponse"},"Global":{"properties":{"type":{"type":"string","enum":["global"],"title":"Type","description":"Apply analysis to the full spatial extent of the dataset.","default":"global"}},"additionalProperties":false,"type":"object","title":"Global"},"Grid":{"type":"string","enum":["1/4000","3/33600","3/50000","8/32000","10/40000","10/100000","90/1008","90/9984","90/27008","zoom_0","zoom_1","zoom_2","zoom_3","zoom_4","zoom_5","zoom_6","zoom_7","zoom_8","zoom_9","zoom_10","zoom_11","zoom_12","zoom_13","zoom_14","zoom_15","zoom_16","zoom_17","zoom_18","zoom_19","zoom_20","zoom_21","zoom_22"],"title":"Grid","description":"An enumeration."},"HTTPValidationError":{"properties":{"detail":{"items":{"$ref":"#/components/schemas/ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"},"HashPartitionSchema":{"properties":{"partition_count":{"type":"integer","exclusiveMinimum":0.0,"title":"Partition Count"}},"additionalProperties":false,"type":"object","required":["partition_count"],"title":"HashPartitionSchema"},"Histogram":{"properties":{"bin_count":{"type":"integer","title":"Bin Count","description":"Number of bins in histogram."},"min":{"type":"number","title":"Min","description":"Minimum bin value."},"max":{"type":"number","title":"Max","description":"Maximum bin value."},"value_count":{"items":{"type":"integer"},"type":"array","title":"Value Count","description":"Value count for each bin."}},"additionalProperties":false,"type":"object","required":["bin_count","min","max","value_count"],"title":"Histogram"},"Index":{"properties":{"index_type":{"$ref":"#/components/schemas/IndexType"},"column_names":{"items":{"type":"string","pattern":"^[a-z][a-zA-Z0-9_-]{2,}$"},"type":"array","pattern":"^[a-z][a-zA-Z0-9_-]{2,}$","maxItems":32,"minItems":1,"title":"Column Names","description":"Columns to be used by index"}},"additionalProperties":false,"type":"object","required":["index_type","column_names"],"title":"Index"},"IndexType":{"type":"string","enum":["gist","btree","hash"],"title":"IndexType","description":"Index type"},"LandUseInfo":{"properties":{"use":{"$ref":"#/components/schemas/LandUseUse"},"simplify":{"type":"boolean","title":"Simplify"}},"additionalProperties":false,"type":"object","required":["use","simplify"],"title":"LandUseInfo"},"LandUseUse":{"properties":{"use":{"type":"string","title":"Use"},"id":{"type":"integer","title":"Id"}},"additionalProperties":false,"type":"object","required":["use","id"],"title":"LandUseUse"},"ListPartitionSchema":{"properties":{"partition_suffix":{"type":"string","pattern":"^[a-z0-9_-]{3,}$","title":"Partition Suffix","description":"Suffix for partition table"},"value_list":{"items":{"type":"string","pattern":"^[a-zA-Z0-9_-]{1,}$"},"type":"array","pattern":"^[a-zA-Z0-9_-]{1,}$","title":"Value List","description":"List of values for partition"}},"additionalProperties":false,"type":"object","required":["partition_suffix","value_list"],"title":"ListPartitionSchema"},"NonNumericFloat":{"type":"string","enum":["nan"],"title":"NonNumericFloat","description":"An enumeration."},"NumericFieldStats":{"properties":{"data_type":{"$ref":"#/components/schemas/PGNumericType"},"min":{"type":"number","title":"Min","description":"Minimum value in column."},"max":{"type":"number","title":"Max","description":"Maximum value in column."},"sum":{"type":"number","title":"Sum","description":"Sum of column."},"mean":{"type":"number","title":"Mean","description":"Mean value of column."},"std_dev":{"type":"number","title":"Std Dev","description":"Standard deviation of column."}},"additionalProperties":false,"type":"object","required":["data_type","min","max","sum","mean","std_dev"],"title":"NumericFieldStats"},"Order":{"type":"string","enum":["asc","desc"],"title":"Order","description":"An enumeration."},"PGDateType":{"type":"string","enum":["date","timestamp","timestamp without time zone"],"title":"PGDateType","description":"Date PostgreSQL data types"},"PGGeometryType":{"type":"string","enum":["geometry"],"title":"PGGeometryType","description":"Geometry PostgreSQL data types"},"PGNumericType":{"type":"string","enum":["bigint","double precision","integer","numeric","smallint"],"title":"PGNumericType","description":"Numeric PostgreSQL data types"},"PGTextType":{"type":"string","enum":["character varying","text"],"title":"PGTextType","description":"Text PostgreSQL data types"},"PGType":{"type":"string","enum":["date","timestamp","timestamp without time zone","character varying","text","bigint","double precision","integer","numeric","smallint","geometry","ARRAY","boolean","jsonb","time","uuid","xml"],"title":"PGType","description":"PostgreSQL data type enumeration"},"PaginatedAssetsResponse":{"properties":{"data":{"items":{"$ref":"#/components/schemas/Asset"},"type":"array","title":"Data"},"status":{"type":"string","title":"Status","default":"success"},"links":{"$ref":"#/components/schemas/PaginationLinks"},"meta":{"$ref":"#/components/schemas/PaginationMeta"}},"additionalProperties":false,"type":"object","required":["data","links","meta"],"title":"PaginatedAssetsResponse"},"PaginatedDatasetsResponse":{"properties":{"data":{"items":{"$ref":"#/components/schemas/Dataset"},"type":"array","title":"Data"},"status":{"type":"string","title":"Status","default":"success"},"links":{"$ref":"#/components/schemas/PaginationLinks"},"meta":{"$ref":"#/components/schemas/PaginationMeta"}},"additionalProperties":false,"type":"object","required":["data","links","meta"],"title":"PaginatedDatasetsResponse"},"PaginatedTasksResponse":{"properties":{"data":{"items":{"$ref":"#/components/schemas/Task"},"type":"array","title":"Data"},"status":{"type":"string","title":"Status","default":"success"},"links":{"$ref":"#/components/schemas/PaginationLinks"},"meta":{"$ref":"#/components/schemas/PaginationMeta"}},"additionalProperties":false,"type":"object","required":["data","links","meta"],"title":"PaginatedTasksResponse"},"PaginationLinks":{"properties":{"self":{"type":"string","title":"Contains the URL for the current page","example":"https://data-api.globalforestwatch.org/:model?page[number]=1&page[size]=25"},"first":{"type":"string","title":"Contains the URL for the first page","example":"https://data-api.globalforestwatch.org/:model?page[number]=1&page[size]=25"},"last":{"type":"string","title":"Contains the URL for the last page","example":"https://data-api.globalforestwatch.org/:model?page[number]=4&page[size]=25"},"prev":{"type":"string","title":"Contains the URL for the previous page","example":""},"next":{"type":"string","title":"Contains the URL for the next page","example":"https://data-api.globalforestwatch.org/:model?page[number]=2&page[size]=25"}},"additionalProperties":false,"type":"object","required":["self","first","last"],"title":"PaginationLinks"},"PaginationMeta":{"properties":{"size":{"type":"integer","title":"The page size. Reflects the value used in the page[size] query parameter (or the default size of 10 if not provided)","example":"25"},"total_items":{"type":"integer","title":"Contains the total number of items","example":"100"},"total_pages":{"type":"integer","title":"Contains the total number of pages, assuming the page size specified in the page[size] query parameter","example":"4"}},"additionalProperties":false,"type":"object","required":["size","total_items","total_pages"],"title":"PaginationMeta"},"PartitionType":{"type":"string","enum":["hash","list","range"],"title":"PartitionType","description":"An enumeration."},"Partitions":{"properties":{"partition_type":{"allOf":[{"$ref":"#/components/schemas/PartitionType"}],"description":"Partition type"},"partition_column":{"type":"string","pattern":"^[a-z][a-zA-Z0-9_-]{2,}$","title":"Partition Column","description":"Column to be used to create partitions."},"create_default":{"type":"boolean","title":"Create Default","description":"Create default partition to cache values not captured by partition schema","default":false},"partition_schema":{"anyOf":[{"$ref":"#/components/schemas/HashPartitionSchema"},{"items":{"$ref":"#/components/schemas/ListPartitionSchema"},"type":"array"},{"items":{"$ref":"#/components/schemas/RangePartitionSchema"},"type":"array"}],"title":"Partition Schema","description":"Partition Schema to be used."}},"additionalProperties":false,"type":"object","required":["partition_type","partition_column","partition_schema"],"title":"Partitions"},"PhotometricType":{"type":"string","enum":["MINISBLACK","MINISWHITE","RGB","CMYK","YCBCR","CIELAB","ICCLAB","ITULAB"],"title":"PhotometricType","description":"An enumeration."},"QueryBatchRequestIn":{"properties":{"feature_collection":{"allOf":[{"$ref":"#/components/schemas/FeatureCollection"}],"title":"Feature Collection","description":"An inline collection of GeoJson features on which to do the same query"},"uri":{"type":"string","title":"Uri","description":"URI to a vector file in a variety of formats supported by Geopandas, including GeoJson and CSV format, giving a list of features on which to do the same query. For a CSV file, the column with the geometry in WKB format should be named 'WKT' (not 'WKB')"},"geostore_ids":{"items":{"type":"string"},"type":"array","title":"Geostore Ids","description":"An inline list of ResourceWatch geostore ids"},"id_field":{"type":"string","title":"Id Field","description":"Name of field with the feature id, for use in labeling the results for each feature. This field must contain a unique value for each feature. If geostore_ids are specified, then they will automatically be used as the feature id for labeling the results.","default":"fid"},"sql":{"type":"string","title":"Sql"}},"additionalProperties":false,"type":"object","required":["sql"],"title":"QueryBatchRequestIn"},"QueryRequestIn":{"properties":{"geometry":{"$ref":"#/components/schemas/Geometry"},"sql":{"type":"string","title":"Sql"}},"additionalProperties":false,"type":"object","required":["sql"],"title":"QueryRequestIn"},"RGB":{"properties":{"red":{"type":"integer","maximum":255.0,"minimum":0.0,"title":"Red"},"green":{"type":"integer","maximum":255.0,"minimum":0.0,"title":"Green"},"blue":{"type":"integer","maximum":255.0,"minimum":0.0,"title":"Blue"}},"additionalProperties":false,"type":"object","required":["red","green","blue"],"title":"RGB"},"RGBA":{"properties":{"red":{"type":"integer","maximum":255.0,"minimum":0.0,"title":"Red"},"green":{"type":"integer","maximum":255.0,"minimum":0.0,"title":"Green"},"blue":{"type":"integer","maximum":255.0,"minimum":0.0,"title":"Blue"},"alpha":{"type":"integer","maximum":255.0,"minimum":0.0,"title":"Alpha"}},"additionalProperties":false,"type":"object","required":["red","green","blue","alpha"],"title":"RGBA"},"RWGeostoreIn":{"properties":{"geojson":{"anyOf":[{"$ref":"#/components/schemas/Geometry"},{"$ref":"#/components/schemas/Feature"},{"$ref":"#/components/schemas/FeatureCollection"}],"title":"Geojson"}},"additionalProperties":false,"type":"object","required":["geojson"],"title":"RWGeostoreIn"},"RangePartitionSchema":{"properties":{"partition_suffix":{"type":"string","pattern":"^[a-z0-9_-]{3,}$","title":"Partition Suffix","description":"Suffix for partition table"},"start_value":{"anyOf":[{"type":"string","pattern":"^[a-zA-Z0-9_-]{1,}$"},{"type":"integer"},{"type":"number"},{"type":"string","format":"date"}],"title":"Start Value","description":"Start value of partition range"},"end_value":{"anyOf":[{"type":"string","pattern":"^[a-zA-Z0-9_-]{1,}$"},{"type":"integer"},{"type":"number"},{"type":"string","format":"date"}],"title":"End Value","description":"Start value of partition rang"}},"additionalProperties":false,"type":"object","required":["partition_suffix","start_value","end_value"],"title":"RangePartitionSchema"},"RasterBandMetadata":{"properties":{"pixel_meaning":{"type":"string","title":"Pixel Meaning"},"unit":{"type":"string","title":"Unit"},"description":{"type":"string","title":"Description"},"statistics":{"type":"object","title":"Statistics"},"values_table":{"$ref":"#/components/schemas/RasterTable"},"data_type":{"type":"string","title":"Data Type"},"compression":{"type":"string","title":"Compression"},"no_data_value":{"type":"string","title":"No Data Value"}},"additionalProperties":false,"type":"object","required":["pixel_meaning"],"title":"RasterBandMetadata"},"RasterBandMetadataOut":{"properties":{"pixel_meaning":{"type":"string","title":"Pixel Meaning"},"unit":{"type":"string","title":"Unit"},"description":{"type":"string","title":"Description"},"statistics":{"type":"object","title":"Statistics"},"values_table":{"$ref":"#/components/schemas/RasterTable"},"data_type":{"type":"string","title":"Data Type"},"compression":{"type":"string","title":"Compression"},"no_data_value":{"type":"string","title":"No Data Value"}},"additionalProperties":false,"type":"object","required":["pixel_meaning"],"title":"RasterBandMetadataOut"},"RasterBandsMetadataResponse":{"properties":{"data":{"items":{"$ref":"#/components/schemas/RasterBandMetadata"},"type":"array","title":"Data"},"status":{"type":"string","title":"Status","default":"success"}},"additionalProperties":false,"type":"object","required":["data"],"title":"RasterBandsMetadataResponse"},"RasterDrivers":{"type":"string","enum":["GeoTIFF"],"title":"RasterDrivers","description":"Raster source driver of input file"},"RasterLayer":{"type":"string","enum":["area__ha","alert__count","whrc_aboveground_co2_emissions__Mg","umd_tree_cover_loss__year","is__umd_regional_primary_forest_2001","is__umd_tree_cover_gain","whrc_aboveground_biomass_stock_2000__Mg_ha-1","tsc_tree_cover_loss_drivers__type","gfw_plantations__type","wdpa_protected_areas__iucn_cat","esa_land_cover_2015__class","umd_glad_alerts__isoweek","umd_glad_alerts__date","is__birdlife_alliance_for_zero_extinction_sites","is__gmw_mangroves_1996","is__gmw_mangroves_2016","ifl_intact_forest_landscapes__year","is__gfw_tiger_landscapes","is__landmark_land_rights","gfw_land_rights","is__birdlife_key_biodiversity_areas","is__gfw_mining","is__gfw_peatlands","is__gfw_oil_palm","is__gfw_wood_fiber","is__gfw_resource_rights","is__gfw_managed_forests","rspo_oil_palm__certification_status","idn_forest_area__type","per_forest_concessions__type","bra_biomes__name","umd_tree_cover_density_2000__10","umd_tree_cover_density_2000__15","umd_tree_cover_density_2000__20","umd_tree_cover_density_2000__25","umd_tree_cover_density_2000__30","umd_tree_cover_density_2000__50","umd_tree_cover_density_2000__75","umd_tree_cover_density_2010__10","umd_tree_cover_density_2010__15","umd_tree_cover_density_2010__20","umd_tree_cover_density_2010__25","umd_tree_cover_density_2010__30","umd_tree_cover_density_2010__50","umd_tree_cover_density_2010__75"],"title":"RasterLayer","description":"An enumeration."},"RasterSourceType":{"type":"string","enum":["raster"],"title":"RasterSourceType","description":"An enumeration."},"RasterStats":{"properties":{"bands":{"items":{"$ref":"#/components/schemas/BandStats"},"type":"array","title":"Bands"}},"additionalProperties":false,"type":"object","required":["bands"],"title":"RasterStats"},"RasterTable":{"properties":{"rows":{"items":{"$ref":"#/components/schemas/RasterTableRow"},"type":"array","title":"Rows"},"default_meaning":{"title":"Default Meaning"}},"additionalProperties":false,"type":"object","required":["rows"],"title":"RasterTable"},"RasterTableRow":{"properties":{"value":{"type":"integer","title":"Value"},"meaning":{"title":"Meaning"}},"additionalProperties":false,"type":"object","required":["value"],"title":"RasterTableRow","description":"Mapping of pixel value to what it represents in physical world.\n\nE.g., in ESA land cover data, 10 represents agriculture use."},"RasterTileCacheCreationOptions":{"properties":{"min_zoom":{"type":"integer","maximum":22.0,"minimum":0.0,"title":"Min Zoom","description":"Minimum zoom level of tile cache","default":0},"max_zoom":{"type":"integer","maximum":22.0,"minimum":0.0,"title":"Max Zoom","description":"Maximum zoom level of tile cache","default":14},"timeout_sec":{"type":"integer","title":"Timeout Sec","description":"Maximum run time for associated AWS Batch jobs, in seconds"},"max_static_zoom":{"type":"integer","maximum":22.0,"minimum":0.0,"title":"Max Static Zoom","description":"Maximum zoom level to pre-generate tiles for","default":9},"implementation":{"type":"string","title":"Implementation","description":"Name space to use for raster tile cache. This will be part of the URI and will allow creation of multiple raster tile caches per version,","default":"default"},"symbology":{"allOf":[{"$ref":"#/components/schemas/Symbology"}],"title":"Symbology","description":"Symbology to use for output tiles"},"source_asset_id":{"type":"string","title":"Source Asset Id","description":"Raster tile set asset ID to use as source. Must be an asset of the same dataset version"},"resampling":{"allOf":[{"$ref":"#/components/schemas/ResamplingMethod"}],"description":"Resampling method used to downsample tiles","default":"average"}},"additionalProperties":false,"type":"object","required":["symbology","source_asset_id"],"title":"RasterTileCacheCreationOptions"},"RasterTileCacheMetadata":{"properties":{"tags":{"items":{"type":"string"},"type":"array","title":"Tags"},"min_zoom":{"type":"integer","title":"Min Zoom"},"max_zoom":{"type":"integer","title":"Max Zoom"},"fields":{"items":{"$ref":"#/components/schemas/FieldMetadata"},"type":"array","title":"Fields"}},"additionalProperties":false,"type":"object","title":"RasterTileCacheMetadata"},"RasterTileCacheMetadataOut":{"properties":{"tags":{"items":{"type":"string"},"type":"array","title":"Tags"},"min_zoom":{"type":"integer","title":"Min Zoom"},"max_zoom":{"type":"integer","title":"Max Zoom"},"fields":{"items":{"$ref":"#/components/schemas/FieldMetadataOut"},"type":"array","title":"Fields"},"id":{"type":"string","format":"uuid","title":"Id"}},"additionalProperties":false,"type":"object","required":["id"],"title":"RasterTileCacheMetadataOut"},"RasterTileSetAssetCreationOptions":{"properties":{"unify_projection":{"type":"boolean","title":"Unify Projection","description":"First re-project to a common projection (EPSG:4326). Necessary when input files are in different projections from each other.","default":false},"copy_solo_tiles":{"type":"boolean","title":"Copy Solo Tiles","description":"For raster calculations with multiple inputs, copy last source tile directly to the destination if all other source tiles are non-existent,even though union_bands is false.","default":false},"pixel_meaning":{"type":"string","title":"Pixel Meaning","description":"Description of what the pixel value in the raster represents. This is used to clarify the meaning of the raster and distinguish multiple raster tile sets based on the same dataset version. The pixel_meaning string should be fairly short, use all lower-case letters, and use underscores instead of spaces."},"data_type":{"allOf":[{"$ref":"#/components/schemas/DataType"}],"description":"The type of the data stored at every pixel of the destination raster"},"nbits":{"type":"integer","title":"Nbits","description":"Advanced option that lets GDAL compress the data even more based on the number of bits you need."},"calc":{"type":"string","title":"Calc","description":"There are two modes for this field, one for rasterizing vector sources and one for transforming and/or combining one or more sources that are already raster. For rasterizing vector sources, this field should be an SQL expression that yields the desired raster value based on the fields of your vector dataset.\n\nFor raster sources, this should be a raster algebra expression, similar to that provided to gdal_calc (see https://gdal.org/en/stable/programs/gdal_calc.html), that transforms one or more input bands into one or more output bands. For use in this expression, each band in the sources is assigned an alphabetic variable (A-Z, then AA-AZ, etc.) in the order it exists in those sources, with those of the first source first, continuing with those of the second, and so on. So with two input sources of two bands each, they would be assigned to variables A and B (for the first source) and C and D (for the second source). The NumPy module is in scope, accessible as np"},"band_count":{"type":"integer","title":"Band Count","description":"The number of bands in the output raster.  The default is 1, and output rasters with multiple bands are not common. To create multiple bands in the output, the calc string will normally use np.ma.array([...]).","default":1},"union_bands":{"type":"boolean","title":"Union Bands","description":"Relevant only for multiple input layers (because of multiple bands or auxiliary assets).  If true, then the destination extent is the union of the extents of the source layers. This is useful when some of the input bands have limited geographic extents. If false (the default), then the destination extent is the intersection of the extents of the source layers.","default":false},"no_data":{"anyOf":[{"items":{"anyOf":[{"type":"integer"},{"$ref":"#/components/schemas/NonNumericFloat"}]},"type":"array"},{"type":"integer"},{"$ref":"#/components/schemas/NonNumericFloat"}],"title":"No Data","description":"The value of a pixel that indicates that no data is present (because the dataset extent does not include that pixel). Typical values are -1 for signed ints, 0 for unsigned ints, and nan for floating point values. But any valid value of the data type can be used. If nodata is a List, its length must be equal to band_count."},"rasterize_method":{"allOf":[{"$ref":"#/components/schemas/RasterizeMethod"}],"description":"For raster sources or default assets, 'value' (the default) means use the value from the last or only band processed, and 'count' means count the number of bands with data values.","default":"value"},"resampling":{"allOf":[{"$ref":"#/components/schemas/ResamplingMethod"}],"default":"nearest"},"order":{"allOf":[{"$ref":"#/components/schemas/Order"}],"description":"For vector default assets, order the features by the calculated raster value. For 'asc', the features are ordered by ascending calculated value so that the largest calculated value is used in the raster when there are overlapping features. For 'desc', the ordering is descending, so that the smallest calculated value is used when there are overlaps."},"overwrite":{"type":"boolean","title":"Overwrite","default":false},"subset":{"type":"string","title":"Subset"},"grid":{"$ref":"#/components/schemas/Grid"},"symbology":{"$ref":"#/components/schemas/Symbology"},"compute_stats":{"type":"boolean","title":"Compute Stats","default":true},"compute_histogram":{"type":"boolean","title":"Compute Histogram","default":false},"process_locally":{"type":"boolean","title":"Process Locally","default":true},"auxiliary_assets":{"items":{"type":"string","format":"uuid"},"type":"array","title":"Auxiliary Assets","description":"Asset IDs of additional rasters you might want to include in your calc expression. Ignored if source_uri is set."},"photometric":{"$ref":"#/components/schemas/PhotometricType"},"num_processes":{"type":"integer","title":"Num Processes"},"timeout_sec":{"type":"integer","title":"Timeout Sec","description":"Maximum run time for associated AWS Batch jobs, in seconds"}},"additionalProperties":false,"type":"object","required":["pixel_meaning","data_type","grid"],"title":"RasterTileSetAssetCreationOptions"},"RasterTileSetMetadata":{"properties":{"tags":{"items":{"type":"string"},"type":"array","title":"Tags"},"bands":{"items":{"$ref":"#/components/schemas/RasterBandMetadata"},"type":"array","title":"Bands"},"resolution":{"type":"integer","title":"Resolution"}},"additionalProperties":false,"type":"object","required":["bands"],"title":"RasterTileSetMetadata"},"RasterTileSetMetadataOut":{"properties":{"tags":{"items":{"type":"string"},"type":"array","title":"Tags"},"bands":{"items":{"$ref":"#/components/schemas/RasterBandMetadataOut"},"type":"array","title":"Bands"},"resolution":{"type":"integer","title":"Resolution"},"id":{"type":"string","format":"uuid","title":"Id"}},"additionalProperties":false,"type":"object","required":["id"],"title":"RasterTileSetMetadataOut"},"RasterTileSetMetadataUpdate":{"properties":{"tags":{"items":{"type":"string"},"type":"array","title":"Tags"},"resolution":{"type":"integer","title":"Resolution"}},"additionalProperties":false,"type":"object","required":["resolution"],"title":"RasterTileSetMetadataUpdate"},"RasterTileSetSourceCreationOptions":{"properties":{"unify_projection":{"type":"boolean","title":"Unify Projection","description":"First re-project to a common projection (EPSG:4326). Necessary when input files are in different projections from each other.","default":false},"copy_solo_tiles":{"type":"boolean","title":"Copy Solo Tiles","description":"For raster calculations with multiple inputs, copy last source tile directly to the destination if all other source tiles are non-existent,even though union_bands is false.","default":false},"pixel_meaning":{"type":"string","title":"Pixel Meaning","description":"Description of what the pixel value in the raster represents. This is used to clarify the meaning of the raster and distinguish multiple raster tile sets based on the same dataset version. The pixel_meaning string should be fairly short, use all lower-case letters, and use underscores instead of spaces."},"data_type":{"allOf":[{"$ref":"#/components/schemas/DataType"}],"description":"The type of the data stored at every pixel of the destination raster"},"nbits":{"type":"integer","title":"Nbits","description":"Advanced option that lets GDAL compress the data even more based on the number of bits you need."},"calc":{"type":"string","title":"Calc","description":"There are two modes for this field, one for rasterizing vector sources and one for transforming and/or combining one or more sources that are already raster. For rasterizing vector sources, this field should be an SQL expression that yields the desired raster value based on the fields of your vector dataset.\n\nFor raster sources, this should be a raster algebra expression, similar to that provided to gdal_calc (see https://gdal.org/en/stable/programs/gdal_calc.html), that transforms one or more input bands into one or more output bands. For use in this expression, each band in the sources is assigned an alphabetic variable (A-Z, then AA-AZ, etc.) in the order it exists in those sources, with those of the first source first, continuing with those of the second, and so on. So with two input sources of two bands each, they would be assigned to variables A and B (for the first source) and C and D (for the second source). The NumPy module is in scope, accessible as np"},"band_count":{"type":"integer","title":"Band Count","description":"The number of bands in the output raster.  The default is 1, and output rasters with multiple bands are not common. To create multiple bands in the output, the calc string will normally use np.ma.array([...]).","default":1},"union_bands":{"type":"boolean","title":"Union Bands","description":"Relevant only for multiple input layers (because of multiple bands or auxiliary assets).  If true, then the destination extent is the union of the extents of the source layers. This is useful when some of the input bands have limited geographic extents. If false (the default), then the destination extent is the intersection of the extents of the source layers.","default":false},"no_data":{"anyOf":[{"items":{"anyOf":[{"type":"integer"},{"$ref":"#/components/schemas/NonNumericFloat"}]},"type":"array"},{"type":"integer"},{"$ref":"#/components/schemas/NonNumericFloat"}],"title":"No Data","description":"The value of a pixel that indicates that no data is present (because the dataset extent does not include that pixel). Typical values are -1 for signed ints, 0 for unsigned ints, and nan for floating point values. But any valid value of the data type can be used. If nodata is a List, its length must be equal to band_count."},"rasterize_method":{"allOf":[{"$ref":"#/components/schemas/RasterizeMethod"}],"description":"For raster sources or default assets, 'value' (the default) means use the value from the last or only band processed, and 'count' means count the number of bands with data values.","default":"value"},"resampling":{"allOf":[{"$ref":"#/components/schemas/ResamplingMethod"}],"default":"nearest"},"order":{"allOf":[{"$ref":"#/components/schemas/Order"}],"description":"For vector default assets, order the features by the calculated raster value. For 'asc', the features are ordered by ascending calculated value so that the largest calculated value is used in the raster when there are overlapping features. For 'desc', the ordering is descending, so that the smallest calculated value is used when there are overlaps."},"overwrite":{"type":"boolean","title":"Overwrite","default":false},"subset":{"type":"string","title":"Subset"},"grid":{"$ref":"#/components/schemas/Grid"},"symbology":{"$ref":"#/components/schemas/Symbology"},"compute_stats":{"type":"boolean","title":"Compute Stats","default":true},"compute_histogram":{"type":"boolean","title":"Compute Histogram","default":false},"process_locally":{"type":"boolean","title":"Process Locally","default":true},"auxiliary_assets":{"items":{"type":"string","format":"uuid"},"type":"array","title":"Auxiliary Assets","description":"Asset IDs of additional rasters you might want to include in your calc expression. Ignored if source_uri is set."},"photometric":{"$ref":"#/components/schemas/PhotometricType"},"num_processes":{"type":"integer","title":"Num Processes"},"timeout_sec":{"type":"integer","title":"Timeout Sec","description":"Maximum run time for associated AWS Batch jobs, in seconds"},"source_type":{"allOf":[{"$ref":"#/components/schemas/RasterSourceType"}],"description":"Source type of input file."},"source_driver":{"allOf":[{"$ref":"#/components/schemas/RasterDrivers"}],"description":"Driver of source file. Must be a GDAL driver"},"source_uri":{"items":{"type":"string"},"type":"array","title":"Source Uri","description":"List of input sources. Sources must be the URI of either a tiles.geojson file on S3 or a folder (prefix) on S3 or GCS. Features in tiles.geojson must have path starting with either /vsis3/ or /vsigs/auxiliary_assets is ignored if source_uri is set (for creating new versions)"}},"additionalProperties":false,"type":"object","required":["pixel_meaning","data_type","grid","source_type","source_driver"],"title":"RasterTileSetSourceCreationOptions"},"RasterizeMethod":{"type":"string","enum":["count","value"],"title":"RasterizeMethod","description":"An enumeration."},"ResamplingMethod":{"type":"string","enum":["average","bilinear","cubic","cubic_spline","lanczos","max","min","med","mode","nearest","q1","q3"],"title":"ResamplingMethod","description":"An enumeration."},"Response":{"properties":{"data":{"title":"Data"},"status":{"type":"string","title":"Status","default":"success"}},"additionalProperties":false,"type":"object","title":"Response"},"SignUpRequestIn":{"properties":{"name":{"type":"string","title":"Name","description":"Full user name"},"email":{"type":"string","format":"email","title":"Email","description":"User's email address"}},"additionalProperties":false,"type":"object","required":["name","email"],"title":"SignUpRequestIn"},"StaticVector1x1CreationOptions":{"properties":{"field_attributes":{"items":{"type":"string"},"type":"array","title":"Field Attributes","description":"Field attributes to include in vector tiles. If left blank, all fields marked as `is_feature_info` will be included."},"include_tile_id":{"type":"boolean","title":"Include Tile Id","description":"Whether or not to include the tile_id of each feature","default":false}},"additionalProperties":false,"type":"object","title":"StaticVector1x1CreationOptions"},"StaticVectorFileCreationOptions":{"properties":{"field_attributes":{"items":{"type":"string"},"type":"array","title":"Field Attributes","description":"Field attributes to include in vector tiles. If left blank, all fields marked as `is_feature_info` will be included."}},"additionalProperties":false,"type":"object","title":"StaticVectorFileCreationOptions"},"StaticVectorTileCacheCreationOptions":{"properties":{"min_zoom":{"type":"integer","maximum":22.0,"minimum":0.0,"title":"Min Zoom","description":"Minimum zoom level of tile cache","default":0},"max_zoom":{"type":"integer","maximum":22.0,"minimum":0.0,"title":"Max Zoom","description":"Maximum zoom level of tile cache","default":14},"timeout_sec":{"type":"integer","title":"Timeout Sec","description":"Maximum run time for associated AWS Batch jobs, in seconds"},"field_attributes":{"items":{"type":"string"},"type":"array","title":"Field Attributes","description":"Field attributes to include in vector tiles. If left blank, all fields marked as `is_feature_info` will be included."},"tile_strategy":{"allOf":[{"$ref":"#/components/schemas/TileStrategy"}],"description":"`discontinuous` corresponds to `drop-densest-as-needed` and`continuous` corresponds to `coalesce-densest-as-needed`"},"implementation":{"type":"string","title":"Implementation","description":"Name space to use for static tile cache. This will be part of the URI and will allow to create multiple static tile caches per version,","default":"default"},"layer_style":{"items":{"type":"object"},"type":"array","title":"Layer Style","description":"List of [Mapbox layer styling rules](https://docs.mapbox.com/mapbox-gl-js/style-spec/layers) for vector tile caches. `source` and `source-layer` attributes must use `dataset` name.Styling rules will be used in autogenerated root.json and preview."},"feature_filter":{"type":"object","title":"Feature Filter","description":"Optional tippecanoe feature filter(s). Uses the syntax of [Mapbox legacy filters](https://docs.mapbox.com/style-spec/reference/other/#other-filters)"}},"additionalProperties":false,"type":"object","required":["tile_strategy","layer_style"],"title":"StaticVectorTileCacheCreationOptions"},"StaticVectorTileCacheMetadata":{"properties":{"tags":{"items":{"type":"string"},"type":"array","title":"Tags"},"min_zoom":{"type":"integer","title":"Min Zoom"},"max_zoom":{"type":"integer","title":"Max Zoom"},"fields":{"items":{"$ref":"#/components/schemas/FieldMetadata"},"type":"array","title":"Fields"}},"additionalProperties":false,"type":"object","title":"StaticVectorTileCacheMetadata"},"StaticVectorTileCacheMetadataOut":{"properties":{"tags":{"items":{"type":"string"},"type":"array","title":"Tags"},"min_zoom":{"type":"integer","title":"Min Zoom"},"max_zoom":{"type":"integer","title":"Max Zoom"},"fields":{"items":{"$ref":"#/components/schemas/FieldMetadataOut"},"type":"array","title":"Fields"},"id":{"type":"string","format":"uuid","title":"Id"}},"additionalProperties":false,"type":"object","required":["id"],"title":"StaticVectorTileCacheMetadataOut"},"StaticVectorTileCacheMetadataUpdate":{"properties":{"tags":{"items":{"type":"string"},"type":"array","title":"Tags"},"min_zoom":{"type":"integer","title":"Min Zoom"},"max_zoom":{"type":"integer","title":"Max Zoom"}},"additionalProperties":false,"type":"object","title":"StaticVectorTileCacheMetadataUpdate"},"StatsResponse":{"properties":{"data":{"anyOf":[{"$ref":"#/components/schemas/TableStats"},{"$ref":"#/components/schemas/RasterStats"}],"title":"Data"},"status":{"type":"string","title":"Status","default":"success"}},"additionalProperties":false,"type":"object","title":"StatsResponse"},"Symbology":{"properties":{"type":{"$ref":"#/components/schemas/ColorMapType"},"colormap":{"additionalProperties":{"anyOf":[{"$ref":"#/components/schemas/RGB"},{"$ref":"#/components/schemas/RGBA"}]},"type":"object","title":"Colormap"}},"additionalProperties":false,"type":"object","required":["type"],"title":"Symbology"},"TableAssetCreationOptions":{"properties":{"has_header":{"type":"boolean","title":"Has Header","description":"Input file has header. Must be true","default":true},"delimiter":{"allOf":[{"$ref":"#/components/schemas/Delimiters"}],"description":"Delimiter used in input file"},"latitude":{"type":"string","pattern":"^[a-z][a-zA-Z0-9_-]{2,}$","title":"Latitude","description":"Column with latitude coordinate"},"longitude":{"type":"string","pattern":"^[a-z][a-zA-Z0-9_-]{2,}$","title":"Longitude","description":"Column with longitude coordinate"},"cluster":{"allOf":[{"$ref":"#/components/schemas/Index"}],"title":"Cluster","description":"Index to use for clustering (optional)."},"partitions":{"allOf":[{"$ref":"#/components/schemas/Partitions"}],"title":"Partitions","description":"Partitioning schema (optional)"},"indices":{"items":{"$ref":"#/components/schemas/Index"},"type":"array","title":"Indices","description":"List of indices to add to table","default":[]},"constraints":{"items":{"$ref":"#/components/schemas/Constraint"},"type":"array","title":"Constraints","description":"List of constraints to add to table. (optional)"},"table_schema":{"items":{"$ref":"#/components/schemas/FieldType"},"type":"array","title":"Table Schema","description":"List of Field Types. Missing field types will be inferred. (optional)"},"create_dynamic_vector_tile_cache":{"type":"boolean","title":"Create Dynamic Vector Tile Cache","description":"By default, table sources will implicitly create a dynamic vector tile cache when geographic columns are present. Disable this option by setting value to `false`","default":true},"timeout":{"type":"integer","title":"Timeout","default":400000}},"additionalProperties":false,"type":"object","required":["delimiter"],"title":"TableAssetCreationOptions"},"TableDrivers":{"type":"string","enum":["text"],"title":"TableDrivers","description":"Driver of input file."},"TableSourceCreationOptions":{"properties":{"has_header":{"type":"boolean","title":"Has Header","description":"Input file has header. Must be true","default":true},"delimiter":{"allOf":[{"$ref":"#/components/schemas/Delimiters"}],"description":"Delimiter used in input file"},"latitude":{"type":"string","pattern":"^[a-z][a-zA-Z0-9_-]{2,}$","title":"Latitude","description":"Column with latitude coordinate"},"longitude":{"type":"string","pattern":"^[a-z][a-zA-Z0-9_-]{2,}$","title":"Longitude","description":"Column with longitude coordinate"},"cluster":{"allOf":[{"$ref":"#/components/schemas/Index"}],"title":"Cluster","description":"Index to use for clustering (optional)."},"partitions":{"allOf":[{"$ref":"#/components/schemas/Partitions"}],"title":"Partitions","description":"Partitioning schema (optional)"},"indices":{"items":{"$ref":"#/components/schemas/Index"},"type":"array","title":"Indices","description":"List of indices to add to table","default":[]},"constraints":{"items":{"$ref":"#/components/schemas/Constraint"},"type":"array","title":"Constraints","description":"List of constraints to add to table. (optional)"},"table_schema":{"items":{"$ref":"#/components/schemas/FieldType"},"type":"array","title":"Table Schema","description":"List of Field Types. Missing field types will be inferred. (optional)"},"create_dynamic_vector_tile_cache":{"type":"boolean","title":"Create Dynamic Vector Tile Cache","description":"By default, table sources will implicitly create a dynamic vector tile cache when geographic columns are present. Disable this option by setting value to `false`","default":true},"timeout":{"type":"integer","title":"Timeout","default":400000},"source_type":{"allOf":[{"$ref":"#/components/schemas/TableSourceType"}],"description":"Source type of input file."},"source_driver":{"$ref":"#/components/schemas/TableDrivers"},"source_uri":{"items":{"type":"string"},"type":"array","title":"Source Uri","description":"List of input files. Must be a list of s3:// urls"}},"additionalProperties":false,"type":"object","required":["delimiter","source_type","source_driver","source_uri"],"title":"TableSourceCreationOptions"},"TableSourceType":{"type":"string","enum":["table"],"title":"TableSourceType","description":"Source type of input file."},"TableStats":{"properties":{"row_count":{"type":"integer","title":"Row Count","description":"Total row count."},"field_stats":{"items":{"anyOf":[{"$ref":"#/components/schemas/NumericFieldStats"},{"$ref":"#/components/schemas/TextFieldStats"},{"$ref":"#/components/schemas/DateFieldStats"},{"$ref":"#/components/schemas/GeometryFieldStats"}]},"type":"array","title":"Field Stats","description":"Statistics for selected field types."}},"additionalProperties":false,"type":"object","required":["row_count","field_stats"],"title":"TableStats"},"Task":{"properties":{"created_on":{"type":"string","format":"date-time","title":"Created On"},"updated_on":{"type":"string","format":"date-time","title":"Updated On"},"task_id":{"type":"string","format":"uuid","title":"Task Id"},"asset_id":{"type":"string","format":"uuid","title":"Asset Id"},"change_log":{"items":{"$ref":"#/components/schemas/ChangeLog"},"type":"array","title":"Change Log"}},"type":"object","required":["created_on","updated_on","task_id","asset_id","change_log"],"title":"Task"},"TaskCreateIn":{"properties":{"asset_id":{"type":"string","format":"uuid","title":"Asset Id"},"change_log":{"items":{"$ref":"#/components/schemas/ChangeLog"},"type":"array","title":"Change Log"}},"additionalProperties":false,"type":"object","required":["asset_id","change_log"],"title":"TaskCreateIn"},"TaskResponse":{"properties":{"data":{"$ref":"#/components/schemas/Task"},"status":{"type":"string","title":"Status","default":"success"}},"additionalProperties":false,"type":"object","required":["data"],"title":"TaskResponse"},"TaskUpdateIn":{"properties":{"change_log":{"items":{"$ref":"#/components/schemas/ChangeLog"},"type":"array","title":"Change Log"}},"additionalProperties":false,"type":"object","required":["change_log"],"title":"TaskUpdateIn"},"TasksResponse":{"properties":{"data":{"items":{"$ref":"#/components/schemas/Task"},"type":"array","title":"Data"},"status":{"type":"string","title":"Status","default":"success"}},"additionalProperties":false,"type":"object","required":["data"],"title":"TasksResponse"},"TextFieldStats":{"properties":{"data_type":{"$ref":"#/components/schemas/PGTextType"},"discrete_values":{"items":{"type":"string"},"type":"array","title":"Discrete Values","description":"A text field is considered to contain discrete values if it carries no more than 20 distinct values."}},"additionalProperties":false,"type":"object","required":["data_type"],"title":"TextFieldStats"},"TileBlockSize":{"type":"integer","enum":[256,512,1024,2048],"title":"TileBlockSize","description":"An enumeration."},"TileStrategy":{"type":"string","enum":["continuous","discontinuous","keep_all"],"title":"TileStrategy","description":"Tile strategy for generating vector tiles. Use `continuous` when working with mostly adjacent polygon files, use `discontinuous` when working with polygon features which are mostly non-adjacentUse `keep_all` if you don't want features to be removed at all. This might lead to larger tiles."},"TreeCoverLossByDriver":{"properties":{"result":{"$ref":"#/components/schemas/TreeCoverLossByDriverResult"},"metadata":{"$ref":"#/components/schemas/TreeCoverLossByDriverMetadata"},"message":{"type":"string","title":"Message"},"status":{"$ref":"#/components/schemas/AnalysisStatus"}},"additionalProperties":false,"type":"object","required":["status"],"title":"TreeCoverLossByDriver"},"TreeCoverLossByDriverIn":{"properties":{"aoi":{"oneOf":[{"$ref":"#/components/schemas/GeostoreAreaOfInterest"},{"$ref":"#/components/schemas/AdminAreaOfInterest"},{"$ref":"#/components/schemas/Global"},{"$ref":"#/components/schemas/WdpaAreaOfInterest"}],"title":"Aoi","discriminator":{"propertyName":"type","mapping":{"geostore":"#/components/schemas/GeostoreAreaOfInterest","admin":"#/components/schemas/AdminAreaOfInterest","global":"#/components/schemas/Global","protected_area":"#/components/schemas/WdpaAreaOfInterest"}}},"canopy_cover":{"type":"integer","title":"Canopy Cover","default":30},"dataset_version":{"additionalProperties":{"type":"string"},"type":"object","title":"Dataset Version","default":{}}},"additionalProperties":false,"type":"object","required":["aoi"],"title":"TreeCoverLossByDriverIn"},"TreeCoverLossByDriverMetadata":{"properties":{"aoi":{"anyOf":[{"$ref":"#/components/schemas/GeostoreAreaOfInterest"},{"$ref":"#/components/schemas/AdminAreaOfInterest"},{"$ref":"#/components/schemas/Global"},{"$ref":"#/components/schemas/WdpaAreaOfInterest"}],"title":"Aoi"},"sources":{"items":{"$ref":"#/components/schemas/DataMartSource"},"type":"array","title":"Sources"},"canopy_cover":{"type":"integer","title":"Canopy Cover"}},"additionalProperties":false,"type":"object","required":["aoi","sources","canopy_cover"],"title":"TreeCoverLossByDriverMetadata"},"TreeCoverLossByDriverResponse":{"properties":{"data":{"$ref":"#/components/schemas/TreeCoverLossByDriver"},"status":{"type":"string","title":"Status","default":"success"}},"additionalProperties":false,"type":"object","required":["data"],"title":"TreeCoverLossByDriverResponse"},"TreeCoverLossByDriverResult":{"properties":{"tree_cover_loss_by_driver":{"items":{"type":"object"},"type":"array","title":"Tree Cover Loss By Driver"},"yearly_tree_cover_loss_by_driver":{"items":{"type":"object"},"type":"array","title":"Yearly Tree Cover Loss By Driver"}},"additionalProperties":false,"type":"object","required":["tree_cover_loss_by_driver","yearly_tree_cover_loss_by_driver"],"title":"TreeCoverLossByDriverResult"},"UserJob":{"properties":{"job_id":{"type":"string","format":"uuid","title":"Job Id"},"job_link":{"type":"string","title":"Job Link"},"status":{"type":"string","title":"Status","default":"pending"},"message":{"type":"string","title":"Message"},"download_link":{"type":"string","title":"Download Link"},"failed_geometries_link":{"type":"string","title":"Failed Geometries Link"},"progress":{"type":"string","title":"Progress","default":"0%"}},"type":"object","required":["job_id"],"title":"UserJob"},"UserJobResponse":{"properties":{"data":{"$ref":"#/components/schemas/UserJob"},"status":{"type":"string","title":"Status","default":"success"}},"additionalProperties":false,"type":"object","required":["data"],"title":"UserJobResponse"},"ValidationError":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array","title":"Location"},"msg":{"type":"string","title":"Message"},"type":{"type":"string","title":"Error Type"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"},"VectorDrivers":{"type":"string","enum":["CSV","ESRIJSON","FileGDB","GeoJSON","GeoJSONSeq","GPKG","ESRI Shapefile"],"title":"VectorDrivers","description":"Vector source driver of input file"},"VectorFileMetadata":{"properties":{"tags":{"items":{"type":"string"},"type":"array","title":"Tags"},"fields":{"items":{"$ref":"#/components/schemas/FieldMetadata"},"type":"array","title":"Fields"}},"additionalProperties":false,"type":"object","title":"VectorFileMetadata"},"VectorFileMetadataOut":{"properties":{"tags":{"items":{"type":"string"},"type":"array","title":"Tags"},"fields":{"items":{"$ref":"#/components/schemas/FieldMetadataOut"},"type":"array","title":"Fields"},"id":{"type":"string","format":"uuid","title":"Id"}},"additionalProperties":false,"type":"object","required":["id"],"title":"VectorFileMetadataOut"},"VectorSourceCreationOptions":{"properties":{"source_type":{"allOf":[{"$ref":"#/components/schemas/VectorSourceType"}],"description":"Source type of input file."},"source_driver":{"allOf":[{"$ref":"#/components/schemas/VectorDrivers"}],"description":"Driver of source file. Must be an OGR driver"},"source_uri":{"items":{"type":"string"},"type":"array","title":"Source Uri","description":"List of input files. Vector source layers can only have one list item. Must be a s3:// url."},"layers":{"items":{"type":"string"},"type":"array","title":"Layers","description":"List of input layers. Only required for .gdb and .gpkg."},"indices":{"items":{"$ref":"#/components/schemas/Index"},"type":"array","title":"Indices","description":"List of indices to add to the database table representing the vector dataset.  Each element of the indices field contains an index_type field (which is a string) and a column_names field (which is a list of field names included in this index). The possibilities for the index_type field are hash, btree, or gist. hash is efficient for standard exact-value lookups, while btree is efficient for range lookups. gist is used for geometry fields and can do intersection-type lookups. See https://www.postgresql.org/docs/current/indexes-types.html","default":[{"index_type":"gist","column_names":["geom"]},{"index_type":"gist","column_names":["geom_wm"]},{"index_type":"hash","column_names":["gfw_geostore_id"]}]},"cluster":{"allOf":[{"$ref":"#/components/schemas/Index"}],"title":"Cluster","description":"Index to use for clustering."},"table_schema":{"items":{"$ref":"#/components/schemas/FieldType"},"type":"array","title":"Table Schema","description":"List of Field Types. Missing field types will be inferred. (optional)"},"create_dynamic_vector_tile_cache":{"type":"boolean","title":"Create Dynamic Vector Tile Cache","description":"By default, vector sources will implicitly create a dynamic vector tile cache. Disable this option by setting value to `false`","default":true},"add_to_geostore":{"type":"boolean","title":"Add To Geostore","description":"Make geometries searchable via geostore endpoint.","default":true},"timeout":{"type":"integer","title":"Timeout","default":400000}},"additionalProperties":false,"type":"object","required":["source_type","source_driver","source_uri"],"title":"VectorSourceCreationOptions"},"VectorSourceType":{"type":"string","enum":["vector"],"title":"VectorSourceType","description":"An enumeration."},"Version":{"properties":{"created_on":{"type":"string","format":"date-time","title":"Created On"},"updated_on":{"type":"string","format":"date-time","title":"Updated On"},"dataset":{"type":"string","title":"Dataset"},"version":{"type":"string","title":"Version"},"is_latest":{"type":"boolean","title":"Is Latest","default":false},"is_mutable":{"type":"boolean","title":"Is Mutable","default":false},"metadata":{"anyOf":[{"$ref":"#/components/schemas/VersionMetadataOut"},{"$ref":"#/components/schemas/BaseModel"}],"title":"Metadata"},"status":{"type":"string","title":"Status","default":"pending"},"assets":{"items":{"items":[{"type":"string"},{"type":"string"},{"type":"string"}],"type":"array","maxItems":3,"minItems":3},"type":"array","title":"Assets","description":"List of saved (non-pending and non-failed) assets, with  elements in the form: [asset_type, asset_uri, asset_id]. The list of assets is sorted by the creation time of each asset.","default":[]}},"type":"object","required":["created_on","updated_on","dataset","version","metadata"],"title":"Version"},"VersionAppendIn":{"properties":{"source_uri":{"items":{"type":"string"},"type":"array","title":"Source Uri"},"source_driver":{"allOf":[{"$ref":"#/components/schemas/VectorDrivers"}],"description":"Driver of source file. Must be an OGR driver"},"layers":{"items":{"type":"string"},"type":"array","title":"Layers","description":"List of layer names to append to version. Only required for .gdb and .gpkg."}},"additionalProperties":false,"type":"object","required":["source_uri"],"title":"VersionAppendIn"},"VersionCreateIn":{"properties":{"is_downloadable":{"type":"boolean","title":"Is Downloadable","description":"Flag to specify if assets associated with version can be downloaded.If not set, value will default to settings of underlying dataset"},"metadata":{"allOf":[{"$ref":"#/components/schemas/VersionMetadataIn"}],"title":"Metadata","description":"Version metadata. Version will inherit metadata from dataset. You will only need to add fields which you want to add or overwrite."},"creation_options":{"anyOf":[{"$ref":"#/components/schemas/TableSourceCreationOptions"},{"$ref":"#/components/schemas/RasterTileSetSourceCreationOptions"},{"$ref":"#/components/schemas/VectorSourceCreationOptions"}],"title":"Creation Options","description":"Creation option to specify how default asset for version should be created."}},"additionalProperties":false,"type":"object","required":["creation_options"],"title":"VersionCreateIn"},"VersionMetadataIn":{"properties":{"spatial_resolution":{"anyOf":[{"type":"integer"},{"type":"number"}],"title":"Spatial Resolution"},"resolution_description":{"type":"string","title":"Resolution Description"},"geographic_coverage":{"type":"string","title":"Geographic Coverage"},"update_frequency":{"type":"string","title":"Update Frequency"},"scale":{"type":"string","title":"Scale"},"citation":{"type":"string","title":"Citation"},"content_date":{"type":"string","format":"date","title":"Content Date","description":"Date of content."},"content_date_range":{"allOf":[{"$ref":"#/components/schemas/ContentDateRange"}],"title":"Content Date Range","description":"Date range covered by the content"},"content_date_description":{"type":"string","title":"Content Date Description","description":"Date of content to display"},"last_update":{"type":"string","format":"date","title":"Last Update","description":"Date the data were last updated"}},"type":"object","title":"VersionMetadataIn","examples":[{"content_date_range":{"start_date":"2000-01-01","end_date":"2021-04-06"},"content_date_description":"2000 - present"}]},"VersionMetadataOut":{"properties":{"created_on":{"type":"string","format":"date-time","title":"Created On"},"updated_on":{"type":"string","format":"date-time","title":"Updated On"},"spatial_resolution":{"anyOf":[{"type":"integer"},{"type":"number"}],"title":"Spatial Resolution"},"resolution_description":{"type":"string","title":"Resolution Description"},"geographic_coverage":{"type":"string","title":"Geographic Coverage"},"update_frequency":{"type":"string","title":"Update Frequency"},"scale":{"type":"string","title":"Scale"},"citation":{"type":"string","title":"Citation"},"content_date":{"type":"string","format":"date","title":"Content Date","description":"Date of content."},"content_date_range":{"allOf":[{"$ref":"#/components/schemas/ContentDateRange"}],"title":"Content Date Range","description":"Date range covered by the content"},"content_date_description":{"type":"string","title":"Content Date Description","description":"Date of content to display"},"last_update":{"type":"string","format":"date","title":"Last Update","description":"Date the data were last updated"},"id":{"type":"string","format":"uuid","title":"Id"}},"type":"object","required":["created_on","updated_on","id"],"title":"VersionMetadataOut","examples":[{"content_date_range":{"start_date":"2000-01-01","end_date":"2021-04-06"},"content_date_description":"2000 - present"}]},"VersionMetadataOutWithParent":{"properties":{"created_on":{"type":"string","format":"date-time","title":"Created On"},"updated_on":{"type":"string","format":"date-time","title":"Updated On"},"spatial_resolution":{"anyOf":[{"type":"integer"},{"type":"number"}],"title":"Spatial Resolution"},"resolution_description":{"type":"string","title":"Resolution Description"},"geographic_coverage":{"type":"string","title":"Geographic Coverage"},"update_frequency":{"type":"string","title":"Update Frequency"},"scale":{"type":"string","title":"Scale"},"citation":{"type":"string","title":"Citation"},"content_date":{"type":"string","format":"date","title":"Content Date","description":"Date of content."},"content_date_range":{"allOf":[{"$ref":"#/components/schemas/ContentDateRange"}],"title":"Content Date Range","description":"Date range covered by the content"},"content_date_description":{"type":"string","title":"Content Date Description","description":"Date of content to display"},"last_update":{"type":"string","format":"date","title":"Last Update","description":"Date the data were last updated"},"id":{"type":"string","format":"uuid","title":"Id"},"dataset_metadata":{"$ref":"#/components/schemas/DatasetMetadataOut"}},"type":"object","required":["created_on","updated_on","id","dataset_metadata"],"title":"VersionMetadataOutWithParent","examples":[{"content_date_range":{"start_date":"2000-01-01","end_date":"2021-04-06"},"content_date_description":"2000 - present"}]},"VersionMetadataResponse":{"properties":{"data":{"$ref":"#/components/schemas/VersionMetadataOut"},"status":{"type":"string","title":"Status","default":"success"}},"additionalProperties":false,"type":"object","required":["data"],"title":"VersionMetadataResponse"},"VersionMetadataUpdate":{"properties":{"spatial_resolution":{"anyOf":[{"type":"integer"},{"type":"number"}],"title":"Spatial Resolution"},"resolution_description":{"type":"string","title":"Resolution Description"},"geographic_coverage":{"type":"string","title":"Geographic Coverage"},"update_frequency":{"type":"string","title":"Update Frequency"},"scale":{"type":"string","title":"Scale"},"citation":{"type":"string","title":"Citation"},"content_date":{"type":"string","format":"date","title":"Content Date","description":"Date of content"},"content_date_range":{"allOf":[{"$ref":"#/components/schemas/ContentDateRange"}],"title":"Content Date Range","description":"Date range covered by the content"},"content_date_description":{"type":"string","title":"Content Date Description","description":"Date of content to display"},"last_update":{"type":"string","format":"date","title":"Last Update","description":"Date the data were last updated"}},"type":"object","title":"VersionMetadataUpdate","examples":[{"content_date_range":{"start_date":"2000-01-01","end_date":"2021-04-06"},"content_date_description":"2000 - present"}]},"VersionMetadataWithParentResponse":{"properties":{"data":{"$ref":"#/components/schemas/VersionMetadataOutWithParent"},"status":{"type":"string","title":"Status","default":"success"}},"additionalProperties":false,"type":"object","required":["data"],"title":"VersionMetadataWithParentResponse"},"VersionResponse":{"properties":{"data":{"$ref":"#/components/schemas/Version"},"status":{"type":"string","title":"Status","default":"success"}},"additionalProperties":false,"type":"object","required":["data"],"title":"VersionResponse"},"VersionUpdateIn":{"properties":{"is_downloadable":{"type":"boolean","title":"Is Downloadable","description":"Flag to specify if assets associated with version can be downloaded.If not set, value will default to settings of underlying dataset"},"is_latest":{"type":"boolean","title":"Is Latest","description":"Indicate if the current version should be tagged `latest`. This will cause redirects from {dataset}/latest to {dataset}/{current_version}.When tagging a version to `latest` any other version currently tagged `latest` will be untagged."},"metadata":{"allOf":[{"$ref":"#/components/schemas/VersionMetadataUpdate"}],"title":"Metadata","description":"Version metadata. Version will inherit metadata from dataset. You will only need to add fields which you want to add or overwrite."}},"additionalProperties":false,"type":"object","title":"VersionUpdateIn"},"WDPAInfo":{"properties":{"use":{"type":"object","title":"Use"},"wdpaid":{"type":"integer","title":"Wdpaid"}},"additionalProperties":false,"type":"object","required":["use","wdpaid"],"title":"WDPAInfo"},"WdpaAreaOfInterest":{"properties":{"type":{"type":"string","enum":["protected_area"],"title":"Type","default":"protected_area"},"wdpa_id":{"type":"string","title":"World Database on Protected Areas (WDPA) ID"}},"additionalProperties":false,"type":"object","required":["wdpa_id"],"title":"WdpaAreaOfInterest"},"ZonalAnalysisRequestIn":{"properties":{"geometry":{"$ref":"#/components/schemas/Geometry"},"sum":{"items":{"$ref":"#/components/schemas/RasterLayer"},"type":"array"},"group_by":{"items":{"$ref":"#/components/schemas/RasterLayer"},"type":"array","default":[]},"filters":{"items":{"$ref":"#/components/schemas/RasterLayer"},"type":"array","default":[]},"start_date":{"type":"string","title":"Start Date"},"end_date":{"type":"string","title":"End Date"}},"additionalProperties":false,"type":"object","required":["geometry","sum"],"title":"ZonalAnalysisRequestIn"}},"securitySchemes":{"OAuth2PasswordBearer":{"type":"oauth2","flows":{"password":{"scopes":{},"tokenUrl":"/token"}}},"APIKeyOriginQuery":{"type":"apiKey","in":"query","name":"x-api-key"},"APIKeyOriginHeader":{"type":"apiKey","in":"header","name":"x-api-key"}}},"tags":[{"name":"Authentication","description":null},{"name":"Dataset","description":"Datasets are just a bucket, for datasets which share the same core\nmetadata."},{"name":"Version","description":"Datasets can have different versions.\n\nVersions are usually linked to different releases. Versions can be\neither mutable (data can change) or immutable (data cannot change). By\ndefault versions are immutable. Every version needs one or many source\nfiles. These files can be a remote, publicly accessible URL or an\nuploaded file. Based on the source file(s), users can create additional\nassets and activate additional endpoints to view and query the dataset.\nAvailable assets and endpoints to choose from depend on the source type.\n"},{"name":"Assets","description":"Assets are usually alternate representations of the base dataset\nversion, sometimes combining in extra data from other datasets.\n\nAssets might be served in different formats, attribute values might be\naltered, additional attributes added, and feature resolution might have\nchanged. Assets are either managed or unmanaged. Managed assets are\ncreated by the API and users can rely on data integrity. Unmanaged\nassets are only loosely linked to a dataset version and users must\ncannot rely on full integrity. We can only assume that unmanaged assets\nare based on the same version and do not know the processing history.\n"},{"name":"Query","description":"Explore data entries for a given dataset version using standard SQL."},{"name":"Download","description":"Download dataset in different formats."},{"name":"Geostore","description":null},{"name":"Tasks","description":"Tasks represent the steps performed during asset creation.\n\nYou can view a single tasks or all tasks associated with as specific\nasset. Only _service accounts_ can create or update tasks.\n"},{"name":"Analysis","description":"Run analysis on registered datasets."},{"name":"Job","description":"Jobs represent long running analysis tasks. Certain APIs, like querying like\na list, will return immediately with a job_id. You can poll the job until it's\ncomplete, and a download like will be provided.\n\nJobs are only saved for 90 days.\n"},{"name":"Health","description":"Assets are replicas of the original source files."},{"name":"Land","description":"Beta APIs to more easily access important land use/land cover data without\nneeding to directly query our low-level data management APIs."}],"x-tagGroups":[{"name":"Authentication API","tags":["Authentication"]},{"name":"Dataset API","tags":["Datasets","Versions","Assets"]},{"name":"Geostore API","tags":["Geostore"]},{"name":"Query API","tags":["Query"]},{"name":"Download API","tags":["Download"]},{"name":"Task API","tags":["Tasks"]},{"name":"Analysis API","tags":["Analysis"]},{"name":"Health API","tags":["Health"]},{"name":"Beta Land API","tags":["Beta Land"]}]}