{ "openapi": "3.1.0", "info": { "title": "TiTiler", "description": "A modern dynamic tile server built on top of FastAPI and Rasterio/GDAL.\n\n---\n\n**Documentation**: https://developmentseed.org/titiler/\n\n**Source Code**: https://github.com/developmentseed/titiler\n\n---\n ", "version": "2.0.4" }, "paths": { "/cog/info": { "get": { "tags": [ "Cloud Optimized GeoTIFF" ], "summary": "Info", "description": "Return dataset's basic info.", "operationId": ".cog.getInfo", "parameters": [ { "name": "url", "in": "query", "required": true, "schema": { "type": "string", "description": "Dataset URL", "title": "Url" }, "description": "Dataset URL" } ], "responses": { "200": { "description": "Return dataset's basic info.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rio_tiler__models__Info" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/cog/info.geojson": { "get": { "tags": [ "Cloud Optimized GeoTIFF" ], "summary": "Info Geojson", "description": "Return dataset's basic info as a GeoJSON feature.", "operationId": ".cog.getInfoGeoJSON", "parameters": [ { "name": "url", "in": "query", "required": true, "schema": { "type": "string", "description": "Dataset URL", "title": "Url" }, "description": "Dataset URL" }, { "name": "crs", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Coordinate Reference System.", "title": "Crs" }, "description": "Coordinate Reference System." } ], "responses": { "200": { "description": "Return dataset's basic info as a GeoJSON feature.", "content": { "application/geo+json": { "schema": { "$ref": "#/components/schemas/Feature_Union_Polygon__MultiPolygon__Info_" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/cog/statistics": { "get": { "tags": [ "Cloud Optimized GeoTIFF" ], "summary": "Statistics", "description": "Get Dataset statistics.", "operationId": ".cog.getStatistics", "parameters": [ { "name": "url", "in": "query", "required": true, "schema": { "type": "string", "description": "Dataset URL", "title": "Url" }, "description": "Dataset URL" }, { "name": "bidx", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "array", "items": { "type": "integer" } }, { "type": "null" } ], "title": "Band indexes", "description": "Dataset band indexes" }, "description": "Dataset band indexes", "examples": { "user-provided": {}, "one-band": { "value": [ 1 ] }, "multi-bands": { "value": [ 1, 2, 3 ] } } }, { "name": "expression", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Band Math expression", "description": "rio-tiler's band math expression" }, "description": "rio-tiler's band math expression", "examples": { "user-provided": {}, "simple": { "description": "Simple band math.", "value": "b1/b2" }, "multi-bands": { "description": "Semicolon (;) delimited expressions (band1: b1/b2, band2: b2+b3).", "value": "b1/b2;b2+b3" } } }, { "name": "nodata", "in": "query", "required": false, "schema": { "anyOf": [ { "enum": [ "nan", "inf", "-inf" ], "type": "string" }, { "type": "integer" }, { "type": "number" }, { "type": "null" } ], "title": "Nodata value", "description": "Overwrite internal Nodata value; nan or valid float values only." }, "description": "Overwrite internal Nodata value; nan or valid float values only." }, { "name": "unscale", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Apply internal Scale/Offset", "description": "Apply internal Scale/Offset. Defaults to `False`." }, "description": "Apply internal Scale/Offset. Defaults to `False`." }, { "name": "resampling", "in": "query", "required": false, "schema": { "anyOf": [ { "enum": [ "nearest", "bilinear", "cubic", "cubic_spline", "lanczos", "average", "mode", "gauss", "rms" ], "type": "string" }, { "type": "null" } ], "description": "RasterIO resampling algorithm. Defaults to `nearest`.", "title": "Resampling" }, "description": "RasterIO resampling algorithm. Defaults to `nearest`." }, { "name": "reproject", "in": "query", "required": false, "schema": { "anyOf": [ { "enum": [ "nearest", "bilinear", "cubic", "cubic_spline", "lanczos", "average", "mode", "max", "min", "med", "q1", "q3", "sum", "rms" ], "type": "string" }, { "type": "null" } ], "description": "WarpKernel resampling algorithm (only used when doing re-projection). Defaults to `nearest`.", "title": "Reproject" }, "description": "WarpKernel resampling algorithm (only used when doing re-projection). Defaults to `nearest`." }, { "name": "max_size", "in": "query", "required": false, "schema": { "type": "integer", "description": "Maximum image size to read onto.", "default": 1024, "title": "Max Size" } }, { "name": "height", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "Force output image height.", "title": "Height" } }, { "name": "width", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "Force output image width.", "title": "Width" } }, { "name": "algorithm", "in": "query", "required": false, "schema": { "enum": [ "hillshade", "slope", "contours", "normalizedIndex", "terrarium", "terrainrgb", "cast", "ceil", "floor", "min", "max", "median", "mean", "std", "var", "sum", "grayscale", "bitonal" ], "type": "string", "description": "Algorithm name", "title": "Algorithm" }, "description": "Algorithm name" }, { "name": "algorithm_params", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Algorithm parameter", "title": "Algorithm Params" }, "description": "Algorithm parameter" }, { "name": "categorical", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "Return statistics for categorical dataset. Defaults to `False`", "title": "Categorical" }, "description": "Return statistics for categorical dataset. Defaults to `False`" }, { "name": "c", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "array", "items": { "anyOf": [ { "type": "number" }, { "type": "integer" } ] } }, { "type": "null" } ], "title": "Pixels values for categories.", "description": "List of values for which to report counts.", "examples": [ 1, 2, 3 ] }, "description": "List of values for which to report counts." }, { "name": "p", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "array", "items": { "type": "integer" } }, { "type": "null" } ], "title": "Percentile values", "description": "List of percentile values (default to [2, 98]).", "examples": [ 2, 5, 95, 98 ] }, "description": "List of percentile values (default to [2, 98])." }, { "name": "histogram_bins", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "pattern": "^\\d+(,\\d+)*$" }, { "type": "null" } ], "title": "Histogram bins.", "description": "\nDefines the number of equal-width bins in the given range (10, by default).\n\nIf bins is a sequence (comma `,` delimited values), it defines a monotonically increasing array of bin edges, including the rightmost edge, allowing for non-uniform bin widths.\n\nlink: https://numpy.org/doc/stable/reference/generated/numpy.histogram.html\n " }, "description": "\nDefines the number of equal-width bins in the given range (10, by default).\n\nIf bins is a sequence (comma `,` delimited values), it defines a monotonically increasing array of bin edges, including the rightmost edge, allowing for non-uniform bin widths.\n\nlink: https://numpy.org/doc/stable/reference/generated/numpy.histogram.html\n ", "examples": { "user-provided": {}, "simple": { "description": "Defines the number of equal-width bins", "value": 8 }, "array": { "description": "Defines custom bin edges (comma `,` delimited values)", "value": "0,100,200,300" } } }, { "name": "histogram_range", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "pattern": "^\\s*(-)?\\d+((\\.\\d+)(e\\d+)?)?\\s*,\\s*(-)?\\d+((\\.\\d+)(e\\d+)?)?\\s*$" }, { "type": "null" } ], "title": "Histogram range", "description": "\nComma `,` delimited range of the bins.\n\nThe lower and upper range of the bins. If not provided, range is simply (a.min(), a.max()).\n\nValues outside the range are ignored. The first element of the range must be less than or equal to the second.\nrange affects the automatic bin computation as well.\n\nlink: https://numpy.org/doc/stable/reference/generated/numpy.histogram.html\n " }, "description": "\nComma `,` delimited range of the bins.\n\nThe lower and upper range of the bins. If not provided, range is simply (a.min(), a.max()).\n\nValues outside the range are ignored. The first element of the range must be less than or equal to the second.\nrange affects the automatic bin computation as well.\n\nlink: https://numpy.org/doc/stable/reference/generated/numpy.histogram.html\n ", "examples": { "user-provided": {}, "array": { "description": "Defines custom histogram range (comma `,` delimited values)", "value": "0,1000" } } } ], "responses": { "200": { "description": "Return dataset's statistics.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/BandStatistics" }, "title": "Response .Cog.Getstatistics" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "post": { "tags": [ "Cloud Optimized GeoTIFF" ], "summary": "Geojson Statistics", "description": "Get Statistics from a geojson feature or featureCollection.", "operationId": ".cog.postStatisticsForGeoJSON", "parameters": [ { "name": "url", "in": "query", "required": true, "schema": { "type": "string", "description": "Dataset URL", "title": "Url" }, "description": "Dataset URL" }, { "name": "coord_crs", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Coordinate Reference System of the input coords. Default to `epsg:4326`.", "title": "Coord Crs" }, "description": "Coordinate Reference System of the input coords. Default to `epsg:4326`." }, { "name": "dst_crs", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Output Coordinate Reference System.", "title": "Dst Crs" }, "description": "Output Coordinate Reference System." }, { "name": "bidx", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "array", "items": { "type": "integer" } }, { "type": "null" } ], "title": "Band indexes", "description": "Dataset band indexes" }, "description": "Dataset band indexes", "examples": { "user-provided": {}, "one-band": { "value": [ 1 ] }, "multi-bands": { "value": [ 1, 2, 3 ] } } }, { "name": "expression", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Band Math expression", "description": "rio-tiler's band math expression" }, "description": "rio-tiler's band math expression", "examples": { "user-provided": {}, "simple": { "description": "Simple band math.", "value": "b1/b2" }, "multi-bands": { "description": "Semicolon (;) delimited expressions (band1: b1/b2, band2: b2+b3).", "value": "b1/b2;b2+b3" } } }, { "name": "nodata", "in": "query", "required": false, "schema": { "anyOf": [ { "enum": [ "nan", "inf", "-inf" ], "type": "string" }, { "type": "integer" }, { "type": "number" }, { "type": "null" } ], "title": "Nodata value", "description": "Overwrite internal Nodata value; nan or valid float values only." }, "description": "Overwrite internal Nodata value; nan or valid float values only." }, { "name": "unscale", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Apply internal Scale/Offset", "description": "Apply internal Scale/Offset. Defaults to `False`." }, "description": "Apply internal Scale/Offset. Defaults to `False`." }, { "name": "resampling", "in": "query", "required": false, "schema": { "anyOf": [ { "enum": [ "nearest", "bilinear", "cubic", "cubic_spline", "lanczos", "average", "mode", "gauss", "rms" ], "type": "string" }, { "type": "null" } ], "description": "RasterIO resampling algorithm. Defaults to `nearest`.", "title": "Resampling" }, "description": "RasterIO resampling algorithm. Defaults to `nearest`." }, { "name": "reproject", "in": "query", "required": false, "schema": { "anyOf": [ { "enum": [ "nearest", "bilinear", "cubic", "cubic_spline", "lanczos", "average", "mode", "max", "min", "med", "q1", "q3", "sum", "rms" ], "type": "string" }, { "type": "null" } ], "description": "WarpKernel resampling algorithm (only used when doing re-projection). Defaults to `nearest`.", "title": "Reproject" }, "description": "WarpKernel resampling algorithm (only used when doing re-projection). Defaults to `nearest`." }, { "name": "max_size", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "Maximum image size to read onto.", "title": "Max Size" } }, { "name": "height", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "Force output image height.", "title": "Height" } }, { "name": "width", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "Force output image width.", "title": "Width" } }, { "name": "algorithm", "in": "query", "required": false, "schema": { "enum": [ "hillshade", "slope", "contours", "normalizedIndex", "terrarium", "terrainrgb", "cast", "ceil", "floor", "min", "max", "median", "mean", "std", "var", "sum", "grayscale", "bitonal" ], "type": "string", "description": "Algorithm name", "title": "Algorithm" }, "description": "Algorithm name" }, { "name": "algorithm_params", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Algorithm parameter", "title": "Algorithm Params" }, "description": "Algorithm parameter" }, { "name": "cover_scale", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "integer", "maximum": 1000, "exclusiveMinimum": 0 }, { "type": "null" } ], "description": "Scale used when generating coverage estimates of each\n raster cell by vector feature. Coverage is generated by\n rasterizing the feature at a finer resolution than the raster then using a summation to aggregate\n to the raster resolution and dividing by the square of cover_scale\n to get coverage value for each cell. Increasing cover_scale\n will increase the accuracy of coverage values; three orders\n magnitude finer resolution (cover_scale=1000) is usually enough to\n get coverage estimates with <1% error in individual edge cells coverage\n estimates, though much smaller values (e.g., cover_scale=10) are often\n sufficient (<10% error) and require less memory. Defaults to `10`.", "title": "Cover Scale" }, "description": "Scale used when generating coverage estimates of each\n raster cell by vector feature. Coverage is generated by\n rasterizing the feature at a finer resolution than the raster then using a summation to aggregate\n to the raster resolution and dividing by the square of cover_scale\n to get coverage value for each cell. Increasing cover_scale\n will increase the accuracy of coverage values; three orders\n magnitude finer resolution (cover_scale=1000) is usually enough to\n get coverage estimates with <1% error in individual edge cells coverage\n estimates, though much smaller values (e.g., cover_scale=10) are often\n sufficient (<10% error) and require less memory. Defaults to `10`." }, { "name": "categorical", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "Return statistics for categorical dataset. Defaults to `False`", "title": "Categorical" }, "description": "Return statistics for categorical dataset. Defaults to `False`" }, { "name": "c", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "array", "items": { "anyOf": [ { "type": "number" }, { "type": "integer" } ] } }, { "type": "null" } ], "title": "Pixels values for categories.", "description": "List of values for which to report counts.", "examples": [ 1, 2, 3 ] }, "description": "List of values for which to report counts." }, { "name": "p", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "array", "items": { "type": "integer" } }, { "type": "null" } ], "title": "Percentile values", "description": "List of percentile values (default to [2, 98]).", "examples": [ 2, 5, 95, 98 ] }, "description": "List of percentile values (default to [2, 98])." }, { "name": "histogram_bins", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "pattern": "^\\d+(,\\d+)*$" }, { "type": "null" } ], "title": "Histogram bins.", "description": "\nDefines the number of equal-width bins in the given range (10, by default).\n\nIf bins is a sequence (comma `,` delimited values), it defines a monotonically increasing array of bin edges, including the rightmost edge, allowing for non-uniform bin widths.\n\nlink: https://numpy.org/doc/stable/reference/generated/numpy.histogram.html\n " }, "description": "\nDefines the number of equal-width bins in the given range (10, by default).\n\nIf bins is a sequence (comma `,` delimited values), it defines a monotonically increasing array of bin edges, including the rightmost edge, allowing for non-uniform bin widths.\n\nlink: https://numpy.org/doc/stable/reference/generated/numpy.histogram.html\n ", "examples": { "user-provided": {}, "simple": { "description": "Defines the number of equal-width bins", "value": 8 }, "array": { "description": "Defines custom bin edges (comma `,` delimited values)", "value": "0,100,200,300" } } }, { "name": "histogram_range", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "pattern": "^\\s*(-)?\\d+((\\.\\d+)(e\\d+)?)?\\s*,\\s*(-)?\\d+((\\.\\d+)(e\\d+)?)?\\s*$" }, { "type": "null" } ], "title": "Histogram range", "description": "\nComma `,` delimited range of the bins.\n\nThe lower and upper range of the bins. If not provided, range is simply (a.min(), a.max()).\n\nValues outside the range are ignored. The first element of the range must be less than or equal to the second.\nrange affects the automatic bin computation as well.\n\nlink: https://numpy.org/doc/stable/reference/generated/numpy.histogram.html\n " }, "description": "\nComma `,` delimited range of the bins.\n\nThe lower and upper range of the bins. If not provided, range is simply (a.min(), a.max()).\n\nValues outside the range are ignored. The first element of the range must be less than or equal to the second.\nrange affects the automatic bin computation as well.\n\nlink: https://numpy.org/doc/stable/reference/generated/numpy.histogram.html\n ", "examples": { "user-provided": {}, "array": { "description": "Defines custom histogram range (comma `,` delimited values)", "value": "0,1000" } } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/FeatureCollection" }, { "$ref": "#/components/schemas/Feature-Input" } ], "description": "GeoJSON Feature or FeatureCollection.", "title": "Geojson" } } } }, "responses": { "200": { "description": "Return dataset's statistics from feature or featureCollection.", "content": { "application/geo+json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/FeatureCollection_Feature_Annotated_Union_Point__MultiPoint__LineString__MultiLineString__Polygon__MultiPolygon__GeometryCollection___FieldInfo_annotation_NoneType__required_True__discriminator__type_____StatisticsInGeoJSON__" }, { "$ref": "#/components/schemas/Feature_Annotated_Union_Point__MultiPoint__LineString__MultiLineString__Polygon__MultiPolygon__GeometryCollection___FieldInfo_annotation_NoneType__required_True__discriminator__type____StatisticsInGeoJSON_" } ], "title": "Response .Cog.Poststatisticsforgeojson" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/cog/tiles": { "get": { "tags": [ "Cloud Optimized GeoTIFF" ], "summary": "Retrieve a list of available raster tilesets for the specified dataset.", "description": "Retrieve a list of available raster tilesets for the specified dataset.", "operationId": ".cog.getTileSetList", "parameters": [ { "name": "f", "in": "query", "required": false, "schema": { "anyOf": [ { "enum": [ "html", "json" ], "type": "string" }, { "type": "null" } ], "description": "Response MediaType. Defaults to endpoint's default or value defined in `accept` header.", "title": "F" }, "description": "Response MediaType. Defaults to endpoint's default or value defined in `accept` header." }, { "name": "url", "in": "query", "required": true, "schema": { "type": "string", "description": "Dataset URL", "title": "Url" }, "description": "Dataset URL" }, { "name": "crs", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Coordinate Reference System.", "title": "Crs" }, "description": "Coordinate Reference System." } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TileSetList" } }, "text/html": {} } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/cog/tiles/{tileMatrixSetId}": { "get": { "tags": [ "Cloud Optimized GeoTIFF" ], "summary": "Retrieve the raster tileset metadata for the specified dataset and tiling scheme (tile matrix set).", "description": "Retrieve the raster tileset metadata for the specified dataset and tiling scheme (tile matrix set).", "operationId": ".cog.getTileSet", "parameters": [ { "name": "tileMatrixSetId", "in": "path", "required": true, "schema": { "enum": [ "CDB1GlobalGrid", "CanadianNAD83_LCC", "EuropeanETRS89_LAEAQuad", "GNOSISGlobalGrid", "LINZAntarticaMapTilegrid", "NZTM2000Quad", "UPSAntarcticWGS84Quad", "UPSArcticWGS84Quad", "UTM31WGS84Quad", "WGS1984Quad", "WebMercatorQuad", "WorldCRS84Quad", "WorldMercatorWGS84Quad" ], "type": "string", "description": "Identifier selecting one of the TileMatrixSetId supported.", "title": "Tilematrixsetid" }, "description": "Identifier selecting one of the TileMatrixSetId supported." }, { "name": "minzoom", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "Overwrite default minzoom.", "title": "Minzoom" }, "description": "Overwrite default minzoom." }, { "name": "maxzoom", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "Overwrite default maxzoom.", "title": "Maxzoom" }, "description": "Overwrite default maxzoom." }, { "name": "f", "in": "query", "required": false, "schema": { "anyOf": [ { "enum": [ "html", "json" ], "type": "string" }, { "type": "null" } ], "description": "Response MediaType. Defaults to endpoint's default or value defined in `accept` header.", "title": "F" }, "description": "Response MediaType. Defaults to endpoint's default or value defined in `accept` header." }, { "name": "url", "in": "query", "required": true, "schema": { "type": "string", "description": "Dataset URL", "title": "Url" }, "description": "Dataset URL" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TileSet" } }, "text/html": {} } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/cog/tiles/{tileMatrixSetId}/{z}/{x}/{y}.{format}": { "get": { "tags": [ "Cloud Optimized GeoTIFF" ], "summary": "Tile", "description": "Create map tile from a dataset.", "operationId": ".cog.getTileWithFormat", "parameters": [ { "name": "z", "in": "path", "required": true, "schema": { "type": "integer", "description": "Identifier (Z) selecting one of the scales defined in the TileMatrixSet and representing the scaleDenominator the tile.", "title": "Z" }, "description": "Identifier (Z) selecting one of the scales defined in the TileMatrixSet and representing the scaleDenominator the tile." }, { "name": "x", "in": "path", "required": true, "schema": { "type": "integer", "description": "Column (X) index of the tile on the selected TileMatrix. It cannot exceed the MatrixHeight-1 for the selected TileMatrix.", "title": "X" }, "description": "Column (X) index of the tile on the selected TileMatrix. It cannot exceed the MatrixHeight-1 for the selected TileMatrix." }, { "name": "y", "in": "path", "required": true, "schema": { "type": "integer", "description": "Row (Y) index of the tile on the selected TileMatrix. It cannot exceed the MatrixWidth-1 for the selected TileMatrix.", "title": "Y" }, "description": "Row (Y) index of the tile on the selected TileMatrix. It cannot exceed the MatrixWidth-1 for the selected TileMatrix." }, { "name": "tileMatrixSetId", "in": "path", "required": true, "schema": { "enum": [ "CDB1GlobalGrid", "CanadianNAD83_LCC", "EuropeanETRS89_LAEAQuad", "GNOSISGlobalGrid", "LINZAntarticaMapTilegrid", "NZTM2000Quad", "UPSAntarcticWGS84Quad", "UPSArcticWGS84Quad", "UTM31WGS84Quad", "WGS1984Quad", "WebMercatorQuad", "WorldCRS84Quad", "WorldMercatorWGS84Quad" ], "type": "string", "description": "Identifier selecting one of the TileMatrixSetId supported.", "title": "Tilematrixsetid" }, "description": "Identifier selecting one of the TileMatrixSetId supported." }, { "name": "format", "in": "path", "required": true, "schema": { "anyOf": [ { "$ref": "#/components/schemas/ImageType" }, { "type": "null" } ], "description": "Default will be automatically defined if the output image needs a mask (png) or not (jpeg).", "title": "Format" } }, { "name": "tilesize", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "integer", "exclusiveMinimum": 0 }, { "type": "null" } ], "description": "Tilesize in pixels.", "title": "Tilesize" }, "description": "Tilesize in pixels." }, { "name": "url", "in": "query", "required": true, "schema": { "type": "string", "description": "Dataset URL", "title": "Url" }, "description": "Dataset URL" }, { "name": "buffer", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "number", "exclusiveMinimum": 0 }, { "type": "null" } ], "title": "Tile buffer.", "description": "Buffer on each side of the given tile. It must be a multiple of `0.5`. Output **tilesize** will be expanded to `tilesize + 2 * buffer` (e.g 0.5 = 257x257, 1.0 = 258x258)." }, "description": "Buffer on each side of the given tile. It must be a multiple of `0.5`. Output **tilesize** will be expanded to `tilesize + 2 * buffer` (e.g 0.5 = 257x257, 1.0 = 258x258)." }, { "name": "padding", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "integer", "exclusiveMinimum": 0 }, { "type": "null" } ], "title": "Tile padding.", "description": "Padding to apply to each tile edge. Helps reduce resampling artefacts along edges. Defaults to `0`." }, "description": "Padding to apply to each tile edge. Helps reduce resampling artefacts along edges. Defaults to `0`." }, { "name": "bidx", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "array", "items": { "type": "integer" } }, { "type": "null" } ], "title": "Band indexes", "description": "Dataset band indexes" }, "description": "Dataset band indexes", "examples": { "user-provided": {}, "one-band": { "value": [ 1 ] }, "multi-bands": { "value": [ 1, 2, 3 ] } } }, { "name": "expression", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Band Math expression", "description": "rio-tiler's band math expression" }, "description": "rio-tiler's band math expression", "examples": { "user-provided": {}, "simple": { "description": "Simple band math.", "value": "b1/b2" }, "multi-bands": { "description": "Semicolon (;) delimited expressions (band1: b1/b2, band2: b2+b3).", "value": "b1/b2;b2+b3" } } }, { "name": "nodata", "in": "query", "required": false, "schema": { "anyOf": [ { "enum": [ "nan", "inf", "-inf" ], "type": "string" }, { "type": "integer" }, { "type": "number" }, { "type": "null" } ], "title": "Nodata value", "description": "Overwrite internal Nodata value; nan or valid float values only." }, "description": "Overwrite internal Nodata value; nan or valid float values only." }, { "name": "unscale", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Apply internal Scale/Offset", "description": "Apply internal Scale/Offset. Defaults to `False`." }, "description": "Apply internal Scale/Offset. Defaults to `False`." }, { "name": "resampling", "in": "query", "required": false, "schema": { "anyOf": [ { "enum": [ "nearest", "bilinear", "cubic", "cubic_spline", "lanczos", "average", "mode", "gauss", "rms" ], "type": "string" }, { "type": "null" } ], "description": "RasterIO resampling algorithm. Defaults to `nearest`.", "title": "Resampling" }, "description": "RasterIO resampling algorithm. Defaults to `nearest`." }, { "name": "reproject", "in": "query", "required": false, "schema": { "anyOf": [ { "enum": [ "nearest", "bilinear", "cubic", "cubic_spline", "lanczos", "average", "mode", "max", "min", "med", "q1", "q3", "sum", "rms" ], "type": "string" }, { "type": "null" } ], "description": "WarpKernel resampling algorithm (only used when doing re-projection). Defaults to `nearest`.", "title": "Reproject" }, "description": "WarpKernel resampling algorithm (only used when doing re-projection). Defaults to `nearest`." }, { "name": "algorithm", "in": "query", "required": false, "schema": { "enum": [ "hillshade", "slope", "contours", "normalizedIndex", "terrarium", "terrainrgb", "cast", "ceil", "floor", "min", "max", "median", "mean", "std", "var", "sum", "grayscale", "bitonal" ], "type": "string", "description": "Algorithm name", "title": "Algorithm" }, "description": "Algorithm name" }, { "name": "algorithm_params", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Algorithm parameter", "title": "Algorithm Params" }, "description": "Algorithm parameter" }, { "name": "colormap_name", "in": "query", "required": false, "schema": { "enum": [ "jet_r", "haline", "gist_ncar_r", "algae", "cividis_r", "seismic_r", "pink_r", "rdylbu", "inferno_r", "deep", "rdgy_r", "tab10", "bugn_r", "ocean_r", "purples", "pastel1_r", "thermal_r", "ylorrd_r", "wistia_r", "cmrmap", "pubu", "rain", "ylgnbu", "gnuplot", "gnbu", "gist_gray_r", "greens", "purd_r", "oxy_r", "matter", "summer_r", "gnuplot_r", "gnuplot2", "solar", "jet", "ylgn_r", "dark2_r", "spring", "tab20c", "gist_stern", "bwr", "ylgn", "plasma", "pastel2", "blues_r", "rain_r", "set1", "topo_r", "gist_ncar", "turbid", "magma_r", "pastel2_r", "purd", "gnbu_r", "spring_r", "rdbu_r", "ylorbr", "twilight_shifted", "rplumbo", "winter_r", "tab20b", "ylorrd", "copper", "flag_r", "afmhot", "twilight_shifted_r", "oranges_r", "bone", "seismic", "gray_r", "tarn_r", "bwr_r", "magma", "paired_r", "dark2", "binary", "set3", "viridis_r", "spectral", "prgn", "diff", "hot", "gist_earth", "cubehelix", "dense_r", "coolwarm", "pubugn_r", "autumn_r", "gnuplot2_r", "cividis", "bugn", "deep_r", "prgn_r", "gist_rainbow", "gist_heat_r", "nipy_spectral_r", "tab20", "turbo_r", "pubugn", "set2_r", "gist_yarg_r", "spectral_r", "binary_r", "greys", "rainbow_r", "haline_r", "curl", "tab20c_r", "blues", "prism", "rdgy", "gist_gray", "set2", "cool", "afmhot_r", "bone_r", "paired", "oranges", "orrd", "puor", "autumn", "delta_r", "pubu_r", "piyg_r", "turbo", "greys_r", "accent", "turbid_r", "algae_r", "solar_r", "topo", "cool_r", "inferno", "balance", "tempo_r", "amp_r", "flag", "speed", "gist_heat", "balance_r", "viridis", "cubehelix_r", "ylorbr_r", "summer", "coolwarm_r", "diff_r", "rdylgn_r", "gist_stern_r", "plasma_r", "copper_r", "oxy", "gist_yarg", "twilight", "winter", "brbg", "reds_r", "speed_r", "rainbow", "ice", "nipy_spectral", "piyg", "gray", "reds", "terrain", "tab20_r", "wistia", "accent_r", "thermal", "ocean", "twilight_r", "hot_r", "set3_r", "hsv_r", "brg_r", "gist_rainbow_r", "phase", "bupu", "pastel1", "dense", "set1_r", "phase_r", "matter_r", "greens_r", "cfastie", "tab10_r", "rdbu", "brg", "rdpu_r", "brbg_r", "cmrmap_r", "prism_r", "purples_r", "gist_earth_r", "tempo", "schwarzwald", "rdpu", "orrd_r", "tarn", "puor_r", "bupu_r", "rdylgn", "ice_r", "pink", "terrain_r", "amp", "tab20b_r", "rdylbu_r", "hsv", "curl_r", "delta", "ylgnbu_r" ], "type": "string", "description": "Colormap name", "title": "Colormap Name" }, "description": "Colormap name" }, { "name": "colormap", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "JSON encoded custom Colormap", "title": "Colormap" }, "description": "JSON encoded custom Colormap" }, { "name": "rescale", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ], "title": "Min/Max data Rescaling", "description": "comma (',') delimited Min,Max range. Can set multiple time for multiple bands.", "examples": [ "0,2000", "0,1000", "0,10000" ] }, "description": "comma (',') delimited Min,Max range. Can set multiple time for multiple bands." }, { "name": "color_formula", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Color Formula", "description": "rio-color formula (info: https://github.com/mapbox/rio-color)" }, "description": "rio-color formula (info: https://github.com/mapbox/rio-color)" }, { "name": "return_mask", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "Add mask to the output data. Defaults to `True`", "title": "Return Mask" }, "description": "Add mask to the output data. Defaults to `True`" } ], "responses": { "200": { "description": "Return an image.", "content": { "image/png": {}, "image/jpeg": {}, "image/jpg": {}, "image/webp": {}, "image/jp2": {}, "image/tiff; application=geotiff": {}, "application/x-binary": {} } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/cog/tiles/{tileMatrixSetId}/{z}/{x}/{y}": { "get": { "tags": [ "Cloud Optimized GeoTIFF" ], "summary": "Tile", "description": "Create map tile from a dataset.", "operationId": ".cog.getTile", "parameters": [ { "name": "z", "in": "path", "required": true, "schema": { "type": "integer", "description": "Identifier (Z) selecting one of the scales defined in the TileMatrixSet and representing the scaleDenominator the tile.", "title": "Z" }, "description": "Identifier (Z) selecting one of the scales defined in the TileMatrixSet and representing the scaleDenominator the tile." }, { "name": "x", "in": "path", "required": true, "schema": { "type": "integer", "description": "Column (X) index of the tile on the selected TileMatrix. It cannot exceed the MatrixHeight-1 for the selected TileMatrix.", "title": "X" }, "description": "Column (X) index of the tile on the selected TileMatrix. It cannot exceed the MatrixHeight-1 for the selected TileMatrix." }, { "name": "y", "in": "path", "required": true, "schema": { "type": "integer", "description": "Row (Y) index of the tile on the selected TileMatrix. It cannot exceed the MatrixWidth-1 for the selected TileMatrix.", "title": "Y" }, "description": "Row (Y) index of the tile on the selected TileMatrix. It cannot exceed the MatrixWidth-1 for the selected TileMatrix." }, { "name": "tileMatrixSetId", "in": "path", "required": true, "schema": { "enum": [ "CDB1GlobalGrid", "CanadianNAD83_LCC", "EuropeanETRS89_LAEAQuad", "GNOSISGlobalGrid", "LINZAntarticaMapTilegrid", "NZTM2000Quad", "UPSAntarcticWGS84Quad", "UPSArcticWGS84Quad", "UTM31WGS84Quad", "WGS1984Quad", "WebMercatorQuad", "WorldCRS84Quad", "WorldMercatorWGS84Quad" ], "type": "string", "description": "Identifier selecting one of the TileMatrixSetId supported.", "title": "Tilematrixsetid" }, "description": "Identifier selecting one of the TileMatrixSetId supported." }, { "name": "format", "in": "query", "required": false, "schema": { "anyOf": [ { "$ref": "#/components/schemas/ImageType" }, { "type": "null" } ], "description": "Default will be automatically defined if the output image needs a mask (png) or not (jpeg).", "title": "Format" } }, { "name": "tilesize", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "integer", "exclusiveMinimum": 0 }, { "type": "null" } ], "description": "Tilesize in pixels.", "title": "Tilesize" }, "description": "Tilesize in pixels." }, { "name": "url", "in": "query", "required": true, "schema": { "type": "string", "description": "Dataset URL", "title": "Url" }, "description": "Dataset URL" }, { "name": "buffer", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "number", "exclusiveMinimum": 0 }, { "type": "null" } ], "title": "Tile buffer.", "description": "Buffer on each side of the given tile. It must be a multiple of `0.5`. Output **tilesize** will be expanded to `tilesize + 2 * buffer` (e.g 0.5 = 257x257, 1.0 = 258x258)." }, "description": "Buffer on each side of the given tile. It must be a multiple of `0.5`. Output **tilesize** will be expanded to `tilesize + 2 * buffer` (e.g 0.5 = 257x257, 1.0 = 258x258)." }, { "name": "padding", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "integer", "exclusiveMinimum": 0 }, { "type": "null" } ], "title": "Tile padding.", "description": "Padding to apply to each tile edge. Helps reduce resampling artefacts along edges. Defaults to `0`." }, "description": "Padding to apply to each tile edge. Helps reduce resampling artefacts along edges. Defaults to `0`." }, { "name": "bidx", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "array", "items": { "type": "integer" } }, { "type": "null" } ], "title": "Band indexes", "description": "Dataset band indexes" }, "description": "Dataset band indexes", "examples": { "user-provided": {}, "one-band": { "value": [ 1 ] }, "multi-bands": { "value": [ 1, 2, 3 ] } } }, { "name": "expression", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Band Math expression", "description": "rio-tiler's band math expression" }, "description": "rio-tiler's band math expression", "examples": { "user-provided": {}, "simple": { "description": "Simple band math.", "value": "b1/b2" }, "multi-bands": { "description": "Semicolon (;) delimited expressions (band1: b1/b2, band2: b2+b3).", "value": "b1/b2;b2+b3" } } }, { "name": "nodata", "in": "query", "required": false, "schema": { "anyOf": [ { "enum": [ "nan", "inf", "-inf" ], "type": "string" }, { "type": "integer" }, { "type": "number" }, { "type": "null" } ], "title": "Nodata value", "description": "Overwrite internal Nodata value; nan or valid float values only." }, "description": "Overwrite internal Nodata value; nan or valid float values only." }, { "name": "unscale", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Apply internal Scale/Offset", "description": "Apply internal Scale/Offset. Defaults to `False`." }, "description": "Apply internal Scale/Offset. Defaults to `False`." }, { "name": "resampling", "in": "query", "required": false, "schema": { "anyOf": [ { "enum": [ "nearest", "bilinear", "cubic", "cubic_spline", "lanczos", "average", "mode", "gauss", "rms" ], "type": "string" }, { "type": "null" } ], "description": "RasterIO resampling algorithm. Defaults to `nearest`.", "title": "Resampling" }, "description": "RasterIO resampling algorithm. Defaults to `nearest`." }, { "name": "reproject", "in": "query", "required": false, "schema": { "anyOf": [ { "enum": [ "nearest", "bilinear", "cubic", "cubic_spline", "lanczos", "average", "mode", "max", "min", "med", "q1", "q3", "sum", "rms" ], "type": "string" }, { "type": "null" } ], "description": "WarpKernel resampling algorithm (only used when doing re-projection). Defaults to `nearest`.", "title": "Reproject" }, "description": "WarpKernel resampling algorithm (only used when doing re-projection). Defaults to `nearest`." }, { "name": "algorithm", "in": "query", "required": false, "schema": { "enum": [ "hillshade", "slope", "contours", "normalizedIndex", "terrarium", "terrainrgb", "cast", "ceil", "floor", "min", "max", "median", "mean", "std", "var", "sum", "grayscale", "bitonal" ], "type": "string", "description": "Algorithm name", "title": "Algorithm" }, "description": "Algorithm name" }, { "name": "algorithm_params", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Algorithm parameter", "title": "Algorithm Params" }, "description": "Algorithm parameter" }, { "name": "colormap_name", "in": "query", "required": false, "schema": { "enum": [ "jet_r", "haline", "gist_ncar_r", "algae", "cividis_r", "seismic_r", "pink_r", "rdylbu", "inferno_r", "deep", "rdgy_r", "tab10", "bugn_r", "ocean_r", "purples", "pastel1_r", "thermal_r", "ylorrd_r", "wistia_r", "cmrmap", "pubu", "rain", "ylgnbu", "gnuplot", "gnbu", "gist_gray_r", "greens", "purd_r", "oxy_r", "matter", "summer_r", "gnuplot_r", "gnuplot2", "solar", "jet", "ylgn_r", "dark2_r", "spring", "tab20c", "gist_stern", "bwr", "ylgn", "plasma", "pastel2", "blues_r", "rain_r", "set1", "topo_r", "gist_ncar", "turbid", "magma_r", "pastel2_r", "purd", "gnbu_r", "spring_r", "rdbu_r", "ylorbr", "twilight_shifted", "rplumbo", "winter_r", "tab20b", "ylorrd", "copper", "flag_r", "afmhot", "twilight_shifted_r", "oranges_r", "bone", "seismic", "gray_r", "tarn_r", "bwr_r", "magma", "paired_r", "dark2", "binary", "set3", "viridis_r", "spectral", "prgn", "diff", "hot", "gist_earth", "cubehelix", "dense_r", "coolwarm", "pubugn_r", "autumn_r", "gnuplot2_r", "cividis", "bugn", "deep_r", "prgn_r", "gist_rainbow", "gist_heat_r", "nipy_spectral_r", "tab20", "turbo_r", "pubugn", "set2_r", "gist_yarg_r", "spectral_r", "binary_r", "greys", "rainbow_r", "haline_r", "curl", "tab20c_r", "blues", "prism", "rdgy", "gist_gray", "set2", "cool", "afmhot_r", "bone_r", "paired", "oranges", "orrd", "puor", "autumn", "delta_r", "pubu_r", "piyg_r", "turbo", "greys_r", "accent", "turbid_r", "algae_r", "solar_r", "topo", "cool_r", "inferno", "balance", "tempo_r", "amp_r", "flag", "speed", "gist_heat", "balance_r", "viridis", "cubehelix_r", "ylorbr_r", "summer", "coolwarm_r", "diff_r", "rdylgn_r", "gist_stern_r", "plasma_r", "copper_r", "oxy", "gist_yarg", "twilight", "winter", "brbg", "reds_r", "speed_r", "rainbow", "ice", "nipy_spectral", "piyg", "gray", "reds", "terrain", "tab20_r", "wistia", "accent_r", "thermal", "ocean", "twilight_r", "hot_r", "set3_r", "hsv_r", "brg_r", "gist_rainbow_r", "phase", "bupu", "pastel1", "dense", "set1_r", "phase_r", "matter_r", "greens_r", "cfastie", "tab10_r", "rdbu", "brg", "rdpu_r", "brbg_r", "cmrmap_r", "prism_r", "purples_r", "gist_earth_r", "tempo", "schwarzwald", "rdpu", "orrd_r", "tarn", "puor_r", "bupu_r", "rdylgn", "ice_r", "pink", "terrain_r", "amp", "tab20b_r", "rdylbu_r", "hsv", "curl_r", "delta", "ylgnbu_r" ], "type": "string", "description": "Colormap name", "title": "Colormap Name" }, "description": "Colormap name" }, { "name": "colormap", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "JSON encoded custom Colormap", "title": "Colormap" }, "description": "JSON encoded custom Colormap" }, { "name": "rescale", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ], "title": "Min/Max data Rescaling", "description": "comma (',') delimited Min,Max range. Can set multiple time for multiple bands.", "examples": [ "0,2000", "0,1000", "0,10000" ] }, "description": "comma (',') delimited Min,Max range. Can set multiple time for multiple bands." }, { "name": "color_formula", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Color Formula", "description": "rio-color formula (info: https://github.com/mapbox/rio-color)" }, "description": "rio-color formula (info: https://github.com/mapbox/rio-color)" }, { "name": "return_mask", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "Add mask to the output data. Defaults to `True`", "title": "Return Mask" }, "description": "Add mask to the output data. Defaults to `True`" } ], "responses": { "200": { "description": "Return an image.", "content": { "image/png": {}, "image/jpeg": {}, "image/jpg": {}, "image/webp": {}, "image/jp2": {}, "image/tiff; application=geotiff": {}, "application/x-binary": {} } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/cog/{tileMatrixSetId}/map.html": { "get": { "tags": [ "Cloud Optimized GeoTIFF" ], "summary": "Map Viewer", "description": "Return TileJSON document for a dataset.", "operationId": ".cog.getMapViewer", "parameters": [ { "name": "tileMatrixSetId", "in": "path", "required": true, "schema": { "enum": [ "CDB1GlobalGrid", "CanadianNAD83_LCC", "EuropeanETRS89_LAEAQuad", "GNOSISGlobalGrid", "LINZAntarticaMapTilegrid", "NZTM2000Quad", "UPSAntarcticWGS84Quad", "UPSArcticWGS84Quad", "UTM31WGS84Quad", "WGS1984Quad", "WebMercatorQuad", "WorldCRS84Quad", "WorldMercatorWGS84Quad" ], "type": "string", "description": "Identifier selecting one of the TileMatrixSetId supported.", "title": "Tilematrixsetid" }, "description": "Identifier selecting one of the TileMatrixSetId supported." }, { "name": "tile_format", "in": "query", "required": false, "schema": { "anyOf": [ { "$ref": "#/components/schemas/ImageType" }, { "type": "null" } ], "description": "Default will be automatically defined if the output image needs a mask (png) or not (jpeg).", "title": "Tile Format" }, "description": "Default will be automatically defined if the output image needs a mask (png) or not (jpeg)." }, { "name": "tilesize", "in": "query", "required": false, "schema": { "type": "integer", "exclusiveMinimum": 0, "description": "Tilesize in pixels. Default to 256.", "default": 256, "title": "Tilesize" }, "description": "Tilesize in pixels. Default to 256." }, { "name": "minzoom", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "Overwrite default minzoom.", "title": "Minzoom" }, "description": "Overwrite default minzoom." }, { "name": "maxzoom", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "Overwrite default maxzoom.", "title": "Maxzoom" }, "description": "Overwrite default maxzoom." }, { "name": "url", "in": "query", "required": true, "schema": { "type": "string", "description": "Dataset URL", "title": "Url" }, "description": "Dataset URL" }, { "name": "buffer", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "number", "exclusiveMinimum": 0 }, { "type": "null" } ], "title": "Tile buffer.", "description": "Buffer on each side of the given tile. It must be a multiple of `0.5`. Output **tilesize** will be expanded to `tilesize + 2 * buffer` (e.g 0.5 = 257x257, 1.0 = 258x258)." }, "description": "Buffer on each side of the given tile. It must be a multiple of `0.5`. Output **tilesize** will be expanded to `tilesize + 2 * buffer` (e.g 0.5 = 257x257, 1.0 = 258x258)." }, { "name": "padding", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "integer", "exclusiveMinimum": 0 }, { "type": "null" } ], "title": "Tile padding.", "description": "Padding to apply to each tile edge. Helps reduce resampling artefacts along edges. Defaults to `0`." }, "description": "Padding to apply to each tile edge. Helps reduce resampling artefacts along edges. Defaults to `0`." }, { "name": "bidx", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "array", "items": { "type": "integer" } }, { "type": "null" } ], "title": "Band indexes", "description": "Dataset band indexes" }, "description": "Dataset band indexes", "examples": { "user-provided": {}, "one-band": { "value": [ 1 ] }, "multi-bands": { "value": [ 1, 2, 3 ] } } }, { "name": "expression", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Band Math expression", "description": "rio-tiler's band math expression" }, "description": "rio-tiler's band math expression", "examples": { "user-provided": {}, "simple": { "description": "Simple band math.", "value": "b1/b2" }, "multi-bands": { "description": "Semicolon (;) delimited expressions (band1: b1/b2, band2: b2+b3).", "value": "b1/b2;b2+b3" } } }, { "name": "nodata", "in": "query", "required": false, "schema": { "anyOf": [ { "enum": [ "nan", "inf", "-inf" ], "type": "string" }, { "type": "integer" }, { "type": "number" }, { "type": "null" } ], "title": "Nodata value", "description": "Overwrite internal Nodata value; nan or valid float values only." }, "description": "Overwrite internal Nodata value; nan or valid float values only." }, { "name": "unscale", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Apply internal Scale/Offset", "description": "Apply internal Scale/Offset. Defaults to `False`." }, "description": "Apply internal Scale/Offset. Defaults to `False`." }, { "name": "resampling", "in": "query", "required": false, "schema": { "anyOf": [ { "enum": [ "nearest", "bilinear", "cubic", "cubic_spline", "lanczos", "average", "mode", "gauss", "rms" ], "type": "string" }, { "type": "null" } ], "description": "RasterIO resampling algorithm. Defaults to `nearest`.", "title": "Resampling" }, "description": "RasterIO resampling algorithm. Defaults to `nearest`." }, { "name": "reproject", "in": "query", "required": false, "schema": { "anyOf": [ { "enum": [ "nearest", "bilinear", "cubic", "cubic_spline", "lanczos", "average", "mode", "max", "min", "med", "q1", "q3", "sum", "rms" ], "type": "string" }, { "type": "null" } ], "description": "WarpKernel resampling algorithm (only used when doing re-projection). Defaults to `nearest`.", "title": "Reproject" }, "description": "WarpKernel resampling algorithm (only used when doing re-projection). Defaults to `nearest`." }, { "name": "algorithm", "in": "query", "required": false, "schema": { "enum": [ "hillshade", "slope", "contours", "normalizedIndex", "terrarium", "terrainrgb", "cast", "ceil", "floor", "min", "max", "median", "mean", "std", "var", "sum", "grayscale", "bitonal" ], "type": "string", "description": "Algorithm name", "title": "Algorithm" }, "description": "Algorithm name" }, { "name": "algorithm_params", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Algorithm parameter", "title": "Algorithm Params" }, "description": "Algorithm parameter" }, { "name": "colormap_name", "in": "query", "required": false, "schema": { "enum": [ "jet_r", "haline", "gist_ncar_r", "algae", "cividis_r", "seismic_r", "pink_r", "rdylbu", "inferno_r", "deep", "rdgy_r", "tab10", "bugn_r", "ocean_r", "purples", "pastel1_r", "thermal_r", "ylorrd_r", "wistia_r", "cmrmap", "pubu", "rain", "ylgnbu", "gnuplot", "gnbu", "gist_gray_r", "greens", "purd_r", "oxy_r", "matter", "summer_r", "gnuplot_r", "gnuplot2", "solar", "jet", "ylgn_r", "dark2_r", "spring", "tab20c", "gist_stern", "bwr", "ylgn", "plasma", "pastel2", "blues_r", "rain_r", "set1", "topo_r", "gist_ncar", "turbid", "magma_r", "pastel2_r", "purd", "gnbu_r", "spring_r", "rdbu_r", "ylorbr", "twilight_shifted", "rplumbo", "winter_r", "tab20b", "ylorrd", "copper", "flag_r", "afmhot", "twilight_shifted_r", "oranges_r", "bone", "seismic", "gray_r", "tarn_r", "bwr_r", "magma", "paired_r", "dark2", "binary", "set3", "viridis_r", "spectral", "prgn", "diff", "hot", "gist_earth", "cubehelix", "dense_r", "coolwarm", "pubugn_r", "autumn_r", "gnuplot2_r", "cividis", "bugn", "deep_r", "prgn_r", "gist_rainbow", "gist_heat_r", "nipy_spectral_r", "tab20", "turbo_r", "pubugn", "set2_r", "gist_yarg_r", "spectral_r", "binary_r", "greys", "rainbow_r", "haline_r", "curl", "tab20c_r", "blues", "prism", "rdgy", "gist_gray", "set2", "cool", "afmhot_r", "bone_r", "paired", "oranges", "orrd", "puor", "autumn", "delta_r", "pubu_r", "piyg_r", "turbo", "greys_r", "accent", "turbid_r", "algae_r", "solar_r", "topo", "cool_r", "inferno", "balance", "tempo_r", "amp_r", "flag", "speed", "gist_heat", "balance_r", "viridis", "cubehelix_r", "ylorbr_r", "summer", "coolwarm_r", "diff_r", "rdylgn_r", "gist_stern_r", "plasma_r", "copper_r", "oxy", "gist_yarg", "twilight", "winter", "brbg", "reds_r", "speed_r", "rainbow", "ice", "nipy_spectral", "piyg", "gray", "reds", "terrain", "tab20_r", "wistia", "accent_r", "thermal", "ocean", "twilight_r", "hot_r", "set3_r", "hsv_r", "brg_r", "gist_rainbow_r", "phase", "bupu", "pastel1", "dense", "set1_r", "phase_r", "matter_r", "greens_r", "cfastie", "tab10_r", "rdbu", "brg", "rdpu_r", "brbg_r", "cmrmap_r", "prism_r", "purples_r", "gist_earth_r", "tempo", "schwarzwald", "rdpu", "orrd_r", "tarn", "puor_r", "bupu_r", "rdylgn", "ice_r", "pink", "terrain_r", "amp", "tab20b_r", "rdylbu_r", "hsv", "curl_r", "delta", "ylgnbu_r" ], "type": "string", "description": "Colormap name", "title": "Colormap Name" }, "description": "Colormap name" }, { "name": "colormap", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "JSON encoded custom Colormap", "title": "Colormap" }, "description": "JSON encoded custom Colormap" }, { "name": "rescale", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ], "title": "Min/Max data Rescaling", "description": "comma (',') delimited Min,Max range. Can set multiple time for multiple bands.", "examples": [ "0,2000", "0,1000", "0,10000" ] }, "description": "comma (',') delimited Min,Max range. Can set multiple time for multiple bands." }, { "name": "color_formula", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Color Formula", "description": "rio-color formula (info: https://github.com/mapbox/rio-color)" }, "description": "rio-color formula (info: https://github.com/mapbox/rio-color)" }, { "name": "return_mask", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "Add mask to the output data. Defaults to `True`", "title": "Return Mask" }, "description": "Add mask to the output data. Defaults to `True`" } ], "responses": { "200": { "description": "Successful Response", "content": { "text/html": { "schema": { "type": "string" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/cog/{tileMatrixSetId}/tilejson.json": { "get": { "tags": [ "Cloud Optimized GeoTIFF" ], "summary": "Tilejson", "description": "Return TileJSON document for a dataset.", "operationId": ".cog.getTileJSON", "parameters": [ { "name": "tileMatrixSetId", "in": "path", "required": true, "schema": { "enum": [ "CDB1GlobalGrid", "CanadianNAD83_LCC", "EuropeanETRS89_LAEAQuad", "GNOSISGlobalGrid", "LINZAntarticaMapTilegrid", "NZTM2000Quad", "UPSAntarcticWGS84Quad", "UPSArcticWGS84Quad", "UTM31WGS84Quad", "WGS1984Quad", "WebMercatorQuad", "WorldCRS84Quad", "WorldMercatorWGS84Quad" ], "type": "string", "description": "Identifier selecting one of the TileMatrixSetId supported.", "title": "Tilematrixsetid" }, "description": "Identifier selecting one of the TileMatrixSetId supported." }, { "name": "tilesize", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "integer", "exclusiveMinimum": 0 }, { "type": "null" } ], "description": "Tilesize in pixels. Default to 512.", "default": 512, "title": "Tilesize" }, "description": "Tilesize in pixels. Default to 512." }, { "name": "tile_format", "in": "query", "required": false, "schema": { "anyOf": [ { "$ref": "#/components/schemas/ImageType" }, { "type": "null" } ], "description": "Default will be automatically defined if the output image needs a mask (png) or not (jpeg).", "title": "Tile Format" }, "description": "Default will be automatically defined if the output image needs a mask (png) or not (jpeg)." }, { "name": "minzoom", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "Overwrite default minzoom.", "title": "Minzoom" }, "description": "Overwrite default minzoom." }, { "name": "maxzoom", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "Overwrite default maxzoom.", "title": "Maxzoom" }, "description": "Overwrite default maxzoom." }, { "name": "url", "in": "query", "required": true, "schema": { "type": "string", "description": "Dataset URL", "title": "Url" }, "description": "Dataset URL" }, { "name": "buffer", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "number", "exclusiveMinimum": 0 }, { "type": "null" } ], "title": "Tile buffer.", "description": "Buffer on each side of the given tile. It must be a multiple of `0.5`. Output **tilesize** will be expanded to `tilesize + 2 * buffer` (e.g 0.5 = 257x257, 1.0 = 258x258)." }, "description": "Buffer on each side of the given tile. It must be a multiple of `0.5`. Output **tilesize** will be expanded to `tilesize + 2 * buffer` (e.g 0.5 = 257x257, 1.0 = 258x258)." }, { "name": "padding", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "integer", "exclusiveMinimum": 0 }, { "type": "null" } ], "title": "Tile padding.", "description": "Padding to apply to each tile edge. Helps reduce resampling artefacts along edges. Defaults to `0`." }, "description": "Padding to apply to each tile edge. Helps reduce resampling artefacts along edges. Defaults to `0`." }, { "name": "bidx", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "array", "items": { "type": "integer" } }, { "type": "null" } ], "title": "Band indexes", "description": "Dataset band indexes" }, "description": "Dataset band indexes", "examples": { "user-provided": {}, "one-band": { "value": [ 1 ] }, "multi-bands": { "value": [ 1, 2, 3 ] } } }, { "name": "expression", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Band Math expression", "description": "rio-tiler's band math expression" }, "description": "rio-tiler's band math expression", "examples": { "user-provided": {}, "simple": { "description": "Simple band math.", "value": "b1/b2" }, "multi-bands": { "description": "Semicolon (;) delimited expressions (band1: b1/b2, band2: b2+b3).", "value": "b1/b2;b2+b3" } } }, { "name": "nodata", "in": "query", "required": false, "schema": { "anyOf": [ { "enum": [ "nan", "inf", "-inf" ], "type": "string" }, { "type": "integer" }, { "type": "number" }, { "type": "null" } ], "title": "Nodata value", "description": "Overwrite internal Nodata value; nan or valid float values only." }, "description": "Overwrite internal Nodata value; nan or valid float values only." }, { "name": "unscale", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Apply internal Scale/Offset", "description": "Apply internal Scale/Offset. Defaults to `False`." }, "description": "Apply internal Scale/Offset. Defaults to `False`." }, { "name": "resampling", "in": "query", "required": false, "schema": { "anyOf": [ { "enum": [ "nearest", "bilinear", "cubic", "cubic_spline", "lanczos", "average", "mode", "gauss", "rms" ], "type": "string" }, { "type": "null" } ], "description": "RasterIO resampling algorithm. Defaults to `nearest`.", "title": "Resampling" }, "description": "RasterIO resampling algorithm. Defaults to `nearest`." }, { "name": "reproject", "in": "query", "required": false, "schema": { "anyOf": [ { "enum": [ "nearest", "bilinear", "cubic", "cubic_spline", "lanczos", "average", "mode", "max", "min", "med", "q1", "q3", "sum", "rms" ], "type": "string" }, { "type": "null" } ], "description": "WarpKernel resampling algorithm (only used when doing re-projection). Defaults to `nearest`.", "title": "Reproject" }, "description": "WarpKernel resampling algorithm (only used when doing re-projection). Defaults to `nearest`." }, { "name": "algorithm", "in": "query", "required": false, "schema": { "enum": [ "hillshade", "slope", "contours", "normalizedIndex", "terrarium", "terrainrgb", "cast", "ceil", "floor", "min", "max", "median", "mean", "std", "var", "sum", "grayscale", "bitonal" ], "type": "string", "description": "Algorithm name", "title": "Algorithm" }, "description": "Algorithm name" }, { "name": "algorithm_params", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Algorithm parameter", "title": "Algorithm Params" }, "description": "Algorithm parameter" }, { "name": "colormap_name", "in": "query", "required": false, "schema": { "enum": [ "jet_r", "haline", "gist_ncar_r", "algae", "cividis_r", "seismic_r", "pink_r", "rdylbu", "inferno_r", "deep", "rdgy_r", "tab10", "bugn_r", "ocean_r", "purples", "pastel1_r", "thermal_r", "ylorrd_r", "wistia_r", "cmrmap", "pubu", "rain", "ylgnbu", "gnuplot", "gnbu", "gist_gray_r", "greens", "purd_r", "oxy_r", "matter", "summer_r", "gnuplot_r", "gnuplot2", "solar", "jet", "ylgn_r", "dark2_r", "spring", "tab20c", "gist_stern", "bwr", "ylgn", "plasma", "pastel2", "blues_r", "rain_r", "set1", "topo_r", "gist_ncar", "turbid", "magma_r", "pastel2_r", "purd", "gnbu_r", "spring_r", "rdbu_r", "ylorbr", "twilight_shifted", "rplumbo", "winter_r", "tab20b", "ylorrd", "copper", "flag_r", "afmhot", "twilight_shifted_r", "oranges_r", "bone", "seismic", "gray_r", "tarn_r", "bwr_r", "magma", "paired_r", "dark2", "binary", "set3", "viridis_r", "spectral", "prgn", "diff", "hot", "gist_earth", "cubehelix", "dense_r", "coolwarm", "pubugn_r", "autumn_r", "gnuplot2_r", "cividis", "bugn", "deep_r", "prgn_r", "gist_rainbow", "gist_heat_r", "nipy_spectral_r", "tab20", "turbo_r", "pubugn", "set2_r", "gist_yarg_r", "spectral_r", "binary_r", "greys", "rainbow_r", "haline_r", "curl", "tab20c_r", "blues", "prism", "rdgy", "gist_gray", "set2", "cool", "afmhot_r", "bone_r", "paired", "oranges", "orrd", "puor", "autumn", "delta_r", "pubu_r", "piyg_r", "turbo", "greys_r", "accent", "turbid_r", "algae_r", "solar_r", "topo", "cool_r", "inferno", "balance", "tempo_r", "amp_r", "flag", "speed", "gist_heat", "balance_r", "viridis", "cubehelix_r", "ylorbr_r", "summer", "coolwarm_r", "diff_r", "rdylgn_r", "gist_stern_r", "plasma_r", "copper_r", "oxy", "gist_yarg", "twilight", "winter", "brbg", "reds_r", "speed_r", "rainbow", "ice", "nipy_spectral", "piyg", "gray", "reds", "terrain", "tab20_r", "wistia", "accent_r", "thermal", "ocean", "twilight_r", "hot_r", "set3_r", "hsv_r", "brg_r", "gist_rainbow_r", "phase", "bupu", "pastel1", "dense", "set1_r", "phase_r", "matter_r", "greens_r", "cfastie", "tab10_r", "rdbu", "brg", "rdpu_r", "brbg_r", "cmrmap_r", "prism_r", "purples_r", "gist_earth_r", "tempo", "schwarzwald", "rdpu", "orrd_r", "tarn", "puor_r", "bupu_r", "rdylgn", "ice_r", "pink", "terrain_r", "amp", "tab20b_r", "rdylbu_r", "hsv", "curl_r", "delta", "ylgnbu_r" ], "type": "string", "description": "Colormap name", "title": "Colormap Name" }, "description": "Colormap name" }, { "name": "colormap", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "JSON encoded custom Colormap", "title": "Colormap" }, "description": "JSON encoded custom Colormap" }, { "name": "rescale", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ], "title": "Min/Max data Rescaling", "description": "comma (',') delimited Min,Max range. Can set multiple time for multiple bands.", "examples": [ "0,2000", "0,1000", "0,10000" ] }, "description": "comma (',') delimited Min,Max range. Can set multiple time for multiple bands." }, { "name": "color_formula", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Color Formula", "description": "rio-color formula (info: https://github.com/mapbox/rio-color)" }, "description": "rio-color formula (info: https://github.com/mapbox/rio-color)" }, { "name": "return_mask", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "Add mask to the output data. Defaults to `True`", "title": "Return Mask" }, "description": "Add mask to the output data. Defaults to `True`" } ], "responses": { "200": { "description": "Return a tilejson", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TileJSON" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/cog/point/{lon},{lat}": { "get": { "tags": [ "Cloud Optimized GeoTIFF" ], "summary": "Point", "description": "Get Point value for a dataset.", "operationId": ".cog.getDataForPoint", "parameters": [ { "name": "lon", "in": "path", "required": true, "schema": { "type": "number", "description": "Longitude", "title": "Lon" }, "description": "Longitude" }, { "name": "lat", "in": "path", "required": true, "schema": { "type": "number", "description": "Latitude", "title": "Lat" }, "description": "Latitude" }, { "name": "url", "in": "query", "required": true, "schema": { "type": "string", "description": "Dataset URL", "title": "Url" }, "description": "Dataset URL" }, { "name": "coord_crs", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Coordinate Reference System of the input coords. Default to `epsg:4326`.", "title": "Coord Crs" }, "description": "Coordinate Reference System of the input coords. Default to `epsg:4326`." }, { "name": "bidx", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "array", "items": { "type": "integer" } }, { "type": "null" } ], "title": "Band indexes", "description": "Dataset band indexes" }, "description": "Dataset band indexes", "examples": { "user-provided": {}, "one-band": { "value": [ 1 ] }, "multi-bands": { "value": [ 1, 2, 3 ] } } }, { "name": "expression", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Band Math expression", "description": "rio-tiler's band math expression" }, "description": "rio-tiler's band math expression", "examples": { "user-provided": {}, "simple": { "description": "Simple band math.", "value": "b1/b2" }, "multi-bands": { "description": "Semicolon (;) delimited expressions (band1: b1/b2, band2: b2+b3).", "value": "b1/b2;b2+b3" } } }, { "name": "nodata", "in": "query", "required": false, "schema": { "anyOf": [ { "enum": [ "nan", "inf", "-inf" ], "type": "string" }, { "type": "integer" }, { "type": "number" }, { "type": "null" } ], "title": "Nodata value", "description": "Overwrite internal Nodata value; nan or valid float values only." }, "description": "Overwrite internal Nodata value; nan or valid float values only." }, { "name": "unscale", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Apply internal Scale/Offset", "description": "Apply internal Scale/Offset. Defaults to `False`." }, "description": "Apply internal Scale/Offset. Defaults to `False`." }, { "name": "resampling", "in": "query", "required": false, "schema": { "anyOf": [ { "enum": [ "nearest", "bilinear", "cubic", "cubic_spline", "lanczos", "average", "mode", "gauss", "rms" ], "type": "string" }, { "type": "null" } ], "description": "RasterIO resampling algorithm. Defaults to `nearest`.", "title": "Resampling" }, "description": "RasterIO resampling algorithm. Defaults to `nearest`." }, { "name": "reproject", "in": "query", "required": false, "schema": { "anyOf": [ { "enum": [ "nearest", "bilinear", "cubic", "cubic_spline", "lanczos", "average", "mode", "max", "min", "med", "q1", "q3", "sum", "rms" ], "type": "string" }, { "type": "null" } ], "description": "WarpKernel resampling algorithm (only used when doing re-projection). Defaults to `nearest`.", "title": "Reproject" }, "description": "WarpKernel resampling algorithm (only used when doing re-projection). Defaults to `nearest`." } ], "responses": { "200": { "description": "Return a value for a point", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/titiler__core__models__responses__Point" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/cog/preview/{width}x{height}.{format}": { "get": { "tags": [ "Cloud Optimized GeoTIFF" ], "summary": "Preview", "description": "Create preview of a dataset.", "operationId": ".cog.getPreviewWithSizeAndFormat", "parameters": [ { "name": "format", "in": "path", "required": true, "schema": { "anyOf": [ { "$ref": "#/components/schemas/ImageType" }, { "type": "null" } ], "description": "Default will be automatically defined if the output image needs a mask (png) or not (jpeg).", "title": "Format" } }, { "name": "height", "in": "path", "required": true, "schema": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "Force output image height.", "title": "Height" } }, { "name": "width", "in": "path", "required": true, "schema": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "Force output image width.", "title": "Width" } }, { "name": "url", "in": "query", "required": true, "schema": { "type": "string", "description": "Dataset URL", "title": "Url" }, "description": "Dataset URL" }, { "name": "bidx", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "array", "items": { "type": "integer" } }, { "type": "null" } ], "title": "Band indexes", "description": "Dataset band indexes" }, "description": "Dataset band indexes", "examples": { "user-provided": {}, "one-band": { "value": [ 1 ] }, "multi-bands": { "value": [ 1, 2, 3 ] } } }, { "name": "expression", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Band Math expression", "description": "rio-tiler's band math expression" }, "description": "rio-tiler's band math expression", "examples": { "user-provided": {}, "simple": { "description": "Simple band math.", "value": "b1/b2" }, "multi-bands": { "description": "Semicolon (;) delimited expressions (band1: b1/b2, band2: b2+b3).", "value": "b1/b2;b2+b3" } } }, { "name": "nodata", "in": "query", "required": false, "schema": { "anyOf": [ { "enum": [ "nan", "inf", "-inf" ], "type": "string" }, { "type": "integer" }, { "type": "number" }, { "type": "null" } ], "title": "Nodata value", "description": "Overwrite internal Nodata value; nan or valid float values only." }, "description": "Overwrite internal Nodata value; nan or valid float values only." }, { "name": "unscale", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Apply internal Scale/Offset", "description": "Apply internal Scale/Offset. Defaults to `False`." }, "description": "Apply internal Scale/Offset. Defaults to `False`." }, { "name": "resampling", "in": "query", "required": false, "schema": { "anyOf": [ { "enum": [ "nearest", "bilinear", "cubic", "cubic_spline", "lanczos", "average", "mode", "gauss", "rms" ], "type": "string" }, { "type": "null" } ], "description": "RasterIO resampling algorithm. Defaults to `nearest`.", "title": "Resampling" }, "description": "RasterIO resampling algorithm. Defaults to `nearest`." }, { "name": "reproject", "in": "query", "required": false, "schema": { "anyOf": [ { "enum": [ "nearest", "bilinear", "cubic", "cubic_spline", "lanczos", "average", "mode", "max", "min", "med", "q1", "q3", "sum", "rms" ], "type": "string" }, { "type": "null" } ], "description": "WarpKernel resampling algorithm (only used when doing re-projection). Defaults to `nearest`.", "title": "Reproject" }, "description": "WarpKernel resampling algorithm (only used when doing re-projection). Defaults to `nearest`." }, { "name": "max_size", "in": "query", "required": false, "schema": { "type": "integer", "description": "Maximum image size to read onto.", "default": 1024, "title": "Max Size" } }, { "name": "dst_crs", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Output Coordinate Reference System.", "title": "Dst Crs" }, "description": "Output Coordinate Reference System." }, { "name": "algorithm", "in": "query", "required": false, "schema": { "enum": [ "hillshade", "slope", "contours", "normalizedIndex", "terrarium", "terrainrgb", "cast", "ceil", "floor", "min", "max", "median", "mean", "std", "var", "sum", "grayscale", "bitonal" ], "type": "string", "description": "Algorithm name", "title": "Algorithm" }, "description": "Algorithm name" }, { "name": "algorithm_params", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Algorithm parameter", "title": "Algorithm Params" }, "description": "Algorithm parameter" }, { "name": "colormap_name", "in": "query", "required": false, "schema": { "enum": [ "jet_r", "haline", "gist_ncar_r", "algae", "cividis_r", "seismic_r", "pink_r", "rdylbu", "inferno_r", "deep", "rdgy_r", "tab10", "bugn_r", "ocean_r", "purples", "pastel1_r", "thermal_r", "ylorrd_r", "wistia_r", "cmrmap", "pubu", "rain", "ylgnbu", "gnuplot", "gnbu", "gist_gray_r", "greens", "purd_r", "oxy_r", "matter", "summer_r", "gnuplot_r", "gnuplot2", "solar", "jet", "ylgn_r", "dark2_r", "spring", "tab20c", "gist_stern", "bwr", "ylgn", "plasma", "pastel2", "blues_r", "rain_r", "set1", "topo_r", "gist_ncar", "turbid", "magma_r", "pastel2_r", "purd", "gnbu_r", "spring_r", "rdbu_r", "ylorbr", "twilight_shifted", "rplumbo", "winter_r", "tab20b", "ylorrd", "copper", "flag_r", "afmhot", "twilight_shifted_r", "oranges_r", "bone", "seismic", "gray_r", "tarn_r", "bwr_r", "magma", "paired_r", "dark2", "binary", "set3", "viridis_r", "spectral", "prgn", "diff", "hot", "gist_earth", "cubehelix", "dense_r", "coolwarm", "pubugn_r", "autumn_r", "gnuplot2_r", "cividis", "bugn", "deep_r", "prgn_r", "gist_rainbow", "gist_heat_r", "nipy_spectral_r", "tab20", "turbo_r", "pubugn", "set2_r", "gist_yarg_r", "spectral_r", "binary_r", "greys", "rainbow_r", "haline_r", "curl", "tab20c_r", "blues", "prism", "rdgy", "gist_gray", "set2", "cool", "afmhot_r", "bone_r", "paired", "oranges", "orrd", "puor", "autumn", "delta_r", "pubu_r", "piyg_r", "turbo", "greys_r", "accent", "turbid_r", "algae_r", "solar_r", "topo", "cool_r", "inferno", "balance", "tempo_r", "amp_r", "flag", "speed", "gist_heat", "balance_r", "viridis", "cubehelix_r", "ylorbr_r", "summer", "coolwarm_r", "diff_r", "rdylgn_r", "gist_stern_r", "plasma_r", "copper_r", "oxy", "gist_yarg", "twilight", "winter", "brbg", "reds_r", "speed_r", "rainbow", "ice", "nipy_spectral", "piyg", "gray", "reds", "terrain", "tab20_r", "wistia", "accent_r", "thermal", "ocean", "twilight_r", "hot_r", "set3_r", "hsv_r", "brg_r", "gist_rainbow_r", "phase", "bupu", "pastel1", "dense", "set1_r", "phase_r", "matter_r", "greens_r", "cfastie", "tab10_r", "rdbu", "brg", "rdpu_r", "brbg_r", "cmrmap_r", "prism_r", "purples_r", "gist_earth_r", "tempo", "schwarzwald", "rdpu", "orrd_r", "tarn", "puor_r", "bupu_r", "rdylgn", "ice_r", "pink", "terrain_r", "amp", "tab20b_r", "rdylbu_r", "hsv", "curl_r", "delta", "ylgnbu_r" ], "type": "string", "description": "Colormap name", "title": "Colormap Name" }, "description": "Colormap name" }, { "name": "colormap", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "JSON encoded custom Colormap", "title": "Colormap" }, "description": "JSON encoded custom Colormap" }, { "name": "rescale", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ], "title": "Min/Max data Rescaling", "description": "comma (',') delimited Min,Max range. Can set multiple time for multiple bands.", "examples": [ "0,2000", "0,1000", "0,10000" ] }, "description": "comma (',') delimited Min,Max range. Can set multiple time for multiple bands." }, { "name": "color_formula", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Color Formula", "description": "rio-color formula (info: https://github.com/mapbox/rio-color)" }, "description": "rio-color formula (info: https://github.com/mapbox/rio-color)" }, { "name": "return_mask", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "Add mask to the output data. Defaults to `True`", "title": "Return Mask" }, "description": "Add mask to the output data. Defaults to `True`" } ], "responses": { "200": { "description": "Return an image.", "content": { "image/png": {}, "image/jpeg": {}, "image/jpg": {}, "image/webp": {}, "image/jp2": {}, "image/tiff; application=geotiff": {}, "application/x-binary": {} } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/cog/preview.{format}": { "get": { "tags": [ "Cloud Optimized GeoTIFF" ], "summary": "Preview", "description": "Create preview of a dataset.", "operationId": ".cog.getPreviewWithFormat", "parameters": [ { "name": "format", "in": "path", "required": true, "schema": { "anyOf": [ { "$ref": "#/components/schemas/ImageType" }, { "type": "null" } ], "description": "Default will be automatically defined if the output image needs a mask (png) or not (jpeg).", "title": "Format" } }, { "name": "url", "in": "query", "required": true, "schema": { "type": "string", "description": "Dataset URL", "title": "Url" }, "description": "Dataset URL" }, { "name": "bidx", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "array", "items": { "type": "integer" } }, { "type": "null" } ], "title": "Band indexes", "description": "Dataset band indexes" }, "description": "Dataset band indexes", "examples": { "user-provided": {}, "one-band": { "value": [ 1 ] }, "multi-bands": { "value": [ 1, 2, 3 ] } } }, { "name": "expression", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Band Math expression", "description": "rio-tiler's band math expression" }, "description": "rio-tiler's band math expression", "examples": { "user-provided": {}, "simple": { "description": "Simple band math.", "value": "b1/b2" }, "multi-bands": { "description": "Semicolon (;) delimited expressions (band1: b1/b2, band2: b2+b3).", "value": "b1/b2;b2+b3" } } }, { "name": "nodata", "in": "query", "required": false, "schema": { "anyOf": [ { "enum": [ "nan", "inf", "-inf" ], "type": "string" }, { "type": "integer" }, { "type": "number" }, { "type": "null" } ], "title": "Nodata value", "description": "Overwrite internal Nodata value; nan or valid float values only." }, "description": "Overwrite internal Nodata value; nan or valid float values only." }, { "name": "unscale", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Apply internal Scale/Offset", "description": "Apply internal Scale/Offset. Defaults to `False`." }, "description": "Apply internal Scale/Offset. Defaults to `False`." }, { "name": "resampling", "in": "query", "required": false, "schema": { "anyOf": [ { "enum": [ "nearest", "bilinear", "cubic", "cubic_spline", "lanczos", "average", "mode", "gauss", "rms" ], "type": "string" }, { "type": "null" } ], "description": "RasterIO resampling algorithm. Defaults to `nearest`.", "title": "Resampling" }, "description": "RasterIO resampling algorithm. Defaults to `nearest`." }, { "name": "reproject", "in": "query", "required": false, "schema": { "anyOf": [ { "enum": [ "nearest", "bilinear", "cubic", "cubic_spline", "lanczos", "average", "mode", "max", "min", "med", "q1", "q3", "sum", "rms" ], "type": "string" }, { "type": "null" } ], "description": "WarpKernel resampling algorithm (only used when doing re-projection). Defaults to `nearest`.", "title": "Reproject" }, "description": "WarpKernel resampling algorithm (only used when doing re-projection). Defaults to `nearest`." }, { "name": "max_size", "in": "query", "required": false, "schema": { "type": "integer", "description": "Maximum image size to read onto.", "default": 1024, "title": "Max Size" } }, { "name": "height", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "Force output image height.", "title": "Height" } }, { "name": "width", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "Force output image width.", "title": "Width" } }, { "name": "dst_crs", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Output Coordinate Reference System.", "title": "Dst Crs" }, "description": "Output Coordinate Reference System." }, { "name": "algorithm", "in": "query", "required": false, "schema": { "enum": [ "hillshade", "slope", "contours", "normalizedIndex", "terrarium", "terrainrgb", "cast", "ceil", "floor", "min", "max", "median", "mean", "std", "var", "sum", "grayscale", "bitonal" ], "type": "string", "description": "Algorithm name", "title": "Algorithm" }, "description": "Algorithm name" }, { "name": "algorithm_params", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Algorithm parameter", "title": "Algorithm Params" }, "description": "Algorithm parameter" }, { "name": "colormap_name", "in": "query", "required": false, "schema": { "enum": [ "jet_r", "haline", "gist_ncar_r", "algae", "cividis_r", "seismic_r", "pink_r", "rdylbu", "inferno_r", "deep", "rdgy_r", "tab10", "bugn_r", "ocean_r", "purples", "pastel1_r", "thermal_r", "ylorrd_r", "wistia_r", "cmrmap", "pubu", "rain", "ylgnbu", "gnuplot", "gnbu", "gist_gray_r", "greens", "purd_r", "oxy_r", "matter", "summer_r", "gnuplot_r", "gnuplot2", "solar", "jet", "ylgn_r", "dark2_r", "spring", "tab20c", "gist_stern", "bwr", "ylgn", "plasma", "pastel2", "blues_r", "rain_r", "set1", "topo_r", "gist_ncar", "turbid", "magma_r", "pastel2_r", "purd", "gnbu_r", "spring_r", "rdbu_r", "ylorbr", "twilight_shifted", "rplumbo", "winter_r", "tab20b", "ylorrd", "copper", "flag_r", "afmhot", "twilight_shifted_r", "oranges_r", "bone", "seismic", "gray_r", "tarn_r", "bwr_r", "magma", "paired_r", "dark2", "binary", "set3", "viridis_r", "spectral", "prgn", "diff", "hot", "gist_earth", "cubehelix", "dense_r", "coolwarm", "pubugn_r", "autumn_r", "gnuplot2_r", "cividis", "bugn", "deep_r", "prgn_r", "gist_rainbow", "gist_heat_r", "nipy_spectral_r", "tab20", "turbo_r", "pubugn", "set2_r", "gist_yarg_r", "spectral_r", "binary_r", "greys", "rainbow_r", "haline_r", "curl", "tab20c_r", "blues", "prism", "rdgy", "gist_gray", "set2", "cool", "afmhot_r", "bone_r", "paired", "oranges", "orrd", "puor", "autumn", "delta_r", "pubu_r", "piyg_r", "turbo", "greys_r", "accent", "turbid_r", "algae_r", "solar_r", "topo", "cool_r", "inferno", "balance", "tempo_r", "amp_r", "flag", "speed", "gist_heat", "balance_r", "viridis", "cubehelix_r", "ylorbr_r", "summer", "coolwarm_r", "diff_r", "rdylgn_r", "gist_stern_r", "plasma_r", "copper_r", "oxy", "gist_yarg", "twilight", "winter", "brbg", "reds_r", "speed_r", "rainbow", "ice", "nipy_spectral", "piyg", "gray", "reds", "terrain", "tab20_r", "wistia", "accent_r", "thermal", "ocean", "twilight_r", "hot_r", "set3_r", "hsv_r", "brg_r", "gist_rainbow_r", "phase", "bupu", "pastel1", "dense", "set1_r", "phase_r", "matter_r", "greens_r", "cfastie", "tab10_r", "rdbu", "brg", "rdpu_r", "brbg_r", "cmrmap_r", "prism_r", "purples_r", "gist_earth_r", "tempo", "schwarzwald", "rdpu", "orrd_r", "tarn", "puor_r", "bupu_r", "rdylgn", "ice_r", "pink", "terrain_r", "amp", "tab20b_r", "rdylbu_r", "hsv", "curl_r", "delta", "ylgnbu_r" ], "type": "string", "description": "Colormap name", "title": "Colormap Name" }, "description": "Colormap name" }, { "name": "colormap", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "JSON encoded custom Colormap", "title": "Colormap" }, "description": "JSON encoded custom Colormap" }, { "name": "rescale", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ], "title": "Min/Max data Rescaling", "description": "comma (',') delimited Min,Max range. Can set multiple time for multiple bands.", "examples": [ "0,2000", "0,1000", "0,10000" ] }, "description": "comma (',') delimited Min,Max range. Can set multiple time for multiple bands." }, { "name": "color_formula", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Color Formula", "description": "rio-color formula (info: https://github.com/mapbox/rio-color)" }, "description": "rio-color formula (info: https://github.com/mapbox/rio-color)" }, { "name": "return_mask", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "Add mask to the output data. Defaults to `True`", "title": "Return Mask" }, "description": "Add mask to the output data. Defaults to `True`" } ], "responses": { "200": { "description": "Return an image.", "content": { "image/png": {}, "image/jpeg": {}, "image/jpg": {}, "image/webp": {}, "image/jp2": {}, "image/tiff; application=geotiff": {}, "application/x-binary": {} } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/cog/preview": { "get": { "tags": [ "Cloud Optimized GeoTIFF" ], "summary": "Preview", "description": "Create preview of a dataset.", "operationId": ".cog.getPreview", "parameters": [ { "name": "format", "in": "query", "required": false, "schema": { "anyOf": [ { "$ref": "#/components/schemas/ImageType" }, { "type": "null" } ], "description": "Default will be automatically defined if the output image needs a mask (png) or not (jpeg).", "title": "Format" } }, { "name": "url", "in": "query", "required": true, "schema": { "type": "string", "description": "Dataset URL", "title": "Url" }, "description": "Dataset URL" }, { "name": "bidx", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "array", "items": { "type": "integer" } }, { "type": "null" } ], "title": "Band indexes", "description": "Dataset band indexes" }, "description": "Dataset band indexes", "examples": { "user-provided": {}, "one-band": { "value": [ 1 ] }, "multi-bands": { "value": [ 1, 2, 3 ] } } }, { "name": "expression", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Band Math expression", "description": "rio-tiler's band math expression" }, "description": "rio-tiler's band math expression", "examples": { "user-provided": {}, "simple": { "description": "Simple band math.", "value": "b1/b2" }, "multi-bands": { "description": "Semicolon (;) delimited expressions (band1: b1/b2, band2: b2+b3).", "value": "b1/b2;b2+b3" } } }, { "name": "nodata", "in": "query", "required": false, "schema": { "anyOf": [ { "enum": [ "nan", "inf", "-inf" ], "type": "string" }, { "type": "integer" }, { "type": "number" }, { "type": "null" } ], "title": "Nodata value", "description": "Overwrite internal Nodata value; nan or valid float values only." }, "description": "Overwrite internal Nodata value; nan or valid float values only." }, { "name": "unscale", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Apply internal Scale/Offset", "description": "Apply internal Scale/Offset. Defaults to `False`." }, "description": "Apply internal Scale/Offset. Defaults to `False`." }, { "name": "resampling", "in": "query", "required": false, "schema": { "anyOf": [ { "enum": [ "nearest", "bilinear", "cubic", "cubic_spline", "lanczos", "average", "mode", "gauss", "rms" ], "type": "string" }, { "type": "null" } ], "description": "RasterIO resampling algorithm. Defaults to `nearest`.", "title": "Resampling" }, "description": "RasterIO resampling algorithm. Defaults to `nearest`." }, { "name": "reproject", "in": "query", "required": false, "schema": { "anyOf": [ { "enum": [ "nearest", "bilinear", "cubic", "cubic_spline", "lanczos", "average", "mode", "max", "min", "med", "q1", "q3", "sum", "rms" ], "type": "string" }, { "type": "null" } ], "description": "WarpKernel resampling algorithm (only used when doing re-projection). Defaults to `nearest`.", "title": "Reproject" }, "description": "WarpKernel resampling algorithm (only used when doing re-projection). Defaults to `nearest`." }, { "name": "max_size", "in": "query", "required": false, "schema": { "type": "integer", "description": "Maximum image size to read onto.", "default": 1024, "title": "Max Size" } }, { "name": "height", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "Force output image height.", "title": "Height" } }, { "name": "width", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "Force output image width.", "title": "Width" } }, { "name": "dst_crs", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Output Coordinate Reference System.", "title": "Dst Crs" }, "description": "Output Coordinate Reference System." }, { "name": "algorithm", "in": "query", "required": false, "schema": { "enum": [ "hillshade", "slope", "contours", "normalizedIndex", "terrarium", "terrainrgb", "cast", "ceil", "floor", "min", "max", "median", "mean", "std", "var", "sum", "grayscale", "bitonal" ], "type": "string", "description": "Algorithm name", "title": "Algorithm" }, "description": "Algorithm name" }, { "name": "algorithm_params", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Algorithm parameter", "title": "Algorithm Params" }, "description": "Algorithm parameter" }, { "name": "colormap_name", "in": "query", "required": false, "schema": { "enum": [ "jet_r", "haline", "gist_ncar_r", "algae", "cividis_r", "seismic_r", "pink_r", "rdylbu", "inferno_r", "deep", "rdgy_r", "tab10", "bugn_r", "ocean_r", "purples", "pastel1_r", "thermal_r", "ylorrd_r", "wistia_r", "cmrmap", "pubu", "rain", "ylgnbu", "gnuplot", "gnbu", "gist_gray_r", "greens", "purd_r", "oxy_r", "matter", "summer_r", "gnuplot_r", "gnuplot2", "solar", "jet", "ylgn_r", "dark2_r", "spring", "tab20c", "gist_stern", "bwr", "ylgn", "plasma", "pastel2", "blues_r", "rain_r", "set1", "topo_r", "gist_ncar", "turbid", "magma_r", "pastel2_r", "purd", "gnbu_r", "spring_r", "rdbu_r", "ylorbr", "twilight_shifted", "rplumbo", "winter_r", "tab20b", "ylorrd", "copper", "flag_r", "afmhot", "twilight_shifted_r", "oranges_r", "bone", "seismic", "gray_r", "tarn_r", "bwr_r", "magma", "paired_r", "dark2", "binary", "set3", "viridis_r", "spectral", "prgn", "diff", "hot", "gist_earth", "cubehelix", "dense_r", "coolwarm", "pubugn_r", "autumn_r", "gnuplot2_r", "cividis", "bugn", "deep_r", "prgn_r", "gist_rainbow", "gist_heat_r", "nipy_spectral_r", "tab20", "turbo_r", "pubugn", "set2_r", "gist_yarg_r", "spectral_r", "binary_r", "greys", "rainbow_r", "haline_r", "curl", "tab20c_r", "blues", "prism", "rdgy", "gist_gray", "set2", "cool", "afmhot_r", "bone_r", "paired", "oranges", "orrd", "puor", "autumn", "delta_r", "pubu_r", "piyg_r", "turbo", "greys_r", "accent", "turbid_r", "algae_r", "solar_r", "topo", "cool_r", "inferno", "balance", "tempo_r", "amp_r", "flag", "speed", "gist_heat", "balance_r", "viridis", "cubehelix_r", "ylorbr_r", "summer", "coolwarm_r", "diff_r", "rdylgn_r", "gist_stern_r", "plasma_r", "copper_r", "oxy", "gist_yarg", "twilight", "winter", "brbg", "reds_r", "speed_r", "rainbow", "ice", "nipy_spectral", "piyg", "gray", "reds", "terrain", "tab20_r", "wistia", "accent_r", "thermal", "ocean", "twilight_r", "hot_r", "set3_r", "hsv_r", "brg_r", "gist_rainbow_r", "phase", "bupu", "pastel1", "dense", "set1_r", "phase_r", "matter_r", "greens_r", "cfastie", "tab10_r", "rdbu", "brg", "rdpu_r", "brbg_r", "cmrmap_r", "prism_r", "purples_r", "gist_earth_r", "tempo", "schwarzwald", "rdpu", "orrd_r", "tarn", "puor_r", "bupu_r", "rdylgn", "ice_r", "pink", "terrain_r", "amp", "tab20b_r", "rdylbu_r", "hsv", "curl_r", "delta", "ylgnbu_r" ], "type": "string", "description": "Colormap name", "title": "Colormap Name" }, "description": "Colormap name" }, { "name": "colormap", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "JSON encoded custom Colormap", "title": "Colormap" }, "description": "JSON encoded custom Colormap" }, { "name": "rescale", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ], "title": "Min/Max data Rescaling", "description": "comma (',') delimited Min,Max range. Can set multiple time for multiple bands.", "examples": [ "0,2000", "0,1000", "0,10000" ] }, "description": "comma (',') delimited Min,Max range. Can set multiple time for multiple bands." }, { "name": "color_formula", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Color Formula", "description": "rio-color formula (info: https://github.com/mapbox/rio-color)" }, "description": "rio-color formula (info: https://github.com/mapbox/rio-color)" }, { "name": "return_mask", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "Add mask to the output data. Defaults to `True`", "title": "Return Mask" }, "description": "Add mask to the output data. Defaults to `True`" } ], "responses": { "200": { "description": "Return an image.", "content": { "image/png": {}, "image/jpeg": {}, "image/jpg": {}, "image/webp": {}, "image/jp2": {}, "image/tiff; application=geotiff": {}, "application/x-binary": {} } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/cog/bbox/{minx},{miny},{maxx},{maxy}/{width}x{height}.{format}": { "get": { "tags": [ "Cloud Optimized GeoTIFF" ], "summary": "Bbox Image", "description": "Create image from a bbox.", "operationId": ".cog.getDataForBoundingBoxWithSizesAndFormat", "parameters": [ { "name": "minx", "in": "path", "required": true, "schema": { "type": "number", "description": "Bounding box min X", "title": "Minx" }, "description": "Bounding box min X" }, { "name": "miny", "in": "path", "required": true, "schema": { "type": "number", "description": "Bounding box min Y", "title": "Miny" }, "description": "Bounding box min Y" }, { "name": "maxx", "in": "path", "required": true, "schema": { "type": "number", "description": "Bounding box max X", "title": "Maxx" }, "description": "Bounding box max X" }, { "name": "maxy", "in": "path", "required": true, "schema": { "type": "number", "description": "Bounding box max Y", "title": "Maxy" }, "description": "Bounding box max Y" }, { "name": "format", "in": "path", "required": true, "schema": { "anyOf": [ { "$ref": "#/components/schemas/ImageType" }, { "type": "null" } ], "description": "Default will be automatically defined if the output image needs a mask (png) or not (jpeg).", "title": "Format" } }, { "name": "height", "in": "path", "required": true, "schema": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "Force output image height.", "title": "Height" } }, { "name": "width", "in": "path", "required": true, "schema": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "Force output image width.", "title": "Width" } }, { "name": "url", "in": "query", "required": true, "schema": { "type": "string", "description": "Dataset URL", "title": "Url" }, "description": "Dataset URL" }, { "name": "bidx", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "array", "items": { "type": "integer" } }, { "type": "null" } ], "title": "Band indexes", "description": "Dataset band indexes" }, "description": "Dataset band indexes", "examples": { "user-provided": {}, "one-band": { "value": [ 1 ] }, "multi-bands": { "value": [ 1, 2, 3 ] } } }, { "name": "expression", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Band Math expression", "description": "rio-tiler's band math expression" }, "description": "rio-tiler's band math expression", "examples": { "user-provided": {}, "simple": { "description": "Simple band math.", "value": "b1/b2" }, "multi-bands": { "description": "Semicolon (;) delimited expressions (band1: b1/b2, band2: b2+b3).", "value": "b1/b2;b2+b3" } } }, { "name": "nodata", "in": "query", "required": false, "schema": { "anyOf": [ { "enum": [ "nan", "inf", "-inf" ], "type": "string" }, { "type": "integer" }, { "type": "number" }, { "type": "null" } ], "title": "Nodata value", "description": "Overwrite internal Nodata value; nan or valid float values only." }, "description": "Overwrite internal Nodata value; nan or valid float values only." }, { "name": "unscale", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Apply internal Scale/Offset", "description": "Apply internal Scale/Offset. Defaults to `False`." }, "description": "Apply internal Scale/Offset. Defaults to `False`." }, { "name": "resampling", "in": "query", "required": false, "schema": { "anyOf": [ { "enum": [ "nearest", "bilinear", "cubic", "cubic_spline", "lanczos", "average", "mode", "gauss", "rms" ], "type": "string" }, { "type": "null" } ], "description": "RasterIO resampling algorithm. Defaults to `nearest`.", "title": "Resampling" }, "description": "RasterIO resampling algorithm. Defaults to `nearest`." }, { "name": "reproject", "in": "query", "required": false, "schema": { "anyOf": [ { "enum": [ "nearest", "bilinear", "cubic", "cubic_spline", "lanczos", "average", "mode", "max", "min", "med", "q1", "q3", "sum", "rms" ], "type": "string" }, { "type": "null" } ], "description": "WarpKernel resampling algorithm (only used when doing re-projection). Defaults to `nearest`.", "title": "Reproject" }, "description": "WarpKernel resampling algorithm (only used when doing re-projection). Defaults to `nearest`." }, { "name": "max_size", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "Maximum image size to read onto.", "title": "Max Size" } }, { "name": "dst_crs", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Output Coordinate Reference System.", "title": "Dst Crs" }, "description": "Output Coordinate Reference System." }, { "name": "coord_crs", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Coordinate Reference System of the input coords. Default to `epsg:4326`.", "title": "Coord Crs" }, "description": "Coordinate Reference System of the input coords. Default to `epsg:4326`." }, { "name": "algorithm", "in": "query", "required": false, "schema": { "enum": [ "hillshade", "slope", "contours", "normalizedIndex", "terrarium", "terrainrgb", "cast", "ceil", "floor", "min", "max", "median", "mean", "std", "var", "sum", "grayscale", "bitonal" ], "type": "string", "description": "Algorithm name", "title": "Algorithm" }, "description": "Algorithm name" }, { "name": "algorithm_params", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Algorithm parameter", "title": "Algorithm Params" }, "description": "Algorithm parameter" }, { "name": "colormap_name", "in": "query", "required": false, "schema": { "enum": [ "jet_r", "haline", "gist_ncar_r", "algae", "cividis_r", "seismic_r", "pink_r", "rdylbu", "inferno_r", "deep", "rdgy_r", "tab10", "bugn_r", "ocean_r", "purples", "pastel1_r", "thermal_r", "ylorrd_r", "wistia_r", "cmrmap", "pubu", "rain", "ylgnbu", "gnuplot", "gnbu", "gist_gray_r", "greens", "purd_r", "oxy_r", "matter", "summer_r", "gnuplot_r", "gnuplot2", "solar", "jet", "ylgn_r", "dark2_r", "spring", "tab20c", "gist_stern", "bwr", "ylgn", "plasma", "pastel2", "blues_r", "rain_r", "set1", "topo_r", "gist_ncar", "turbid", "magma_r", "pastel2_r", "purd", "gnbu_r", "spring_r", "rdbu_r", "ylorbr", "twilight_shifted", "rplumbo", "winter_r", "tab20b", "ylorrd", "copper", "flag_r", "afmhot", "twilight_shifted_r", "oranges_r", "bone", "seismic", "gray_r", "tarn_r", "bwr_r", "magma", "paired_r", "dark2", "binary", "set3", "viridis_r", "spectral", "prgn", "diff", "hot", "gist_earth", "cubehelix", "dense_r", "coolwarm", "pubugn_r", "autumn_r", "gnuplot2_r", "cividis", "bugn", "deep_r", "prgn_r", "gist_rainbow", "gist_heat_r", "nipy_spectral_r", "tab20", "turbo_r", "pubugn", "set2_r", "gist_yarg_r", "spectral_r", "binary_r", "greys", "rainbow_r", "haline_r", "curl", "tab20c_r", "blues", "prism", "rdgy", "gist_gray", "set2", "cool", "afmhot_r", "bone_r", "paired", "oranges", "orrd", "puor", "autumn", "delta_r", "pubu_r", "piyg_r", "turbo", "greys_r", "accent", "turbid_r", "algae_r", "solar_r", "topo", "cool_r", "inferno", "balance", "tempo_r", "amp_r", "flag", "speed", "gist_heat", "balance_r", "viridis", "cubehelix_r", "ylorbr_r", "summer", "coolwarm_r", "diff_r", "rdylgn_r", "gist_stern_r", "plasma_r", "copper_r", "oxy", "gist_yarg", "twilight", "winter", "brbg", "reds_r", "speed_r", "rainbow", "ice", "nipy_spectral", "piyg", "gray", "reds", "terrain", "tab20_r", "wistia", "accent_r", "thermal", "ocean", "twilight_r", "hot_r", "set3_r", "hsv_r", "brg_r", "gist_rainbow_r", "phase", "bupu", "pastel1", "dense", "set1_r", "phase_r", "matter_r", "greens_r", "cfastie", "tab10_r", "rdbu", "brg", "rdpu_r", "brbg_r", "cmrmap_r", "prism_r", "purples_r", "gist_earth_r", "tempo", "schwarzwald", "rdpu", "orrd_r", "tarn", "puor_r", "bupu_r", "rdylgn", "ice_r", "pink", "terrain_r", "amp", "tab20b_r", "rdylbu_r", "hsv", "curl_r", "delta", "ylgnbu_r" ], "type": "string", "description": "Colormap name", "title": "Colormap Name" }, "description": "Colormap name" }, { "name": "colormap", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "JSON encoded custom Colormap", "title": "Colormap" }, "description": "JSON encoded custom Colormap" }, { "name": "rescale", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ], "title": "Min/Max data Rescaling", "description": "comma (',') delimited Min,Max range. Can set multiple time for multiple bands.", "examples": [ "0,2000", "0,1000", "0,10000" ] }, "description": "comma (',') delimited Min,Max range. Can set multiple time for multiple bands." }, { "name": "color_formula", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Color Formula", "description": "rio-color formula (info: https://github.com/mapbox/rio-color)" }, "description": "rio-color formula (info: https://github.com/mapbox/rio-color)" }, { "name": "return_mask", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "Add mask to the output data. Defaults to `True`", "title": "Return Mask" }, "description": "Add mask to the output data. Defaults to `True`" } ], "responses": { "200": { "description": "Return an image.", "content": { "image/png": {}, "image/jpeg": {}, "image/jpg": {}, "image/webp": {}, "image/jp2": {}, "image/tiff; application=geotiff": {}, "application/x-binary": {} } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/cog/bbox/{minx},{miny},{maxx},{maxy}.{format}": { "get": { "tags": [ "Cloud Optimized GeoTIFF" ], "summary": "Bbox Image", "description": "Create image from a bbox.", "operationId": ".cog.getDataForBoundingBoxWithFormat", "parameters": [ { "name": "minx", "in": "path", "required": true, "schema": { "type": "number", "description": "Bounding box min X", "title": "Minx" }, "description": "Bounding box min X" }, { "name": "miny", "in": "path", "required": true, "schema": { "type": "number", "description": "Bounding box min Y", "title": "Miny" }, "description": "Bounding box min Y" }, { "name": "maxx", "in": "path", "required": true, "schema": { "type": "number", "description": "Bounding box max X", "title": "Maxx" }, "description": "Bounding box max X" }, { "name": "maxy", "in": "path", "required": true, "schema": { "type": "number", "description": "Bounding box max Y", "title": "Maxy" }, "description": "Bounding box max Y" }, { "name": "format", "in": "path", "required": true, "schema": { "anyOf": [ { "$ref": "#/components/schemas/ImageType" }, { "type": "null" } ], "description": "Default will be automatically defined if the output image needs a mask (png) or not (jpeg).", "title": "Format" } }, { "name": "url", "in": "query", "required": true, "schema": { "type": "string", "description": "Dataset URL", "title": "Url" }, "description": "Dataset URL" }, { "name": "bidx", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "array", "items": { "type": "integer" } }, { "type": "null" } ], "title": "Band indexes", "description": "Dataset band indexes" }, "description": "Dataset band indexes", "examples": { "user-provided": {}, "one-band": { "value": [ 1 ] }, "multi-bands": { "value": [ 1, 2, 3 ] } } }, { "name": "expression", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Band Math expression", "description": "rio-tiler's band math expression" }, "description": "rio-tiler's band math expression", "examples": { "user-provided": {}, "simple": { "description": "Simple band math.", "value": "b1/b2" }, "multi-bands": { "description": "Semicolon (;) delimited expressions (band1: b1/b2, band2: b2+b3).", "value": "b1/b2;b2+b3" } } }, { "name": "nodata", "in": "query", "required": false, "schema": { "anyOf": [ { "enum": [ "nan", "inf", "-inf" ], "type": "string" }, { "type": "integer" }, { "type": "number" }, { "type": "null" } ], "title": "Nodata value", "description": "Overwrite internal Nodata value; nan or valid float values only." }, "description": "Overwrite internal Nodata value; nan or valid float values only." }, { "name": "unscale", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Apply internal Scale/Offset", "description": "Apply internal Scale/Offset. Defaults to `False`." }, "description": "Apply internal Scale/Offset. Defaults to `False`." }, { "name": "resampling", "in": "query", "required": false, "schema": { "anyOf": [ { "enum": [ "nearest", "bilinear", "cubic", "cubic_spline", "lanczos", "average", "mode", "gauss", "rms" ], "type": "string" }, { "type": "null" } ], "description": "RasterIO resampling algorithm. Defaults to `nearest`.", "title": "Resampling" }, "description": "RasterIO resampling algorithm. Defaults to `nearest`." }, { "name": "reproject", "in": "query", "required": false, "schema": { "anyOf": [ { "enum": [ "nearest", "bilinear", "cubic", "cubic_spline", "lanczos", "average", "mode", "max", "min", "med", "q1", "q3", "sum", "rms" ], "type": "string" }, { "type": "null" } ], "description": "WarpKernel resampling algorithm (only used when doing re-projection). Defaults to `nearest`.", "title": "Reproject" }, "description": "WarpKernel resampling algorithm (only used when doing re-projection). Defaults to `nearest`." }, { "name": "max_size", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "Maximum image size to read onto.", "title": "Max Size" } }, { "name": "height", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "Force output image height.", "title": "Height" } }, { "name": "width", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "Force output image width.", "title": "Width" } }, { "name": "dst_crs", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Output Coordinate Reference System.", "title": "Dst Crs" }, "description": "Output Coordinate Reference System." }, { "name": "coord_crs", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Coordinate Reference System of the input coords. Default to `epsg:4326`.", "title": "Coord Crs" }, "description": "Coordinate Reference System of the input coords. Default to `epsg:4326`." }, { "name": "algorithm", "in": "query", "required": false, "schema": { "enum": [ "hillshade", "slope", "contours", "normalizedIndex", "terrarium", "terrainrgb", "cast", "ceil", "floor", "min", "max", "median", "mean", "std", "var", "sum", "grayscale", "bitonal" ], "type": "string", "description": "Algorithm name", "title": "Algorithm" }, "description": "Algorithm name" }, { "name": "algorithm_params", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Algorithm parameter", "title": "Algorithm Params" }, "description": "Algorithm parameter" }, { "name": "colormap_name", "in": "query", "required": false, "schema": { "enum": [ "jet_r", "haline", "gist_ncar_r", "algae", "cividis_r", "seismic_r", "pink_r", "rdylbu", "inferno_r", "deep", "rdgy_r", "tab10", "bugn_r", "ocean_r", "purples", "pastel1_r", "thermal_r", "ylorrd_r", "wistia_r", "cmrmap", "pubu", "rain", "ylgnbu", "gnuplot", "gnbu", "gist_gray_r", "greens", "purd_r", "oxy_r", "matter", "summer_r", "gnuplot_r", "gnuplot2", "solar", "jet", "ylgn_r", "dark2_r", "spring", "tab20c", "gist_stern", "bwr", "ylgn", "plasma", "pastel2", "blues_r", "rain_r", "set1", "topo_r", "gist_ncar", "turbid", "magma_r", "pastel2_r", "purd", "gnbu_r", "spring_r", "rdbu_r", "ylorbr", "twilight_shifted", "rplumbo", "winter_r", "tab20b", "ylorrd", "copper", "flag_r", "afmhot", "twilight_shifted_r", "oranges_r", "bone", "seismic", "gray_r", "tarn_r", "bwr_r", "magma", "paired_r", "dark2", "binary", "set3", "viridis_r", "spectral", "prgn", "diff", "hot", "gist_earth", "cubehelix", "dense_r", "coolwarm", "pubugn_r", "autumn_r", "gnuplot2_r", "cividis", "bugn", "deep_r", "prgn_r", "gist_rainbow", "gist_heat_r", "nipy_spectral_r", "tab20", "turbo_r", "pubugn", "set2_r", "gist_yarg_r", "spectral_r", "binary_r", "greys", "rainbow_r", "haline_r", "curl", "tab20c_r", "blues", "prism", "rdgy", "gist_gray", "set2", "cool", "afmhot_r", "bone_r", "paired", "oranges", "orrd", "puor", "autumn", "delta_r", "pubu_r", "piyg_r", "turbo", "greys_r", "accent", "turbid_r", "algae_r", "solar_r", "topo", "cool_r", "inferno", "balance", "tempo_r", "amp_r", "flag", "speed", "gist_heat", "balance_r", "viridis", "cubehelix_r", "ylorbr_r", "summer", "coolwarm_r", "diff_r", "rdylgn_r", "gist_stern_r", "plasma_r", "copper_r", "oxy", "gist_yarg", "twilight", "winter", "brbg", "reds_r", "speed_r", "rainbow", "ice", "nipy_spectral", "piyg", "gray", "reds", "terrain", "tab20_r", "wistia", "accent_r", "thermal", "ocean", "twilight_r", "hot_r", "set3_r", "hsv_r", "brg_r", "gist_rainbow_r", "phase", "bupu", "pastel1", "dense", "set1_r", "phase_r", "matter_r", "greens_r", "cfastie", "tab10_r", "rdbu", "brg", "rdpu_r", "brbg_r", "cmrmap_r", "prism_r", "purples_r", "gist_earth_r", "tempo", "schwarzwald", "rdpu", "orrd_r", "tarn", "puor_r", "bupu_r", "rdylgn", "ice_r", "pink", "terrain_r", "amp", "tab20b_r", "rdylbu_r", "hsv", "curl_r", "delta", "ylgnbu_r" ], "type": "string", "description": "Colormap name", "title": "Colormap Name" }, "description": "Colormap name" }, { "name": "colormap", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "JSON encoded custom Colormap", "title": "Colormap" }, "description": "JSON encoded custom Colormap" }, { "name": "rescale", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ], "title": "Min/Max data Rescaling", "description": "comma (',') delimited Min,Max range. Can set multiple time for multiple bands.", "examples": [ "0,2000", "0,1000", "0,10000" ] }, "description": "comma (',') delimited Min,Max range. Can set multiple time for multiple bands." }, { "name": "color_formula", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Color Formula", "description": "rio-color formula (info: https://github.com/mapbox/rio-color)" }, "description": "rio-color formula (info: https://github.com/mapbox/rio-color)" }, { "name": "return_mask", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "Add mask to the output data. Defaults to `True`", "title": "Return Mask" }, "description": "Add mask to the output data. Defaults to `True`" } ], "responses": { "200": { "description": "Return an image.", "content": { "image/png": {}, "image/jpeg": {}, "image/jpg": {}, "image/webp": {}, "image/jp2": {}, "image/tiff; application=geotiff": {}, "application/x-binary": {} } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/cog/feature/{width}x{height}.{format}": { "post": { "tags": [ "Cloud Optimized GeoTIFF" ], "summary": "Feature Image", "description": "Create image from a geojson feature.", "operationId": ".cog.postDataForGeoJSONWithSizesAndFormat", "parameters": [ { "name": "format", "in": "path", "required": true, "schema": { "anyOf": [ { "$ref": "#/components/schemas/ImageType" }, { "type": "null" } ], "description": "Default will be automatically defined if the output image needs a mask (png) or not (jpeg).", "title": "Format" } }, { "name": "height", "in": "path", "required": true, "schema": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "Force output image height.", "title": "Height" } }, { "name": "width", "in": "path", "required": true, "schema": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "Force output image width.", "title": "Width" } }, { "name": "url", "in": "query", "required": true, "schema": { "type": "string", "description": "Dataset URL", "title": "Url" }, "description": "Dataset URL" }, { "name": "bidx", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "array", "items": { "type": "integer" } }, { "type": "null" } ], "title": "Band indexes", "description": "Dataset band indexes" }, "description": "Dataset band indexes", "examples": { "user-provided": {}, "one-band": { "value": [ 1 ] }, "multi-bands": { "value": [ 1, 2, 3 ] } } }, { "name": "expression", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Band Math expression", "description": "rio-tiler's band math expression" }, "description": "rio-tiler's band math expression", "examples": { "user-provided": {}, "simple": { "description": "Simple band math.", "value": "b1/b2" }, "multi-bands": { "description": "Semicolon (;) delimited expressions (band1: b1/b2, band2: b2+b3).", "value": "b1/b2;b2+b3" } } }, { "name": "nodata", "in": "query", "required": false, "schema": { "anyOf": [ { "enum": [ "nan", "inf", "-inf" ], "type": "string" }, { "type": "integer" }, { "type": "number" }, { "type": "null" } ], "title": "Nodata value", "description": "Overwrite internal Nodata value; nan or valid float values only." }, "description": "Overwrite internal Nodata value; nan or valid float values only." }, { "name": "unscale", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Apply internal Scale/Offset", "description": "Apply internal Scale/Offset. Defaults to `False`." }, "description": "Apply internal Scale/Offset. Defaults to `False`." }, { "name": "resampling", "in": "query", "required": false, "schema": { "anyOf": [ { "enum": [ "nearest", "bilinear", "cubic", "cubic_spline", "lanczos", "average", "mode", "gauss", "rms" ], "type": "string" }, { "type": "null" } ], "description": "RasterIO resampling algorithm. Defaults to `nearest`.", "title": "Resampling" }, "description": "RasterIO resampling algorithm. Defaults to `nearest`." }, { "name": "reproject", "in": "query", "required": false, "schema": { "anyOf": [ { "enum": [ "nearest", "bilinear", "cubic", "cubic_spline", "lanczos", "average", "mode", "max", "min", "med", "q1", "q3", "sum", "rms" ], "type": "string" }, { "type": "null" } ], "description": "WarpKernel resampling algorithm (only used when doing re-projection). Defaults to `nearest`.", "title": "Reproject" }, "description": "WarpKernel resampling algorithm (only used when doing re-projection). Defaults to `nearest`." }, { "name": "max_size", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "Maximum image size to read onto.", "title": "Max Size" } }, { "name": "coord_crs", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Coordinate Reference System of the input coords. Default to `epsg:4326`.", "title": "Coord Crs" }, "description": "Coordinate Reference System of the input coords. Default to `epsg:4326`." }, { "name": "dst_crs", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Output Coordinate Reference System.", "title": "Dst Crs" }, "description": "Output Coordinate Reference System." }, { "name": "algorithm", "in": "query", "required": false, "schema": { "enum": [ "hillshade", "slope", "contours", "normalizedIndex", "terrarium", "terrainrgb", "cast", "ceil", "floor", "min", "max", "median", "mean", "std", "var", "sum", "grayscale", "bitonal" ], "type": "string", "description": "Algorithm name", "title": "Algorithm" }, "description": "Algorithm name" }, { "name": "algorithm_params", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Algorithm parameter", "title": "Algorithm Params" }, "description": "Algorithm parameter" }, { "name": "colormap_name", "in": "query", "required": false, "schema": { "enum": [ "jet_r", "haline", "gist_ncar_r", "algae", "cividis_r", "seismic_r", "pink_r", "rdylbu", "inferno_r", "deep", "rdgy_r", "tab10", "bugn_r", "ocean_r", "purples", "pastel1_r", "thermal_r", "ylorrd_r", "wistia_r", "cmrmap", "pubu", "rain", "ylgnbu", "gnuplot", "gnbu", "gist_gray_r", "greens", "purd_r", "oxy_r", "matter", "summer_r", "gnuplot_r", "gnuplot2", "solar", "jet", "ylgn_r", "dark2_r", "spring", "tab20c", "gist_stern", "bwr", "ylgn", "plasma", "pastel2", "blues_r", "rain_r", "set1", "topo_r", "gist_ncar", "turbid", "magma_r", "pastel2_r", "purd", "gnbu_r", "spring_r", "rdbu_r", "ylorbr", "twilight_shifted", "rplumbo", "winter_r", "tab20b", "ylorrd", "copper", "flag_r", "afmhot", "twilight_shifted_r", "oranges_r", "bone", "seismic", "gray_r", "tarn_r", "bwr_r", "magma", "paired_r", "dark2", "binary", "set3", "viridis_r", "spectral", "prgn", "diff", "hot", "gist_earth", "cubehelix", "dense_r", "coolwarm", "pubugn_r", "autumn_r", "gnuplot2_r", "cividis", "bugn", "deep_r", "prgn_r", "gist_rainbow", "gist_heat_r", "nipy_spectral_r", "tab20", "turbo_r", "pubugn", "set2_r", "gist_yarg_r", "spectral_r", "binary_r", "greys", "rainbow_r", "haline_r", "curl", "tab20c_r", "blues", "prism", "rdgy", "gist_gray", "set2", "cool", "afmhot_r", "bone_r", "paired", "oranges", "orrd", "puor", "autumn", "delta_r", "pubu_r", "piyg_r", "turbo", "greys_r", "accent", "turbid_r", "algae_r", "solar_r", "topo", "cool_r", "inferno", "balance", "tempo_r", "amp_r", "flag", "speed", "gist_heat", "balance_r", "viridis", "cubehelix_r", "ylorbr_r", "summer", "coolwarm_r", "diff_r", "rdylgn_r", "gist_stern_r", "plasma_r", "copper_r", "oxy", "gist_yarg", "twilight", "winter", "brbg", "reds_r", "speed_r", "rainbow", "ice", "nipy_spectral", "piyg", "gray", "reds", "terrain", "tab20_r", "wistia", "accent_r", "thermal", "ocean", "twilight_r", "hot_r", "set3_r", "hsv_r", "brg_r", "gist_rainbow_r", "phase", "bupu", "pastel1", "dense", "set1_r", "phase_r", "matter_r", "greens_r", "cfastie", "tab10_r", "rdbu", "brg", "rdpu_r", "brbg_r", "cmrmap_r", "prism_r", "purples_r", "gist_earth_r", "tempo", "schwarzwald", "rdpu", "orrd_r", "tarn", "puor_r", "bupu_r", "rdylgn", "ice_r", "pink", "terrain_r", "amp", "tab20b_r", "rdylbu_r", "hsv", "curl_r", "delta", "ylgnbu_r" ], "type": "string", "description": "Colormap name", "title": "Colormap Name" }, "description": "Colormap name" }, { "name": "colormap", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "JSON encoded custom Colormap", "title": "Colormap" }, "description": "JSON encoded custom Colormap" }, { "name": "rescale", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ], "title": "Min/Max data Rescaling", "description": "comma (',') delimited Min,Max range. Can set multiple time for multiple bands.", "examples": [ "0,2000", "0,1000", "0,10000" ] }, "description": "comma (',') delimited Min,Max range. Can set multiple time for multiple bands." }, { "name": "color_formula", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Color Formula", "description": "rio-color formula (info: https://github.com/mapbox/rio-color)" }, "description": "rio-color formula (info: https://github.com/mapbox/rio-color)" }, { "name": "return_mask", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "Add mask to the output data. Defaults to `True`", "title": "Return Mask" }, "description": "Add mask to the output data. Defaults to `True`" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Feature-Input", "description": "GeoJSON Feature." } } } }, "responses": { "200": { "description": "Return an image.", "content": { "image/png": {}, "image/jpeg": {}, "image/jpg": {}, "image/webp": {}, "image/jp2": {}, "image/tiff; application=geotiff": {}, "application/x-binary": {} } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/cog/feature.{format}": { "post": { "tags": [ "Cloud Optimized GeoTIFF" ], "summary": "Feature Image", "description": "Create image from a geojson feature.", "operationId": ".cog.postDataForGeoJSONWithFormat", "parameters": [ { "name": "format", "in": "path", "required": true, "schema": { "anyOf": [ { "$ref": "#/components/schemas/ImageType" }, { "type": "null" } ], "description": "Default will be automatically defined if the output image needs a mask (png) or not (jpeg).", "title": "Format" } }, { "name": "url", "in": "query", "required": true, "schema": { "type": "string", "description": "Dataset URL", "title": "Url" }, "description": "Dataset URL" }, { "name": "bidx", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "array", "items": { "type": "integer" } }, { "type": "null" } ], "title": "Band indexes", "description": "Dataset band indexes" }, "description": "Dataset band indexes", "examples": { "user-provided": {}, "one-band": { "value": [ 1 ] }, "multi-bands": { "value": [ 1, 2, 3 ] } } }, { "name": "expression", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Band Math expression", "description": "rio-tiler's band math expression" }, "description": "rio-tiler's band math expression", "examples": { "user-provided": {}, "simple": { "description": "Simple band math.", "value": "b1/b2" }, "multi-bands": { "description": "Semicolon (;) delimited expressions (band1: b1/b2, band2: b2+b3).", "value": "b1/b2;b2+b3" } } }, { "name": "nodata", "in": "query", "required": false, "schema": { "anyOf": [ { "enum": [ "nan", "inf", "-inf" ], "type": "string" }, { "type": "integer" }, { "type": "number" }, { "type": "null" } ], "title": "Nodata value", "description": "Overwrite internal Nodata value; nan or valid float values only." }, "description": "Overwrite internal Nodata value; nan or valid float values only." }, { "name": "unscale", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Apply internal Scale/Offset", "description": "Apply internal Scale/Offset. Defaults to `False`." }, "description": "Apply internal Scale/Offset. Defaults to `False`." }, { "name": "resampling", "in": "query", "required": false, "schema": { "anyOf": [ { "enum": [ "nearest", "bilinear", "cubic", "cubic_spline", "lanczos", "average", "mode", "gauss", "rms" ], "type": "string" }, { "type": "null" } ], "description": "RasterIO resampling algorithm. Defaults to `nearest`.", "title": "Resampling" }, "description": "RasterIO resampling algorithm. Defaults to `nearest`." }, { "name": "reproject", "in": "query", "required": false, "schema": { "anyOf": [ { "enum": [ "nearest", "bilinear", "cubic", "cubic_spline", "lanczos", "average", "mode", "max", "min", "med", "q1", "q3", "sum", "rms" ], "type": "string" }, { "type": "null" } ], "description": "WarpKernel resampling algorithm (only used when doing re-projection). Defaults to `nearest`.", "title": "Reproject" }, "description": "WarpKernel resampling algorithm (only used when doing re-projection). Defaults to `nearest`." }, { "name": "max_size", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "Maximum image size to read onto.", "title": "Max Size" } }, { "name": "height", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "Force output image height.", "title": "Height" } }, { "name": "width", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "Force output image width.", "title": "Width" } }, { "name": "coord_crs", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Coordinate Reference System of the input coords. Default to `epsg:4326`.", "title": "Coord Crs" }, "description": "Coordinate Reference System of the input coords. Default to `epsg:4326`." }, { "name": "dst_crs", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Output Coordinate Reference System.", "title": "Dst Crs" }, "description": "Output Coordinate Reference System." }, { "name": "algorithm", "in": "query", "required": false, "schema": { "enum": [ "hillshade", "slope", "contours", "normalizedIndex", "terrarium", "terrainrgb", "cast", "ceil", "floor", "min", "max", "median", "mean", "std", "var", "sum", "grayscale", "bitonal" ], "type": "string", "description": "Algorithm name", "title": "Algorithm" }, "description": "Algorithm name" }, { "name": "algorithm_params", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Algorithm parameter", "title": "Algorithm Params" }, "description": "Algorithm parameter" }, { "name": "colormap_name", "in": "query", "required": false, "schema": { "enum": [ "jet_r", "haline", "gist_ncar_r", "algae", "cividis_r", "seismic_r", "pink_r", "rdylbu", "inferno_r", "deep", "rdgy_r", "tab10", "bugn_r", "ocean_r", "purples", "pastel1_r", "thermal_r", "ylorrd_r", "wistia_r", "cmrmap", "pubu", "rain", "ylgnbu", "gnuplot", "gnbu", "gist_gray_r", "greens", "purd_r", "oxy_r", "matter", "summer_r", "gnuplot_r", "gnuplot2", "solar", "jet", "ylgn_r", "dark2_r", "spring", "tab20c", "gist_stern", "bwr", "ylgn", "plasma", "pastel2", "blues_r", "rain_r", "set1", "topo_r", "gist_ncar", "turbid", "magma_r", "pastel2_r", "purd", "gnbu_r", "spring_r", "rdbu_r", "ylorbr", "twilight_shifted", "rplumbo", "winter_r", "tab20b", "ylorrd", "copper", "flag_r", "afmhot", "twilight_shifted_r", "oranges_r", "bone", "seismic", "gray_r", "tarn_r", "bwr_r", "magma", "paired_r", "dark2", "binary", "set3", "viridis_r", "spectral", "prgn", "diff", "hot", "gist_earth", "cubehelix", "dense_r", "coolwarm", "pubugn_r", "autumn_r", "gnuplot2_r", "cividis", "bugn", "deep_r", "prgn_r", "gist_rainbow", "gist_heat_r", "nipy_spectral_r", "tab20", "turbo_r", "pubugn", "set2_r", "gist_yarg_r", "spectral_r", "binary_r", "greys", "rainbow_r", "haline_r", "curl", "tab20c_r", "blues", "prism", "rdgy", "gist_gray", "set2", "cool", "afmhot_r", "bone_r", "paired", "oranges", "orrd", "puor", "autumn", "delta_r", "pubu_r", "piyg_r", "turbo", "greys_r", "accent", "turbid_r", "algae_r", "solar_r", "topo", "cool_r", "inferno", "balance", "tempo_r", "amp_r", "flag", "speed", "gist_heat", "balance_r", "viridis", "cubehelix_r", "ylorbr_r", "summer", "coolwarm_r", "diff_r", "rdylgn_r", "gist_stern_r", "plasma_r", "copper_r", "oxy", "gist_yarg", "twilight", "winter", "brbg", "reds_r", "speed_r", "rainbow", "ice", "nipy_spectral", "piyg", "gray", "reds", "terrain", "tab20_r", "wistia", "accent_r", "thermal", "ocean", "twilight_r", "hot_r", "set3_r", "hsv_r", "brg_r", "gist_rainbow_r", "phase", "bupu", "pastel1", "dense", "set1_r", "phase_r", "matter_r", "greens_r", "cfastie", "tab10_r", "rdbu", "brg", "rdpu_r", "brbg_r", "cmrmap_r", "prism_r", "purples_r", "gist_earth_r", "tempo", "schwarzwald", "rdpu", "orrd_r", "tarn", "puor_r", "bupu_r", "rdylgn", "ice_r", "pink", "terrain_r", "amp", "tab20b_r", "rdylbu_r", "hsv", "curl_r", "delta", "ylgnbu_r" ], "type": "string", "description": "Colormap name", "title": "Colormap Name" }, "description": "Colormap name" }, { "name": "colormap", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "JSON encoded custom Colormap", "title": "Colormap" }, "description": "JSON encoded custom Colormap" }, { "name": "rescale", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ], "title": "Min/Max data Rescaling", "description": "comma (',') delimited Min,Max range. Can set multiple time for multiple bands.", "examples": [ "0,2000", "0,1000", "0,10000" ] }, "description": "comma (',') delimited Min,Max range. Can set multiple time for multiple bands." }, { "name": "color_formula", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Color Formula", "description": "rio-color formula (info: https://github.com/mapbox/rio-color)" }, "description": "rio-color formula (info: https://github.com/mapbox/rio-color)" }, { "name": "return_mask", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "Add mask to the output data. Defaults to `True`", "title": "Return Mask" }, "description": "Add mask to the output data. Defaults to `True`" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Feature-Input", "description": "GeoJSON Feature." } } } }, "responses": { "200": { "description": "Return an image.", "content": { "image/png": {}, "image/jpeg": {}, "image/jpg": {}, "image/webp": {}, "image/jp2": {}, "image/tiff; application=geotiff": {}, "application/x-binary": {} } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/cog/feature": { "post": { "tags": [ "Cloud Optimized GeoTIFF" ], "summary": "Feature Image", "description": "Create image from a geojson feature.", "operationId": ".cog.postDataForGeoJSON", "parameters": [ { "name": "format", "in": "query", "required": false, "schema": { "anyOf": [ { "$ref": "#/components/schemas/ImageType" }, { "type": "null" } ], "description": "Default will be automatically defined if the output image needs a mask (png) or not (jpeg).", "title": "Format" } }, { "name": "url", "in": "query", "required": true, "schema": { "type": "string", "description": "Dataset URL", "title": "Url" }, "description": "Dataset URL" }, { "name": "bidx", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "array", "items": { "type": "integer" } }, { "type": "null" } ], "title": "Band indexes", "description": "Dataset band indexes" }, "description": "Dataset band indexes", "examples": { "user-provided": {}, "one-band": { "value": [ 1 ] }, "multi-bands": { "value": [ 1, 2, 3 ] } } }, { "name": "expression", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Band Math expression", "description": "rio-tiler's band math expression" }, "description": "rio-tiler's band math expression", "examples": { "user-provided": {}, "simple": { "description": "Simple band math.", "value": "b1/b2" }, "multi-bands": { "description": "Semicolon (;) delimited expressions (band1: b1/b2, band2: b2+b3).", "value": "b1/b2;b2+b3" } } }, { "name": "nodata", "in": "query", "required": false, "schema": { "anyOf": [ { "enum": [ "nan", "inf", "-inf" ], "type": "string" }, { "type": "integer" }, { "type": "number" }, { "type": "null" } ], "title": "Nodata value", "description": "Overwrite internal Nodata value; nan or valid float values only." }, "description": "Overwrite internal Nodata value; nan or valid float values only." }, { "name": "unscale", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Apply internal Scale/Offset", "description": "Apply internal Scale/Offset. Defaults to `False`." }, "description": "Apply internal Scale/Offset. Defaults to `False`." }, { "name": "resampling", "in": "query", "required": false, "schema": { "anyOf": [ { "enum": [ "nearest", "bilinear", "cubic", "cubic_spline", "lanczos", "average", "mode", "gauss", "rms" ], "type": "string" }, { "type": "null" } ], "description": "RasterIO resampling algorithm. Defaults to `nearest`.", "title": "Resampling" }, "description": "RasterIO resampling algorithm. Defaults to `nearest`." }, { "name": "reproject", "in": "query", "required": false, "schema": { "anyOf": [ { "enum": [ "nearest", "bilinear", "cubic", "cubic_spline", "lanczos", "average", "mode", "max", "min", "med", "q1", "q3", "sum", "rms" ], "type": "string" }, { "type": "null" } ], "description": "WarpKernel resampling algorithm (only used when doing re-projection). Defaults to `nearest`.", "title": "Reproject" }, "description": "WarpKernel resampling algorithm (only used when doing re-projection). Defaults to `nearest`." }, { "name": "max_size", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "Maximum image size to read onto.", "title": "Max Size" } }, { "name": "height", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "Force output image height.", "title": "Height" } }, { "name": "width", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "Force output image width.", "title": "Width" } }, { "name": "coord_crs", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Coordinate Reference System of the input coords. Default to `epsg:4326`.", "title": "Coord Crs" }, "description": "Coordinate Reference System of the input coords. Default to `epsg:4326`." }, { "name": "dst_crs", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Output Coordinate Reference System.", "title": "Dst Crs" }, "description": "Output Coordinate Reference System." }, { "name": "algorithm", "in": "query", "required": false, "schema": { "enum": [ "hillshade", "slope", "contours", "normalizedIndex", "terrarium", "terrainrgb", "cast", "ceil", "floor", "min", "max", "median", "mean", "std", "var", "sum", "grayscale", "bitonal" ], "type": "string", "description": "Algorithm name", "title": "Algorithm" }, "description": "Algorithm name" }, { "name": "algorithm_params", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Algorithm parameter", "title": "Algorithm Params" }, "description": "Algorithm parameter" }, { "name": "colormap_name", "in": "query", "required": false, "schema": { "enum": [ "jet_r", "haline", "gist_ncar_r", "algae", "cividis_r", "seismic_r", "pink_r", "rdylbu", "inferno_r", "deep", "rdgy_r", "tab10", "bugn_r", "ocean_r", "purples", "pastel1_r", "thermal_r", "ylorrd_r", "wistia_r", "cmrmap", "pubu", "rain", "ylgnbu", "gnuplot", "gnbu", "gist_gray_r", "greens", "purd_r", "oxy_r", "matter", "summer_r", "gnuplot_r", "gnuplot2", "solar", "jet", "ylgn_r", "dark2_r", "spring", "tab20c", "gist_stern", "bwr", "ylgn", "plasma", "pastel2", "blues_r", "rain_r", "set1", "topo_r", "gist_ncar", "turbid", "magma_r", "pastel2_r", "purd", "gnbu_r", "spring_r", "rdbu_r", "ylorbr", "twilight_shifted", "rplumbo", "winter_r", "tab20b", "ylorrd", "copper", "flag_r", "afmhot", "twilight_shifted_r", "oranges_r", "bone", "seismic", "gray_r", "tarn_r", "bwr_r", "magma", "paired_r", "dark2", "binary", "set3", "viridis_r", "spectral", "prgn", "diff", "hot", "gist_earth", "cubehelix", "dense_r", "coolwarm", "pubugn_r", "autumn_r", "gnuplot2_r", "cividis", "bugn", "deep_r", "prgn_r", "gist_rainbow", "gist_heat_r", "nipy_spectral_r", "tab20", "turbo_r", "pubugn", "set2_r", "gist_yarg_r", "spectral_r", "binary_r", "greys", "rainbow_r", "haline_r", "curl", "tab20c_r", "blues", "prism", "rdgy", "gist_gray", "set2", "cool", "afmhot_r", "bone_r", "paired", "oranges", "orrd", "puor", "autumn", "delta_r", "pubu_r", "piyg_r", "turbo", "greys_r", "accent", "turbid_r", "algae_r", "solar_r", "topo", "cool_r", "inferno", "balance", "tempo_r", "amp_r", "flag", "speed", "gist_heat", "balance_r", "viridis", "cubehelix_r", "ylorbr_r", "summer", "coolwarm_r", "diff_r", "rdylgn_r", "gist_stern_r", "plasma_r", "copper_r", "oxy", "gist_yarg", "twilight", "winter", "brbg", "reds_r", "speed_r", "rainbow", "ice", "nipy_spectral", "piyg", "gray", "reds", "terrain", "tab20_r", "wistia", "accent_r", "thermal", "ocean", "twilight_r", "hot_r", "set3_r", "hsv_r", "brg_r", "gist_rainbow_r", "phase", "bupu", "pastel1", "dense", "set1_r", "phase_r", "matter_r", "greens_r", "cfastie", "tab10_r", "rdbu", "brg", "rdpu_r", "brbg_r", "cmrmap_r", "prism_r", "purples_r", "gist_earth_r", "tempo", "schwarzwald", "rdpu", "orrd_r", "tarn", "puor_r", "bupu_r", "rdylgn", "ice_r", "pink", "terrain_r", "amp", "tab20b_r", "rdylbu_r", "hsv", "curl_r", "delta", "ylgnbu_r" ], "type": "string", "description": "Colormap name", "title": "Colormap Name" }, "description": "Colormap name" }, { "name": "colormap", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "JSON encoded custom Colormap", "title": "Colormap" }, "description": "JSON encoded custom Colormap" }, { "name": "rescale", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ], "title": "Min/Max data Rescaling", "description": "comma (',') delimited Min,Max range. Can set multiple time for multiple bands.", "examples": [ "0,2000", "0,1000", "0,10000" ] }, "description": "comma (',') delimited Min,Max range. Can set multiple time for multiple bands." }, { "name": "color_formula", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Color Formula", "description": "rio-color formula (info: https://github.com/mapbox/rio-color)" }, "description": "rio-color formula (info: https://github.com/mapbox/rio-color)" }, { "name": "return_mask", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "Add mask to the output data. Defaults to `True`", "title": "Return Mask" }, "description": "Add mask to the output data. Defaults to `True`" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Feature-Input", "description": "GeoJSON Feature." } } } }, "responses": { "200": { "description": "Return an image.", "content": { "image/png": {}, "image/jpeg": {}, "image/jpg": {}, "image/webp": {}, "image/jp2": {}, "image/tiff; application=geotiff": {}, "application/x-binary": {} } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/cog/map": { "get": { "tags": [ "Cloud Optimized GeoTIFF" ], "summary": "Get Map", "description": "OGC Maps API.", "operationId": ".cog.getMap", "parameters": [ { "name": "url", "in": "query", "required": true, "schema": { "type": "string", "description": "Dataset URL", "title": "Url" }, "description": "Dataset URL" }, { "name": "bbox", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Bounding box of the rendered map. The bounding box is provided as four or six coordinates.", "title": "Bbox" }, "description": "Bounding box of the rendered map. The bounding box is provided as four or six coordinates." }, { "name": "crs", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Reproject the output to the given crs.", "title": "Crs" }, "description": "Reproject the output to the given crs." }, { "name": "bbox-crs", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "crs for the specified bbox.", "title": "Bbox-Crs" }, "description": "crs for the specified bbox." }, { "name": "height", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "integer", "exclusiveMinimum": 0 }, { "type": "null" } ], "description": "Height of the map in pixels. If omitted and `width` is specified, defaults to the `height` maintaining a 1:1 aspect ratio. If both `width` and `height` are omitted, the server will select default dimensions.", "title": "Height" }, "description": "Height of the map in pixels. If omitted and `width` is specified, defaults to the `height` maintaining a 1:1 aspect ratio. If both `width` and `height` are omitted, the server will select default dimensions." }, { "name": "width", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "integer", "exclusiveMinimum": 0 }, { "type": "null" } ], "description": "Width of the map in pixels. If omitted and `height` is specified, defaults to the `width` maintaining a 1:1 aspect ratio. If both `width` and `height` are omitted, the server will select default dimensions.", "title": "Width" }, "description": "Width of the map in pixels. If omitted and `height` is specified, defaults to the `width` maintaining a 1:1 aspect ratio. If both `width` and `height` are omitted, the server will select default dimensions." }, { "name": "f", "in": "query", "required": false, "schema": { "anyOf": [ { "$ref": "#/components/schemas/ImageType" }, { "type": "null" } ], "description": "The format of the map response (e.g. png).", "title": "F" }, "description": "The format of the map response (e.g. png)." }, { "name": "bidx", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "array", "items": { "type": "integer" } }, { "type": "null" } ], "title": "Band indexes", "description": "Dataset band indexes" }, "description": "Dataset band indexes", "examples": { "user-provided": {}, "one-band": { "value": [ 1 ] }, "multi-bands": { "value": [ 1, 2, 3 ] } } }, { "name": "expression", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Band Math expression", "description": "rio-tiler's band math expression" }, "description": "rio-tiler's band math expression", "examples": { "user-provided": {}, "simple": { "description": "Simple band math.", "value": "b1/b2" }, "multi-bands": { "description": "Semicolon (;) delimited expressions (band1: b1/b2, band2: b2+b3).", "value": "b1/b2;b2+b3" } } }, { "name": "nodata", "in": "query", "required": false, "schema": { "anyOf": [ { "enum": [ "nan", "inf", "-inf" ], "type": "string" }, { "type": "integer" }, { "type": "number" }, { "type": "null" } ], "title": "Nodata value", "description": "Overwrite internal Nodata value; nan or valid float values only." }, "description": "Overwrite internal Nodata value; nan or valid float values only." }, { "name": "unscale", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Apply internal Scale/Offset", "description": "Apply internal Scale/Offset. Defaults to `False`." }, "description": "Apply internal Scale/Offset. Defaults to `False`." }, { "name": "resampling", "in": "query", "required": false, "schema": { "anyOf": [ { "enum": [ "nearest", "bilinear", "cubic", "cubic_spline", "lanczos", "average", "mode", "gauss", "rms" ], "type": "string" }, { "type": "null" } ], "description": "RasterIO resampling algorithm. Defaults to `nearest`.", "title": "Resampling" }, "description": "RasterIO resampling algorithm. Defaults to `nearest`." }, { "name": "reproject", "in": "query", "required": false, "schema": { "anyOf": [ { "enum": [ "nearest", "bilinear", "cubic", "cubic_spline", "lanczos", "average", "mode", "max", "min", "med", "q1", "q3", "sum", "rms" ], "type": "string" }, { "type": "null" } ], "description": "WarpKernel resampling algorithm (only used when doing re-projection). Defaults to `nearest`.", "title": "Reproject" }, "description": "WarpKernel resampling algorithm (only used when doing re-projection). Defaults to `nearest`." }, { "name": "algorithm", "in": "query", "required": false, "schema": { "enum": [ "hillshade", "slope", "contours", "normalizedIndex", "terrarium", "terrainrgb", "cast", "ceil", "floor", "min", "max", "median", "mean", "std", "var", "sum", "grayscale", "bitonal" ], "type": "string", "description": "Algorithm name", "title": "Algorithm" }, "description": "Algorithm name" }, { "name": "algorithm_params", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Algorithm parameter", "title": "Algorithm Params" }, "description": "Algorithm parameter" }, { "name": "colormap_name", "in": "query", "required": false, "schema": { "enum": [ "jet_r", "haline", "gist_ncar_r", "algae", "cividis_r", "seismic_r", "pink_r", "rdylbu", "inferno_r", "deep", "rdgy_r", "tab10", "bugn_r", "ocean_r", "purples", "pastel1_r", "thermal_r", "ylorrd_r", "wistia_r", "cmrmap", "pubu", "rain", "ylgnbu", "gnuplot", "gnbu", "gist_gray_r", "greens", "purd_r", "oxy_r", "matter", "summer_r", "gnuplot_r", "gnuplot2", "solar", "jet", "ylgn_r", "dark2_r", "spring", "tab20c", "gist_stern", "bwr", "ylgn", "plasma", "pastel2", "blues_r", "rain_r", "set1", "topo_r", "gist_ncar", "turbid", "magma_r", "pastel2_r", "purd", "gnbu_r", "spring_r", "rdbu_r", "ylorbr", "twilight_shifted", "rplumbo", "winter_r", "tab20b", "ylorrd", "copper", "flag_r", "afmhot", "twilight_shifted_r", "oranges_r", "bone", "seismic", "gray_r", "tarn_r", "bwr_r", "magma", "paired_r", "dark2", "binary", "set3", "viridis_r", "spectral", "prgn", "diff", "hot", "gist_earth", "cubehelix", "dense_r", "coolwarm", "pubugn_r", "autumn_r", "gnuplot2_r", "cividis", "bugn", "deep_r", "prgn_r", "gist_rainbow", "gist_heat_r", "nipy_spectral_r", "tab20", "turbo_r", "pubugn", "set2_r", "gist_yarg_r", "spectral_r", "binary_r", "greys", "rainbow_r", "haline_r", "curl", "tab20c_r", "blues", "prism", "rdgy", "gist_gray", "set2", "cool", "afmhot_r", "bone_r", "paired", "oranges", "orrd", "puor", "autumn", "delta_r", "pubu_r", "piyg_r", "turbo", "greys_r", "accent", "turbid_r", "algae_r", "solar_r", "topo", "cool_r", "inferno", "balance", "tempo_r", "amp_r", "flag", "speed", "gist_heat", "balance_r", "viridis", "cubehelix_r", "ylorbr_r", "summer", "coolwarm_r", "diff_r", "rdylgn_r", "gist_stern_r", "plasma_r", "copper_r", "oxy", "gist_yarg", "twilight", "winter", "brbg", "reds_r", "speed_r", "rainbow", "ice", "nipy_spectral", "piyg", "gray", "reds", "terrain", "tab20_r", "wistia", "accent_r", "thermal", "ocean", "twilight_r", "hot_r", "set3_r", "hsv_r", "brg_r", "gist_rainbow_r", "phase", "bupu", "pastel1", "dense", "set1_r", "phase_r", "matter_r", "greens_r", "cfastie", "tab10_r", "rdbu", "brg", "rdpu_r", "brbg_r", "cmrmap_r", "prism_r", "purples_r", "gist_earth_r", "tempo", "schwarzwald", "rdpu", "orrd_r", "tarn", "puor_r", "bupu_r", "rdylgn", "ice_r", "pink", "terrain_r", "amp", "tab20b_r", "rdylbu_r", "hsv", "curl_r", "delta", "ylgnbu_r" ], "type": "string", "description": "Colormap name", "title": "Colormap Name" }, "description": "Colormap name" }, { "name": "colormap", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "JSON encoded custom Colormap", "title": "Colormap" }, "description": "JSON encoded custom Colormap" }, { "name": "rescale", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ], "title": "Min/Max data Rescaling", "description": "comma (',') delimited Min,Max range. Can set multiple time for multiple bands.", "examples": [ "0,2000", "0,1000", "0,10000" ] }, "description": "comma (',') delimited Min,Max range. Can set multiple time for multiple bands." }, { "name": "color_formula", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Color Formula", "description": "rio-color formula (info: https://github.com/mapbox/rio-color)" }, "description": "rio-color formula (info: https://github.com/mapbox/rio-color)" }, { "name": "return_mask", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "Add mask to the output data. Defaults to `True`", "title": "Return Mask" }, "description": "Add mask to the output data. Defaults to `True`" } ], "responses": { "200": { "description": "Return an image.", "content": { "image/png": {}, "image/jpeg": {}, "image/jpg": {}, "image/webp": {}, "image/jp2": {}, "image/tiff; application=geotiff": {}, "application/x-binary": {} } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/cog/validate": { "get": { "tags": [ "Cloud Optimized GeoTIFF" ], "summary": "Validate", "description": "Validate a COG", "operationId": ".cog.validate", "parameters": [ { "name": "strict", "in": "query", "required": false, "schema": { "type": "boolean", "description": "Treat warnings as errors", "default": false, "title": "Strict" }, "description": "Treat warnings as errors" }, { "name": "url", "in": "query", "required": true, "schema": { "type": "string", "description": "Dataset URL", "title": "Url" }, "description": "Dataset URL" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rio_cogeo__models__Info" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/cog/viewer": { "get": { "tags": [ "Cloud Optimized GeoTIFF" ], "summary": "Cog Viewer", "description": "COG Viewer.", "operationId": ".cog.getViewer", "responses": { "200": { "description": "Successful Response", "content": { "text/html": { "schema": { "type": "string" } } } } } } }, "/cog/stac": { "get": { "tags": [ "Cloud Optimized GeoTIFF" ], "summary": "Create Stac Item", "description": "Create STAC item.", "operationId": ".cog.createSTAC", "parameters": [ { "name": "datetime", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The date and time of the assets, in UTC (e.g 2020-01-01, 2020-01-01T01:01:01).", "title": "Datetime" }, "description": "The date and time of the assets, in UTC (e.g 2020-01-01, 2020-01-01T01:01:01)." }, { "name": "extensions", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ], "description": "STAC extension URL the Item implements.", "title": "Extensions" }, "description": "STAC extension URL the Item implements." }, { "name": "collection", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The Collection ID that this item belongs to.", "title": "Collection" }, "description": "The Collection ID that this item belongs to." }, { "name": "collection_url", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Link to the STAC Collection.", "title": "Collection Url" }, "description": "Link to the STAC Collection." }, { "name": "id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Id to assign to the item (default to the source basename).", "title": "Id" }, "description": "Id to assign to the item (default to the source basename)." }, { "name": "asset_name", "in": "query", "required": false, "schema": { "type": "string", "description": "asset name for the source (default to 'data').", "default": "data", "title": "Asset Name" }, "description": "asset name for the source (default to 'data')." }, { "name": "asset_roles", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ], "description": "list of asset's roles.", "title": "Asset Roles" }, "description": "list of asset's roles." }, { "name": "asset_media_type", "in": "query", "required": false, "schema": { "enum": [ "image/tiff; application=geotiff; profile=cloud-optimized", "application/vnd.flatgeobuf", "application/geo+json", "application/geopackage+sqlite3", "image/tiff; application=geotiff", "application/x-hdf", "application/x-hdf5", "text/html", "image/jpeg", "image/jp2", "application/json", "image/png", "text/plain", "image/tiff", "application/vnd.google-earth.kml+xml", "application/xml", "application/pdf", "application/netcdf", "application/vnd.laszip+copc", "application/vnd.pmtiles", "application/vnd.apache.parquet", "application/vnd.zarr", "application/x-parquet", "application/vnd+zarr", "auto" ], "type": "string", "description": "Asset's media type", "default": "auto", "title": "Asset Media Type" }, "description": "Asset's media type" }, { "name": "asset_href", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Asset's URI (default to source's path)", "title": "Asset Href" }, "description": "Asset's URI (default to source's path)" }, { "name": "with_proj", "in": "query", "required": false, "schema": { "type": "boolean", "description": "Add the `projection` extension and properties.", "default": true, "title": "With Proj" }, "description": "Add the `projection` extension and properties." }, { "name": "with_raster", "in": "query", "required": false, "schema": { "type": "boolean", "description": "Add the `raster` extension and properties.", "default": true, "title": "With Raster" }, "description": "Add the `raster` extension and properties." }, { "name": "with_eo", "in": "query", "required": false, "schema": { "type": "boolean", "description": "Add the `eo` extension and properties.", "default": true, "title": "With Eo" }, "description": "Add the `eo` extension and properties." }, { "name": "max_size", "in": "query", "required": false, "schema": { "type": "integer", "exclusiveMinimum": 0, "description": "Limit array size from which to get the raster statistics.", "default": 1024, "title": "Max Size" }, "description": "Limit array size from which to get the raster statistics." }, { "name": "geometry_densify", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 0, "description": "Number of points to add to each edge to account for nonlinear edges transformation.", "default": 0, "title": "Geometry Densify" }, "description": "Number of points to add to each edge to account for nonlinear edges transformation." }, { "name": "geometry_precision", "in": "query", "required": false, "schema": { "type": "integer", "minimum": -1, "description": "Round geometry coordinates to this number of decimal.", "default": -1, "title": "Geometry Precision" }, "description": "Round geometry coordinates to this number of decimal." }, { "name": "url", "in": "query", "required": true, "schema": { "type": "string", "description": "Dataset URL", "title": "Url" }, "description": "Dataset URL" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Item" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/cog/WMTSCapabilities.xml": { "get": { "tags": [ "Cloud Optimized GeoTIFF" ], "summary": "Wmts", "description": "OGC RESTful WMTS endpoint.", "operationId": ".cog.getWMTS", "parameters": [ { "name": "tile_format", "in": "query", "required": false, "schema": { "$ref": "#/components/schemas/ImageType", "description": "Output image type. Default is png.", "default": "png" }, "description": "Output image type. Default is png." }, { "name": "use_epsg", "in": "query", "required": false, "schema": { "type": "boolean", "description": "Use EPSG code, not opengis.net, for the ows:SupportedCRS in the TileMatrixSet (set to True to enable ArcMap compatability)", "default": false, "title": "Use Epsg" }, "description": "Use EPSG code, not opengis.net, for the ows:SupportedCRS in the TileMatrixSet (set to True to enable ArcMap compatability)" }, { "name": "url", "in": "query", "required": true, "schema": { "type": "string", "description": "Dataset URL", "title": "Url" }, "description": "Dataset URL" }, { "name": "buffer", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "number", "exclusiveMinimum": 0 }, { "type": "null" } ], "title": "Tile buffer.", "description": "Buffer on each side of the given tile. It must be a multiple of `0.5`. Output **tilesize** will be expanded to `tilesize + 2 * buffer` (e.g 0.5 = 257x257, 1.0 = 258x258)." }, "description": "Buffer on each side of the given tile. It must be a multiple of `0.5`. Output **tilesize** will be expanded to `tilesize + 2 * buffer` (e.g 0.5 = 257x257, 1.0 = 258x258)." }, { "name": "padding", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "integer", "exclusiveMinimum": 0 }, { "type": "null" } ], "title": "Tile padding.", "description": "Padding to apply to each tile edge. Helps reduce resampling artefacts along edges. Defaults to `0`." }, "description": "Padding to apply to each tile edge. Helps reduce resampling artefacts along edges. Defaults to `0`." }, { "name": "bidx", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "array", "items": { "type": "integer" } }, { "type": "null" } ], "title": "Band indexes", "description": "Dataset band indexes" }, "description": "Dataset band indexes", "examples": { "user-provided": {}, "one-band": { "value": [ 1 ] }, "multi-bands": { "value": [ 1, 2, 3 ] } } }, { "name": "expression", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Band Math expression", "description": "rio-tiler's band math expression" }, "description": "rio-tiler's band math expression", "examples": { "user-provided": {}, "simple": { "description": "Simple band math.", "value": "b1/b2" }, "multi-bands": { "description": "Semicolon (;) delimited expressions (band1: b1/b2, band2: b2+b3).", "value": "b1/b2;b2+b3" } } }, { "name": "nodata", "in": "query", "required": false, "schema": { "anyOf": [ { "enum": [ "nan", "inf", "-inf" ], "type": "string" }, { "type": "integer" }, { "type": "number" }, { "type": "null" } ], "title": "Nodata value", "description": "Overwrite internal Nodata value; nan or valid float values only." }, "description": "Overwrite internal Nodata value; nan or valid float values only." }, { "name": "unscale", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Apply internal Scale/Offset", "description": "Apply internal Scale/Offset. Defaults to `False`." }, "description": "Apply internal Scale/Offset. Defaults to `False`." }, { "name": "resampling", "in": "query", "required": false, "schema": { "anyOf": [ { "enum": [ "nearest", "bilinear", "cubic", "cubic_spline", "lanczos", "average", "mode", "gauss", "rms" ], "type": "string" }, { "type": "null" } ], "description": "RasterIO resampling algorithm. Defaults to `nearest`.", "title": "Resampling" }, "description": "RasterIO resampling algorithm. Defaults to `nearest`." }, { "name": "reproject", "in": "query", "required": false, "schema": { "anyOf": [ { "enum": [ "nearest", "bilinear", "cubic", "cubic_spline", "lanczos", "average", "mode", "max", "min", "med", "q1", "q3", "sum", "rms" ], "type": "string" }, { "type": "null" } ], "description": "WarpKernel resampling algorithm (only used when doing re-projection). Defaults to `nearest`.", "title": "Reproject" }, "description": "WarpKernel resampling algorithm (only used when doing re-projection). Defaults to `nearest`." }, { "name": "algorithm", "in": "query", "required": false, "schema": { "enum": [ "hillshade", "slope", "contours", "normalizedIndex", "terrarium", "terrainrgb", "cast", "ceil", "floor", "min", "max", "median", "mean", "std", "var", "sum", "grayscale", "bitonal" ], "type": "string", "description": "Algorithm name", "title": "Algorithm" }, "description": "Algorithm name" }, { "name": "algorithm_params", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Algorithm parameter", "title": "Algorithm Params" }, "description": "Algorithm parameter" }, { "name": "colormap_name", "in": "query", "required": false, "schema": { "enum": [ "jet_r", "haline", "gist_ncar_r", "algae", "cividis_r", "seismic_r", "pink_r", "rdylbu", "inferno_r", "deep", "rdgy_r", "tab10", "bugn_r", "ocean_r", "purples", "pastel1_r", "thermal_r", "ylorrd_r", "wistia_r", "cmrmap", "pubu", "rain", "ylgnbu", "gnuplot", "gnbu", "gist_gray_r", "greens", "purd_r", "oxy_r", "matter", "summer_r", "gnuplot_r", "gnuplot2", "solar", "jet", "ylgn_r", "dark2_r", "spring", "tab20c", "gist_stern", "bwr", "ylgn", "plasma", "pastel2", "blues_r", "rain_r", "set1", "topo_r", "gist_ncar", "turbid", "magma_r", "pastel2_r", "purd", "gnbu_r", "spring_r", "rdbu_r", "ylorbr", "twilight_shifted", "rplumbo", "winter_r", "tab20b", "ylorrd", "copper", "flag_r", "afmhot", "twilight_shifted_r", "oranges_r", "bone", "seismic", "gray_r", "tarn_r", "bwr_r", "magma", "paired_r", "dark2", "binary", "set3", "viridis_r", "spectral", "prgn", "diff", "hot", "gist_earth", "cubehelix", "dense_r", "coolwarm", "pubugn_r", "autumn_r", "gnuplot2_r", "cividis", "bugn", "deep_r", "prgn_r", "gist_rainbow", "gist_heat_r", "nipy_spectral_r", "tab20", "turbo_r", "pubugn", "set2_r", "gist_yarg_r", "spectral_r", "binary_r", "greys", "rainbow_r", "haline_r", "curl", "tab20c_r", "blues", "prism", "rdgy", "gist_gray", "set2", "cool", "afmhot_r", "bone_r", "paired", "oranges", "orrd", "puor", "autumn", "delta_r", "pubu_r", "piyg_r", "turbo", "greys_r", "accent", "turbid_r", "algae_r", "solar_r", "topo", "cool_r", "inferno", "balance", "tempo_r", "amp_r", "flag", "speed", "gist_heat", "balance_r", "viridis", "cubehelix_r", "ylorbr_r", "summer", "coolwarm_r", "diff_r", "rdylgn_r", "gist_stern_r", "plasma_r", "copper_r", "oxy", "gist_yarg", "twilight", "winter", "brbg", "reds_r", "speed_r", "rainbow", "ice", "nipy_spectral", "piyg", "gray", "reds", "terrain", "tab20_r", "wistia", "accent_r", "thermal", "ocean", "twilight_r", "hot_r", "set3_r", "hsv_r", "brg_r", "gist_rainbow_r", "phase", "bupu", "pastel1", "dense", "set1_r", "phase_r", "matter_r", "greens_r", "cfastie", "tab10_r", "rdbu", "brg", "rdpu_r", "brbg_r", "cmrmap_r", "prism_r", "purples_r", "gist_earth_r", "tempo", "schwarzwald", "rdpu", "orrd_r", "tarn", "puor_r", "bupu_r", "rdylgn", "ice_r", "pink", "terrain_r", "amp", "tab20b_r", "rdylbu_r", "hsv", "curl_r", "delta", "ylgnbu_r" ], "type": "string", "description": "Colormap name", "title": "Colormap Name" }, "description": "Colormap name" }, { "name": "colormap", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "JSON encoded custom Colormap", "title": "Colormap" }, "description": "JSON encoded custom Colormap" }, { "name": "rescale", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ], "title": "Min/Max data Rescaling", "description": "comma (',') delimited Min,Max range. Can set multiple time for multiple bands.", "examples": [ "0,2000", "0,1000", "0,10000" ] }, "description": "comma (',') delimited Min,Max range. Can set multiple time for multiple bands." }, { "name": "color_formula", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Color Formula", "description": "rio-color formula (info: https://github.com/mapbox/rio-color)" }, "description": "rio-color formula (info: https://github.com/mapbox/rio-color)" }, { "name": "return_mask", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "Add mask to the output data. Defaults to `True`", "title": "Return Mask" }, "description": "Add mask to the output data. Defaults to `True`" } ], "responses": { "200": { "description": "Return RESTful WMTS service capabilities document.", "content": { "application/xml": { "schema": { "type": "string" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/stac/info": { "get": { "tags": [ "SpatioTemporal Asset Catalog" ], "summary": "Info", "description": "Return dataset's basic info or the list of available assets.", "operationId": ".stac.getInfo", "parameters": [ { "name": "url", "in": "query", "required": true, "schema": { "type": "string", "description": "Dataset URL", "title": "Url" }, "description": "Dataset URL" }, { "name": "assets", "in": "query", "required": true, "schema": { "type": "array", "items": { "type": "string" }, "title": "Asset names", "description": "Asset's names." }, "description": "Asset's names.", "examples": { "user-provided": {}, "one-asset": { "description": "Return results for asset `data`.", "value": [ "data" ] }, "multi-assets": { "description": "Return results for assets `data` and `cog`.", "value": [ "data", "cog" ] }, "multi-assets-with-options": { "description": "Return results for assets `data` and `cog`.", "value": [ "data|bidx=1", "cog|bidx=1,2" ] } } } ], "responses": { "200": { "description": "Return dataset's basic info or the list of available assets.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/rio_tiler__models__Info" }, "title": "Response .Stac.Getinfo" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/stac/info.geojson": { "get": { "tags": [ "SpatioTemporal Asset Catalog" ], "summary": "Info Geojson", "description": "Return dataset's basic info as a GeoJSON feature.", "operationId": ".stac.getInfoGeoJSON", "parameters": [ { "name": "url", "in": "query", "required": true, "schema": { "type": "string", "description": "Dataset URL", "title": "Url" }, "description": "Dataset URL" }, { "name": "assets", "in": "query", "required": true, "schema": { "type": "array", "items": { "type": "string" }, "title": "Asset names", "description": "Asset's names." }, "description": "Asset's names.", "examples": { "user-provided": {}, "one-asset": { "description": "Return results for asset `data`.", "value": [ "data" ] }, "multi-assets": { "description": "Return results for assets `data` and `cog`.", "value": [ "data", "cog" ] }, "multi-assets-with-options": { "description": "Return results for assets `data` and `cog`.", "value": [ "data|bidx=1", "cog|bidx=1,2" ] } } }, { "name": "crs", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Coordinate Reference System.", "title": "Crs" }, "description": "Coordinate Reference System." } ], "responses": { "200": { "description": "Return dataset's basic info as a GeoJSON feature.", "content": { "application/geo+json": { "schema": { "$ref": "#/components/schemas/Feature_Union_Polygon__MultiPolygon__dict_str__Info__" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/stac/assets": { "get": { "tags": [ "SpatioTemporal Asset Catalog" ], "summary": "Available Assets", "description": "Return a list of supported assets.", "operationId": ".stac.getAssets", "parameters": [ { "name": "url", "in": "query", "required": true, "schema": { "type": "string", "description": "Dataset URL", "title": "Url" }, "description": "Dataset URL" } ], "responses": { "200": { "description": "Return a list of supported assets.", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "string" }, "title": "Response .Stac.Getassets" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/stac/asset_statistics": { "get": { "tags": [ "SpatioTemporal Asset Catalog" ], "summary": "Asset Statistics", "description": "Per Asset statistics", "operationId": ".stac.getAssetsStatistics", "parameters": [ { "name": "url", "in": "query", "required": true, "schema": { "type": "string", "description": "Dataset URL", "title": "Url" }, "description": "Dataset URL" }, { "name": "assets", "in": "query", "required": true, "schema": { "type": "array", "items": { "type": "string" }, "title": "Asset names", "description": "Asset's names." }, "description": "Asset's names.", "examples": { "user-provided": {}, "one-asset": { "description": "Return results for asset `data`.", "value": [ "data" ] }, "multi-assets": { "description": "Return results for assets `data` and `cog`.", "value": [ "data", "cog" ] }, "multi-assets-with-options": { "description": "Return results for assets `data` and `cog`.", "value": [ "data|bidx=1", "cog|bidx=1,2" ] } } }, { "name": "nodata", "in": "query", "required": false, "schema": { "anyOf": [ { "enum": [ "nan", "inf", "-inf" ], "type": "string" }, { "type": "integer" }, { "type": "number" }, { "type": "null" } ], "title": "Nodata value", "description": "Overwrite internal Nodata value; nan or valid float values only." }, "description": "Overwrite internal Nodata value; nan or valid float values only." }, { "name": "unscale", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Apply internal Scale/Offset", "description": "Apply internal Scale/Offset. Defaults to `False`." }, "description": "Apply internal Scale/Offset. Defaults to `False`." }, { "name": "resampling", "in": "query", "required": false, "schema": { "anyOf": [ { "enum": [ "nearest", "bilinear", "cubic", "cubic_spline", "lanczos", "average", "mode", "gauss", "rms" ], "type": "string" }, { "type": "null" } ], "description": "RasterIO resampling algorithm. Defaults to `nearest`.", "title": "Resampling" }, "description": "RasterIO resampling algorithm. Defaults to `nearest`." }, { "name": "reproject", "in": "query", "required": false, "schema": { "anyOf": [ { "enum": [ "nearest", "bilinear", "cubic", "cubic_spline", "lanczos", "average", "mode", "max", "min", "med", "q1", "q3", "sum", "rms" ], "type": "string" }, { "type": "null" } ], "description": "WarpKernel resampling algorithm (only used when doing re-projection). Defaults to `nearest`.", "title": "Reproject" }, "description": "WarpKernel resampling algorithm (only used when doing re-projection). Defaults to `nearest`." }, { "name": "max_size", "in": "query", "required": false, "schema": { "type": "integer", "description": "Maximum image size to read onto.", "default": 1024, "title": "Max Size" } }, { "name": "height", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "Force output image height.", "title": "Height" } }, { "name": "width", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "Force output image width.", "title": "Width" } }, { "name": "categorical", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "Return statistics for categorical dataset. Defaults to `False`", "title": "Categorical" }, "description": "Return statistics for categorical dataset. Defaults to `False`" }, { "name": "c", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "array", "items": { "anyOf": [ { "type": "number" }, { "type": "integer" } ] } }, { "type": "null" } ], "title": "Pixels values for categories.", "description": "List of values for which to report counts.", "examples": [ 1, 2, 3 ] }, "description": "List of values for which to report counts." }, { "name": "p", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "array", "items": { "type": "integer" } }, { "type": "null" } ], "title": "Percentile values", "description": "List of percentile values (default to [2, 98]).", "examples": [ 2, 5, 95, 98 ] }, "description": "List of percentile values (default to [2, 98])." }, { "name": "histogram_bins", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "pattern": "^\\d+(,\\d+)*$" }, { "type": "null" } ], "title": "Histogram bins.", "description": "\nDefines the number of equal-width bins in the given range (10, by default).\n\nIf bins is a sequence (comma `,` delimited values), it defines a monotonically increasing array of bin edges, including the rightmost edge, allowing for non-uniform bin widths.\n\nlink: https://numpy.org/doc/stable/reference/generated/numpy.histogram.html\n " }, "description": "\nDefines the number of equal-width bins in the given range (10, by default).\n\nIf bins is a sequence (comma `,` delimited values), it defines a monotonically increasing array of bin edges, including the rightmost edge, allowing for non-uniform bin widths.\n\nlink: https://numpy.org/doc/stable/reference/generated/numpy.histogram.html\n ", "examples": { "user-provided": {}, "simple": { "description": "Defines the number of equal-width bins", "value": 8 }, "array": { "description": "Defines custom bin edges (comma `,` delimited values)", "value": "0,100,200,300" } } }, { "name": "histogram_range", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "pattern": "^\\s*(-)?\\d+((\\.\\d+)(e\\d+)?)?\\s*,\\s*(-)?\\d+((\\.\\d+)(e\\d+)?)?\\s*$" }, { "type": "null" } ], "title": "Histogram range", "description": "\nComma `,` delimited range of the bins.\n\nThe lower and upper range of the bins. If not provided, range is simply (a.min(), a.max()).\n\nValues outside the range are ignored. The first element of the range must be less than or equal to the second.\nrange affects the automatic bin computation as well.\n\nlink: https://numpy.org/doc/stable/reference/generated/numpy.histogram.html\n " }, "description": "\nComma `,` delimited range of the bins.\n\nThe lower and upper range of the bins. If not provided, range is simply (a.min(), a.max()).\n\nValues outside the range are ignored. The first element of the range must be less than or equal to the second.\nrange affects the automatic bin computation as well.\n\nlink: https://numpy.org/doc/stable/reference/generated/numpy.histogram.html\n ", "examples": { "user-provided": {}, "array": { "description": "Defines custom histogram range (comma `,` delimited values)", "value": "0,1000" } } } ], "responses": { "200": { "description": "Return dataset's statistics.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/BandStatistics" } }, "title": "Response .Stac.Getassetsstatistics" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/stac/statistics": { "get": { "tags": [ "SpatioTemporal Asset Catalog" ], "summary": "Statistics", "description": "Merged assets statistics.", "operationId": ".stac.getStatistics", "parameters": [ { "name": "url", "in": "query", "required": true, "schema": { "type": "string", "description": "Dataset URL", "title": "Url" }, "description": "Dataset URL" }, { "name": "assets", "in": "query", "required": true, "schema": { "type": "array", "items": { "type": "string" }, "title": "Asset names", "description": "Asset's names." }, "description": "Asset's names.", "examples": { "user-provided": {}, "one-asset": { "description": "Return results for asset `data`.", "value": [ "data" ] }, "multi-assets": { "description": "Return results for assets `data` and `cog`.", "value": [ "data", "cog" ] }, "multi-assets-with-options": { "description": "Return results for assets `data` and `cog`.", "value": [ "data|bidx=1", "cog|bidx=1,2" ] } } }, { "name": "expression", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Band Math expression", "description": "rio-tiler's band math expression" }, "description": "rio-tiler's band math expression", "examples": { "user-provided": {}, "simple": { "description": "Simple band math.", "value": "b1/b2" }, "multi-bands": { "description": "Semicolon (;) delimited expressions (band1: b1/b2, band2: b2+b3).", "value": "b1/b2;b2+b3" } } }, { "name": "asset_as_band", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Consider asset as a 1 band dataset", "description": "Asset as Band" }, "description": "Asset as Band" }, { "name": "nodata", "in": "query", "required": false, "schema": { "anyOf": [ { "enum": [ "nan", "inf", "-inf" ], "type": "string" }, { "type": "integer" }, { "type": "number" }, { "type": "null" } ], "title": "Nodata value", "description": "Overwrite internal Nodata value; nan or valid float values only." }, "description": "Overwrite internal Nodata value; nan or valid float values only." }, { "name": "unscale", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Apply internal Scale/Offset", "description": "Apply internal Scale/Offset. Defaults to `False`." }, "description": "Apply internal Scale/Offset. Defaults to `False`." }, { "name": "resampling", "in": "query", "required": false, "schema": { "anyOf": [ { "enum": [ "nearest", "bilinear", "cubic", "cubic_spline", "lanczos", "average", "mode", "gauss", "rms" ], "type": "string" }, { "type": "null" } ], "description": "RasterIO resampling algorithm. Defaults to `nearest`.", "title": "Resampling" }, "description": "RasterIO resampling algorithm. Defaults to `nearest`." }, { "name": "reproject", "in": "query", "required": false, "schema": { "anyOf": [ { "enum": [ "nearest", "bilinear", "cubic", "cubic_spline", "lanczos", "average", "mode", "max", "min", "med", "q1", "q3", "sum", "rms" ], "type": "string" }, { "type": "null" } ], "description": "WarpKernel resampling algorithm (only used when doing re-projection). Defaults to `nearest`.", "title": "Reproject" }, "description": "WarpKernel resampling algorithm (only used when doing re-projection). Defaults to `nearest`." }, { "name": "max_size", "in": "query", "required": false, "schema": { "type": "integer", "description": "Maximum image size to read onto.", "default": 1024, "title": "Max Size" } }, { "name": "height", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "Force output image height.", "title": "Height" } }, { "name": "width", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "Force output image width.", "title": "Width" } }, { "name": "algorithm", "in": "query", "required": false, "schema": { "enum": [ "hillshade", "slope", "contours", "normalizedIndex", "terrarium", "terrainrgb", "cast", "ceil", "floor", "min", "max", "median", "mean", "std", "var", "sum", "grayscale", "bitonal" ], "type": "string", "description": "Algorithm name", "title": "Algorithm" }, "description": "Algorithm name" }, { "name": "algorithm_params", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Algorithm parameter", "title": "Algorithm Params" }, "description": "Algorithm parameter" }, { "name": "categorical", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "Return statistics for categorical dataset. Defaults to `False`", "title": "Categorical" }, "description": "Return statistics for categorical dataset. Defaults to `False`" }, { "name": "c", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "array", "items": { "anyOf": [ { "type": "number" }, { "type": "integer" } ] } }, { "type": "null" } ], "title": "Pixels values for categories.", "description": "List of values for which to report counts.", "examples": [ 1, 2, 3 ] }, "description": "List of values for which to report counts." }, { "name": "p", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "array", "items": { "type": "integer" } }, { "type": "null" } ], "title": "Percentile values", "description": "List of percentile values (default to [2, 98]).", "examples": [ 2, 5, 95, 98 ] }, "description": "List of percentile values (default to [2, 98])." }, { "name": "histogram_bins", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "pattern": "^\\d+(,\\d+)*$" }, { "type": "null" } ], "title": "Histogram bins.", "description": "\nDefines the number of equal-width bins in the given range (10, by default).\n\nIf bins is a sequence (comma `,` delimited values), it defines a monotonically increasing array of bin edges, including the rightmost edge, allowing for non-uniform bin widths.\n\nlink: https://numpy.org/doc/stable/reference/generated/numpy.histogram.html\n " }, "description": "\nDefines the number of equal-width bins in the given range (10, by default).\n\nIf bins is a sequence (comma `,` delimited values), it defines a monotonically increasing array of bin edges, including the rightmost edge, allowing for non-uniform bin widths.\n\nlink: https://numpy.org/doc/stable/reference/generated/numpy.histogram.html\n ", "examples": { "user-provided": {}, "simple": { "description": "Defines the number of equal-width bins", "value": 8 }, "array": { "description": "Defines custom bin edges (comma `,` delimited values)", "value": "0,100,200,300" } } }, { "name": "histogram_range", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "pattern": "^\\s*(-)?\\d+((\\.\\d+)(e\\d+)?)?\\s*,\\s*(-)?\\d+((\\.\\d+)(e\\d+)?)?\\s*$" }, { "type": "null" } ], "title": "Histogram range", "description": "\nComma `,` delimited range of the bins.\n\nThe lower and upper range of the bins. If not provided, range is simply (a.min(), a.max()).\n\nValues outside the range are ignored. The first element of the range must be less than or equal to the second.\nrange affects the automatic bin computation as well.\n\nlink: https://numpy.org/doc/stable/reference/generated/numpy.histogram.html\n " }, "description": "\nComma `,` delimited range of the bins.\n\nThe lower and upper range of the bins. If not provided, range is simply (a.min(), a.max()).\n\nValues outside the range are ignored. The first element of the range must be less than or equal to the second.\nrange affects the automatic bin computation as well.\n\nlink: https://numpy.org/doc/stable/reference/generated/numpy.histogram.html\n ", "examples": { "user-provided": {}, "array": { "description": "Defines custom histogram range (comma `,` delimited values)", "value": "0,1000" } } } ], "responses": { "200": { "description": "Return dataset's statistics.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/BandStatistics" }, "title": "Response .Stac.Getstatistics" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "post": { "tags": [ "SpatioTemporal Asset Catalog" ], "summary": "Geojson Statistics", "description": "Get Statistics from a geojson feature or featureCollection.", "operationId": ".stac.postStatisticsForGeoJSON", "parameters": [ { "name": "url", "in": "query", "required": true, "schema": { "type": "string", "description": "Dataset URL", "title": "Url" }, "description": "Dataset URL" }, { "name": "assets", "in": "query", "required": true, "schema": { "type": "array", "items": { "type": "string" }, "title": "Asset names", "description": "Asset's names." }, "description": "Asset's names.", "examples": { "user-provided": {}, "one-asset": { "description": "Return results for asset `data`.", "value": [ "data" ] }, "multi-assets": { "description": "Return results for assets `data` and `cog`.", "value": [ "data", "cog" ] }, "multi-assets-with-options": { "description": "Return results for assets `data` and `cog`.", "value": [ "data|bidx=1", "cog|bidx=1,2" ] } } }, { "name": "expression", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Band Math expression", "description": "rio-tiler's band math expression" }, "description": "rio-tiler's band math expression", "examples": { "user-provided": {}, "simple": { "description": "Simple band math.", "value": "b1/b2" }, "multi-bands": { "description": "Semicolon (;) delimited expressions (band1: b1/b2, band2: b2+b3).", "value": "b1/b2;b2+b3" } } }, { "name": "asset_as_band", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Consider asset as a 1 band dataset", "description": "Asset as Band" }, "description": "Asset as Band" }, { "name": "nodata", "in": "query", "required": false, "schema": { "anyOf": [ { "enum": [ "nan", "inf", "-inf" ], "type": "string" }, { "type": "integer" }, { "type": "number" }, { "type": "null" } ], "title": "Nodata value", "description": "Overwrite internal Nodata value; nan or valid float values only." }, "description": "Overwrite internal Nodata value; nan or valid float values only." }, { "name": "unscale", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Apply internal Scale/Offset", "description": "Apply internal Scale/Offset. Defaults to `False`." }, "description": "Apply internal Scale/Offset. Defaults to `False`." }, { "name": "resampling", "in": "query", "required": false, "schema": { "anyOf": [ { "enum": [ "nearest", "bilinear", "cubic", "cubic_spline", "lanczos", "average", "mode", "gauss", "rms" ], "type": "string" }, { "type": "null" } ], "description": "RasterIO resampling algorithm. Defaults to `nearest`.", "title": "Resampling" }, "description": "RasterIO resampling algorithm. Defaults to `nearest`." }, { "name": "reproject", "in": "query", "required": false, "schema": { "anyOf": [ { "enum": [ "nearest", "bilinear", "cubic", "cubic_spline", "lanczos", "average", "mode", "max", "min", "med", "q1", "q3", "sum", "rms" ], "type": "string" }, { "type": "null" } ], "description": "WarpKernel resampling algorithm (only used when doing re-projection). Defaults to `nearest`.", "title": "Reproject" }, "description": "WarpKernel resampling algorithm (only used when doing re-projection). Defaults to `nearest`." }, { "name": "coord_crs", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Coordinate Reference System of the input coords. Default to `epsg:4326`.", "title": "Coord Crs" }, "description": "Coordinate Reference System of the input coords. Default to `epsg:4326`." }, { "name": "dst_crs", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Output Coordinate Reference System.", "title": "Dst Crs" }, "description": "Output Coordinate Reference System." }, { "name": "algorithm", "in": "query", "required": false, "schema": { "enum": [ "hillshade", "slope", "contours", "normalizedIndex", "terrarium", "terrainrgb", "cast", "ceil", "floor", "min", "max", "median", "mean", "std", "var", "sum", "grayscale", "bitonal" ], "type": "string", "description": "Algorithm name", "title": "Algorithm" }, "description": "Algorithm name" }, { "name": "algorithm_params", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Algorithm parameter", "title": "Algorithm Params" }, "description": "Algorithm parameter" }, { "name": "max_size", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "Maximum image size to read onto.", "title": "Max Size" } }, { "name": "height", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "Force output image height.", "title": "Height" } }, { "name": "width", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "Force output image width.", "title": "Width" } }, { "name": "cover_scale", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "integer", "maximum": 1000, "exclusiveMinimum": 0 }, { "type": "null" } ], "description": "Scale used when generating coverage estimates of each\n raster cell by vector feature. Coverage is generated by\n rasterizing the feature at a finer resolution than the raster then using a summation to aggregate\n to the raster resolution and dividing by the square of cover_scale\n to get coverage value for each cell. Increasing cover_scale\n will increase the accuracy of coverage values; three orders\n magnitude finer resolution (cover_scale=1000) is usually enough to\n get coverage estimates with <1% error in individual edge cells coverage\n estimates, though much smaller values (e.g., cover_scale=10) are often\n sufficient (<10% error) and require less memory. Defaults to `10`.", "title": "Cover Scale" }, "description": "Scale used when generating coverage estimates of each\n raster cell by vector feature. Coverage is generated by\n rasterizing the feature at a finer resolution than the raster then using a summation to aggregate\n to the raster resolution and dividing by the square of cover_scale\n to get coverage value for each cell. Increasing cover_scale\n will increase the accuracy of coverage values; three orders\n magnitude finer resolution (cover_scale=1000) is usually enough to\n get coverage estimates with <1% error in individual edge cells coverage\n estimates, though much smaller values (e.g., cover_scale=10) are often\n sufficient (<10% error) and require less memory. Defaults to `10`." }, { "name": "categorical", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "Return statistics for categorical dataset. Defaults to `False`", "title": "Categorical" }, "description": "Return statistics for categorical dataset. Defaults to `False`" }, { "name": "c", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "array", "items": { "anyOf": [ { "type": "number" }, { "type": "integer" } ] } }, { "type": "null" } ], "title": "Pixels values for categories.", "description": "List of values for which to report counts.", "examples": [ 1, 2, 3 ] }, "description": "List of values for which to report counts." }, { "name": "p", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "array", "items": { "type": "integer" } }, { "type": "null" } ], "title": "Percentile values", "description": "List of percentile values (default to [2, 98]).", "examples": [ 2, 5, 95, 98 ] }, "description": "List of percentile values (default to [2, 98])." }, { "name": "histogram_bins", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "pattern": "^\\d+(,\\d+)*$" }, { "type": "null" } ], "title": "Histogram bins.", "description": "\nDefines the number of equal-width bins in the given range (10, by default).\n\nIf bins is a sequence (comma `,` delimited values), it defines a monotonically increasing array of bin edges, including the rightmost edge, allowing for non-uniform bin widths.\n\nlink: https://numpy.org/doc/stable/reference/generated/numpy.histogram.html\n " }, "description": "\nDefines the number of equal-width bins in the given range (10, by default).\n\nIf bins is a sequence (comma `,` delimited values), it defines a monotonically increasing array of bin edges, including the rightmost edge, allowing for non-uniform bin widths.\n\nlink: https://numpy.org/doc/stable/reference/generated/numpy.histogram.html\n ", "examples": { "user-provided": {}, "simple": { "description": "Defines the number of equal-width bins", "value": 8 }, "array": { "description": "Defines custom bin edges (comma `,` delimited values)", "value": "0,100,200,300" } } }, { "name": "histogram_range", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "pattern": "^\\s*(-)?\\d+((\\.\\d+)(e\\d+)?)?\\s*,\\s*(-)?\\d+((\\.\\d+)(e\\d+)?)?\\s*$" }, { "type": "null" } ], "title": "Histogram range", "description": "\nComma `,` delimited range of the bins.\n\nThe lower and upper range of the bins. If not provided, range is simply (a.min(), a.max()).\n\nValues outside the range are ignored. The first element of the range must be less than or equal to the second.\nrange affects the automatic bin computation as well.\n\nlink: https://numpy.org/doc/stable/reference/generated/numpy.histogram.html\n " }, "description": "\nComma `,` delimited range of the bins.\n\nThe lower and upper range of the bins. If not provided, range is simply (a.min(), a.max()).\n\nValues outside the range are ignored. The first element of the range must be less than or equal to the second.\nrange affects the automatic bin computation as well.\n\nlink: https://numpy.org/doc/stable/reference/generated/numpy.histogram.html\n ", "examples": { "user-provided": {}, "array": { "description": "Defines custom histogram range (comma `,` delimited values)", "value": "0,1000" } } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/FeatureCollection" }, { "$ref": "#/components/schemas/Feature-Input" } ], "description": "GeoJSON Feature or FeatureCollection.", "title": "Geojson" } } } }, "responses": { "200": { "description": "Return dataset's statistics from feature or featureCollection.", "content": { "application/geo+json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/FeatureCollection_Feature_Annotated_Union_Point__MultiPoint__LineString__MultiLineString__Polygon__MultiPolygon__GeometryCollection___FieldInfo_annotation_NoneType__required_True__discriminator__type_____StatisticsInGeoJSON__" }, { "$ref": "#/components/schemas/Feature_Annotated_Union_Point__MultiPoint__LineString__MultiLineString__Polygon__MultiPolygon__GeometryCollection___FieldInfo_annotation_NoneType__required_True__discriminator__type____StatisticsInGeoJSON_" } ], "title": "Response .Stac.Poststatisticsforgeojson" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/stac/tiles": { "get": { "tags": [ "SpatioTemporal Asset Catalog" ], "summary": "Retrieve a list of available raster tilesets for the specified dataset.", "description": "Retrieve a list of available raster tilesets for the specified dataset.", "operationId": ".stac.getTileSetList", "parameters": [ { "name": "f", "in": "query", "required": false, "schema": { "anyOf": [ { "enum": [ "html", "json" ], "type": "string" }, { "type": "null" } ], "description": "Response MediaType. Defaults to endpoint's default or value defined in `accept` header.", "title": "F" }, "description": "Response MediaType. Defaults to endpoint's default or value defined in `accept` header." }, { "name": "url", "in": "query", "required": true, "schema": { "type": "string", "description": "Dataset URL", "title": "Url" }, "description": "Dataset URL" }, { "name": "crs", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Coordinate Reference System.", "title": "Crs" }, "description": "Coordinate Reference System." } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TileSetList" } }, "text/html": {} } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/stac/tiles/{tileMatrixSetId}": { "get": { "tags": [ "SpatioTemporal Asset Catalog" ], "summary": "Retrieve the raster tileset metadata for the specified dataset and tiling scheme (tile matrix set).", "description": "Retrieve the raster tileset metadata for the specified dataset and tiling scheme (tile matrix set).", "operationId": ".stac.getTileSet", "parameters": [ { "name": "tileMatrixSetId", "in": "path", "required": true, "schema": { "enum": [ "CDB1GlobalGrid", "CanadianNAD83_LCC", "EuropeanETRS89_LAEAQuad", "GNOSISGlobalGrid", "LINZAntarticaMapTilegrid", "NZTM2000Quad", "UPSAntarcticWGS84Quad", "UPSArcticWGS84Quad", "UTM31WGS84Quad", "WGS1984Quad", "WebMercatorQuad", "WorldCRS84Quad", "WorldMercatorWGS84Quad" ], "type": "string", "description": "Identifier selecting one of the TileMatrixSetId supported.", "title": "Tilematrixsetid" }, "description": "Identifier selecting one of the TileMatrixSetId supported." }, { "name": "minzoom", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "Overwrite default minzoom.", "title": "Minzoom" }, "description": "Overwrite default minzoom." }, { "name": "maxzoom", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "Overwrite default maxzoom.", "title": "Maxzoom" }, "description": "Overwrite default maxzoom." }, { "name": "f", "in": "query", "required": false, "schema": { "anyOf": [ { "enum": [ "html", "json" ], "type": "string" }, { "type": "null" } ], "description": "Response MediaType. Defaults to endpoint's default or value defined in `accept` header.", "title": "F" }, "description": "Response MediaType. Defaults to endpoint's default or value defined in `accept` header." }, { "name": "url", "in": "query", "required": true, "schema": { "type": "string", "description": "Dataset URL", "title": "Url" }, "description": "Dataset URL" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TileSet" } }, "text/html": {} } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/stac/tiles/{tileMatrixSetId}/{z}/{x}/{y}.{format}": { "get": { "tags": [ "SpatioTemporal Asset Catalog" ], "summary": "Tile", "description": "Create map tile from a dataset.", "operationId": ".stac.getTileWithFormat", "parameters": [ { "name": "z", "in": "path", "required": true, "schema": { "type": "integer", "description": "Identifier (Z) selecting one of the scales defined in the TileMatrixSet and representing the scaleDenominator the tile.", "title": "Z" }, "description": "Identifier (Z) selecting one of the scales defined in the TileMatrixSet and representing the scaleDenominator the tile." }, { "name": "x", "in": "path", "required": true, "schema": { "type": "integer", "description": "Column (X) index of the tile on the selected TileMatrix. It cannot exceed the MatrixHeight-1 for the selected TileMatrix.", "title": "X" }, "description": "Column (X) index of the tile on the selected TileMatrix. It cannot exceed the MatrixHeight-1 for the selected TileMatrix." }, { "name": "y", "in": "path", "required": true, "schema": { "type": "integer", "description": "Row (Y) index of the tile on the selected TileMatrix. It cannot exceed the MatrixWidth-1 for the selected TileMatrix.", "title": "Y" }, "description": "Row (Y) index of the tile on the selected TileMatrix. It cannot exceed the MatrixWidth-1 for the selected TileMatrix." }, { "name": "tileMatrixSetId", "in": "path", "required": true, "schema": { "enum": [ "CDB1GlobalGrid", "CanadianNAD83_LCC", "EuropeanETRS89_LAEAQuad", "GNOSISGlobalGrid", "LINZAntarticaMapTilegrid", "NZTM2000Quad", "UPSAntarcticWGS84Quad", "UPSArcticWGS84Quad", "UTM31WGS84Quad", "WGS1984Quad", "WebMercatorQuad", "WorldCRS84Quad", "WorldMercatorWGS84Quad" ], "type": "string", "description": "Identifier selecting one of the TileMatrixSetId supported.", "title": "Tilematrixsetid" }, "description": "Identifier selecting one of the TileMatrixSetId supported." }, { "name": "format", "in": "path", "required": true, "schema": { "anyOf": [ { "$ref": "#/components/schemas/ImageType" }, { "type": "null" } ], "description": "Default will be automatically defined if the output image needs a mask (png) or not (jpeg).", "title": "Format" } }, { "name": "tilesize", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "integer", "exclusiveMinimum": 0 }, { "type": "null" } ], "description": "Tilesize in pixels.", "title": "Tilesize" }, "description": "Tilesize in pixels." }, { "name": "url", "in": "query", "required": true, "schema": { "type": "string", "description": "Dataset URL", "title": "Url" }, "description": "Dataset URL" }, { "name": "buffer", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "number", "exclusiveMinimum": 0 }, { "type": "null" } ], "title": "Tile buffer.", "description": "Buffer on each side of the given tile. It must be a multiple of `0.5`. Output **tilesize** will be expanded to `tilesize + 2 * buffer` (e.g 0.5 = 257x257, 1.0 = 258x258)." }, "description": "Buffer on each side of the given tile. It must be a multiple of `0.5`. Output **tilesize** will be expanded to `tilesize + 2 * buffer` (e.g 0.5 = 257x257, 1.0 = 258x258)." }, { "name": "padding", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "integer", "exclusiveMinimum": 0 }, { "type": "null" } ], "title": "Tile padding.", "description": "Padding to apply to each tile edge. Helps reduce resampling artefacts along edges. Defaults to `0`." }, "description": "Padding to apply to each tile edge. Helps reduce resampling artefacts along edges. Defaults to `0`." }, { "name": "assets", "in": "query", "required": true, "schema": { "type": "array", "items": { "type": "string" }, "title": "Asset names", "description": "Asset's names." }, "description": "Asset's names.", "examples": { "user-provided": {}, "one-asset": { "description": "Return results for asset `data`.", "value": [ "data" ] }, "multi-assets": { "description": "Return results for assets `data` and `cog`.", "value": [ "data", "cog" ] }, "multi-assets-with-options": { "description": "Return results for assets `data` and `cog`.", "value": [ "data|bidx=1", "cog|bidx=1,2" ] } } }, { "name": "expression", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Band Math expression", "description": "rio-tiler's band math expression" }, "description": "rio-tiler's band math expression", "examples": { "user-provided": {}, "simple": { "description": "Simple band math.", "value": "b1/b2" }, "multi-bands": { "description": "Semicolon (;) delimited expressions (band1: b1/b2, band2: b2+b3).", "value": "b1/b2;b2+b3" } } }, { "name": "asset_as_band", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Consider asset as a 1 band dataset", "description": "Asset as Band" }, "description": "Asset as Band" }, { "name": "nodata", "in": "query", "required": false, "schema": { "anyOf": [ { "enum": [ "nan", "inf", "-inf" ], "type": "string" }, { "type": "integer" }, { "type": "number" }, { "type": "null" } ], "title": "Nodata value", "description": "Overwrite internal Nodata value; nan or valid float values only." }, "description": "Overwrite internal Nodata value; nan or valid float values only." }, { "name": "unscale", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Apply internal Scale/Offset", "description": "Apply internal Scale/Offset. Defaults to `False`." }, "description": "Apply internal Scale/Offset. Defaults to `False`." }, { "name": "resampling", "in": "query", "required": false, "schema": { "anyOf": [ { "enum": [ "nearest", "bilinear", "cubic", "cubic_spline", "lanczos", "average", "mode", "gauss", "rms" ], "type": "string" }, { "type": "null" } ], "description": "RasterIO resampling algorithm. Defaults to `nearest`.", "title": "Resampling" }, "description": "RasterIO resampling algorithm. Defaults to `nearest`." }, { "name": "reproject", "in": "query", "required": false, "schema": { "anyOf": [ { "enum": [ "nearest", "bilinear", "cubic", "cubic_spline", "lanczos", "average", "mode", "max", "min", "med", "q1", "q3", "sum", "rms" ], "type": "string" }, { "type": "null" } ], "description": "WarpKernel resampling algorithm (only used when doing re-projection). Defaults to `nearest`.", "title": "Reproject" }, "description": "WarpKernel resampling algorithm (only used when doing re-projection). Defaults to `nearest`." }, { "name": "algorithm", "in": "query", "required": false, "schema": { "enum": [ "hillshade", "slope", "contours", "normalizedIndex", "terrarium", "terrainrgb", "cast", "ceil", "floor", "min", "max", "median", "mean", "std", "var", "sum", "grayscale", "bitonal" ], "type": "string", "description": "Algorithm name", "title": "Algorithm" }, "description": "Algorithm name" }, { "name": "algorithm_params", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Algorithm parameter", "title": "Algorithm Params" }, "description": "Algorithm parameter" }, { "name": "colormap_name", "in": "query", "required": false, "schema": { "enum": [ "jet_r", "haline", "gist_ncar_r", "algae", "cividis_r", "seismic_r", "pink_r", "rdylbu", "inferno_r", "deep", "rdgy_r", "tab10", "bugn_r", "ocean_r", "purples", "pastel1_r", "thermal_r", "ylorrd_r", "wistia_r", "cmrmap", "pubu", "rain", "ylgnbu", "gnuplot", "gnbu", "gist_gray_r", "greens", "purd_r", "oxy_r", "matter", "summer_r", "gnuplot_r", "gnuplot2", "solar", "jet", "ylgn_r", "dark2_r", "spring", "tab20c", "gist_stern", "bwr", "ylgn", "plasma", "pastel2", "blues_r", "rain_r", "set1", "topo_r", "gist_ncar", "turbid", "magma_r", "pastel2_r", "purd", "gnbu_r", "spring_r", "rdbu_r", "ylorbr", "twilight_shifted", "rplumbo", "winter_r", "tab20b", "ylorrd", "copper", "flag_r", "afmhot", "twilight_shifted_r", "oranges_r", "bone", "seismic", "gray_r", "tarn_r", "bwr_r", "magma", "paired_r", "dark2", "binary", "set3", "viridis_r", "spectral", "prgn", "diff", "hot", "gist_earth", "cubehelix", "dense_r", "coolwarm", "pubugn_r", "autumn_r", "gnuplot2_r", "cividis", "bugn", "deep_r", "prgn_r", "gist_rainbow", "gist_heat_r", "nipy_spectral_r", "tab20", "turbo_r", "pubugn", "set2_r", "gist_yarg_r", "spectral_r", "binary_r", "greys", "rainbow_r", "haline_r", "curl", "tab20c_r", "blues", "prism", "rdgy", "gist_gray", "set2", "cool", "afmhot_r", "bone_r", "paired", "oranges", "orrd", "puor", "autumn", "delta_r", "pubu_r", "piyg_r", "turbo", "greys_r", "accent", "turbid_r", "algae_r", "solar_r", "topo", "cool_r", "inferno", "balance", "tempo_r", "amp_r", "flag", "speed", "gist_heat", "balance_r", "viridis", "cubehelix_r", "ylorbr_r", "summer", "coolwarm_r", "diff_r", "rdylgn_r", "gist_stern_r", "plasma_r", "copper_r", "oxy", "gist_yarg", "twilight", "winter", "brbg", "reds_r", "speed_r", "rainbow", "ice", "nipy_spectral", "piyg", "gray", "reds", "terrain", "tab20_r", "wistia", "accent_r", "thermal", "ocean", "twilight_r", "hot_r", "set3_r", "hsv_r", "brg_r", "gist_rainbow_r", "phase", "bupu", "pastel1", "dense", "set1_r", "phase_r", "matter_r", "greens_r", "cfastie", "tab10_r", "rdbu", "brg", "rdpu_r", "brbg_r", "cmrmap_r", "prism_r", "purples_r", "gist_earth_r", "tempo", "schwarzwald", "rdpu", "orrd_r", "tarn", "puor_r", "bupu_r", "rdylgn", "ice_r", "pink", "terrain_r", "amp", "tab20b_r", "rdylbu_r", "hsv", "curl_r", "delta", "ylgnbu_r" ], "type": "string", "description": "Colormap name", "title": "Colormap Name" }, "description": "Colormap name" }, { "name": "colormap", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "JSON encoded custom Colormap", "title": "Colormap" }, "description": "JSON encoded custom Colormap" }, { "name": "rescale", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ], "title": "Min/Max data Rescaling", "description": "comma (',') delimited Min,Max range. Can set multiple time for multiple bands.", "examples": [ "0,2000", "0,1000", "0,10000" ] }, "description": "comma (',') delimited Min,Max range. Can set multiple time for multiple bands." }, { "name": "color_formula", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Color Formula", "description": "rio-color formula (info: https://github.com/mapbox/rio-color)" }, "description": "rio-color formula (info: https://github.com/mapbox/rio-color)" }, { "name": "return_mask", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "Add mask to the output data. Defaults to `True`", "title": "Return Mask" }, "description": "Add mask to the output data. Defaults to `True`" } ], "responses": { "200": { "description": "Return an image.", "content": { "image/png": {}, "image/jpeg": {}, "image/jpg": {}, "image/webp": {}, "image/jp2": {}, "image/tiff; application=geotiff": {}, "application/x-binary": {} } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/stac/tiles/{tileMatrixSetId}/{z}/{x}/{y}": { "get": { "tags": [ "SpatioTemporal Asset Catalog" ], "summary": "Tile", "description": "Create map tile from a dataset.", "operationId": ".stac.getTile", "parameters": [ { "name": "z", "in": "path", "required": true, "schema": { "type": "integer", "description": "Identifier (Z) selecting one of the scales defined in the TileMatrixSet and representing the scaleDenominator the tile.", "title": "Z" }, "description": "Identifier (Z) selecting one of the scales defined in the TileMatrixSet and representing the scaleDenominator the tile." }, { "name": "x", "in": "path", "required": true, "schema": { "type": "integer", "description": "Column (X) index of the tile on the selected TileMatrix. It cannot exceed the MatrixHeight-1 for the selected TileMatrix.", "title": "X" }, "description": "Column (X) index of the tile on the selected TileMatrix. It cannot exceed the MatrixHeight-1 for the selected TileMatrix." }, { "name": "y", "in": "path", "required": true, "schema": { "type": "integer", "description": "Row (Y) index of the tile on the selected TileMatrix. It cannot exceed the MatrixWidth-1 for the selected TileMatrix.", "title": "Y" }, "description": "Row (Y) index of the tile on the selected TileMatrix. It cannot exceed the MatrixWidth-1 for the selected TileMatrix." }, { "name": "tileMatrixSetId", "in": "path", "required": true, "schema": { "enum": [ "CDB1GlobalGrid", "CanadianNAD83_LCC", "EuropeanETRS89_LAEAQuad", "GNOSISGlobalGrid", "LINZAntarticaMapTilegrid", "NZTM2000Quad", "UPSAntarcticWGS84Quad", "UPSArcticWGS84Quad", "UTM31WGS84Quad", "WGS1984Quad", "WebMercatorQuad", "WorldCRS84Quad", "WorldMercatorWGS84Quad" ], "type": "string", "description": "Identifier selecting one of the TileMatrixSetId supported.", "title": "Tilematrixsetid" }, "description": "Identifier selecting one of the TileMatrixSetId supported." }, { "name": "format", "in": "query", "required": false, "schema": { "anyOf": [ { "$ref": "#/components/schemas/ImageType" }, { "type": "null" } ], "description": "Default will be automatically defined if the output image needs a mask (png) or not (jpeg).", "title": "Format" } }, { "name": "tilesize", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "integer", "exclusiveMinimum": 0 }, { "type": "null" } ], "description": "Tilesize in pixels.", "title": "Tilesize" }, "description": "Tilesize in pixels." }, { "name": "url", "in": "query", "required": true, "schema": { "type": "string", "description": "Dataset URL", "title": "Url" }, "description": "Dataset URL" }, { "name": "buffer", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "number", "exclusiveMinimum": 0 }, { "type": "null" } ], "title": "Tile buffer.", "description": "Buffer on each side of the given tile. It must be a multiple of `0.5`. Output **tilesize** will be expanded to `tilesize + 2 * buffer` (e.g 0.5 = 257x257, 1.0 = 258x258)." }, "description": "Buffer on each side of the given tile. It must be a multiple of `0.5`. Output **tilesize** will be expanded to `tilesize + 2 * buffer` (e.g 0.5 = 257x257, 1.0 = 258x258)." }, { "name": "padding", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "integer", "exclusiveMinimum": 0 }, { "type": "null" } ], "title": "Tile padding.", "description": "Padding to apply to each tile edge. Helps reduce resampling artefacts along edges. Defaults to `0`." }, "description": "Padding to apply to each tile edge. Helps reduce resampling artefacts along edges. Defaults to `0`." }, { "name": "assets", "in": "query", "required": true, "schema": { "type": "array", "items": { "type": "string" }, "title": "Asset names", "description": "Asset's names." }, "description": "Asset's names.", "examples": { "user-provided": {}, "one-asset": { "description": "Return results for asset `data`.", "value": [ "data" ] }, "multi-assets": { "description": "Return results for assets `data` and `cog`.", "value": [ "data", "cog" ] }, "multi-assets-with-options": { "description": "Return results for assets `data` and `cog`.", "value": [ "data|bidx=1", "cog|bidx=1,2" ] } } }, { "name": "expression", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Band Math expression", "description": "rio-tiler's band math expression" }, "description": "rio-tiler's band math expression", "examples": { "user-provided": {}, "simple": { "description": "Simple band math.", "value": "b1/b2" }, "multi-bands": { "description": "Semicolon (;) delimited expressions (band1: b1/b2, band2: b2+b3).", "value": "b1/b2;b2+b3" } } }, { "name": "asset_as_band", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Consider asset as a 1 band dataset", "description": "Asset as Band" }, "description": "Asset as Band" }, { "name": "nodata", "in": "query", "required": false, "schema": { "anyOf": [ { "enum": [ "nan", "inf", "-inf" ], "type": "string" }, { "type": "integer" }, { "type": "number" }, { "type": "null" } ], "title": "Nodata value", "description": "Overwrite internal Nodata value; nan or valid float values only." }, "description": "Overwrite internal Nodata value; nan or valid float values only." }, { "name": "unscale", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Apply internal Scale/Offset", "description": "Apply internal Scale/Offset. Defaults to `False`." }, "description": "Apply internal Scale/Offset. Defaults to `False`." }, { "name": "resampling", "in": "query", "required": false, "schema": { "anyOf": [ { "enum": [ "nearest", "bilinear", "cubic", "cubic_spline", "lanczos", "average", "mode", "gauss", "rms" ], "type": "string" }, { "type": "null" } ], "description": "RasterIO resampling algorithm. Defaults to `nearest`.", "title": "Resampling" }, "description": "RasterIO resampling algorithm. Defaults to `nearest`." }, { "name": "reproject", "in": "query", "required": false, "schema": { "anyOf": [ { "enum": [ "nearest", "bilinear", "cubic", "cubic_spline", "lanczos", "average", "mode", "max", "min", "med", "q1", "q3", "sum", "rms" ], "type": "string" }, { "type": "null" } ], "description": "WarpKernel resampling algorithm (only used when doing re-projection). Defaults to `nearest`.", "title": "Reproject" }, "description": "WarpKernel resampling algorithm (only used when doing re-projection). Defaults to `nearest`." }, { "name": "algorithm", "in": "query", "required": false, "schema": { "enum": [ "hillshade", "slope", "contours", "normalizedIndex", "terrarium", "terrainrgb", "cast", "ceil", "floor", "min", "max", "median", "mean", "std", "var", "sum", "grayscale", "bitonal" ], "type": "string", "description": "Algorithm name", "title": "Algorithm" }, "description": "Algorithm name" }, { "name": "algorithm_params", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Algorithm parameter", "title": "Algorithm Params" }, "description": "Algorithm parameter" }, { "name": "colormap_name", "in": "query", "required": false, "schema": { "enum": [ "jet_r", "haline", "gist_ncar_r", "algae", "cividis_r", "seismic_r", "pink_r", "rdylbu", "inferno_r", "deep", "rdgy_r", "tab10", "bugn_r", "ocean_r", "purples", "pastel1_r", "thermal_r", "ylorrd_r", "wistia_r", "cmrmap", "pubu", "rain", "ylgnbu", "gnuplot", "gnbu", "gist_gray_r", "greens", "purd_r", "oxy_r", "matter", "summer_r", "gnuplot_r", "gnuplot2", "solar", "jet", "ylgn_r", "dark2_r", "spring", "tab20c", "gist_stern", "bwr", "ylgn", "plasma", "pastel2", "blues_r", "rain_r", "set1", "topo_r", "gist_ncar", "turbid", "magma_r", "pastel2_r", "purd", "gnbu_r", "spring_r", "rdbu_r", "ylorbr", "twilight_shifted", "rplumbo", "winter_r", "tab20b", "ylorrd", "copper", "flag_r", "afmhot", "twilight_shifted_r", "oranges_r", "bone", "seismic", "gray_r", "tarn_r", "bwr_r", "magma", "paired_r", "dark2", "binary", "set3", "viridis_r", "spectral", "prgn", "diff", "hot", "gist_earth", "cubehelix", "dense_r", "coolwarm", "pubugn_r", "autumn_r", "gnuplot2_r", "cividis", "bugn", "deep_r", "prgn_r", "gist_rainbow", "gist_heat_r", "nipy_spectral_r", "tab20", "turbo_r", "pubugn", "set2_r", "gist_yarg_r", "spectral_r", "binary_r", "greys", "rainbow_r", "haline_r", "curl", "tab20c_r", "blues", "prism", "rdgy", "gist_gray", "set2", "cool", "afmhot_r", "bone_r", "paired", "oranges", "orrd", "puor", "autumn", "delta_r", "pubu_r", "piyg_r", "turbo", "greys_r", "accent", "turbid_r", "algae_r", "solar_r", "topo", "cool_r", "inferno", "balance", "tempo_r", "amp_r", "flag", "speed", "gist_heat", "balance_r", "viridis", "cubehelix_r", "ylorbr_r", "summer", "coolwarm_r", "diff_r", "rdylgn_r", "gist_stern_r", "plasma_r", "copper_r", "oxy", "gist_yarg", "twilight", "winter", "brbg", "reds_r", "speed_r", "rainbow", "ice", "nipy_spectral", "piyg", "gray", "reds", "terrain", "tab20_r", "wistia", "accent_r", "thermal", "ocean", "twilight_r", "hot_r", "set3_r", "hsv_r", "brg_r", "gist_rainbow_r", "phase", "bupu", "pastel1", "dense", "set1_r", "phase_r", "matter_r", "greens_r", "cfastie", "tab10_r", "rdbu", "brg", "rdpu_r", "brbg_r", "cmrmap_r", "prism_r", "purples_r", "gist_earth_r", "tempo", "schwarzwald", "rdpu", "orrd_r", "tarn", "puor_r", "bupu_r", "rdylgn", "ice_r", "pink", "terrain_r", "amp", "tab20b_r", "rdylbu_r", "hsv", "curl_r", "delta", "ylgnbu_r" ], "type": "string", "description": "Colormap name", "title": "Colormap Name" }, "description": "Colormap name" }, { "name": "colormap", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "JSON encoded custom Colormap", "title": "Colormap" }, "description": "JSON encoded custom Colormap" }, { "name": "rescale", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ], "title": "Min/Max data Rescaling", "description": "comma (',') delimited Min,Max range. Can set multiple time for multiple bands.", "examples": [ "0,2000", "0,1000", "0,10000" ] }, "description": "comma (',') delimited Min,Max range. Can set multiple time for multiple bands." }, { "name": "color_formula", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Color Formula", "description": "rio-color formula (info: https://github.com/mapbox/rio-color)" }, "description": "rio-color formula (info: https://github.com/mapbox/rio-color)" }, { "name": "return_mask", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "Add mask to the output data. Defaults to `True`", "title": "Return Mask" }, "description": "Add mask to the output data. Defaults to `True`" } ], "responses": { "200": { "description": "Return an image.", "content": { "image/png": {}, "image/jpeg": {}, "image/jpg": {}, "image/webp": {}, "image/jp2": {}, "image/tiff; application=geotiff": {}, "application/x-binary": {} } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/stac/{tileMatrixSetId}/map.html": { "get": { "tags": [ "SpatioTemporal Asset Catalog" ], "summary": "Map Viewer", "description": "Return TileJSON document for a dataset.", "operationId": ".stac.getMapViewer", "parameters": [ { "name": "tileMatrixSetId", "in": "path", "required": true, "schema": { "enum": [ "CDB1GlobalGrid", "CanadianNAD83_LCC", "EuropeanETRS89_LAEAQuad", "GNOSISGlobalGrid", "LINZAntarticaMapTilegrid", "NZTM2000Quad", "UPSAntarcticWGS84Quad", "UPSArcticWGS84Quad", "UTM31WGS84Quad", "WGS1984Quad", "WebMercatorQuad", "WorldCRS84Quad", "WorldMercatorWGS84Quad" ], "type": "string", "description": "Identifier selecting one of the TileMatrixSetId supported.", "title": "Tilematrixsetid" }, "description": "Identifier selecting one of the TileMatrixSetId supported." }, { "name": "tile_format", "in": "query", "required": false, "schema": { "anyOf": [ { "$ref": "#/components/schemas/ImageType" }, { "type": "null" } ], "description": "Default will be automatically defined if the output image needs a mask (png) or not (jpeg).", "title": "Tile Format" }, "description": "Default will be automatically defined if the output image needs a mask (png) or not (jpeg)." }, { "name": "tilesize", "in": "query", "required": false, "schema": { "type": "integer", "exclusiveMinimum": 0, "description": "Tilesize in pixels. Default to 256.", "default": 256, "title": "Tilesize" }, "description": "Tilesize in pixels. Default to 256." }, { "name": "minzoom", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "Overwrite default minzoom.", "title": "Minzoom" }, "description": "Overwrite default minzoom." }, { "name": "maxzoom", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "Overwrite default maxzoom.", "title": "Maxzoom" }, "description": "Overwrite default maxzoom." }, { "name": "url", "in": "query", "required": true, "schema": { "type": "string", "description": "Dataset URL", "title": "Url" }, "description": "Dataset URL" }, { "name": "buffer", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "number", "exclusiveMinimum": 0 }, { "type": "null" } ], "title": "Tile buffer.", "description": "Buffer on each side of the given tile. It must be a multiple of `0.5`. Output **tilesize** will be expanded to `tilesize + 2 * buffer` (e.g 0.5 = 257x257, 1.0 = 258x258)." }, "description": "Buffer on each side of the given tile. It must be a multiple of `0.5`. Output **tilesize** will be expanded to `tilesize + 2 * buffer` (e.g 0.5 = 257x257, 1.0 = 258x258)." }, { "name": "padding", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "integer", "exclusiveMinimum": 0 }, { "type": "null" } ], "title": "Tile padding.", "description": "Padding to apply to each tile edge. Helps reduce resampling artefacts along edges. Defaults to `0`." }, "description": "Padding to apply to each tile edge. Helps reduce resampling artefacts along edges. Defaults to `0`." }, { "name": "assets", "in": "query", "required": true, "schema": { "type": "array", "items": { "type": "string" }, "title": "Asset names", "description": "Asset's names." }, "description": "Asset's names.", "examples": { "user-provided": {}, "one-asset": { "description": "Return results for asset `data`.", "value": [ "data" ] }, "multi-assets": { "description": "Return results for assets `data` and `cog`.", "value": [ "data", "cog" ] }, "multi-assets-with-options": { "description": "Return results for assets `data` and `cog`.", "value": [ "data|bidx=1", "cog|bidx=1,2" ] } } }, { "name": "expression", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Band Math expression", "description": "rio-tiler's band math expression" }, "description": "rio-tiler's band math expression", "examples": { "user-provided": {}, "simple": { "description": "Simple band math.", "value": "b1/b2" }, "multi-bands": { "description": "Semicolon (;) delimited expressions (band1: b1/b2, band2: b2+b3).", "value": "b1/b2;b2+b3" } } }, { "name": "asset_as_band", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Consider asset as a 1 band dataset", "description": "Asset as Band" }, "description": "Asset as Band" }, { "name": "nodata", "in": "query", "required": false, "schema": { "anyOf": [ { "enum": [ "nan", "inf", "-inf" ], "type": "string" }, { "type": "integer" }, { "type": "number" }, { "type": "null" } ], "title": "Nodata value", "description": "Overwrite internal Nodata value; nan or valid float values only." }, "description": "Overwrite internal Nodata value; nan or valid float values only." }, { "name": "unscale", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Apply internal Scale/Offset", "description": "Apply internal Scale/Offset. Defaults to `False`." }, "description": "Apply internal Scale/Offset. Defaults to `False`." }, { "name": "resampling", "in": "query", "required": false, "schema": { "anyOf": [ { "enum": [ "nearest", "bilinear", "cubic", "cubic_spline", "lanczos", "average", "mode", "gauss", "rms" ], "type": "string" }, { "type": "null" } ], "description": "RasterIO resampling algorithm. Defaults to `nearest`.", "title": "Resampling" }, "description": "RasterIO resampling algorithm. Defaults to `nearest`." }, { "name": "reproject", "in": "query", "required": false, "schema": { "anyOf": [ { "enum": [ "nearest", "bilinear", "cubic", "cubic_spline", "lanczos", "average", "mode", "max", "min", "med", "q1", "q3", "sum", "rms" ], "type": "string" }, { "type": "null" } ], "description": "WarpKernel resampling algorithm (only used when doing re-projection). Defaults to `nearest`.", "title": "Reproject" }, "description": "WarpKernel resampling algorithm (only used when doing re-projection). Defaults to `nearest`." }, { "name": "algorithm", "in": "query", "required": false, "schema": { "enum": [ "hillshade", "slope", "contours", "normalizedIndex", "terrarium", "terrainrgb", "cast", "ceil", "floor", "min", "max", "median", "mean", "std", "var", "sum", "grayscale", "bitonal" ], "type": "string", "description": "Algorithm name", "title": "Algorithm" }, "description": "Algorithm name" }, { "name": "algorithm_params", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Algorithm parameter", "title": "Algorithm Params" }, "description": "Algorithm parameter" }, { "name": "colormap_name", "in": "query", "required": false, "schema": { "enum": [ "jet_r", "haline", "gist_ncar_r", "algae", "cividis_r", "seismic_r", "pink_r", "rdylbu", "inferno_r", "deep", "rdgy_r", "tab10", "bugn_r", "ocean_r", "purples", "pastel1_r", "thermal_r", "ylorrd_r", "wistia_r", "cmrmap", "pubu", "rain", "ylgnbu", "gnuplot", "gnbu", "gist_gray_r", "greens", "purd_r", "oxy_r", "matter", "summer_r", "gnuplot_r", "gnuplot2", "solar", "jet", "ylgn_r", "dark2_r", "spring", "tab20c", "gist_stern", "bwr", "ylgn", "plasma", "pastel2", "blues_r", "rain_r", "set1", "topo_r", "gist_ncar", "turbid", "magma_r", "pastel2_r", "purd", "gnbu_r", "spring_r", "rdbu_r", "ylorbr", "twilight_shifted", "rplumbo", "winter_r", "tab20b", "ylorrd", "copper", "flag_r", "afmhot", "twilight_shifted_r", "oranges_r", "bone", "seismic", "gray_r", "tarn_r", "bwr_r", "magma", "paired_r", "dark2", "binary", "set3", "viridis_r", "spectral", "prgn", "diff", "hot", "gist_earth", "cubehelix", "dense_r", "coolwarm", "pubugn_r", "autumn_r", "gnuplot2_r", "cividis", "bugn", "deep_r", "prgn_r", "gist_rainbow", "gist_heat_r", "nipy_spectral_r", "tab20", "turbo_r", "pubugn", "set2_r", "gist_yarg_r", "spectral_r", "binary_r", "greys", "rainbow_r", "haline_r", "curl", "tab20c_r", "blues", "prism", "rdgy", "gist_gray", "set2", "cool", "afmhot_r", "bone_r", "paired", "oranges", "orrd", "puor", "autumn", "delta_r", "pubu_r", "piyg_r", "turbo", "greys_r", "accent", "turbid_r", "algae_r", "solar_r", "topo", "cool_r", "inferno", "balance", "tempo_r", "amp_r", "flag", "speed", "gist_heat", "balance_r", "viridis", "cubehelix_r", "ylorbr_r", "summer", "coolwarm_r", "diff_r", "rdylgn_r", "gist_stern_r", "plasma_r", "copper_r", "oxy", "gist_yarg", "twilight", "winter", "brbg", "reds_r", "speed_r", "rainbow", "ice", "nipy_spectral", "piyg", "gray", "reds", "terrain", "tab20_r", "wistia", "accent_r", "thermal", "ocean", "twilight_r", "hot_r", "set3_r", "hsv_r", "brg_r", "gist_rainbow_r", "phase", "bupu", "pastel1", "dense", "set1_r", "phase_r", "matter_r", "greens_r", "cfastie", "tab10_r", "rdbu", "brg", "rdpu_r", "brbg_r", "cmrmap_r", "prism_r", "purples_r", "gist_earth_r", "tempo", "schwarzwald", "rdpu", "orrd_r", "tarn", "puor_r", "bupu_r", "rdylgn", "ice_r", "pink", "terrain_r", "amp", "tab20b_r", "rdylbu_r", "hsv", "curl_r", "delta", "ylgnbu_r" ], "type": "string", "description": "Colormap name", "title": "Colormap Name" }, "description": "Colormap name" }, { "name": "colormap", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "JSON encoded custom Colormap", "title": "Colormap" }, "description": "JSON encoded custom Colormap" }, { "name": "rescale", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ], "title": "Min/Max data Rescaling", "description": "comma (',') delimited Min,Max range. Can set multiple time for multiple bands.", "examples": [ "0,2000", "0,1000", "0,10000" ] }, "description": "comma (',') delimited Min,Max range. Can set multiple time for multiple bands." }, { "name": "color_formula", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Color Formula", "description": "rio-color formula (info: https://github.com/mapbox/rio-color)" }, "description": "rio-color formula (info: https://github.com/mapbox/rio-color)" }, { "name": "return_mask", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "Add mask to the output data. Defaults to `True`", "title": "Return Mask" }, "description": "Add mask to the output data. Defaults to `True`" } ], "responses": { "200": { "description": "Successful Response", "content": { "text/html": { "schema": { "type": "string" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/stac/{tileMatrixSetId}/tilejson.json": { "get": { "tags": [ "SpatioTemporal Asset Catalog" ], "summary": "Tilejson", "description": "Return TileJSON document for a dataset.", "operationId": ".stac.getTileJSON", "parameters": [ { "name": "tileMatrixSetId", "in": "path", "required": true, "schema": { "enum": [ "CDB1GlobalGrid", "CanadianNAD83_LCC", "EuropeanETRS89_LAEAQuad", "GNOSISGlobalGrid", "LINZAntarticaMapTilegrid", "NZTM2000Quad", "UPSAntarcticWGS84Quad", "UPSArcticWGS84Quad", "UTM31WGS84Quad", "WGS1984Quad", "WebMercatorQuad", "WorldCRS84Quad", "WorldMercatorWGS84Quad" ], "type": "string", "description": "Identifier selecting one of the TileMatrixSetId supported.", "title": "Tilematrixsetid" }, "description": "Identifier selecting one of the TileMatrixSetId supported." }, { "name": "tilesize", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "integer", "exclusiveMinimum": 0 }, { "type": "null" } ], "description": "Tilesize in pixels. Default to 512.", "default": 512, "title": "Tilesize" }, "description": "Tilesize in pixels. Default to 512." }, { "name": "tile_format", "in": "query", "required": false, "schema": { "anyOf": [ { "$ref": "#/components/schemas/ImageType" }, { "type": "null" } ], "description": "Default will be automatically defined if the output image needs a mask (png) or not (jpeg).", "title": "Tile Format" }, "description": "Default will be automatically defined if the output image needs a mask (png) or not (jpeg)." }, { "name": "minzoom", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "Overwrite default minzoom.", "title": "Minzoom" }, "description": "Overwrite default minzoom." }, { "name": "maxzoom", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "Overwrite default maxzoom.", "title": "Maxzoom" }, "description": "Overwrite default maxzoom." }, { "name": "url", "in": "query", "required": true, "schema": { "type": "string", "description": "Dataset URL", "title": "Url" }, "description": "Dataset URL" }, { "name": "buffer", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "number", "exclusiveMinimum": 0 }, { "type": "null" } ], "title": "Tile buffer.", "description": "Buffer on each side of the given tile. It must be a multiple of `0.5`. Output **tilesize** will be expanded to `tilesize + 2 * buffer` (e.g 0.5 = 257x257, 1.0 = 258x258)." }, "description": "Buffer on each side of the given tile. It must be a multiple of `0.5`. Output **tilesize** will be expanded to `tilesize + 2 * buffer` (e.g 0.5 = 257x257, 1.0 = 258x258)." }, { "name": "padding", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "integer", "exclusiveMinimum": 0 }, { "type": "null" } ], "title": "Tile padding.", "description": "Padding to apply to each tile edge. Helps reduce resampling artefacts along edges. Defaults to `0`." }, "description": "Padding to apply to each tile edge. Helps reduce resampling artefacts along edges. Defaults to `0`." }, { "name": "assets", "in": "query", "required": true, "schema": { "type": "array", "items": { "type": "string" }, "title": "Asset names", "description": "Asset's names." }, "description": "Asset's names.", "examples": { "user-provided": {}, "one-asset": { "description": "Return results for asset `data`.", "value": [ "data" ] }, "multi-assets": { "description": "Return results for assets `data` and `cog`.", "value": [ "data", "cog" ] }, "multi-assets-with-options": { "description": "Return results for assets `data` and `cog`.", "value": [ "data|bidx=1", "cog|bidx=1,2" ] } } }, { "name": "expression", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Band Math expression", "description": "rio-tiler's band math expression" }, "description": "rio-tiler's band math expression", "examples": { "user-provided": {}, "simple": { "description": "Simple band math.", "value": "b1/b2" }, "multi-bands": { "description": "Semicolon (;) delimited expressions (band1: b1/b2, band2: b2+b3).", "value": "b1/b2;b2+b3" } } }, { "name": "asset_as_band", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Consider asset as a 1 band dataset", "description": "Asset as Band" }, "description": "Asset as Band" }, { "name": "nodata", "in": "query", "required": false, "schema": { "anyOf": [ { "enum": [ "nan", "inf", "-inf" ], "type": "string" }, { "type": "integer" }, { "type": "number" }, { "type": "null" } ], "title": "Nodata value", "description": "Overwrite internal Nodata value; nan or valid float values only." }, "description": "Overwrite internal Nodata value; nan or valid float values only." }, { "name": "unscale", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Apply internal Scale/Offset", "description": "Apply internal Scale/Offset. Defaults to `False`." }, "description": "Apply internal Scale/Offset. Defaults to `False`." }, { "name": "resampling", "in": "query", "required": false, "schema": { "anyOf": [ { "enum": [ "nearest", "bilinear", "cubic", "cubic_spline", "lanczos", "average", "mode", "gauss", "rms" ], "type": "string" }, { "type": "null" } ], "description": "RasterIO resampling algorithm. Defaults to `nearest`.", "title": "Resampling" }, "description": "RasterIO resampling algorithm. Defaults to `nearest`." }, { "name": "reproject", "in": "query", "required": false, "schema": { "anyOf": [ { "enum": [ "nearest", "bilinear", "cubic", "cubic_spline", "lanczos", "average", "mode", "max", "min", "med", "q1", "q3", "sum", "rms" ], "type": "string" }, { "type": "null" } ], "description": "WarpKernel resampling algorithm (only used when doing re-projection). Defaults to `nearest`.", "title": "Reproject" }, "description": "WarpKernel resampling algorithm (only used when doing re-projection). Defaults to `nearest`." }, { "name": "algorithm", "in": "query", "required": false, "schema": { "enum": [ "hillshade", "slope", "contours", "normalizedIndex", "terrarium", "terrainrgb", "cast", "ceil", "floor", "min", "max", "median", "mean", "std", "var", "sum", "grayscale", "bitonal" ], "type": "string", "description": "Algorithm name", "title": "Algorithm" }, "description": "Algorithm name" }, { "name": "algorithm_params", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Algorithm parameter", "title": "Algorithm Params" }, "description": "Algorithm parameter" }, { "name": "colormap_name", "in": "query", "required": false, "schema": { "enum": [ "jet_r", "haline", "gist_ncar_r", "algae", "cividis_r", "seismic_r", "pink_r", "rdylbu", "inferno_r", "deep", "rdgy_r", "tab10", "bugn_r", "ocean_r", "purples", "pastel1_r", "thermal_r", "ylorrd_r", "wistia_r", "cmrmap", "pubu", "rain", "ylgnbu", "gnuplot", "gnbu", "gist_gray_r", "greens", "purd_r", "oxy_r", "matter", "summer_r", "gnuplot_r", "gnuplot2", "solar", "jet", "ylgn_r", "dark2_r", "spring", "tab20c", "gist_stern", "bwr", "ylgn", "plasma", "pastel2", "blues_r", "rain_r", "set1", "topo_r", "gist_ncar", "turbid", "magma_r", "pastel2_r", "purd", "gnbu_r", "spring_r", "rdbu_r", "ylorbr", "twilight_shifted", "rplumbo", "winter_r", "tab20b", "ylorrd", "copper", "flag_r", "afmhot", "twilight_shifted_r", "oranges_r", "bone", "seismic", "gray_r", "tarn_r", "bwr_r", "magma", "paired_r", "dark2", "binary", "set3", "viridis_r", "spectral", "prgn", "diff", "hot", "gist_earth", "cubehelix", "dense_r", "coolwarm", "pubugn_r", "autumn_r", "gnuplot2_r", "cividis", "bugn", "deep_r", "prgn_r", "gist_rainbow", "gist_heat_r", "nipy_spectral_r", "tab20", "turbo_r", "pubugn", "set2_r", "gist_yarg_r", "spectral_r", "binary_r", "greys", "rainbow_r", "haline_r", "curl", "tab20c_r", "blues", "prism", "rdgy", "gist_gray", "set2", "cool", "afmhot_r", "bone_r", "paired", "oranges", "orrd", "puor", "autumn", "delta_r", "pubu_r", "piyg_r", "turbo", "greys_r", "accent", "turbid_r", "algae_r", "solar_r", "topo", "cool_r", "inferno", "balance", "tempo_r", "amp_r", "flag", "speed", "gist_heat", "balance_r", "viridis", "cubehelix_r", "ylorbr_r", "summer", "coolwarm_r", "diff_r", "rdylgn_r", "gist_stern_r", "plasma_r", "copper_r", "oxy", "gist_yarg", "twilight", "winter", "brbg", "reds_r", "speed_r", "rainbow", "ice", "nipy_spectral", "piyg", "gray", "reds", "terrain", "tab20_r", "wistia", "accent_r", "thermal", "ocean", "twilight_r", "hot_r", "set3_r", "hsv_r", "brg_r", "gist_rainbow_r", "phase", "bupu", "pastel1", "dense", "set1_r", "phase_r", "matter_r", "greens_r", "cfastie", "tab10_r", "rdbu", "brg", "rdpu_r", "brbg_r", "cmrmap_r", "prism_r", "purples_r", "gist_earth_r", "tempo", "schwarzwald", "rdpu", "orrd_r", "tarn", "puor_r", "bupu_r", "rdylgn", "ice_r", "pink", "terrain_r", "amp", "tab20b_r", "rdylbu_r", "hsv", "curl_r", "delta", "ylgnbu_r" ], "type": "string", "description": "Colormap name", "title": "Colormap Name" }, "description": "Colormap name" }, { "name": "colormap", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "JSON encoded custom Colormap", "title": "Colormap" }, "description": "JSON encoded custom Colormap" }, { "name": "rescale", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ], "title": "Min/Max data Rescaling", "description": "comma (',') delimited Min,Max range. Can set multiple time for multiple bands.", "examples": [ "0,2000", "0,1000", "0,10000" ] }, "description": "comma (',') delimited Min,Max range. Can set multiple time for multiple bands." }, { "name": "color_formula", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Color Formula", "description": "rio-color formula (info: https://github.com/mapbox/rio-color)" }, "description": "rio-color formula (info: https://github.com/mapbox/rio-color)" }, { "name": "return_mask", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "Add mask to the output data. Defaults to `True`", "title": "Return Mask" }, "description": "Add mask to the output data. Defaults to `True`" } ], "responses": { "200": { "description": "Return a tilejson", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TileJSON" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/stac/point/{lon},{lat}": { "get": { "tags": [ "SpatioTemporal Asset Catalog" ], "summary": "Point", "description": "Get Point value for a dataset.", "operationId": ".stac.getDataForPoint", "parameters": [ { "name": "lon", "in": "path", "required": true, "schema": { "type": "number", "description": "Longitude", "title": "Lon" }, "description": "Longitude" }, { "name": "lat", "in": "path", "required": true, "schema": { "type": "number", "description": "Latitude", "title": "Lat" }, "description": "Latitude" }, { "name": "url", "in": "query", "required": true, "schema": { "type": "string", "description": "Dataset URL", "title": "Url" }, "description": "Dataset URL" }, { "name": "coord_crs", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Coordinate Reference System of the input coords. Default to `epsg:4326`.", "title": "Coord Crs" }, "description": "Coordinate Reference System of the input coords. Default to `epsg:4326`." }, { "name": "assets", "in": "query", "required": true, "schema": { "type": "array", "items": { "type": "string" }, "title": "Asset names", "description": "Asset's names." }, "description": "Asset's names.", "examples": { "user-provided": {}, "one-asset": { "description": "Return results for asset `data`.", "value": [ "data" ] }, "multi-assets": { "description": "Return results for assets `data` and `cog`.", "value": [ "data", "cog" ] }, "multi-assets-with-options": { "description": "Return results for assets `data` and `cog`.", "value": [ "data|bidx=1", "cog|bidx=1,2" ] } } }, { "name": "expression", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Band Math expression", "description": "rio-tiler's band math expression" }, "description": "rio-tiler's band math expression", "examples": { "user-provided": {}, "simple": { "description": "Simple band math.", "value": "b1/b2" }, "multi-bands": { "description": "Semicolon (;) delimited expressions (band1: b1/b2, band2: b2+b3).", "value": "b1/b2;b2+b3" } } }, { "name": "asset_as_band", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Consider asset as a 1 band dataset", "description": "Asset as Band" }, "description": "Asset as Band" }, { "name": "nodata", "in": "query", "required": false, "schema": { "anyOf": [ { "enum": [ "nan", "inf", "-inf" ], "type": "string" }, { "type": "integer" }, { "type": "number" }, { "type": "null" } ], "title": "Nodata value", "description": "Overwrite internal Nodata value; nan or valid float values only." }, "description": "Overwrite internal Nodata value; nan or valid float values only." }, { "name": "unscale", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Apply internal Scale/Offset", "description": "Apply internal Scale/Offset. Defaults to `False`." }, "description": "Apply internal Scale/Offset. Defaults to `False`." }, { "name": "resampling", "in": "query", "required": false, "schema": { "anyOf": [ { "enum": [ "nearest", "bilinear", "cubic", "cubic_spline", "lanczos", "average", "mode", "gauss", "rms" ], "type": "string" }, { "type": "null" } ], "description": "RasterIO resampling algorithm. Defaults to `nearest`.", "title": "Resampling" }, "description": "RasterIO resampling algorithm. Defaults to `nearest`." }, { "name": "reproject", "in": "query", "required": false, "schema": { "anyOf": [ { "enum": [ "nearest", "bilinear", "cubic", "cubic_spline", "lanczos", "average", "mode", "max", "min", "med", "q1", "q3", "sum", "rms" ], "type": "string" }, { "type": "null" } ], "description": "WarpKernel resampling algorithm (only used when doing re-projection). Defaults to `nearest`.", "title": "Reproject" }, "description": "WarpKernel resampling algorithm (only used when doing re-projection). Defaults to `nearest`." } ], "responses": { "200": { "description": "Return a value for a point", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/titiler__core__models__responses__Point" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/stac/preview/{width}x{height}.{format}": { "get": { "tags": [ "SpatioTemporal Asset Catalog" ], "summary": "Preview", "description": "Create preview of a dataset.", "operationId": ".stac.getPreviewWithSizeAndFormat", "parameters": [ { "name": "format", "in": "path", "required": true, "schema": { "anyOf": [ { "$ref": "#/components/schemas/ImageType" }, { "type": "null" } ], "description": "Default will be automatically defined if the output image needs a mask (png) or not (jpeg).", "title": "Format" } }, { "name": "height", "in": "path", "required": true, "schema": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "Force output image height.", "title": "Height" } }, { "name": "width", "in": "path", "required": true, "schema": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "Force output image width.", "title": "Width" } }, { "name": "url", "in": "query", "required": true, "schema": { "type": "string", "description": "Dataset URL", "title": "Url" }, "description": "Dataset URL" }, { "name": "assets", "in": "query", "required": true, "schema": { "type": "array", "items": { "type": "string" }, "title": "Asset names", "description": "Asset's names." }, "description": "Asset's names.", "examples": { "user-provided": {}, "one-asset": { "description": "Return results for asset `data`.", "value": [ "data" ] }, "multi-assets": { "description": "Return results for assets `data` and `cog`.", "value": [ "data", "cog" ] }, "multi-assets-with-options": { "description": "Return results for assets `data` and `cog`.", "value": [ "data|bidx=1", "cog|bidx=1,2" ] } } }, { "name": "expression", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Band Math expression", "description": "rio-tiler's band math expression" }, "description": "rio-tiler's band math expression", "examples": { "user-provided": {}, "simple": { "description": "Simple band math.", "value": "b1/b2" }, "multi-bands": { "description": "Semicolon (;) delimited expressions (band1: b1/b2, band2: b2+b3).", "value": "b1/b2;b2+b3" } } }, { "name": "asset_as_band", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Consider asset as a 1 band dataset", "description": "Asset as Band" }, "description": "Asset as Band" }, { "name": "nodata", "in": "query", "required": false, "schema": { "anyOf": [ { "enum": [ "nan", "inf", "-inf" ], "type": "string" }, { "type": "integer" }, { "type": "number" }, { "type": "null" } ], "title": "Nodata value", "description": "Overwrite internal Nodata value; nan or valid float values only." }, "description": "Overwrite internal Nodata value; nan or valid float values only." }, { "name": "unscale", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Apply internal Scale/Offset", "description": "Apply internal Scale/Offset. Defaults to `False`." }, "description": "Apply internal Scale/Offset. Defaults to `False`." }, { "name": "resampling", "in": "query", "required": false, "schema": { "anyOf": [ { "enum": [ "nearest", "bilinear", "cubic", "cubic_spline", "lanczos", "average", "mode", "gauss", "rms" ], "type": "string" }, { "type": "null" } ], "description": "RasterIO resampling algorithm. Defaults to `nearest`.", "title": "Resampling" }, "description": "RasterIO resampling algorithm. Defaults to `nearest`." }, { "name": "reproject", "in": "query", "required": false, "schema": { "anyOf": [ { "enum": [ "nearest", "bilinear", "cubic", "cubic_spline", "lanczos", "average", "mode", "max", "min", "med", "q1", "q3", "sum", "rms" ], "type": "string" }, { "type": "null" } ], "description": "WarpKernel resampling algorithm (only used when doing re-projection). Defaults to `nearest`.", "title": "Reproject" }, "description": "WarpKernel resampling algorithm (only used when doing re-projection). Defaults to `nearest`." }, { "name": "max_size", "in": "query", "required": false, "schema": { "type": "integer", "description": "Maximum image size to read onto.", "default": 1024, "title": "Max Size" } }, { "name": "dst_crs", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Output Coordinate Reference System.", "title": "Dst Crs" }, "description": "Output Coordinate Reference System." }, { "name": "algorithm", "in": "query", "required": false, "schema": { "enum": [ "hillshade", "slope", "contours", "normalizedIndex", "terrarium", "terrainrgb", "cast", "ceil", "floor", "min", "max", "median", "mean", "std", "var", "sum", "grayscale", "bitonal" ], "type": "string", "description": "Algorithm name", "title": "Algorithm" }, "description": "Algorithm name" }, { "name": "algorithm_params", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Algorithm parameter", "title": "Algorithm Params" }, "description": "Algorithm parameter" }, { "name": "colormap_name", "in": "query", "required": false, "schema": { "enum": [ "jet_r", "haline", "gist_ncar_r", "algae", "cividis_r", "seismic_r", "pink_r", "rdylbu", "inferno_r", "deep", "rdgy_r", "tab10", "bugn_r", "ocean_r", "purples", "pastel1_r", "thermal_r", "ylorrd_r", "wistia_r", "cmrmap", "pubu", "rain", "ylgnbu", "gnuplot", "gnbu", "gist_gray_r", "greens", "purd_r", "oxy_r", "matter", "summer_r", "gnuplot_r", "gnuplot2", "solar", "jet", "ylgn_r", "dark2_r", "spring", "tab20c", "gist_stern", "bwr", "ylgn", "plasma", "pastel2", "blues_r", "rain_r", "set1", "topo_r", "gist_ncar", "turbid", "magma_r", "pastel2_r", "purd", "gnbu_r", "spring_r", "rdbu_r", "ylorbr", "twilight_shifted", "rplumbo", "winter_r", "tab20b", "ylorrd", "copper", "flag_r", "afmhot", "twilight_shifted_r", "oranges_r", "bone", "seismic", "gray_r", "tarn_r", "bwr_r", "magma", "paired_r", "dark2", "binary", "set3", "viridis_r", "spectral", "prgn", "diff", "hot", "gist_earth", "cubehelix", "dense_r", "coolwarm", "pubugn_r", "autumn_r", "gnuplot2_r", "cividis", "bugn", "deep_r", "prgn_r", "gist_rainbow", "gist_heat_r", "nipy_spectral_r", "tab20", "turbo_r", "pubugn", "set2_r", "gist_yarg_r", "spectral_r", "binary_r", "greys", "rainbow_r", "haline_r", "curl", "tab20c_r", "blues", "prism", "rdgy", "gist_gray", "set2", "cool", "afmhot_r", "bone_r", "paired", "oranges", "orrd", "puor", "autumn", "delta_r", "pubu_r", "piyg_r", "turbo", "greys_r", "accent", "turbid_r", "algae_r", "solar_r", "topo", "cool_r", "inferno", "balance", "tempo_r", "amp_r", "flag", "speed", "gist_heat", "balance_r", "viridis", "cubehelix_r", "ylorbr_r", "summer", "coolwarm_r", "diff_r", "rdylgn_r", "gist_stern_r", "plasma_r", "copper_r", "oxy", "gist_yarg", "twilight", "winter", "brbg", "reds_r", "speed_r", "rainbow", "ice", "nipy_spectral", "piyg", "gray", "reds", "terrain", "tab20_r", "wistia", "accent_r", "thermal", "ocean", "twilight_r", "hot_r", "set3_r", "hsv_r", "brg_r", "gist_rainbow_r", "phase", "bupu", "pastel1", "dense", "set1_r", "phase_r", "matter_r", "greens_r", "cfastie", "tab10_r", "rdbu", "brg", "rdpu_r", "brbg_r", "cmrmap_r", "prism_r", "purples_r", "gist_earth_r", "tempo", "schwarzwald", "rdpu", "orrd_r", "tarn", "puor_r", "bupu_r", "rdylgn", "ice_r", "pink", "terrain_r", "amp", "tab20b_r", "rdylbu_r", "hsv", "curl_r", "delta", "ylgnbu_r" ], "type": "string", "description": "Colormap name", "title": "Colormap Name" }, "description": "Colormap name" }, { "name": "colormap", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "JSON encoded custom Colormap", "title": "Colormap" }, "description": "JSON encoded custom Colormap" }, { "name": "rescale", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ], "title": "Min/Max data Rescaling", "description": "comma (',') delimited Min,Max range. Can set multiple time for multiple bands.", "examples": [ "0,2000", "0,1000", "0,10000" ] }, "description": "comma (',') delimited Min,Max range. Can set multiple time for multiple bands." }, { "name": "color_formula", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Color Formula", "description": "rio-color formula (info: https://github.com/mapbox/rio-color)" }, "description": "rio-color formula (info: https://github.com/mapbox/rio-color)" }, { "name": "return_mask", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "Add mask to the output data. Defaults to `True`", "title": "Return Mask" }, "description": "Add mask to the output data. Defaults to `True`" } ], "responses": { "200": { "description": "Return an image.", "content": { "image/png": {}, "image/jpeg": {}, "image/jpg": {}, "image/webp": {}, "image/jp2": {}, "image/tiff; application=geotiff": {}, "application/x-binary": {} } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/stac/preview.{format}": { "get": { "tags": [ "SpatioTemporal Asset Catalog" ], "summary": "Preview", "description": "Create preview of a dataset.", "operationId": ".stac.getPreviewWithFormat", "parameters": [ { "name": "format", "in": "path", "required": true, "schema": { "anyOf": [ { "$ref": "#/components/schemas/ImageType" }, { "type": "null" } ], "description": "Default will be automatically defined if the output image needs a mask (png) or not (jpeg).", "title": "Format" } }, { "name": "url", "in": "query", "required": true, "schema": { "type": "string", "description": "Dataset URL", "title": "Url" }, "description": "Dataset URL" }, { "name": "assets", "in": "query", "required": true, "schema": { "type": "array", "items": { "type": "string" }, "title": "Asset names", "description": "Asset's names." }, "description": "Asset's names.", "examples": { "user-provided": {}, "one-asset": { "description": "Return results for asset `data`.", "value": [ "data" ] }, "multi-assets": { "description": "Return results for assets `data` and `cog`.", "value": [ "data", "cog" ] }, "multi-assets-with-options": { "description": "Return results for assets `data` and `cog`.", "value": [ "data|bidx=1", "cog|bidx=1,2" ] } } }, { "name": "expression", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Band Math expression", "description": "rio-tiler's band math expression" }, "description": "rio-tiler's band math expression", "examples": { "user-provided": {}, "simple": { "description": "Simple band math.", "value": "b1/b2" }, "multi-bands": { "description": "Semicolon (;) delimited expressions (band1: b1/b2, band2: b2+b3).", "value": "b1/b2;b2+b3" } } }, { "name": "asset_as_band", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Consider asset as a 1 band dataset", "description": "Asset as Band" }, "description": "Asset as Band" }, { "name": "nodata", "in": "query", "required": false, "schema": { "anyOf": [ { "enum": [ "nan", "inf", "-inf" ], "type": "string" }, { "type": "integer" }, { "type": "number" }, { "type": "null" } ], "title": "Nodata value", "description": "Overwrite internal Nodata value; nan or valid float values only." }, "description": "Overwrite internal Nodata value; nan or valid float values only." }, { "name": "unscale", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Apply internal Scale/Offset", "description": "Apply internal Scale/Offset. Defaults to `False`." }, "description": "Apply internal Scale/Offset. Defaults to `False`." }, { "name": "resampling", "in": "query", "required": false, "schema": { "anyOf": [ { "enum": [ "nearest", "bilinear", "cubic", "cubic_spline", "lanczos", "average", "mode", "gauss", "rms" ], "type": "string" }, { "type": "null" } ], "description": "RasterIO resampling algorithm. Defaults to `nearest`.", "title": "Resampling" }, "description": "RasterIO resampling algorithm. Defaults to `nearest`." }, { "name": "reproject", "in": "query", "required": false, "schema": { "anyOf": [ { "enum": [ "nearest", "bilinear", "cubic", "cubic_spline", "lanczos", "average", "mode", "max", "min", "med", "q1", "q3", "sum", "rms" ], "type": "string" }, { "type": "null" } ], "description": "WarpKernel resampling algorithm (only used when doing re-projection). Defaults to `nearest`.", "title": "Reproject" }, "description": "WarpKernel resampling algorithm (only used when doing re-projection). Defaults to `nearest`." }, { "name": "max_size", "in": "query", "required": false, "schema": { "type": "integer", "description": "Maximum image size to read onto.", "default": 1024, "title": "Max Size" } }, { "name": "height", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "Force output image height.", "title": "Height" } }, { "name": "width", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "Force output image width.", "title": "Width" } }, { "name": "dst_crs", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Output Coordinate Reference System.", "title": "Dst Crs" }, "description": "Output Coordinate Reference System." }, { "name": "algorithm", "in": "query", "required": false, "schema": { "enum": [ "hillshade", "slope", "contours", "normalizedIndex", "terrarium", "terrainrgb", "cast", "ceil", "floor", "min", "max", "median", "mean", "std", "var", "sum", "grayscale", "bitonal" ], "type": "string", "description": "Algorithm name", "title": "Algorithm" }, "description": "Algorithm name" }, { "name": "algorithm_params", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Algorithm parameter", "title": "Algorithm Params" }, "description": "Algorithm parameter" }, { "name": "colormap_name", "in": "query", "required": false, "schema": { "enum": [ "jet_r", "haline", "gist_ncar_r", "algae", "cividis_r", "seismic_r", "pink_r", "rdylbu", "inferno_r", "deep", "rdgy_r", "tab10", "bugn_r", "ocean_r", "purples", "pastel1_r", "thermal_r", "ylorrd_r", "wistia_r", "cmrmap", "pubu", "rain", "ylgnbu", "gnuplot", "gnbu", "gist_gray_r", "greens", "purd_r", "oxy_r", "matter", "summer_r", "gnuplot_r", "gnuplot2", "solar", "jet", "ylgn_r", "dark2_r", "spring", "tab20c", "gist_stern", "bwr", "ylgn", "plasma", "pastel2", "blues_r", "rain_r", "set1", "topo_r", "gist_ncar", "turbid", "magma_r", "pastel2_r", "purd", "gnbu_r", "spring_r", "rdbu_r", "ylorbr", "twilight_shifted", "rplumbo", "winter_r", "tab20b", "ylorrd", "copper", "flag_r", "afmhot", "twilight_shifted_r", "oranges_r", "bone", "seismic", "gray_r", "tarn_r", "bwr_r", "magma", "paired_r", "dark2", "binary", "set3", "viridis_r", "spectral", "prgn", "diff", "hot", "gist_earth", "cubehelix", "dense_r", "coolwarm", "pubugn_r", "autumn_r", "gnuplot2_r", "cividis", "bugn", "deep_r", "prgn_r", "gist_rainbow", "gist_heat_r", "nipy_spectral_r", "tab20", "turbo_r", "pubugn", "set2_r", "gist_yarg_r", "spectral_r", "binary_r", "greys", "rainbow_r", "haline_r", "curl", "tab20c_r", "blues", "prism", "rdgy", "gist_gray", "set2", "cool", "afmhot_r", "bone_r", "paired", "oranges", "orrd", "puor", "autumn", "delta_r", "pubu_r", "piyg_r", "turbo", "greys_r", "accent", "turbid_r", "algae_r", "solar_r", "topo", "cool_r", "inferno", "balance", "tempo_r", "amp_r", "flag", "speed", "gist_heat", "balance_r", "viridis", "cubehelix_r", "ylorbr_r", "summer", "coolwarm_r", "diff_r", "rdylgn_r", "gist_stern_r", "plasma_r", "copper_r", "oxy", "gist_yarg", "twilight", "winter", "brbg", "reds_r", "speed_r", "rainbow", "ice", "nipy_spectral", "piyg", "gray", "reds", "terrain", "tab20_r", "wistia", "accent_r", "thermal", "ocean", "twilight_r", "hot_r", "set3_r", "hsv_r", "brg_r", "gist_rainbow_r", "phase", "bupu", "pastel1", "dense", "set1_r", "phase_r", "matter_r", "greens_r", "cfastie", "tab10_r", "rdbu", "brg", "rdpu_r", "brbg_r", "cmrmap_r", "prism_r", "purples_r", "gist_earth_r", "tempo", "schwarzwald", "rdpu", "orrd_r", "tarn", "puor_r", "bupu_r", "rdylgn", "ice_r", "pink", "terrain_r", "amp", "tab20b_r", "rdylbu_r", "hsv", "curl_r", "delta", "ylgnbu_r" ], "type": "string", "description": "Colormap name", "title": "Colormap Name" }, "description": "Colormap name" }, { "name": "colormap", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "JSON encoded custom Colormap", "title": "Colormap" }, "description": "JSON encoded custom Colormap" }, { "name": "rescale", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ], "title": "Min/Max data Rescaling", "description": "comma (',') delimited Min,Max range. Can set multiple time for multiple bands.", "examples": [ "0,2000", "0,1000", "0,10000" ] }, "description": "comma (',') delimited Min,Max range. Can set multiple time for multiple bands." }, { "name": "color_formula", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Color Formula", "description": "rio-color formula (info: https://github.com/mapbox/rio-color)" }, "description": "rio-color formula (info: https://github.com/mapbox/rio-color)" }, { "name": "return_mask", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "Add mask to the output data. Defaults to `True`", "title": "Return Mask" }, "description": "Add mask to the output data. Defaults to `True`" } ], "responses": { "200": { "description": "Return an image.", "content": { "image/png": {}, "image/jpeg": {}, "image/jpg": {}, "image/webp": {}, "image/jp2": {}, "image/tiff; application=geotiff": {}, "application/x-binary": {} } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/stac/preview": { "get": { "tags": [ "SpatioTemporal Asset Catalog" ], "summary": "Preview", "description": "Create preview of a dataset.", "operationId": ".stac.getPreview", "parameters": [ { "name": "format", "in": "query", "required": false, "schema": { "anyOf": [ { "$ref": "#/components/schemas/ImageType" }, { "type": "null" } ], "description": "Default will be automatically defined if the output image needs a mask (png) or not (jpeg).", "title": "Format" } }, { "name": "url", "in": "query", "required": true, "schema": { "type": "string", "description": "Dataset URL", "title": "Url" }, "description": "Dataset URL" }, { "name": "assets", "in": "query", "required": true, "schema": { "type": "array", "items": { "type": "string" }, "title": "Asset names", "description": "Asset's names." }, "description": "Asset's names.", "examples": { "user-provided": {}, "one-asset": { "description": "Return results for asset `data`.", "value": [ "data" ] }, "multi-assets": { "description": "Return results for assets `data` and `cog`.", "value": [ "data", "cog" ] }, "multi-assets-with-options": { "description": "Return results for assets `data` and `cog`.", "value": [ "data|bidx=1", "cog|bidx=1,2" ] } } }, { "name": "expression", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Band Math expression", "description": "rio-tiler's band math expression" }, "description": "rio-tiler's band math expression", "examples": { "user-provided": {}, "simple": { "description": "Simple band math.", "value": "b1/b2" }, "multi-bands": { "description": "Semicolon (;) delimited expressions (band1: b1/b2, band2: b2+b3).", "value": "b1/b2;b2+b3" } } }, { "name": "asset_as_band", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Consider asset as a 1 band dataset", "description": "Asset as Band" }, "description": "Asset as Band" }, { "name": "nodata", "in": "query", "required": false, "schema": { "anyOf": [ { "enum": [ "nan", "inf", "-inf" ], "type": "string" }, { "type": "integer" }, { "type": "number" }, { "type": "null" } ], "title": "Nodata value", "description": "Overwrite internal Nodata value; nan or valid float values only." }, "description": "Overwrite internal Nodata value; nan or valid float values only." }, { "name": "unscale", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Apply internal Scale/Offset", "description": "Apply internal Scale/Offset. Defaults to `False`." }, "description": "Apply internal Scale/Offset. Defaults to `False`." }, { "name": "resampling", "in": "query", "required": false, "schema": { "anyOf": [ { "enum": [ "nearest", "bilinear", "cubic", "cubic_spline", "lanczos", "average", "mode", "gauss", "rms" ], "type": "string" }, { "type": "null" } ], "description": "RasterIO resampling algorithm. Defaults to `nearest`.", "title": "Resampling" }, "description": "RasterIO resampling algorithm. Defaults to `nearest`." }, { "name": "reproject", "in": "query", "required": false, "schema": { "anyOf": [ { "enum": [ "nearest", "bilinear", "cubic", "cubic_spline", "lanczos", "average", "mode", "max", "min", "med", "q1", "q3", "sum", "rms" ], "type": "string" }, { "type": "null" } ], "description": "WarpKernel resampling algorithm (only used when doing re-projection). Defaults to `nearest`.", "title": "Reproject" }, "description": "WarpKernel resampling algorithm (only used when doing re-projection). Defaults to `nearest`." }, { "name": "max_size", "in": "query", "required": false, "schema": { "type": "integer", "description": "Maximum image size to read onto.", "default": 1024, "title": "Max Size" } }, { "name": "height", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "Force output image height.", "title": "Height" } }, { "name": "width", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "Force output image width.", "title": "Width" } }, { "name": "dst_crs", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Output Coordinate Reference System.", "title": "Dst Crs" }, "description": "Output Coordinate Reference System." }, { "name": "algorithm", "in": "query", "required": false, "schema": { "enum": [ "hillshade", "slope", "contours", "normalizedIndex", "terrarium", "terrainrgb", "cast", "ceil", "floor", "min", "max", "median", "mean", "std", "var", "sum", "grayscale", "bitonal" ], "type": "string", "description": "Algorithm name", "title": "Algorithm" }, "description": "Algorithm name" }, { "name": "algorithm_params", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Algorithm parameter", "title": "Algorithm Params" }, "description": "Algorithm parameter" }, { "name": "colormap_name", "in": "query", "required": false, "schema": { "enum": [ "jet_r", "haline", "gist_ncar_r", "algae", "cividis_r", "seismic_r", "pink_r", "rdylbu", "inferno_r", "deep", "rdgy_r", "tab10", "bugn_r", "ocean_r", "purples", "pastel1_r", "thermal_r", "ylorrd_r", "wistia_r", "cmrmap", "pubu", "rain", "ylgnbu", "gnuplot", "gnbu", "gist_gray_r", "greens", "purd_r", "oxy_r", "matter", "summer_r", "gnuplot_r", "gnuplot2", "solar", "jet", "ylgn_r", "dark2_r", "spring", "tab20c", "gist_stern", "bwr", "ylgn", "plasma", "pastel2", "blues_r", "rain_r", "set1", "topo_r", "gist_ncar", "turbid", "magma_r", "pastel2_r", "purd", "gnbu_r", "spring_r", "rdbu_r", "ylorbr", "twilight_shifted", "rplumbo", "winter_r", "tab20b", "ylorrd", "copper", "flag_r", "afmhot", "twilight_shifted_r", "oranges_r", "bone", "seismic", "gray_r", "tarn_r", "bwr_r", "magma", "paired_r", "dark2", "binary", "set3", "viridis_r", "spectral", "prgn", "diff", "hot", "gist_earth", "cubehelix", "dense_r", "coolwarm", "pubugn_r", "autumn_r", "gnuplot2_r", "cividis", "bugn", "deep_r", "prgn_r", "gist_rainbow", "gist_heat_r", "nipy_spectral_r", "tab20", "turbo_r", "pubugn", "set2_r", "gist_yarg_r", "spectral_r", "binary_r", "greys", "rainbow_r", "haline_r", "curl", "tab20c_r", "blues", "prism", "rdgy", "gist_gray", "set2", "cool", "afmhot_r", "bone_r", "paired", "oranges", "orrd", "puor", "autumn", "delta_r", "pubu_r", "piyg_r", "turbo", "greys_r", "accent", "turbid_r", "algae_r", "solar_r", "topo", "cool_r", "inferno", "balance", "tempo_r", "amp_r", "flag", "speed", "gist_heat", "balance_r", "viridis", "cubehelix_r", "ylorbr_r", "summer", "coolwarm_r", "diff_r", "rdylgn_r", "gist_stern_r", "plasma_r", "copper_r", "oxy", "gist_yarg", "twilight", "winter", "brbg", "reds_r", "speed_r", "rainbow", "ice", "nipy_spectral", "piyg", "gray", "reds", "terrain", "tab20_r", "wistia", "accent_r", "thermal", "ocean", "twilight_r", "hot_r", "set3_r", "hsv_r", "brg_r", "gist_rainbow_r", "phase", "bupu", "pastel1", "dense", "set1_r", "phase_r", "matter_r", "greens_r", "cfastie", "tab10_r", "rdbu", "brg", "rdpu_r", "brbg_r", "cmrmap_r", "prism_r", "purples_r", "gist_earth_r", "tempo", "schwarzwald", "rdpu", "orrd_r", "tarn", "puor_r", "bupu_r", "rdylgn", "ice_r", "pink", "terrain_r", "amp", "tab20b_r", "rdylbu_r", "hsv", "curl_r", "delta", "ylgnbu_r" ], "type": "string", "description": "Colormap name", "title": "Colormap Name" }, "description": "Colormap name" }, { "name": "colormap", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "JSON encoded custom Colormap", "title": "Colormap" }, "description": "JSON encoded custom Colormap" }, { "name": "rescale", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ], "title": "Min/Max data Rescaling", "description": "comma (',') delimited Min,Max range. Can set multiple time for multiple bands.", "examples": [ "0,2000", "0,1000", "0,10000" ] }, "description": "comma (',') delimited Min,Max range. Can set multiple time for multiple bands." }, { "name": "color_formula", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Color Formula", "description": "rio-color formula (info: https://github.com/mapbox/rio-color)" }, "description": "rio-color formula (info: https://github.com/mapbox/rio-color)" }, { "name": "return_mask", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "Add mask to the output data. Defaults to `True`", "title": "Return Mask" }, "description": "Add mask to the output data. Defaults to `True`" } ], "responses": { "200": { "description": "Return an image.", "content": { "image/png": {}, "image/jpeg": {}, "image/jpg": {}, "image/webp": {}, "image/jp2": {}, "image/tiff; application=geotiff": {}, "application/x-binary": {} } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/stac/bbox/{minx},{miny},{maxx},{maxy}/{width}x{height}.{format}": { "get": { "tags": [ "SpatioTemporal Asset Catalog" ], "summary": "Bbox Image", "description": "Create image from a bbox.", "operationId": ".stac.getDataForBoundingBoxWithSizesAndFormat", "parameters": [ { "name": "minx", "in": "path", "required": true, "schema": { "type": "number", "description": "Bounding box min X", "title": "Minx" }, "description": "Bounding box min X" }, { "name": "miny", "in": "path", "required": true, "schema": { "type": "number", "description": "Bounding box min Y", "title": "Miny" }, "description": "Bounding box min Y" }, { "name": "maxx", "in": "path", "required": true, "schema": { "type": "number", "description": "Bounding box max X", "title": "Maxx" }, "description": "Bounding box max X" }, { "name": "maxy", "in": "path", "required": true, "schema": { "type": "number", "description": "Bounding box max Y", "title": "Maxy" }, "description": "Bounding box max Y" }, { "name": "format", "in": "path", "required": true, "schema": { "anyOf": [ { "$ref": "#/components/schemas/ImageType" }, { "type": "null" } ], "description": "Default will be automatically defined if the output image needs a mask (png) or not (jpeg).", "title": "Format" } }, { "name": "height", "in": "path", "required": true, "schema": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "Force output image height.", "title": "Height" } }, { "name": "width", "in": "path", "required": true, "schema": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "Force output image width.", "title": "Width" } }, { "name": "url", "in": "query", "required": true, "schema": { "type": "string", "description": "Dataset URL", "title": "Url" }, "description": "Dataset URL" }, { "name": "assets", "in": "query", "required": true, "schema": { "type": "array", "items": { "type": "string" }, "title": "Asset names", "description": "Asset's names." }, "description": "Asset's names.", "examples": { "user-provided": {}, "one-asset": { "description": "Return results for asset `data`.", "value": [ "data" ] }, "multi-assets": { "description": "Return results for assets `data` and `cog`.", "value": [ "data", "cog" ] }, "multi-assets-with-options": { "description": "Return results for assets `data` and `cog`.", "value": [ "data|bidx=1", "cog|bidx=1,2" ] } } }, { "name": "expression", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Band Math expression", "description": "rio-tiler's band math expression" }, "description": "rio-tiler's band math expression", "examples": { "user-provided": {}, "simple": { "description": "Simple band math.", "value": "b1/b2" }, "multi-bands": { "description": "Semicolon (;) delimited expressions (band1: b1/b2, band2: b2+b3).", "value": "b1/b2;b2+b3" } } }, { "name": "asset_as_band", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Consider asset as a 1 band dataset", "description": "Asset as Band" }, "description": "Asset as Band" }, { "name": "nodata", "in": "query", "required": false, "schema": { "anyOf": [ { "enum": [ "nan", "inf", "-inf" ], "type": "string" }, { "type": "integer" }, { "type": "number" }, { "type": "null" } ], "title": "Nodata value", "description": "Overwrite internal Nodata value; nan or valid float values only." }, "description": "Overwrite internal Nodata value; nan or valid float values only." }, { "name": "unscale", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Apply internal Scale/Offset", "description": "Apply internal Scale/Offset. Defaults to `False`." }, "description": "Apply internal Scale/Offset. Defaults to `False`." }, { "name": "resampling", "in": "query", "required": false, "schema": { "anyOf": [ { "enum": [ "nearest", "bilinear", "cubic", "cubic_spline", "lanczos", "average", "mode", "gauss", "rms" ], "type": "string" }, { "type": "null" } ], "description": "RasterIO resampling algorithm. Defaults to `nearest`.", "title": "Resampling" }, "description": "RasterIO resampling algorithm. Defaults to `nearest`." }, { "name": "reproject", "in": "query", "required": false, "schema": { "anyOf": [ { "enum": [ "nearest", "bilinear", "cubic", "cubic_spline", "lanczos", "average", "mode", "max", "min", "med", "q1", "q3", "sum", "rms" ], "type": "string" }, { "type": "null" } ], "description": "WarpKernel resampling algorithm (only used when doing re-projection). Defaults to `nearest`.", "title": "Reproject" }, "description": "WarpKernel resampling algorithm (only used when doing re-projection). Defaults to `nearest`." }, { "name": "max_size", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "Maximum image size to read onto.", "title": "Max Size" } }, { "name": "dst_crs", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Output Coordinate Reference System.", "title": "Dst Crs" }, "description": "Output Coordinate Reference System." }, { "name": "coord_crs", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Coordinate Reference System of the input coords. Default to `epsg:4326`.", "title": "Coord Crs" }, "description": "Coordinate Reference System of the input coords. Default to `epsg:4326`." }, { "name": "algorithm", "in": "query", "required": false, "schema": { "enum": [ "hillshade", "slope", "contours", "normalizedIndex", "terrarium", "terrainrgb", "cast", "ceil", "floor", "min", "max", "median", "mean", "std", "var", "sum", "grayscale", "bitonal" ], "type": "string", "description": "Algorithm name", "title": "Algorithm" }, "description": "Algorithm name" }, { "name": "algorithm_params", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Algorithm parameter", "title": "Algorithm Params" }, "description": "Algorithm parameter" }, { "name": "colormap_name", "in": "query", "required": false, "schema": { "enum": [ "jet_r", "haline", "gist_ncar_r", "algae", "cividis_r", "seismic_r", "pink_r", "rdylbu", "inferno_r", "deep", "rdgy_r", "tab10", "bugn_r", "ocean_r", "purples", "pastel1_r", "thermal_r", "ylorrd_r", "wistia_r", "cmrmap", "pubu", "rain", "ylgnbu", "gnuplot", "gnbu", "gist_gray_r", "greens", "purd_r", "oxy_r", "matter", "summer_r", "gnuplot_r", "gnuplot2", "solar", "jet", "ylgn_r", "dark2_r", "spring", "tab20c", "gist_stern", "bwr", "ylgn", "plasma", "pastel2", "blues_r", "rain_r", "set1", "topo_r", "gist_ncar", "turbid", "magma_r", "pastel2_r", "purd", "gnbu_r", "spring_r", "rdbu_r", "ylorbr", "twilight_shifted", "rplumbo", "winter_r", "tab20b", "ylorrd", "copper", "flag_r", "afmhot", "twilight_shifted_r", "oranges_r", "bone", "seismic", "gray_r", "tarn_r", "bwr_r", "magma", "paired_r", "dark2", "binary", "set3", "viridis_r", "spectral", "prgn", "diff", "hot", "gist_earth", "cubehelix", "dense_r", "coolwarm", "pubugn_r", "autumn_r", "gnuplot2_r", "cividis", "bugn", "deep_r", "prgn_r", "gist_rainbow", "gist_heat_r", "nipy_spectral_r", "tab20", "turbo_r", "pubugn", "set2_r", "gist_yarg_r", "spectral_r", "binary_r", "greys", "rainbow_r", "haline_r", "curl", "tab20c_r", "blues", "prism", "rdgy", "gist_gray", "set2", "cool", "afmhot_r", "bone_r", "paired", "oranges", "orrd", "puor", "autumn", "delta_r", "pubu_r", "piyg_r", "turbo", "greys_r", "accent", "turbid_r", "algae_r", "solar_r", "topo", "cool_r", "inferno", "balance", "tempo_r", "amp_r", "flag", "speed", "gist_heat", "balance_r", "viridis", "cubehelix_r", "ylorbr_r", "summer", "coolwarm_r", "diff_r", "rdylgn_r", "gist_stern_r", "plasma_r", "copper_r", "oxy", "gist_yarg", "twilight", "winter", "brbg", "reds_r", "speed_r", "rainbow", "ice", "nipy_spectral", "piyg", "gray", "reds", "terrain", "tab20_r", "wistia", "accent_r", "thermal", "ocean", "twilight_r", "hot_r", "set3_r", "hsv_r", "brg_r", "gist_rainbow_r", "phase", "bupu", "pastel1", "dense", "set1_r", "phase_r", "matter_r", "greens_r", "cfastie", "tab10_r", "rdbu", "brg", "rdpu_r", "brbg_r", "cmrmap_r", "prism_r", "purples_r", "gist_earth_r", "tempo", "schwarzwald", "rdpu", "orrd_r", "tarn", "puor_r", "bupu_r", "rdylgn", "ice_r", "pink", "terrain_r", "amp", "tab20b_r", "rdylbu_r", "hsv", "curl_r", "delta", "ylgnbu_r" ], "type": "string", "description": "Colormap name", "title": "Colormap Name" }, "description": "Colormap name" }, { "name": "colormap", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "JSON encoded custom Colormap", "title": "Colormap" }, "description": "JSON encoded custom Colormap" }, { "name": "rescale", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ], "title": "Min/Max data Rescaling", "description": "comma (',') delimited Min,Max range. Can set multiple time for multiple bands.", "examples": [ "0,2000", "0,1000", "0,10000" ] }, "description": "comma (',') delimited Min,Max range. Can set multiple time for multiple bands." }, { "name": "color_formula", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Color Formula", "description": "rio-color formula (info: https://github.com/mapbox/rio-color)" }, "description": "rio-color formula (info: https://github.com/mapbox/rio-color)" }, { "name": "return_mask", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "Add mask to the output data. Defaults to `True`", "title": "Return Mask" }, "description": "Add mask to the output data. Defaults to `True`" } ], "responses": { "200": { "description": "Return an image.", "content": { "image/png": {}, "image/jpeg": {}, "image/jpg": {}, "image/webp": {}, "image/jp2": {}, "image/tiff; application=geotiff": {}, "application/x-binary": {} } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/stac/bbox/{minx},{miny},{maxx},{maxy}.{format}": { "get": { "tags": [ "SpatioTemporal Asset Catalog" ], "summary": "Bbox Image", "description": "Create image from a bbox.", "operationId": ".stac.getDataForBoundingBoxWithFormat", "parameters": [ { "name": "minx", "in": "path", "required": true, "schema": { "type": "number", "description": "Bounding box min X", "title": "Minx" }, "description": "Bounding box min X" }, { "name": "miny", "in": "path", "required": true, "schema": { "type": "number", "description": "Bounding box min Y", "title": "Miny" }, "description": "Bounding box min Y" }, { "name": "maxx", "in": "path", "required": true, "schema": { "type": "number", "description": "Bounding box max X", "title": "Maxx" }, "description": "Bounding box max X" }, { "name": "maxy", "in": "path", "required": true, "schema": { "type": "number", "description": "Bounding box max Y", "title": "Maxy" }, "description": "Bounding box max Y" }, { "name": "format", "in": "path", "required": true, "schema": { "anyOf": [ { "$ref": "#/components/schemas/ImageType" }, { "type": "null" } ], "description": "Default will be automatically defined if the output image needs a mask (png) or not (jpeg).", "title": "Format" } }, { "name": "url", "in": "query", "required": true, "schema": { "type": "string", "description": "Dataset URL", "title": "Url" }, "description": "Dataset URL" }, { "name": "assets", "in": "query", "required": true, "schema": { "type": "array", "items": { "type": "string" }, "title": "Asset names", "description": "Asset's names." }, "description": "Asset's names.", "examples": { "user-provided": {}, "one-asset": { "description": "Return results for asset `data`.", "value": [ "data" ] }, "multi-assets": { "description": "Return results for assets `data` and `cog`.", "value": [ "data", "cog" ] }, "multi-assets-with-options": { "description": "Return results for assets `data` and `cog`.", "value": [ "data|bidx=1", "cog|bidx=1,2" ] } } }, { "name": "expression", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Band Math expression", "description": "rio-tiler's band math expression" }, "description": "rio-tiler's band math expression", "examples": { "user-provided": {}, "simple": { "description": "Simple band math.", "value": "b1/b2" }, "multi-bands": { "description": "Semicolon (;) delimited expressions (band1: b1/b2, band2: b2+b3).", "value": "b1/b2;b2+b3" } } }, { "name": "asset_as_band", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Consider asset as a 1 band dataset", "description": "Asset as Band" }, "description": "Asset as Band" }, { "name": "nodata", "in": "query", "required": false, "schema": { "anyOf": [ { "enum": [ "nan", "inf", "-inf" ], "type": "string" }, { "type": "integer" }, { "type": "number" }, { "type": "null" } ], "title": "Nodata value", "description": "Overwrite internal Nodata value; nan or valid float values only." }, "description": "Overwrite internal Nodata value; nan or valid float values only." }, { "name": "unscale", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Apply internal Scale/Offset", "description": "Apply internal Scale/Offset. Defaults to `False`." }, "description": "Apply internal Scale/Offset. Defaults to `False`." }, { "name": "resampling", "in": "query", "required": false, "schema": { "anyOf": [ { "enum": [ "nearest", "bilinear", "cubic", "cubic_spline", "lanczos", "average", "mode", "gauss", "rms" ], "type": "string" }, { "type": "null" } ], "description": "RasterIO resampling algorithm. Defaults to `nearest`.", "title": "Resampling" }, "description": "RasterIO resampling algorithm. Defaults to `nearest`." }, { "name": "reproject", "in": "query", "required": false, "schema": { "anyOf": [ { "enum": [ "nearest", "bilinear", "cubic", "cubic_spline", "lanczos", "average", "mode", "max", "min", "med", "q1", "q3", "sum", "rms" ], "type": "string" }, { "type": "null" } ], "description": "WarpKernel resampling algorithm (only used when doing re-projection). Defaults to `nearest`.", "title": "Reproject" }, "description": "WarpKernel resampling algorithm (only used when doing re-projection). Defaults to `nearest`." }, { "name": "max_size", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "Maximum image size to read onto.", "title": "Max Size" } }, { "name": "height", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "Force output image height.", "title": "Height" } }, { "name": "width", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "Force output image width.", "title": "Width" } }, { "name": "dst_crs", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Output Coordinate Reference System.", "title": "Dst Crs" }, "description": "Output Coordinate Reference System." }, { "name": "coord_crs", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Coordinate Reference System of the input coords. Default to `epsg:4326`.", "title": "Coord Crs" }, "description": "Coordinate Reference System of the input coords. Default to `epsg:4326`." }, { "name": "algorithm", "in": "query", "required": false, "schema": { "enum": [ "hillshade", "slope", "contours", "normalizedIndex", "terrarium", "terrainrgb", "cast", "ceil", "floor", "min", "max", "median", "mean", "std", "var", "sum", "grayscale", "bitonal" ], "type": "string", "description": "Algorithm name", "title": "Algorithm" }, "description": "Algorithm name" }, { "name": "algorithm_params", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Algorithm parameter", "title": "Algorithm Params" }, "description": "Algorithm parameter" }, { "name": "colormap_name", "in": "query", "required": false, "schema": { "enum": [ "jet_r", "haline", "gist_ncar_r", "algae", "cividis_r", "seismic_r", "pink_r", "rdylbu", "inferno_r", "deep", "rdgy_r", "tab10", "bugn_r", "ocean_r", "purples", "pastel1_r", "thermal_r", "ylorrd_r", "wistia_r", "cmrmap", "pubu", "rain", "ylgnbu", "gnuplot", "gnbu", "gist_gray_r", "greens", "purd_r", "oxy_r", "matter", "summer_r", "gnuplot_r", "gnuplot2", "solar", "jet", "ylgn_r", "dark2_r", "spring", "tab20c", "gist_stern", "bwr", "ylgn", "plasma", "pastel2", "blues_r", "rain_r", "set1", "topo_r", "gist_ncar", "turbid", "magma_r", "pastel2_r", "purd", "gnbu_r", "spring_r", "rdbu_r", "ylorbr", "twilight_shifted", "rplumbo", "winter_r", "tab20b", "ylorrd", "copper", "flag_r", "afmhot", "twilight_shifted_r", "oranges_r", "bone", "seismic", "gray_r", "tarn_r", "bwr_r", "magma", "paired_r", "dark2", "binary", "set3", "viridis_r", "spectral", "prgn", "diff", "hot", "gist_earth", "cubehelix", "dense_r", "coolwarm", "pubugn_r", "autumn_r", "gnuplot2_r", "cividis", "bugn", "deep_r", "prgn_r", "gist_rainbow", "gist_heat_r", "nipy_spectral_r", "tab20", "turbo_r", "pubugn", "set2_r", "gist_yarg_r", "spectral_r", "binary_r", "greys", "rainbow_r", "haline_r", "curl", "tab20c_r", "blues", "prism", "rdgy", "gist_gray", "set2", "cool", "afmhot_r", "bone_r", "paired", "oranges", "orrd", "puor", "autumn", "delta_r", "pubu_r", "piyg_r", "turbo", "greys_r", "accent", "turbid_r", "algae_r", "solar_r", "topo", "cool_r", "inferno", "balance", "tempo_r", "amp_r", "flag", "speed", "gist_heat", "balance_r", "viridis", "cubehelix_r", "ylorbr_r", "summer", "coolwarm_r", "diff_r", "rdylgn_r", "gist_stern_r", "plasma_r", "copper_r", "oxy", "gist_yarg", "twilight", "winter", "brbg", "reds_r", "speed_r", "rainbow", "ice", "nipy_spectral", "piyg", "gray", "reds", "terrain", "tab20_r", "wistia", "accent_r", "thermal", "ocean", "twilight_r", "hot_r", "set3_r", "hsv_r", "brg_r", "gist_rainbow_r", "phase", "bupu", "pastel1", "dense", "set1_r", "phase_r", "matter_r", "greens_r", "cfastie", "tab10_r", "rdbu", "brg", "rdpu_r", "brbg_r", "cmrmap_r", "prism_r", "purples_r", "gist_earth_r", "tempo", "schwarzwald", "rdpu", "orrd_r", "tarn", "puor_r", "bupu_r", "rdylgn", "ice_r", "pink", "terrain_r", "amp", "tab20b_r", "rdylbu_r", "hsv", "curl_r", "delta", "ylgnbu_r" ], "type": "string", "description": "Colormap name", "title": "Colormap Name" }, "description": "Colormap name" }, { "name": "colormap", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "JSON encoded custom Colormap", "title": "Colormap" }, "description": "JSON encoded custom Colormap" }, { "name": "rescale", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ], "title": "Min/Max data Rescaling", "description": "comma (',') delimited Min,Max range. Can set multiple time for multiple bands.", "examples": [ "0,2000", "0,1000", "0,10000" ] }, "description": "comma (',') delimited Min,Max range. Can set multiple time for multiple bands." }, { "name": "color_formula", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Color Formula", "description": "rio-color formula (info: https://github.com/mapbox/rio-color)" }, "description": "rio-color formula (info: https://github.com/mapbox/rio-color)" }, { "name": "return_mask", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "Add mask to the output data. Defaults to `True`", "title": "Return Mask" }, "description": "Add mask to the output data. Defaults to `True`" } ], "responses": { "200": { "description": "Return an image.", "content": { "image/png": {}, "image/jpeg": {}, "image/jpg": {}, "image/webp": {}, "image/jp2": {}, "image/tiff; application=geotiff": {}, "application/x-binary": {} } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/stac/feature/{width}x{height}.{format}": { "post": { "tags": [ "SpatioTemporal Asset Catalog" ], "summary": "Feature Image", "description": "Create image from a geojson feature.", "operationId": ".stac.postDataForGeoJSONWithSizesAndFormat", "parameters": [ { "name": "format", "in": "path", "required": true, "schema": { "anyOf": [ { "$ref": "#/components/schemas/ImageType" }, { "type": "null" } ], "description": "Default will be automatically defined if the output image needs a mask (png) or not (jpeg).", "title": "Format" } }, { "name": "height", "in": "path", "required": true, "schema": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "Force output image height.", "title": "Height" } }, { "name": "width", "in": "path", "required": true, "schema": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "Force output image width.", "title": "Width" } }, { "name": "url", "in": "query", "required": true, "schema": { "type": "string", "description": "Dataset URL", "title": "Url" }, "description": "Dataset URL" }, { "name": "assets", "in": "query", "required": true, "schema": { "type": "array", "items": { "type": "string" }, "title": "Asset names", "description": "Asset's names." }, "description": "Asset's names.", "examples": { "user-provided": {}, "one-asset": { "description": "Return results for asset `data`.", "value": [ "data" ] }, "multi-assets": { "description": "Return results for assets `data` and `cog`.", "value": [ "data", "cog" ] }, "multi-assets-with-options": { "description": "Return results for assets `data` and `cog`.", "value": [ "data|bidx=1", "cog|bidx=1,2" ] } } }, { "name": "expression", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Band Math expression", "description": "rio-tiler's band math expression" }, "description": "rio-tiler's band math expression", "examples": { "user-provided": {}, "simple": { "description": "Simple band math.", "value": "b1/b2" }, "multi-bands": { "description": "Semicolon (;) delimited expressions (band1: b1/b2, band2: b2+b3).", "value": "b1/b2;b2+b3" } } }, { "name": "asset_as_band", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Consider asset as a 1 band dataset", "description": "Asset as Band" }, "description": "Asset as Band" }, { "name": "nodata", "in": "query", "required": false, "schema": { "anyOf": [ { "enum": [ "nan", "inf", "-inf" ], "type": "string" }, { "type": "integer" }, { "type": "number" }, { "type": "null" } ], "title": "Nodata value", "description": "Overwrite internal Nodata value; nan or valid float values only." }, "description": "Overwrite internal Nodata value; nan or valid float values only." }, { "name": "unscale", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Apply internal Scale/Offset", "description": "Apply internal Scale/Offset. Defaults to `False`." }, "description": "Apply internal Scale/Offset. Defaults to `False`." }, { "name": "resampling", "in": "query", "required": false, "schema": { "anyOf": [ { "enum": [ "nearest", "bilinear", "cubic", "cubic_spline", "lanczos", "average", "mode", "gauss", "rms" ], "type": "string" }, { "type": "null" } ], "description": "RasterIO resampling algorithm. Defaults to `nearest`.", "title": "Resampling" }, "description": "RasterIO resampling algorithm. Defaults to `nearest`." }, { "name": "reproject", "in": "query", "required": false, "schema": { "anyOf": [ { "enum": [ "nearest", "bilinear", "cubic", "cubic_spline", "lanczos", "average", "mode", "max", "min", "med", "q1", "q3", "sum", "rms" ], "type": "string" }, { "type": "null" } ], "description": "WarpKernel resampling algorithm (only used when doing re-projection). Defaults to `nearest`.", "title": "Reproject" }, "description": "WarpKernel resampling algorithm (only used when doing re-projection). Defaults to `nearest`." }, { "name": "max_size", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "Maximum image size to read onto.", "title": "Max Size" } }, { "name": "coord_crs", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Coordinate Reference System of the input coords. Default to `epsg:4326`.", "title": "Coord Crs" }, "description": "Coordinate Reference System of the input coords. Default to `epsg:4326`." }, { "name": "dst_crs", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Output Coordinate Reference System.", "title": "Dst Crs" }, "description": "Output Coordinate Reference System." }, { "name": "algorithm", "in": "query", "required": false, "schema": { "enum": [ "hillshade", "slope", "contours", "normalizedIndex", "terrarium", "terrainrgb", "cast", "ceil", "floor", "min", "max", "median", "mean", "std", "var", "sum", "grayscale", "bitonal" ], "type": "string", "description": "Algorithm name", "title": "Algorithm" }, "description": "Algorithm name" }, { "name": "algorithm_params", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Algorithm parameter", "title": "Algorithm Params" }, "description": "Algorithm parameter" }, { "name": "colormap_name", "in": "query", "required": false, "schema": { "enum": [ "jet_r", "haline", "gist_ncar_r", "algae", "cividis_r", "seismic_r", "pink_r", "rdylbu", "inferno_r", "deep", "rdgy_r", "tab10", "bugn_r", "ocean_r", "purples", "pastel1_r", "thermal_r", "ylorrd_r", "wistia_r", "cmrmap", "pubu", "rain", "ylgnbu", "gnuplot", "gnbu", "gist_gray_r", "greens", "purd_r", "oxy_r", "matter", "summer_r", "gnuplot_r", "gnuplot2", "solar", "jet", "ylgn_r", "dark2_r", "spring", "tab20c", "gist_stern", "bwr", "ylgn", "plasma", "pastel2", "blues_r", "rain_r", "set1", "topo_r", "gist_ncar", "turbid", "magma_r", "pastel2_r", "purd", "gnbu_r", "spring_r", "rdbu_r", "ylorbr", "twilight_shifted", "rplumbo", "winter_r", "tab20b", "ylorrd", "copper", "flag_r", "afmhot", "twilight_shifted_r", "oranges_r", "bone", "seismic", "gray_r", "tarn_r", "bwr_r", "magma", "paired_r", "dark2", "binary", "set3", "viridis_r", "spectral", "prgn", "diff", "hot", "gist_earth", "cubehelix", "dense_r", "coolwarm", "pubugn_r", "autumn_r", "gnuplot2_r", "cividis", "bugn", "deep_r", "prgn_r", "gist_rainbow", "gist_heat_r", "nipy_spectral_r", "tab20", "turbo_r", "pubugn", "set2_r", "gist_yarg_r", "spectral_r", "binary_r", "greys", "rainbow_r", "haline_r", "curl", "tab20c_r", "blues", "prism", "rdgy", "gist_gray", "set2", "cool", "afmhot_r", "bone_r", "paired", "oranges", "orrd", "puor", "autumn", "delta_r", "pubu_r", "piyg_r", "turbo", "greys_r", "accent", "turbid_r", "algae_r", "solar_r", "topo", "cool_r", "inferno", "balance", "tempo_r", "amp_r", "flag", "speed", "gist_heat", "balance_r", "viridis", "cubehelix_r", "ylorbr_r", "summer", "coolwarm_r", "diff_r", "rdylgn_r", "gist_stern_r", "plasma_r", "copper_r", "oxy", "gist_yarg", "twilight", "winter", "brbg", "reds_r", "speed_r", "rainbow", "ice", "nipy_spectral", "piyg", "gray", "reds", "terrain", "tab20_r", "wistia", "accent_r", "thermal", "ocean", "twilight_r", "hot_r", "set3_r", "hsv_r", "brg_r", "gist_rainbow_r", "phase", "bupu", "pastel1", "dense", "set1_r", "phase_r", "matter_r", "greens_r", "cfastie", "tab10_r", "rdbu", "brg", "rdpu_r", "brbg_r", "cmrmap_r", "prism_r", "purples_r", "gist_earth_r", "tempo", "schwarzwald", "rdpu", "orrd_r", "tarn", "puor_r", "bupu_r", "rdylgn", "ice_r", "pink", "terrain_r", "amp", "tab20b_r", "rdylbu_r", "hsv", "curl_r", "delta", "ylgnbu_r" ], "type": "string", "description": "Colormap name", "title": "Colormap Name" }, "description": "Colormap name" }, { "name": "colormap", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "JSON encoded custom Colormap", "title": "Colormap" }, "description": "JSON encoded custom Colormap" }, { "name": "rescale", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ], "title": "Min/Max data Rescaling", "description": "comma (',') delimited Min,Max range. Can set multiple time for multiple bands.", "examples": [ "0,2000", "0,1000", "0,10000" ] }, "description": "comma (',') delimited Min,Max range. Can set multiple time for multiple bands." }, { "name": "color_formula", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Color Formula", "description": "rio-color formula (info: https://github.com/mapbox/rio-color)" }, "description": "rio-color formula (info: https://github.com/mapbox/rio-color)" }, { "name": "return_mask", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "Add mask to the output data. Defaults to `True`", "title": "Return Mask" }, "description": "Add mask to the output data. Defaults to `True`" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Feature-Input", "description": "GeoJSON Feature." } } } }, "responses": { "200": { "description": "Return an image.", "content": { "image/png": {}, "image/jpeg": {}, "image/jpg": {}, "image/webp": {}, "image/jp2": {}, "image/tiff; application=geotiff": {}, "application/x-binary": {} } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/stac/feature.{format}": { "post": { "tags": [ "SpatioTemporal Asset Catalog" ], "summary": "Feature Image", "description": "Create image from a geojson feature.", "operationId": ".stac.postDataForGeoJSONWithFormat", "parameters": [ { "name": "format", "in": "path", "required": true, "schema": { "anyOf": [ { "$ref": "#/components/schemas/ImageType" }, { "type": "null" } ], "description": "Default will be automatically defined if the output image needs a mask (png) or not (jpeg).", "title": "Format" } }, { "name": "url", "in": "query", "required": true, "schema": { "type": "string", "description": "Dataset URL", "title": "Url" }, "description": "Dataset URL" }, { "name": "assets", "in": "query", "required": true, "schema": { "type": "array", "items": { "type": "string" }, "title": "Asset names", "description": "Asset's names." }, "description": "Asset's names.", "examples": { "user-provided": {}, "one-asset": { "description": "Return results for asset `data`.", "value": [ "data" ] }, "multi-assets": { "description": "Return results for assets `data` and `cog`.", "value": [ "data", "cog" ] }, "multi-assets-with-options": { "description": "Return results for assets `data` and `cog`.", "value": [ "data|bidx=1", "cog|bidx=1,2" ] } } }, { "name": "expression", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Band Math expression", "description": "rio-tiler's band math expression" }, "description": "rio-tiler's band math expression", "examples": { "user-provided": {}, "simple": { "description": "Simple band math.", "value": "b1/b2" }, "multi-bands": { "description": "Semicolon (;) delimited expressions (band1: b1/b2, band2: b2+b3).", "value": "b1/b2;b2+b3" } } }, { "name": "asset_as_band", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Consider asset as a 1 band dataset", "description": "Asset as Band" }, "description": "Asset as Band" }, { "name": "nodata", "in": "query", "required": false, "schema": { "anyOf": [ { "enum": [ "nan", "inf", "-inf" ], "type": "string" }, { "type": "integer" }, { "type": "number" }, { "type": "null" } ], "title": "Nodata value", "description": "Overwrite internal Nodata value; nan or valid float values only." }, "description": "Overwrite internal Nodata value; nan or valid float values only." }, { "name": "unscale", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Apply internal Scale/Offset", "description": "Apply internal Scale/Offset. Defaults to `False`." }, "description": "Apply internal Scale/Offset. Defaults to `False`." }, { "name": "resampling", "in": "query", "required": false, "schema": { "anyOf": [ { "enum": [ "nearest", "bilinear", "cubic", "cubic_spline", "lanczos", "average", "mode", "gauss", "rms" ], "type": "string" }, { "type": "null" } ], "description": "RasterIO resampling algorithm. Defaults to `nearest`.", "title": "Resampling" }, "description": "RasterIO resampling algorithm. Defaults to `nearest`." }, { "name": "reproject", "in": "query", "required": false, "schema": { "anyOf": [ { "enum": [ "nearest", "bilinear", "cubic", "cubic_spline", "lanczos", "average", "mode", "max", "min", "med", "q1", "q3", "sum", "rms" ], "type": "string" }, { "type": "null" } ], "description": "WarpKernel resampling algorithm (only used when doing re-projection). Defaults to `nearest`.", "title": "Reproject" }, "description": "WarpKernel resampling algorithm (only used when doing re-projection). Defaults to `nearest`." }, { "name": "max_size", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "Maximum image size to read onto.", "title": "Max Size" } }, { "name": "height", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "Force output image height.", "title": "Height" } }, { "name": "width", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "Force output image width.", "title": "Width" } }, { "name": "coord_crs", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Coordinate Reference System of the input coords. Default to `epsg:4326`.", "title": "Coord Crs" }, "description": "Coordinate Reference System of the input coords. Default to `epsg:4326`." }, { "name": "dst_crs", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Output Coordinate Reference System.", "title": "Dst Crs" }, "description": "Output Coordinate Reference System." }, { "name": "algorithm", "in": "query", "required": false, "schema": { "enum": [ "hillshade", "slope", "contours", "normalizedIndex", "terrarium", "terrainrgb", "cast", "ceil", "floor", "min", "max", "median", "mean", "std", "var", "sum", "grayscale", "bitonal" ], "type": "string", "description": "Algorithm name", "title": "Algorithm" }, "description": "Algorithm name" }, { "name": "algorithm_params", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Algorithm parameter", "title": "Algorithm Params" }, "description": "Algorithm parameter" }, { "name": "colormap_name", "in": "query", "required": false, "schema": { "enum": [ "jet_r", "haline", "gist_ncar_r", "algae", "cividis_r", "seismic_r", "pink_r", "rdylbu", "inferno_r", "deep", "rdgy_r", "tab10", "bugn_r", "ocean_r", "purples", "pastel1_r", "thermal_r", "ylorrd_r", "wistia_r", "cmrmap", "pubu", "rain", "ylgnbu", "gnuplot", "gnbu", "gist_gray_r", "greens", "purd_r", "oxy_r", "matter", "summer_r", "gnuplot_r", "gnuplot2", "solar", "jet", "ylgn_r", "dark2_r", "spring", "tab20c", "gist_stern", "bwr", "ylgn", "plasma", "pastel2", "blues_r", "rain_r", "set1", "topo_r", "gist_ncar", "turbid", "magma_r", "pastel2_r", "purd", "gnbu_r", "spring_r", "rdbu_r", "ylorbr", "twilight_shifted", "rplumbo", "winter_r", "tab20b", "ylorrd", "copper", "flag_r", "afmhot", "twilight_shifted_r", "oranges_r", "bone", "seismic", "gray_r", "tarn_r", "bwr_r", "magma", "paired_r", "dark2", "binary", "set3", "viridis_r", "spectral", "prgn", "diff", "hot", "gist_earth", "cubehelix", "dense_r", "coolwarm", "pubugn_r", "autumn_r", "gnuplot2_r", "cividis", "bugn", "deep_r", "prgn_r", "gist_rainbow", "gist_heat_r", "nipy_spectral_r", "tab20", "turbo_r", "pubugn", "set2_r", "gist_yarg_r", "spectral_r", "binary_r", "greys", "rainbow_r", "haline_r", "curl", "tab20c_r", "blues", "prism", "rdgy", "gist_gray", "set2", "cool", "afmhot_r", "bone_r", "paired", "oranges", "orrd", "puor", "autumn", "delta_r", "pubu_r", "piyg_r", "turbo", "greys_r", "accent", "turbid_r", "algae_r", "solar_r", "topo", "cool_r", "inferno", "balance", "tempo_r", "amp_r", "flag", "speed", "gist_heat", "balance_r", "viridis", "cubehelix_r", "ylorbr_r", "summer", "coolwarm_r", "diff_r", "rdylgn_r", "gist_stern_r", "plasma_r", "copper_r", "oxy", "gist_yarg", "twilight", "winter", "brbg", "reds_r", "speed_r", "rainbow", "ice", "nipy_spectral", "piyg", "gray", "reds", "terrain", "tab20_r", "wistia", "accent_r", "thermal", "ocean", "twilight_r", "hot_r", "set3_r", "hsv_r", "brg_r", "gist_rainbow_r", "phase", "bupu", "pastel1", "dense", "set1_r", "phase_r", "matter_r", "greens_r", "cfastie", "tab10_r", "rdbu", "brg", "rdpu_r", "brbg_r", "cmrmap_r", "prism_r", "purples_r", "gist_earth_r", "tempo", "schwarzwald", "rdpu", "orrd_r", "tarn", "puor_r", "bupu_r", "rdylgn", "ice_r", "pink", "terrain_r", "amp", "tab20b_r", "rdylbu_r", "hsv", "curl_r", "delta", "ylgnbu_r" ], "type": "string", "description": "Colormap name", "title": "Colormap Name" }, "description": "Colormap name" }, { "name": "colormap", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "JSON encoded custom Colormap", "title": "Colormap" }, "description": "JSON encoded custom Colormap" }, { "name": "rescale", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ], "title": "Min/Max data Rescaling", "description": "comma (',') delimited Min,Max range. Can set multiple time for multiple bands.", "examples": [ "0,2000", "0,1000", "0,10000" ] }, "description": "comma (',') delimited Min,Max range. Can set multiple time for multiple bands." }, { "name": "color_formula", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Color Formula", "description": "rio-color formula (info: https://github.com/mapbox/rio-color)" }, "description": "rio-color formula (info: https://github.com/mapbox/rio-color)" }, { "name": "return_mask", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "Add mask to the output data. Defaults to `True`", "title": "Return Mask" }, "description": "Add mask to the output data. Defaults to `True`" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Feature-Input", "description": "GeoJSON Feature." } } } }, "responses": { "200": { "description": "Return an image.", "content": { "image/png": {}, "image/jpeg": {}, "image/jpg": {}, "image/webp": {}, "image/jp2": {}, "image/tiff; application=geotiff": {}, "application/x-binary": {} } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/stac/feature": { "post": { "tags": [ "SpatioTemporal Asset Catalog" ], "summary": "Feature Image", "description": "Create image from a geojson feature.", "operationId": ".stac.postDataForGeoJSON", "parameters": [ { "name": "format", "in": "query", "required": false, "schema": { "anyOf": [ { "$ref": "#/components/schemas/ImageType" }, { "type": "null" } ], "description": "Default will be automatically defined if the output image needs a mask (png) or not (jpeg).", "title": "Format" } }, { "name": "url", "in": "query", "required": true, "schema": { "type": "string", "description": "Dataset URL", "title": "Url" }, "description": "Dataset URL" }, { "name": "assets", "in": "query", "required": true, "schema": { "type": "array", "items": { "type": "string" }, "title": "Asset names", "description": "Asset's names." }, "description": "Asset's names.", "examples": { "user-provided": {}, "one-asset": { "description": "Return results for asset `data`.", "value": [ "data" ] }, "multi-assets": { "description": "Return results for assets `data` and `cog`.", "value": [ "data", "cog" ] }, "multi-assets-with-options": { "description": "Return results for assets `data` and `cog`.", "value": [ "data|bidx=1", "cog|bidx=1,2" ] } } }, { "name": "expression", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Band Math expression", "description": "rio-tiler's band math expression" }, "description": "rio-tiler's band math expression", "examples": { "user-provided": {}, "simple": { "description": "Simple band math.", "value": "b1/b2" }, "multi-bands": { "description": "Semicolon (;) delimited expressions (band1: b1/b2, band2: b2+b3).", "value": "b1/b2;b2+b3" } } }, { "name": "asset_as_band", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Consider asset as a 1 band dataset", "description": "Asset as Band" }, "description": "Asset as Band" }, { "name": "nodata", "in": "query", "required": false, "schema": { "anyOf": [ { "enum": [ "nan", "inf", "-inf" ], "type": "string" }, { "type": "integer" }, { "type": "number" }, { "type": "null" } ], "title": "Nodata value", "description": "Overwrite internal Nodata value; nan or valid float values only." }, "description": "Overwrite internal Nodata value; nan or valid float values only." }, { "name": "unscale", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Apply internal Scale/Offset", "description": "Apply internal Scale/Offset. Defaults to `False`." }, "description": "Apply internal Scale/Offset. Defaults to `False`." }, { "name": "resampling", "in": "query", "required": false, "schema": { "anyOf": [ { "enum": [ "nearest", "bilinear", "cubic", "cubic_spline", "lanczos", "average", "mode", "gauss", "rms" ], "type": "string" }, { "type": "null" } ], "description": "RasterIO resampling algorithm. Defaults to `nearest`.", "title": "Resampling" }, "description": "RasterIO resampling algorithm. Defaults to `nearest`." }, { "name": "reproject", "in": "query", "required": false, "schema": { "anyOf": [ { "enum": [ "nearest", "bilinear", "cubic", "cubic_spline", "lanczos", "average", "mode", "max", "min", "med", "q1", "q3", "sum", "rms" ], "type": "string" }, { "type": "null" } ], "description": "WarpKernel resampling algorithm (only used when doing re-projection). Defaults to `nearest`.", "title": "Reproject" }, "description": "WarpKernel resampling algorithm (only used when doing re-projection). Defaults to `nearest`." }, { "name": "max_size", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "Maximum image size to read onto.", "title": "Max Size" } }, { "name": "height", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "Force output image height.", "title": "Height" } }, { "name": "width", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "Force output image width.", "title": "Width" } }, { "name": "coord_crs", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Coordinate Reference System of the input coords. Default to `epsg:4326`.", "title": "Coord Crs" }, "description": "Coordinate Reference System of the input coords. Default to `epsg:4326`." }, { "name": "dst_crs", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Output Coordinate Reference System.", "title": "Dst Crs" }, "description": "Output Coordinate Reference System." }, { "name": "algorithm", "in": "query", "required": false, "schema": { "enum": [ "hillshade", "slope", "contours", "normalizedIndex", "terrarium", "terrainrgb", "cast", "ceil", "floor", "min", "max", "median", "mean", "std", "var", "sum", "grayscale", "bitonal" ], "type": "string", "description": "Algorithm name", "title": "Algorithm" }, "description": "Algorithm name" }, { "name": "algorithm_params", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Algorithm parameter", "title": "Algorithm Params" }, "description": "Algorithm parameter" }, { "name": "colormap_name", "in": "query", "required": false, "schema": { "enum": [ "jet_r", "haline", "gist_ncar_r", "algae", "cividis_r", "seismic_r", "pink_r", "rdylbu", "inferno_r", "deep", "rdgy_r", "tab10", "bugn_r", "ocean_r", "purples", "pastel1_r", "thermal_r", "ylorrd_r", "wistia_r", "cmrmap", "pubu", "rain", "ylgnbu", "gnuplot", "gnbu", "gist_gray_r", "greens", "purd_r", "oxy_r", "matter", "summer_r", "gnuplot_r", "gnuplot2", "solar", "jet", "ylgn_r", "dark2_r", "spring", "tab20c", "gist_stern", "bwr", "ylgn", "plasma", "pastel2", "blues_r", "rain_r", "set1", "topo_r", "gist_ncar", "turbid", "magma_r", "pastel2_r", "purd", "gnbu_r", "spring_r", "rdbu_r", "ylorbr", "twilight_shifted", "rplumbo", "winter_r", "tab20b", "ylorrd", "copper", "flag_r", "afmhot", "twilight_shifted_r", "oranges_r", "bone", "seismic", "gray_r", "tarn_r", "bwr_r", "magma", "paired_r", "dark2", "binary", "set3", "viridis_r", "spectral", "prgn", "diff", "hot", "gist_earth", "cubehelix", "dense_r", "coolwarm", "pubugn_r", "autumn_r", "gnuplot2_r", "cividis", "bugn", "deep_r", "prgn_r", "gist_rainbow", "gist_heat_r", "nipy_spectral_r", "tab20", "turbo_r", "pubugn", "set2_r", "gist_yarg_r", "spectral_r", "binary_r", "greys", "rainbow_r", "haline_r", "curl", "tab20c_r", "blues", "prism", "rdgy", "gist_gray", "set2", "cool", "afmhot_r", "bone_r", "paired", "oranges", "orrd", "puor", "autumn", "delta_r", "pubu_r", "piyg_r", "turbo", "greys_r", "accent", "turbid_r", "algae_r", "solar_r", "topo", "cool_r", "inferno", "balance", "tempo_r", "amp_r", "flag", "speed", "gist_heat", "balance_r", "viridis", "cubehelix_r", "ylorbr_r", "summer", "coolwarm_r", "diff_r", "rdylgn_r", "gist_stern_r", "plasma_r", "copper_r", "oxy", "gist_yarg", "twilight", "winter", "brbg", "reds_r", "speed_r", "rainbow", "ice", "nipy_spectral", "piyg", "gray", "reds", "terrain", "tab20_r", "wistia", "accent_r", "thermal", "ocean", "twilight_r", "hot_r", "set3_r", "hsv_r", "brg_r", "gist_rainbow_r", "phase", "bupu", "pastel1", "dense", "set1_r", "phase_r", "matter_r", "greens_r", "cfastie", "tab10_r", "rdbu", "brg", "rdpu_r", "brbg_r", "cmrmap_r", "prism_r", "purples_r", "gist_earth_r", "tempo", "schwarzwald", "rdpu", "orrd_r", "tarn", "puor_r", "bupu_r", "rdylgn", "ice_r", "pink", "terrain_r", "amp", "tab20b_r", "rdylbu_r", "hsv", "curl_r", "delta", "ylgnbu_r" ], "type": "string", "description": "Colormap name", "title": "Colormap Name" }, "description": "Colormap name" }, { "name": "colormap", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "JSON encoded custom Colormap", "title": "Colormap" }, "description": "JSON encoded custom Colormap" }, { "name": "rescale", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ], "title": "Min/Max data Rescaling", "description": "comma (',') delimited Min,Max range. Can set multiple time for multiple bands.", "examples": [ "0,2000", "0,1000", "0,10000" ] }, "description": "comma (',') delimited Min,Max range. Can set multiple time for multiple bands." }, { "name": "color_formula", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Color Formula", "description": "rio-color formula (info: https://github.com/mapbox/rio-color)" }, "description": "rio-color formula (info: https://github.com/mapbox/rio-color)" }, { "name": "return_mask", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "Add mask to the output data. Defaults to `True`", "title": "Return Mask" }, "description": "Add mask to the output data. Defaults to `True`" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Feature-Input", "description": "GeoJSON Feature." } } } }, "responses": { "200": { "description": "Return an image.", "content": { "image/png": {}, "image/jpeg": {}, "image/jpg": {}, "image/webp": {}, "image/jp2": {}, "image/tiff; application=geotiff": {}, "application/x-binary": {} } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/stac/map": { "get": { "tags": [ "SpatioTemporal Asset Catalog" ], "summary": "Get Map", "description": "OGC Maps API.", "operationId": ".stac.getMap", "parameters": [ { "name": "url", "in": "query", "required": true, "schema": { "type": "string", "description": "Dataset URL", "title": "Url" }, "description": "Dataset URL" }, { "name": "bbox", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Bounding box of the rendered map. The bounding box is provided as four or six coordinates.", "title": "Bbox" }, "description": "Bounding box of the rendered map. The bounding box is provided as four or six coordinates." }, { "name": "crs", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Reproject the output to the given crs.", "title": "Crs" }, "description": "Reproject the output to the given crs." }, { "name": "bbox-crs", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "crs for the specified bbox.", "title": "Bbox-Crs" }, "description": "crs for the specified bbox." }, { "name": "height", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "integer", "exclusiveMinimum": 0 }, { "type": "null" } ], "description": "Height of the map in pixels. If omitted and `width` is specified, defaults to the `height` maintaining a 1:1 aspect ratio. If both `width` and `height` are omitted, the server will select default dimensions.", "title": "Height" }, "description": "Height of the map in pixels. If omitted and `width` is specified, defaults to the `height` maintaining a 1:1 aspect ratio. If both `width` and `height` are omitted, the server will select default dimensions." }, { "name": "width", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "integer", "exclusiveMinimum": 0 }, { "type": "null" } ], "description": "Width of the map in pixels. If omitted and `height` is specified, defaults to the `width` maintaining a 1:1 aspect ratio. If both `width` and `height` are omitted, the server will select default dimensions.", "title": "Width" }, "description": "Width of the map in pixels. If omitted and `height` is specified, defaults to the `width` maintaining a 1:1 aspect ratio. If both `width` and `height` are omitted, the server will select default dimensions." }, { "name": "f", "in": "query", "required": false, "schema": { "anyOf": [ { "$ref": "#/components/schemas/ImageType" }, { "type": "null" } ], "description": "The format of the map response (e.g. png).", "title": "F" }, "description": "The format of the map response (e.g. png)." }, { "name": "assets", "in": "query", "required": true, "schema": { "type": "array", "items": { "type": "string" }, "title": "Asset names", "description": "Asset's names." }, "description": "Asset's names.", "examples": { "user-provided": {}, "one-asset": { "description": "Return results for asset `data`.", "value": [ "data" ] }, "multi-assets": { "description": "Return results for assets `data` and `cog`.", "value": [ "data", "cog" ] }, "multi-assets-with-options": { "description": "Return results for assets `data` and `cog`.", "value": [ "data|bidx=1", "cog|bidx=1,2" ] } } }, { "name": "expression", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Band Math expression", "description": "rio-tiler's band math expression" }, "description": "rio-tiler's band math expression", "examples": { "user-provided": {}, "simple": { "description": "Simple band math.", "value": "b1/b2" }, "multi-bands": { "description": "Semicolon (;) delimited expressions (band1: b1/b2, band2: b2+b3).", "value": "b1/b2;b2+b3" } } }, { "name": "asset_as_band", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Consider asset as a 1 band dataset", "description": "Asset as Band" }, "description": "Asset as Band" }, { "name": "nodata", "in": "query", "required": false, "schema": { "anyOf": [ { "enum": [ "nan", "inf", "-inf" ], "type": "string" }, { "type": "integer" }, { "type": "number" }, { "type": "null" } ], "title": "Nodata value", "description": "Overwrite internal Nodata value; nan or valid float values only." }, "description": "Overwrite internal Nodata value; nan or valid float values only." }, { "name": "unscale", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Apply internal Scale/Offset", "description": "Apply internal Scale/Offset. Defaults to `False`." }, "description": "Apply internal Scale/Offset. Defaults to `False`." }, { "name": "resampling", "in": "query", "required": false, "schema": { "anyOf": [ { "enum": [ "nearest", "bilinear", "cubic", "cubic_spline", "lanczos", "average", "mode", "gauss", "rms" ], "type": "string" }, { "type": "null" } ], "description": "RasterIO resampling algorithm. Defaults to `nearest`.", "title": "Resampling" }, "description": "RasterIO resampling algorithm. Defaults to `nearest`." }, { "name": "reproject", "in": "query", "required": false, "schema": { "anyOf": [ { "enum": [ "nearest", "bilinear", "cubic", "cubic_spline", "lanczos", "average", "mode", "max", "min", "med", "q1", "q3", "sum", "rms" ], "type": "string" }, { "type": "null" } ], "description": "WarpKernel resampling algorithm (only used when doing re-projection). Defaults to `nearest`.", "title": "Reproject" }, "description": "WarpKernel resampling algorithm (only used when doing re-projection). Defaults to `nearest`." }, { "name": "algorithm", "in": "query", "required": false, "schema": { "enum": [ "hillshade", "slope", "contours", "normalizedIndex", "terrarium", "terrainrgb", "cast", "ceil", "floor", "min", "max", "median", "mean", "std", "var", "sum", "grayscale", "bitonal" ], "type": "string", "description": "Algorithm name", "title": "Algorithm" }, "description": "Algorithm name" }, { "name": "algorithm_params", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Algorithm parameter", "title": "Algorithm Params" }, "description": "Algorithm parameter" }, { "name": "colormap_name", "in": "query", "required": false, "schema": { "enum": [ "jet_r", "haline", "gist_ncar_r", "algae", "cividis_r", "seismic_r", "pink_r", "rdylbu", "inferno_r", "deep", "rdgy_r", "tab10", "bugn_r", "ocean_r", "purples", "pastel1_r", "thermal_r", "ylorrd_r", "wistia_r", "cmrmap", "pubu", "rain", "ylgnbu", "gnuplot", "gnbu", "gist_gray_r", "greens", "purd_r", "oxy_r", "matter", "summer_r", "gnuplot_r", "gnuplot2", "solar", "jet", "ylgn_r", "dark2_r", "spring", "tab20c", "gist_stern", "bwr", "ylgn", "plasma", "pastel2", "blues_r", "rain_r", "set1", "topo_r", "gist_ncar", "turbid", "magma_r", "pastel2_r", "purd", "gnbu_r", "spring_r", "rdbu_r", "ylorbr", "twilight_shifted", "rplumbo", "winter_r", "tab20b", "ylorrd", "copper", "flag_r", "afmhot", "twilight_shifted_r", "oranges_r", "bone", "seismic", "gray_r", "tarn_r", "bwr_r", "magma", "paired_r", "dark2", "binary", "set3", "viridis_r", "spectral", "prgn", "diff", "hot", "gist_earth", "cubehelix", "dense_r", "coolwarm", "pubugn_r", "autumn_r", "gnuplot2_r", "cividis", "bugn", "deep_r", "prgn_r", "gist_rainbow", "gist_heat_r", "nipy_spectral_r", "tab20", "turbo_r", "pubugn", "set2_r", "gist_yarg_r", "spectral_r", "binary_r", "greys", "rainbow_r", "haline_r", "curl", "tab20c_r", "blues", "prism", "rdgy", "gist_gray", "set2", "cool", "afmhot_r", "bone_r", "paired", "oranges", "orrd", "puor", "autumn", "delta_r", "pubu_r", "piyg_r", "turbo", "greys_r", "accent", "turbid_r", "algae_r", "solar_r", "topo", "cool_r", "inferno", "balance", "tempo_r", "amp_r", "flag", "speed", "gist_heat", "balance_r", "viridis", "cubehelix_r", "ylorbr_r", "summer", "coolwarm_r", "diff_r", "rdylgn_r", "gist_stern_r", "plasma_r", "copper_r", "oxy", "gist_yarg", "twilight", "winter", "brbg", "reds_r", "speed_r", "rainbow", "ice", "nipy_spectral", "piyg", "gray", "reds", "terrain", "tab20_r", "wistia", "accent_r", "thermal", "ocean", "twilight_r", "hot_r", "set3_r", "hsv_r", "brg_r", "gist_rainbow_r", "phase", "bupu", "pastel1", "dense", "set1_r", "phase_r", "matter_r", "greens_r", "cfastie", "tab10_r", "rdbu", "brg", "rdpu_r", "brbg_r", "cmrmap_r", "prism_r", "purples_r", "gist_earth_r", "tempo", "schwarzwald", "rdpu", "orrd_r", "tarn", "puor_r", "bupu_r", "rdylgn", "ice_r", "pink", "terrain_r", "amp", "tab20b_r", "rdylbu_r", "hsv", "curl_r", "delta", "ylgnbu_r" ], "type": "string", "description": "Colormap name", "title": "Colormap Name" }, "description": "Colormap name" }, { "name": "colormap", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "JSON encoded custom Colormap", "title": "Colormap" }, "description": "JSON encoded custom Colormap" }, { "name": "rescale", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ], "title": "Min/Max data Rescaling", "description": "comma (',') delimited Min,Max range. Can set multiple time for multiple bands.", "examples": [ "0,2000", "0,1000", "0,10000" ] }, "description": "comma (',') delimited Min,Max range. Can set multiple time for multiple bands." }, { "name": "color_formula", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Color Formula", "description": "rio-color formula (info: https://github.com/mapbox/rio-color)" }, "description": "rio-color formula (info: https://github.com/mapbox/rio-color)" }, { "name": "return_mask", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "Add mask to the output data. Defaults to `True`", "title": "Return Mask" }, "description": "Add mask to the output data. Defaults to `True`" } ], "responses": { "200": { "description": "Return an image.", "content": { "image/png": {}, "image/jpeg": {}, "image/jpg": {}, "image/webp": {}, "image/jp2": {}, "image/tiff; application=geotiff": {}, "application/x-binary": {} } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/stac/viewer": { "get": { "tags": [ "SpatioTemporal Asset Catalog" ], "summary": "Stac Viewer", "description": "STAC Viewer.", "operationId": ".stac.getViewer", "responses": { "200": { "description": "Successful Response", "content": { "text/html": { "schema": { "type": "string" } } } } } } }, "/stac/renders": { "get": { "tags": [ "SpatioTemporal Asset Catalog" ], "summary": "List Stac Renders Metadata", "operationId": ".stac.getRenderList", "parameters": [ { "name": "url", "in": "query", "required": true, "schema": { "type": "string", "description": "Dataset URL", "title": "Url" }, "description": "Dataset URL" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RenderItemList" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/stac/renders/{render_id}": { "get": { "tags": [ "SpatioTemporal Asset Catalog" ], "summary": "Stac Renders Metadata", "operationId": ".stac.getRender", "parameters": [ { "name": "render_id", "in": "path", "required": true, "schema": { "type": "string", "description": "render id", "title": "Render Id" }, "description": "render id" }, { "name": "url", "in": "query", "required": true, "schema": { "type": "string", "description": "Dataset URL", "title": "Url" }, "description": "Dataset URL" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RenderItemWithLinks" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/stac/WMTSCapabilities.xml": { "get": { "tags": [ "SpatioTemporal Asset Catalog" ], "summary": "Wmts", "description": "OGC RESTful WMTS endpoint.", "operationId": ".stac.getWMTS", "parameters": [ { "name": "tile_format", "in": "query", "required": false, "schema": { "$ref": "#/components/schemas/ImageType", "description": "Output image type. Default is png.", "default": "png" }, "description": "Output image type. Default is png." }, { "name": "use_epsg", "in": "query", "required": false, "schema": { "type": "boolean", "description": "Use EPSG code, not opengis.net, for the ows:SupportedCRS in the TileMatrixSet (set to True to enable ArcMap compatability)", "default": false, "title": "Use Epsg" }, "description": "Use EPSG code, not opengis.net, for the ows:SupportedCRS in the TileMatrixSet (set to True to enable ArcMap compatability)" }, { "name": "url", "in": "query", "required": true, "schema": { "type": "string", "description": "Dataset URL", "title": "Url" }, "description": "Dataset URL" }, { "name": "buffer", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "number", "exclusiveMinimum": 0 }, { "type": "null" } ], "title": "Tile buffer.", "description": "Buffer on each side of the given tile. It must be a multiple of `0.5`. Output **tilesize** will be expanded to `tilesize + 2 * buffer` (e.g 0.5 = 257x257, 1.0 = 258x258)." }, "description": "Buffer on each side of the given tile. It must be a multiple of `0.5`. Output **tilesize** will be expanded to `tilesize + 2 * buffer` (e.g 0.5 = 257x257, 1.0 = 258x258)." }, { "name": "padding", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "integer", "exclusiveMinimum": 0 }, { "type": "null" } ], "title": "Tile padding.", "description": "Padding to apply to each tile edge. Helps reduce resampling artefacts along edges. Defaults to `0`." }, "description": "Padding to apply to each tile edge. Helps reduce resampling artefacts along edges. Defaults to `0`." }, { "name": "assets", "in": "query", "required": true, "schema": { "type": "array", "items": { "type": "string" }, "title": "Asset names", "description": "Asset's names." }, "description": "Asset's names.", "examples": { "user-provided": {}, "one-asset": { "description": "Return results for asset `data`.", "value": [ "data" ] }, "multi-assets": { "description": "Return results for assets `data` and `cog`.", "value": [ "data", "cog" ] }, "multi-assets-with-options": { "description": "Return results for assets `data` and `cog`.", "value": [ "data|bidx=1", "cog|bidx=1,2" ] } } }, { "name": "expression", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Band Math expression", "description": "rio-tiler's band math expression" }, "description": "rio-tiler's band math expression", "examples": { "user-provided": {}, "simple": { "description": "Simple band math.", "value": "b1/b2" }, "multi-bands": { "description": "Semicolon (;) delimited expressions (band1: b1/b2, band2: b2+b3).", "value": "b1/b2;b2+b3" } } }, { "name": "asset_as_band", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Consider asset as a 1 band dataset", "description": "Asset as Band" }, "description": "Asset as Band" }, { "name": "nodata", "in": "query", "required": false, "schema": { "anyOf": [ { "enum": [ "nan", "inf", "-inf" ], "type": "string" }, { "type": "integer" }, { "type": "number" }, { "type": "null" } ], "title": "Nodata value", "description": "Overwrite internal Nodata value; nan or valid float values only." }, "description": "Overwrite internal Nodata value; nan or valid float values only." }, { "name": "unscale", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Apply internal Scale/Offset", "description": "Apply internal Scale/Offset. Defaults to `False`." }, "description": "Apply internal Scale/Offset. Defaults to `False`." }, { "name": "resampling", "in": "query", "required": false, "schema": { "anyOf": [ { "enum": [ "nearest", "bilinear", "cubic", "cubic_spline", "lanczos", "average", "mode", "gauss", "rms" ], "type": "string" }, { "type": "null" } ], "description": "RasterIO resampling algorithm. Defaults to `nearest`.", "title": "Resampling" }, "description": "RasterIO resampling algorithm. Defaults to `nearest`." }, { "name": "reproject", "in": "query", "required": false, "schema": { "anyOf": [ { "enum": [ "nearest", "bilinear", "cubic", "cubic_spline", "lanczos", "average", "mode", "max", "min", "med", "q1", "q3", "sum", "rms" ], "type": "string" }, { "type": "null" } ], "description": "WarpKernel resampling algorithm (only used when doing re-projection). Defaults to `nearest`.", "title": "Reproject" }, "description": "WarpKernel resampling algorithm (only used when doing re-projection). Defaults to `nearest`." }, { "name": "algorithm", "in": "query", "required": false, "schema": { "enum": [ "hillshade", "slope", "contours", "normalizedIndex", "terrarium", "terrainrgb", "cast", "ceil", "floor", "min", "max", "median", "mean", "std", "var", "sum", "grayscale", "bitonal" ], "type": "string", "description": "Algorithm name", "title": "Algorithm" }, "description": "Algorithm name" }, { "name": "algorithm_params", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Algorithm parameter", "title": "Algorithm Params" }, "description": "Algorithm parameter" }, { "name": "colormap_name", "in": "query", "required": false, "schema": { "enum": [ "jet_r", "haline", "gist_ncar_r", "algae", "cividis_r", "seismic_r", "pink_r", "rdylbu", "inferno_r", "deep", "rdgy_r", "tab10", "bugn_r", "ocean_r", "purples", "pastel1_r", "thermal_r", "ylorrd_r", "wistia_r", "cmrmap", "pubu", "rain", "ylgnbu", "gnuplot", "gnbu", "gist_gray_r", "greens", "purd_r", "oxy_r", "matter", "summer_r", "gnuplot_r", "gnuplot2", "solar", "jet", "ylgn_r", "dark2_r", "spring", "tab20c", "gist_stern", "bwr", "ylgn", "plasma", "pastel2", "blues_r", "rain_r", "set1", "topo_r", "gist_ncar", "turbid", "magma_r", "pastel2_r", "purd", "gnbu_r", "spring_r", "rdbu_r", "ylorbr", "twilight_shifted", "rplumbo", "winter_r", "tab20b", "ylorrd", "copper", "flag_r", "afmhot", "twilight_shifted_r", "oranges_r", "bone", "seismic", "gray_r", "tarn_r", "bwr_r", "magma", "paired_r", "dark2", "binary", "set3", "viridis_r", "spectral", "prgn", "diff", "hot", "gist_earth", "cubehelix", "dense_r", "coolwarm", "pubugn_r", "autumn_r", "gnuplot2_r", "cividis", "bugn", "deep_r", "prgn_r", "gist_rainbow", "gist_heat_r", "nipy_spectral_r", "tab20", "turbo_r", "pubugn", "set2_r", "gist_yarg_r", "spectral_r", "binary_r", "greys", "rainbow_r", "haline_r", "curl", "tab20c_r", "blues", "prism", "rdgy", "gist_gray", "set2", "cool", "afmhot_r", "bone_r", "paired", "oranges", "orrd", "puor", "autumn", "delta_r", "pubu_r", "piyg_r", "turbo", "greys_r", "accent", "turbid_r", "algae_r", "solar_r", "topo", "cool_r", "inferno", "balance", "tempo_r", "amp_r", "flag", "speed", "gist_heat", "balance_r", "viridis", "cubehelix_r", "ylorbr_r", "summer", "coolwarm_r", "diff_r", "rdylgn_r", "gist_stern_r", "plasma_r", "copper_r", "oxy", "gist_yarg", "twilight", "winter", "brbg", "reds_r", "speed_r", "rainbow", "ice", "nipy_spectral", "piyg", "gray", "reds", "terrain", "tab20_r", "wistia", "accent_r", "thermal", "ocean", "twilight_r", "hot_r", "set3_r", "hsv_r", "brg_r", "gist_rainbow_r", "phase", "bupu", "pastel1", "dense", "set1_r", "phase_r", "matter_r", "greens_r", "cfastie", "tab10_r", "rdbu", "brg", "rdpu_r", "brbg_r", "cmrmap_r", "prism_r", "purples_r", "gist_earth_r", "tempo", "schwarzwald", "rdpu", "orrd_r", "tarn", "puor_r", "bupu_r", "rdylgn", "ice_r", "pink", "terrain_r", "amp", "tab20b_r", "rdylbu_r", "hsv", "curl_r", "delta", "ylgnbu_r" ], "type": "string", "description": "Colormap name", "title": "Colormap Name" }, "description": "Colormap name" }, { "name": "colormap", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "JSON encoded custom Colormap", "title": "Colormap" }, "description": "JSON encoded custom Colormap" }, { "name": "rescale", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ], "title": "Min/Max data Rescaling", "description": "comma (',') delimited Min,Max range. Can set multiple time for multiple bands.", "examples": [ "0,2000", "0,1000", "0,10000" ] }, "description": "comma (',') delimited Min,Max range. Can set multiple time for multiple bands." }, { "name": "color_formula", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Color Formula", "description": "rio-color formula (info: https://github.com/mapbox/rio-color)" }, "description": "rio-color formula (info: https://github.com/mapbox/rio-color)" }, { "name": "return_mask", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "Add mask to the output data. Defaults to `True`", "title": "Return Mask" }, "description": "Add mask to the output data. Defaults to `True`" } ], "responses": { "200": { "description": "Return RESTful WMTS service capabilities document.", "content": { "application/xml": { "schema": { "type": "string" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/mosaicjson/info": { "get": { "tags": [ "MosaicJSON" ], "summary": "Info", "description": "Return basic info.", "operationId": ".mosaicjson.getInfo", "parameters": [ { "name": "url", "in": "query", "required": true, "schema": { "type": "string", "description": "Mosaic URL", "title": "Url" }, "description": "Mosaic URL" } ], "responses": { "200": { "description": "Return info about the MosaicJSON", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MosaicInfo" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/mosaicjson/info.geojson": { "get": { "tags": [ "MosaicJSON" ], "summary": "Info Geojson", "description": "Return mosaic's basic info as a GeoJSON feature.", "operationId": ".mosaicjson.getInfoGeoJSON", "parameters": [ { "name": "url", "in": "query", "required": true, "schema": { "type": "string", "description": "Mosaic URL", "title": "Url" }, "description": "Mosaic URL" }, { "name": "crs", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Coordinate Reference System.", "title": "Crs" }, "description": "Coordinate Reference System." } ], "responses": { "200": { "description": "Return mosaic's basic info as a GeoJSON feature.", "content": { "application/geo+json": { "schema": { "$ref": "#/components/schemas/Feature_Polygon_MosaicInfo_" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/mosaicjson/tiles": { "get": { "tags": [ "MosaicJSON" ], "summary": "Retrieve a list of available raster tilesets for the specified dataset.", "description": "Retrieve a list of available raster tilesets for the specified dataset.", "operationId": ".mosaicjson.getTileSetList", "parameters": [ { "name": "f", "in": "query", "required": false, "schema": { "anyOf": [ { "enum": [ "html", "json" ], "type": "string" }, { "type": "null" } ], "description": "Response MediaType. Defaults to endpoint's default or value defined in `accept` header.", "title": "F" }, "description": "Response MediaType. Defaults to endpoint's default or value defined in `accept` header." }, { "name": "url", "in": "query", "required": true, "schema": { "type": "string", "description": "Mosaic URL", "title": "Url" }, "description": "Mosaic URL" }, { "name": "crs", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Coordinate Reference System.", "title": "Crs" }, "description": "Coordinate Reference System." } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TileSetList" } }, "text/html": {} } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/mosaicjson/tiles/{tileMatrixSetId}": { "get": { "tags": [ "MosaicJSON" ], "summary": "Retrieve the raster tileset metadata for the specified dataset and tiling scheme (tile matrix set).", "description": "Retrieve the raster tileset metadata for the specified dataset and tiling scheme (tile matrix set).", "operationId": ".mosaicjson.getTileSet", "parameters": [ { "name": "tileMatrixSetId", "in": "path", "required": true, "schema": { "enum": [ "CDB1GlobalGrid", "CanadianNAD83_LCC", "EuropeanETRS89_LAEAQuad", "GNOSISGlobalGrid", "LINZAntarticaMapTilegrid", "NZTM2000Quad", "UPSAntarcticWGS84Quad", "UPSArcticWGS84Quad", "UTM31WGS84Quad", "WGS1984Quad", "WebMercatorQuad", "WorldCRS84Quad", "WorldMercatorWGS84Quad" ], "type": "string", "description": "Identifier selecting one of the TileMatrixSetId supported.", "title": "Tilematrixsetid" }, "description": "Identifier selecting one of the TileMatrixSetId supported." }, { "name": "minzoom", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "Overwrite default minzoom.", "title": "Minzoom" }, "description": "Overwrite default minzoom." }, { "name": "maxzoom", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "Overwrite default maxzoom.", "title": "Maxzoom" }, "description": "Overwrite default maxzoom." }, { "name": "f", "in": "query", "required": false, "schema": { "anyOf": [ { "enum": [ "html", "json" ], "type": "string" }, { "type": "null" } ], "description": "Response MediaType. Defaults to endpoint's default or value defined in `accept` header.", "title": "F" }, "description": "Response MediaType. Defaults to endpoint's default or value defined in `accept` header." }, { "name": "url", "in": "query", "required": true, "schema": { "type": "string", "description": "Mosaic URL", "title": "Url" }, "description": "Mosaic URL" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TileSet" } }, "text/html": {} } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/mosaicjson/tiles/{tileMatrixSetId}/{z}/{x}/{y}.{format}": { "get": { "tags": [ "MosaicJSON" ], "summary": "Tile", "description": "Create map tile from a COG.", "operationId": ".mosaicjson.getTileWithFormat", "parameters": [ { "name": "z", "in": "path", "required": true, "schema": { "type": "integer", "description": "Identifier (Z) selecting one of the scales defined in the TileMatrixSet and representing the scaleDenominator the tile.", "title": "Z" }, "description": "Identifier (Z) selecting one of the scales defined in the TileMatrixSet and representing the scaleDenominator the tile." }, { "name": "x", "in": "path", "required": true, "schema": { "type": "integer", "description": "Column (X) index of the tile on the selected TileMatrix. It cannot exceed the MatrixHeight-1 for the selected TileMatrix.", "title": "X" }, "description": "Column (X) index of the tile on the selected TileMatrix. It cannot exceed the MatrixHeight-1 for the selected TileMatrix." }, { "name": "y", "in": "path", "required": true, "schema": { "type": "integer", "description": "Row (Y) index of the tile on the selected TileMatrix. It cannot exceed the MatrixWidth-1 for the selected TileMatrix.", "title": "Y" }, "description": "Row (Y) index of the tile on the selected TileMatrix. It cannot exceed the MatrixWidth-1 for the selected TileMatrix." }, { "name": "tileMatrixSetId", "in": "path", "required": true, "schema": { "enum": [ "CDB1GlobalGrid", "CanadianNAD83_LCC", "EuropeanETRS89_LAEAQuad", "GNOSISGlobalGrid", "LINZAntarticaMapTilegrid", "NZTM2000Quad", "UPSAntarcticWGS84Quad", "UPSArcticWGS84Quad", "UTM31WGS84Quad", "WGS1984Quad", "WebMercatorQuad", "WorldCRS84Quad", "WorldMercatorWGS84Quad" ], "type": "string", "description": "Identifier selecting one of the TileMatrixSetId supported.", "title": "Tilematrixsetid" }, "description": "Identifier selecting one of the TileMatrixSetId supported." }, { "name": "format", "in": "path", "required": true, "schema": { "anyOf": [ { "$ref": "#/components/schemas/ImageType" }, { "type": "null" } ], "description": "Default will be automatically defined if the output image needs a mask (png) or not (jpeg).", "title": "Format" } }, { "name": "tilesize", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "integer", "exclusiveMinimum": 0 }, { "type": "null" } ], "description": "Tilesize in pixels.", "title": "Tilesize" }, "description": "Tilesize in pixels." }, { "name": "url", "in": "query", "required": true, "schema": { "type": "string", "description": "Mosaic URL", "title": "Url" }, "description": "Mosaic URL" }, { "name": "bidx", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "array", "items": { "type": "integer" } }, { "type": "null" } ], "title": "Band indexes", "description": "Dataset band indexes" }, "description": "Dataset band indexes", "examples": { "user-provided": {}, "one-band": { "value": [ 1 ] }, "multi-bands": { "value": [ 1, 2, 3 ] } } }, { "name": "expression", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Band Math expression", "description": "rio-tiler's band math expression" }, "description": "rio-tiler's band math expression", "examples": { "user-provided": {}, "simple": { "description": "Simple band math.", "value": "b1/b2" }, "multi-bands": { "description": "Semicolon (;) delimited expressions (band1: b1/b2, band2: b2+b3).", "value": "b1/b2;b2+b3" } } }, { "name": "nodata", "in": "query", "required": false, "schema": { "anyOf": [ { "enum": [ "nan", "inf", "-inf" ], "type": "string" }, { "type": "integer" }, { "type": "number" }, { "type": "null" } ], "title": "Nodata value", "description": "Overwrite internal Nodata value; nan or valid float values only." }, "description": "Overwrite internal Nodata value; nan or valid float values only." }, { "name": "unscale", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Apply internal Scale/Offset", "description": "Apply internal Scale/Offset. Defaults to `False`." }, "description": "Apply internal Scale/Offset. Defaults to `False`." }, { "name": "resampling", "in": "query", "required": false, "schema": { "anyOf": [ { "enum": [ "nearest", "bilinear", "cubic", "cubic_spline", "lanczos", "average", "mode", "gauss", "rms" ], "type": "string" }, { "type": "null" } ], "description": "RasterIO resampling algorithm. Defaults to `nearest`.", "title": "Resampling" }, "description": "RasterIO resampling algorithm. Defaults to `nearest`." }, { "name": "reproject", "in": "query", "required": false, "schema": { "anyOf": [ { "enum": [ "nearest", "bilinear", "cubic", "cubic_spline", "lanczos", "average", "mode", "max", "min", "med", "q1", "q3", "sum", "rms" ], "type": "string" }, { "type": "null" } ], "description": "WarpKernel resampling algorithm (only used when doing re-projection). Defaults to `nearest`.", "title": "Reproject" }, "description": "WarpKernel resampling algorithm (only used when doing re-projection). Defaults to `nearest`." }, { "name": "pixel_selection", "in": "query", "required": false, "schema": { "enum": [ "first", "highest", "lowest", "mean", "median", "stdev", "lastbandlow", "lastbandhigh", "count" ], "type": "string", "description": "Pixel selection method.", "default": "first", "title": "Pixel Selection" }, "description": "Pixel selection method." }, { "name": "buffer", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "number", "exclusiveMinimum": 0 }, { "type": "null" } ], "title": "Tile buffer.", "description": "Buffer on each side of the given tile. It must be a multiple of `0.5`. Output **tilesize** will be expanded to `tilesize + 2 * buffer` (e.g 0.5 = 257x257, 1.0 = 258x258)." }, "description": "Buffer on each side of the given tile. It must be a multiple of `0.5`. Output **tilesize** will be expanded to `tilesize + 2 * buffer` (e.g 0.5 = 257x257, 1.0 = 258x258)." }, { "name": "padding", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "integer", "exclusiveMinimum": 0 }, { "type": "null" } ], "title": "Tile padding.", "description": "Padding to apply to each tile edge. Helps reduce resampling artefacts along edges. Defaults to `0`." }, "description": "Padding to apply to each tile edge. Helps reduce resampling artefacts along edges. Defaults to `0`." }, { "name": "algorithm", "in": "query", "required": false, "schema": { "enum": [ "hillshade", "slope", "contours", "normalizedIndex", "terrarium", "terrainrgb", "cast", "ceil", "floor", "min", "max", "median", "mean", "std", "var", "sum", "grayscale", "bitonal" ], "type": "string", "description": "Algorithm name", "title": "Algorithm" }, "description": "Algorithm name" }, { "name": "algorithm_params", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Algorithm parameter", "title": "Algorithm Params" }, "description": "Algorithm parameter" }, { "name": "colormap_name", "in": "query", "required": false, "schema": { "enum": [ "jet_r", "haline", "gist_ncar_r", "algae", "cividis_r", "seismic_r", "pink_r", "rdylbu", "inferno_r", "deep", "rdgy_r", "tab10", "bugn_r", "ocean_r", "purples", "pastel1_r", "thermal_r", "ylorrd_r", "wistia_r", "cmrmap", "pubu", "rain", "ylgnbu", "gnuplot", "gnbu", "gist_gray_r", "greens", "purd_r", "oxy_r", "matter", "summer_r", "gnuplot_r", "gnuplot2", "solar", "jet", "ylgn_r", "dark2_r", "spring", "tab20c", "gist_stern", "bwr", "ylgn", "plasma", "pastel2", "blues_r", "rain_r", "set1", "topo_r", "gist_ncar", "turbid", "magma_r", "pastel2_r", "purd", "gnbu_r", "spring_r", "rdbu_r", "ylorbr", "twilight_shifted", "rplumbo", "winter_r", "tab20b", "ylorrd", "copper", "flag_r", "afmhot", "twilight_shifted_r", "oranges_r", "bone", "seismic", "gray_r", "tarn_r", "bwr_r", "magma", "paired_r", "dark2", "binary", "set3", "viridis_r", "spectral", "prgn", "diff", "hot", "gist_earth", "cubehelix", "dense_r", "coolwarm", "pubugn_r", "autumn_r", "gnuplot2_r", "cividis", "bugn", "deep_r", "prgn_r", "gist_rainbow", "gist_heat_r", "nipy_spectral_r", "tab20", "turbo_r", "pubugn", "set2_r", "gist_yarg_r", "spectral_r", "binary_r", "greys", "rainbow_r", "haline_r", "curl", "tab20c_r", "blues", "prism", "rdgy", "gist_gray", "set2", "cool", "afmhot_r", "bone_r", "paired", "oranges", "orrd", "puor", "autumn", "delta_r", "pubu_r", "piyg_r", "turbo", "greys_r", "accent", "turbid_r", "algae_r", "solar_r", "topo", "cool_r", "inferno", "balance", "tempo_r", "amp_r", "flag", "speed", "gist_heat", "balance_r", "viridis", "cubehelix_r", "ylorbr_r", "summer", "coolwarm_r", "diff_r", "rdylgn_r", "gist_stern_r", "plasma_r", "copper_r", "oxy", "gist_yarg", "twilight", "winter", "brbg", "reds_r", "speed_r", "rainbow", "ice", "nipy_spectral", "piyg", "gray", "reds", "terrain", "tab20_r", "wistia", "accent_r", "thermal", "ocean", "twilight_r", "hot_r", "set3_r", "hsv_r", "brg_r", "gist_rainbow_r", "phase", "bupu", "pastel1", "dense", "set1_r", "phase_r", "matter_r", "greens_r", "cfastie", "tab10_r", "rdbu", "brg", "rdpu_r", "brbg_r", "cmrmap_r", "prism_r", "purples_r", "gist_earth_r", "tempo", "schwarzwald", "rdpu", "orrd_r", "tarn", "puor_r", "bupu_r", "rdylgn", "ice_r", "pink", "terrain_r", "amp", "tab20b_r", "rdylbu_r", "hsv", "curl_r", "delta", "ylgnbu_r" ], "type": "string", "description": "Colormap name", "title": "Colormap Name" }, "description": "Colormap name" }, { "name": "colormap", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "JSON encoded custom Colormap", "title": "Colormap" }, "description": "JSON encoded custom Colormap" }, { "name": "rescale", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ], "title": "Min/Max data Rescaling", "description": "comma (',') delimited Min,Max range. Can set multiple time for multiple bands.", "examples": [ "0,2000", "0,1000", "0,10000" ] }, "description": "comma (',') delimited Min,Max range. Can set multiple time for multiple bands." }, { "name": "color_formula", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Color Formula", "description": "rio-color formula (info: https://github.com/mapbox/rio-color)" }, "description": "rio-color formula (info: https://github.com/mapbox/rio-color)" }, { "name": "return_mask", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "Add mask to the output data. Defaults to `True`", "title": "Return Mask" }, "description": "Add mask to the output data. Defaults to `True`" } ], "responses": { "200": { "description": "Return an image.", "content": { "image/png": {}, "image/jpeg": {}, "image/jpg": {}, "image/webp": {}, "image/jp2": {}, "image/tiff; application=geotiff": {}, "application/x-binary": {} } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/mosaicjson/tiles/{tileMatrixSetId}/{z}/{x}/{y}": { "get": { "tags": [ "MosaicJSON" ], "summary": "Tile", "description": "Create map tile from a COG.", "operationId": ".mosaicjson.getTile", "parameters": [ { "name": "z", "in": "path", "required": true, "schema": { "type": "integer", "description": "Identifier (Z) selecting one of the scales defined in the TileMatrixSet and representing the scaleDenominator the tile.", "title": "Z" }, "description": "Identifier (Z) selecting one of the scales defined in the TileMatrixSet and representing the scaleDenominator the tile." }, { "name": "x", "in": "path", "required": true, "schema": { "type": "integer", "description": "Column (X) index of the tile on the selected TileMatrix. It cannot exceed the MatrixHeight-1 for the selected TileMatrix.", "title": "X" }, "description": "Column (X) index of the tile on the selected TileMatrix. It cannot exceed the MatrixHeight-1 for the selected TileMatrix." }, { "name": "y", "in": "path", "required": true, "schema": { "type": "integer", "description": "Row (Y) index of the tile on the selected TileMatrix. It cannot exceed the MatrixWidth-1 for the selected TileMatrix.", "title": "Y" }, "description": "Row (Y) index of the tile on the selected TileMatrix. It cannot exceed the MatrixWidth-1 for the selected TileMatrix." }, { "name": "tileMatrixSetId", "in": "path", "required": true, "schema": { "enum": [ "CDB1GlobalGrid", "CanadianNAD83_LCC", "EuropeanETRS89_LAEAQuad", "GNOSISGlobalGrid", "LINZAntarticaMapTilegrid", "NZTM2000Quad", "UPSAntarcticWGS84Quad", "UPSArcticWGS84Quad", "UTM31WGS84Quad", "WGS1984Quad", "WebMercatorQuad", "WorldCRS84Quad", "WorldMercatorWGS84Quad" ], "type": "string", "description": "Identifier selecting one of the TileMatrixSetId supported.", "title": "Tilematrixsetid" }, "description": "Identifier selecting one of the TileMatrixSetId supported." }, { "name": "format", "in": "query", "required": false, "schema": { "anyOf": [ { "$ref": "#/components/schemas/ImageType" }, { "type": "null" } ], "description": "Default will be automatically defined if the output image needs a mask (png) or not (jpeg).", "title": "Format" } }, { "name": "tilesize", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "integer", "exclusiveMinimum": 0 }, { "type": "null" } ], "description": "Tilesize in pixels.", "title": "Tilesize" }, "description": "Tilesize in pixels." }, { "name": "url", "in": "query", "required": true, "schema": { "type": "string", "description": "Mosaic URL", "title": "Url" }, "description": "Mosaic URL" }, { "name": "bidx", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "array", "items": { "type": "integer" } }, { "type": "null" } ], "title": "Band indexes", "description": "Dataset band indexes" }, "description": "Dataset band indexes", "examples": { "user-provided": {}, "one-band": { "value": [ 1 ] }, "multi-bands": { "value": [ 1, 2, 3 ] } } }, { "name": "expression", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Band Math expression", "description": "rio-tiler's band math expression" }, "description": "rio-tiler's band math expression", "examples": { "user-provided": {}, "simple": { "description": "Simple band math.", "value": "b1/b2" }, "multi-bands": { "description": "Semicolon (;) delimited expressions (band1: b1/b2, band2: b2+b3).", "value": "b1/b2;b2+b3" } } }, { "name": "nodata", "in": "query", "required": false, "schema": { "anyOf": [ { "enum": [ "nan", "inf", "-inf" ], "type": "string" }, { "type": "integer" }, { "type": "number" }, { "type": "null" } ], "title": "Nodata value", "description": "Overwrite internal Nodata value; nan or valid float values only." }, "description": "Overwrite internal Nodata value; nan or valid float values only." }, { "name": "unscale", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Apply internal Scale/Offset", "description": "Apply internal Scale/Offset. Defaults to `False`." }, "description": "Apply internal Scale/Offset. Defaults to `False`." }, { "name": "resampling", "in": "query", "required": false, "schema": { "anyOf": [ { "enum": [ "nearest", "bilinear", "cubic", "cubic_spline", "lanczos", "average", "mode", "gauss", "rms" ], "type": "string" }, { "type": "null" } ], "description": "RasterIO resampling algorithm. Defaults to `nearest`.", "title": "Resampling" }, "description": "RasterIO resampling algorithm. Defaults to `nearest`." }, { "name": "reproject", "in": "query", "required": false, "schema": { "anyOf": [ { "enum": [ "nearest", "bilinear", "cubic", "cubic_spline", "lanczos", "average", "mode", "max", "min", "med", "q1", "q3", "sum", "rms" ], "type": "string" }, { "type": "null" } ], "description": "WarpKernel resampling algorithm (only used when doing re-projection). Defaults to `nearest`.", "title": "Reproject" }, "description": "WarpKernel resampling algorithm (only used when doing re-projection). Defaults to `nearest`." }, { "name": "pixel_selection", "in": "query", "required": false, "schema": { "enum": [ "first", "highest", "lowest", "mean", "median", "stdev", "lastbandlow", "lastbandhigh", "count" ], "type": "string", "description": "Pixel selection method.", "default": "first", "title": "Pixel Selection" }, "description": "Pixel selection method." }, { "name": "buffer", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "number", "exclusiveMinimum": 0 }, { "type": "null" } ], "title": "Tile buffer.", "description": "Buffer on each side of the given tile. It must be a multiple of `0.5`. Output **tilesize** will be expanded to `tilesize + 2 * buffer` (e.g 0.5 = 257x257, 1.0 = 258x258)." }, "description": "Buffer on each side of the given tile. It must be a multiple of `0.5`. Output **tilesize** will be expanded to `tilesize + 2 * buffer` (e.g 0.5 = 257x257, 1.0 = 258x258)." }, { "name": "padding", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "integer", "exclusiveMinimum": 0 }, { "type": "null" } ], "title": "Tile padding.", "description": "Padding to apply to each tile edge. Helps reduce resampling artefacts along edges. Defaults to `0`." }, "description": "Padding to apply to each tile edge. Helps reduce resampling artefacts along edges. Defaults to `0`." }, { "name": "algorithm", "in": "query", "required": false, "schema": { "enum": [ "hillshade", "slope", "contours", "normalizedIndex", "terrarium", "terrainrgb", "cast", "ceil", "floor", "min", "max", "median", "mean", "std", "var", "sum", "grayscale", "bitonal" ], "type": "string", "description": "Algorithm name", "title": "Algorithm" }, "description": "Algorithm name" }, { "name": "algorithm_params", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Algorithm parameter", "title": "Algorithm Params" }, "description": "Algorithm parameter" }, { "name": "colormap_name", "in": "query", "required": false, "schema": { "enum": [ "jet_r", "haline", "gist_ncar_r", "algae", "cividis_r", "seismic_r", "pink_r", "rdylbu", "inferno_r", "deep", "rdgy_r", "tab10", "bugn_r", "ocean_r", "purples", "pastel1_r", "thermal_r", "ylorrd_r", "wistia_r", "cmrmap", "pubu", "rain", "ylgnbu", "gnuplot", "gnbu", "gist_gray_r", "greens", "purd_r", "oxy_r", "matter", "summer_r", "gnuplot_r", "gnuplot2", "solar", "jet", "ylgn_r", "dark2_r", "spring", "tab20c", "gist_stern", "bwr", "ylgn", "plasma", "pastel2", "blues_r", "rain_r", "set1", "topo_r", "gist_ncar", "turbid", "magma_r", "pastel2_r", "purd", "gnbu_r", "spring_r", "rdbu_r", "ylorbr", "twilight_shifted", "rplumbo", "winter_r", "tab20b", "ylorrd", "copper", "flag_r", "afmhot", "twilight_shifted_r", "oranges_r", "bone", "seismic", "gray_r", "tarn_r", "bwr_r", "magma", "paired_r", "dark2", "binary", "set3", "viridis_r", "spectral", "prgn", "diff", "hot", "gist_earth", "cubehelix", "dense_r", "coolwarm", "pubugn_r", "autumn_r", "gnuplot2_r", "cividis", "bugn", "deep_r", "prgn_r", "gist_rainbow", "gist_heat_r", "nipy_spectral_r", "tab20", "turbo_r", "pubugn", "set2_r", "gist_yarg_r", "spectral_r", "binary_r", "greys", "rainbow_r", "haline_r", "curl", "tab20c_r", "blues", "prism", "rdgy", "gist_gray", "set2", "cool", "afmhot_r", "bone_r", "paired", "oranges", "orrd", "puor", "autumn", "delta_r", "pubu_r", "piyg_r", "turbo", "greys_r", "accent", "turbid_r", "algae_r", "solar_r", "topo", "cool_r", "inferno", "balance", "tempo_r", "amp_r", "flag", "speed", "gist_heat", "balance_r", "viridis", "cubehelix_r", "ylorbr_r", "summer", "coolwarm_r", "diff_r", "rdylgn_r", "gist_stern_r", "plasma_r", "copper_r", "oxy", "gist_yarg", "twilight", "winter", "brbg", "reds_r", "speed_r", "rainbow", "ice", "nipy_spectral", "piyg", "gray", "reds", "terrain", "tab20_r", "wistia", "accent_r", "thermal", "ocean", "twilight_r", "hot_r", "set3_r", "hsv_r", "brg_r", "gist_rainbow_r", "phase", "bupu", "pastel1", "dense", "set1_r", "phase_r", "matter_r", "greens_r", "cfastie", "tab10_r", "rdbu", "brg", "rdpu_r", "brbg_r", "cmrmap_r", "prism_r", "purples_r", "gist_earth_r", "tempo", "schwarzwald", "rdpu", "orrd_r", "tarn", "puor_r", "bupu_r", "rdylgn", "ice_r", "pink", "terrain_r", "amp", "tab20b_r", "rdylbu_r", "hsv", "curl_r", "delta", "ylgnbu_r" ], "type": "string", "description": "Colormap name", "title": "Colormap Name" }, "description": "Colormap name" }, { "name": "colormap", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "JSON encoded custom Colormap", "title": "Colormap" }, "description": "JSON encoded custom Colormap" }, { "name": "rescale", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ], "title": "Min/Max data Rescaling", "description": "comma (',') delimited Min,Max range. Can set multiple time for multiple bands.", "examples": [ "0,2000", "0,1000", "0,10000" ] }, "description": "comma (',') delimited Min,Max range. Can set multiple time for multiple bands." }, { "name": "color_formula", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Color Formula", "description": "rio-color formula (info: https://github.com/mapbox/rio-color)" }, "description": "rio-color formula (info: https://github.com/mapbox/rio-color)" }, { "name": "return_mask", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "Add mask to the output data. Defaults to `True`", "title": "Return Mask" }, "description": "Add mask to the output data. Defaults to `True`" } ], "responses": { "200": { "description": "Return an image.", "content": { "image/png": {}, "image/jpeg": {}, "image/jpg": {}, "image/webp": {}, "image/jp2": {}, "image/tiff; application=geotiff": {}, "application/x-binary": {} } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/mosaicjson/{tileMatrixSetId}/map.html": { "get": { "tags": [ "MosaicJSON" ], "summary": "Map Viewer", "description": "Return TileJSON document for a dataset.", "operationId": ".mosaicjson.getMapViewer", "parameters": [ { "name": "tileMatrixSetId", "in": "path", "required": true, "schema": { "enum": [ "CDB1GlobalGrid", "CanadianNAD83_LCC", "EuropeanETRS89_LAEAQuad", "GNOSISGlobalGrid", "LINZAntarticaMapTilegrid", "NZTM2000Quad", "UPSAntarcticWGS84Quad", "UPSArcticWGS84Quad", "UTM31WGS84Quad", "WGS1984Quad", "WebMercatorQuad", "WorldCRS84Quad", "WorldMercatorWGS84Quad" ], "type": "string", "description": "Identifier selecting one of the TileMatrixSetId supported.", "title": "Tilematrixsetid" }, "description": "Identifier selecting one of the TileMatrixSetId supported." }, { "name": "tile_format", "in": "query", "required": false, "schema": { "anyOf": [ { "$ref": "#/components/schemas/ImageType" }, { "type": "null" } ], "description": "Default will be automatically defined if the output image needs a mask (png) or not (jpeg).", "title": "Tile Format" }, "description": "Default will be automatically defined if the output image needs a mask (png) or not (jpeg)." }, { "name": "tilesize", "in": "query", "required": false, "schema": { "type": "integer", "exclusiveMinimum": 0, "description": "Tilesize in pixels. Default to 256.", "default": 256, "title": "Tilesize" }, "description": "Tilesize in pixels. Default to 256." }, { "name": "minzoom", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "Overwrite default minzoom.", "title": "Minzoom" }, "description": "Overwrite default minzoom." }, { "name": "maxzoom", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "Overwrite default maxzoom.", "title": "Maxzoom" }, "description": "Overwrite default maxzoom." }, { "name": "url", "in": "query", "required": true, "schema": { "type": "string", "description": "Mosaic URL", "title": "Url" }, "description": "Mosaic URL" }, { "name": "bidx", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "array", "items": { "type": "integer" } }, { "type": "null" } ], "title": "Band indexes", "description": "Dataset band indexes" }, "description": "Dataset band indexes", "examples": { "user-provided": {}, "one-band": { "value": [ 1 ] }, "multi-bands": { "value": [ 1, 2, 3 ] } } }, { "name": "expression", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Band Math expression", "description": "rio-tiler's band math expression" }, "description": "rio-tiler's band math expression", "examples": { "user-provided": {}, "simple": { "description": "Simple band math.", "value": "b1/b2" }, "multi-bands": { "description": "Semicolon (;) delimited expressions (band1: b1/b2, band2: b2+b3).", "value": "b1/b2;b2+b3" } } }, { "name": "nodata", "in": "query", "required": false, "schema": { "anyOf": [ { "enum": [ "nan", "inf", "-inf" ], "type": "string" }, { "type": "integer" }, { "type": "number" }, { "type": "null" } ], "title": "Nodata value", "description": "Overwrite internal Nodata value; nan or valid float values only." }, "description": "Overwrite internal Nodata value; nan or valid float values only." }, { "name": "unscale", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Apply internal Scale/Offset", "description": "Apply internal Scale/Offset. Defaults to `False`." }, "description": "Apply internal Scale/Offset. Defaults to `False`." }, { "name": "resampling", "in": "query", "required": false, "schema": { "anyOf": [ { "enum": [ "nearest", "bilinear", "cubic", "cubic_spline", "lanczos", "average", "mode", "gauss", "rms" ], "type": "string" }, { "type": "null" } ], "description": "RasterIO resampling algorithm. Defaults to `nearest`.", "title": "Resampling" }, "description": "RasterIO resampling algorithm. Defaults to `nearest`." }, { "name": "reproject", "in": "query", "required": false, "schema": { "anyOf": [ { "enum": [ "nearest", "bilinear", "cubic", "cubic_spline", "lanczos", "average", "mode", "max", "min", "med", "q1", "q3", "sum", "rms" ], "type": "string" }, { "type": "null" } ], "description": "WarpKernel resampling algorithm (only used when doing re-projection). Defaults to `nearest`.", "title": "Reproject" }, "description": "WarpKernel resampling algorithm (only used when doing re-projection). Defaults to `nearest`." }, { "name": "pixel_selection", "in": "query", "required": false, "schema": { "enum": [ "first", "highest", "lowest", "mean", "median", "stdev", "lastbandlow", "lastbandhigh", "count" ], "type": "string", "description": "Pixel selection method.", "default": "first", "title": "Pixel Selection" }, "description": "Pixel selection method." }, { "name": "buffer", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "number", "exclusiveMinimum": 0 }, { "type": "null" } ], "title": "Tile buffer.", "description": "Buffer on each side of the given tile. It must be a multiple of `0.5`. Output **tilesize** will be expanded to `tilesize + 2 * buffer` (e.g 0.5 = 257x257, 1.0 = 258x258)." }, "description": "Buffer on each side of the given tile. It must be a multiple of `0.5`. Output **tilesize** will be expanded to `tilesize + 2 * buffer` (e.g 0.5 = 257x257, 1.0 = 258x258)." }, { "name": "padding", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "integer", "exclusiveMinimum": 0 }, { "type": "null" } ], "title": "Tile padding.", "description": "Padding to apply to each tile edge. Helps reduce resampling artefacts along edges. Defaults to `0`." }, "description": "Padding to apply to each tile edge. Helps reduce resampling artefacts along edges. Defaults to `0`." }, { "name": "algorithm", "in": "query", "required": false, "schema": { "enum": [ "hillshade", "slope", "contours", "normalizedIndex", "terrarium", "terrainrgb", "cast", "ceil", "floor", "min", "max", "median", "mean", "std", "var", "sum", "grayscale", "bitonal" ], "type": "string", "description": "Algorithm name", "title": "Algorithm" }, "description": "Algorithm name" }, { "name": "algorithm_params", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Algorithm parameter", "title": "Algorithm Params" }, "description": "Algorithm parameter" }, { "name": "colormap_name", "in": "query", "required": false, "schema": { "enum": [ "jet_r", "haline", "gist_ncar_r", "algae", "cividis_r", "seismic_r", "pink_r", "rdylbu", "inferno_r", "deep", "rdgy_r", "tab10", "bugn_r", "ocean_r", "purples", "pastel1_r", "thermal_r", "ylorrd_r", "wistia_r", "cmrmap", "pubu", "rain", "ylgnbu", "gnuplot", "gnbu", "gist_gray_r", "greens", "purd_r", "oxy_r", "matter", "summer_r", "gnuplot_r", "gnuplot2", "solar", "jet", "ylgn_r", "dark2_r", "spring", "tab20c", "gist_stern", "bwr", "ylgn", "plasma", "pastel2", "blues_r", "rain_r", "set1", "topo_r", "gist_ncar", "turbid", "magma_r", "pastel2_r", "purd", "gnbu_r", "spring_r", "rdbu_r", "ylorbr", "twilight_shifted", "rplumbo", "winter_r", "tab20b", "ylorrd", "copper", "flag_r", "afmhot", "twilight_shifted_r", "oranges_r", "bone", "seismic", "gray_r", "tarn_r", "bwr_r", "magma", "paired_r", "dark2", "binary", "set3", "viridis_r", "spectral", "prgn", "diff", "hot", "gist_earth", "cubehelix", "dense_r", "coolwarm", "pubugn_r", "autumn_r", "gnuplot2_r", "cividis", "bugn", "deep_r", "prgn_r", "gist_rainbow", "gist_heat_r", "nipy_spectral_r", "tab20", "turbo_r", "pubugn", "set2_r", "gist_yarg_r", "spectral_r", "binary_r", "greys", "rainbow_r", "haline_r", "curl", "tab20c_r", "blues", "prism", "rdgy", "gist_gray", "set2", "cool", "afmhot_r", "bone_r", "paired", "oranges", "orrd", "puor", "autumn", "delta_r", "pubu_r", "piyg_r", "turbo", "greys_r", "accent", "turbid_r", "algae_r", "solar_r", "topo", "cool_r", "inferno", "balance", "tempo_r", "amp_r", "flag", "speed", "gist_heat", "balance_r", "viridis", "cubehelix_r", "ylorbr_r", "summer", "coolwarm_r", "diff_r", "rdylgn_r", "gist_stern_r", "plasma_r", "copper_r", "oxy", "gist_yarg", "twilight", "winter", "brbg", "reds_r", "speed_r", "rainbow", "ice", "nipy_spectral", "piyg", "gray", "reds", "terrain", "tab20_r", "wistia", "accent_r", "thermal", "ocean", "twilight_r", "hot_r", "set3_r", "hsv_r", "brg_r", "gist_rainbow_r", "phase", "bupu", "pastel1", "dense", "set1_r", "phase_r", "matter_r", "greens_r", "cfastie", "tab10_r", "rdbu", "brg", "rdpu_r", "brbg_r", "cmrmap_r", "prism_r", "purples_r", "gist_earth_r", "tempo", "schwarzwald", "rdpu", "orrd_r", "tarn", "puor_r", "bupu_r", "rdylgn", "ice_r", "pink", "terrain_r", "amp", "tab20b_r", "rdylbu_r", "hsv", "curl_r", "delta", "ylgnbu_r" ], "type": "string", "description": "Colormap name", "title": "Colormap Name" }, "description": "Colormap name" }, { "name": "colormap", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "JSON encoded custom Colormap", "title": "Colormap" }, "description": "JSON encoded custom Colormap" }, { "name": "rescale", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ], "title": "Min/Max data Rescaling", "description": "comma (',') delimited Min,Max range. Can set multiple time for multiple bands.", "examples": [ "0,2000", "0,1000", "0,10000" ] }, "description": "comma (',') delimited Min,Max range. Can set multiple time for multiple bands." }, { "name": "color_formula", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Color Formula", "description": "rio-color formula (info: https://github.com/mapbox/rio-color)" }, "description": "rio-color formula (info: https://github.com/mapbox/rio-color)" }, { "name": "return_mask", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "Add mask to the output data. Defaults to `True`", "title": "Return Mask" }, "description": "Add mask to the output data. Defaults to `True`" } ], "responses": { "200": { "description": "Successful Response", "content": { "text/html": { "schema": { "type": "string" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/mosaicjson/{tileMatrixSetId}/tilejson.json": { "get": { "tags": [ "MosaicJSON" ], "summary": "Tilejson", "description": "Return TileJSON document for a COG.", "operationId": ".mosaicjson.getTileJSON", "parameters": [ { "name": "tileMatrixSetId", "in": "path", "required": true, "schema": { "enum": [ "CDB1GlobalGrid", "CanadianNAD83_LCC", "EuropeanETRS89_LAEAQuad", "GNOSISGlobalGrid", "LINZAntarticaMapTilegrid", "NZTM2000Quad", "UPSAntarcticWGS84Quad", "UPSArcticWGS84Quad", "UTM31WGS84Quad", "WGS1984Quad", "WebMercatorQuad", "WorldCRS84Quad", "WorldMercatorWGS84Quad" ], "type": "string", "description": "Identifier selecting one of the TileMatrixSetId supported.", "title": "Tilematrixsetid" }, "description": "Identifier selecting one of the TileMatrixSetId supported." }, { "name": "tilesize", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "integer", "exclusiveMinimum": 0 }, { "type": "null" } ], "description": "Tilesize in pixels. Default to 512.", "title": "Tilesize" }, "description": "Tilesize in pixels. Default to 512." }, { "name": "tile_format", "in": "query", "required": false, "schema": { "anyOf": [ { "$ref": "#/components/schemas/ImageType" }, { "type": "null" } ], "description": "Default will be automatically defined if the output image needs a mask (png) or not (jpeg).", "title": "Tile Format" }, "description": "Default will be automatically defined if the output image needs a mask (png) or not (jpeg)." }, { "name": "minzoom", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "Overwrite default minzoom.", "title": "Minzoom" }, "description": "Overwrite default minzoom." }, { "name": "maxzoom", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "Overwrite default maxzoom.", "title": "Maxzoom" }, "description": "Overwrite default maxzoom." }, { "name": "url", "in": "query", "required": true, "schema": { "type": "string", "description": "Mosaic URL", "title": "Url" }, "description": "Mosaic URL" }, { "name": "bidx", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "array", "items": { "type": "integer" } }, { "type": "null" } ], "title": "Band indexes", "description": "Dataset band indexes" }, "description": "Dataset band indexes", "examples": { "user-provided": {}, "one-band": { "value": [ 1 ] }, "multi-bands": { "value": [ 1, 2, 3 ] } } }, { "name": "expression", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Band Math expression", "description": "rio-tiler's band math expression" }, "description": "rio-tiler's band math expression", "examples": { "user-provided": {}, "simple": { "description": "Simple band math.", "value": "b1/b2" }, "multi-bands": { "description": "Semicolon (;) delimited expressions (band1: b1/b2, band2: b2+b3).", "value": "b1/b2;b2+b3" } } }, { "name": "nodata", "in": "query", "required": false, "schema": { "anyOf": [ { "enum": [ "nan", "inf", "-inf" ], "type": "string" }, { "type": "integer" }, { "type": "number" }, { "type": "null" } ], "title": "Nodata value", "description": "Overwrite internal Nodata value; nan or valid float values only." }, "description": "Overwrite internal Nodata value; nan or valid float values only." }, { "name": "unscale", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Apply internal Scale/Offset", "description": "Apply internal Scale/Offset. Defaults to `False`." }, "description": "Apply internal Scale/Offset. Defaults to `False`." }, { "name": "resampling", "in": "query", "required": false, "schema": { "anyOf": [ { "enum": [ "nearest", "bilinear", "cubic", "cubic_spline", "lanczos", "average", "mode", "gauss", "rms" ], "type": "string" }, { "type": "null" } ], "description": "RasterIO resampling algorithm. Defaults to `nearest`.", "title": "Resampling" }, "description": "RasterIO resampling algorithm. Defaults to `nearest`." }, { "name": "reproject", "in": "query", "required": false, "schema": { "anyOf": [ { "enum": [ "nearest", "bilinear", "cubic", "cubic_spline", "lanczos", "average", "mode", "max", "min", "med", "q1", "q3", "sum", "rms" ], "type": "string" }, { "type": "null" } ], "description": "WarpKernel resampling algorithm (only used when doing re-projection). Defaults to `nearest`.", "title": "Reproject" }, "description": "WarpKernel resampling algorithm (only used when doing re-projection). Defaults to `nearest`." }, { "name": "pixel_selection", "in": "query", "required": false, "schema": { "enum": [ "first", "highest", "lowest", "mean", "median", "stdev", "lastbandlow", "lastbandhigh", "count" ], "type": "string", "description": "Pixel selection method.", "default": "first", "title": "Pixel Selection" }, "description": "Pixel selection method." }, { "name": "buffer", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "number", "exclusiveMinimum": 0 }, { "type": "null" } ], "title": "Tile buffer.", "description": "Buffer on each side of the given tile. It must be a multiple of `0.5`. Output **tilesize** will be expanded to `tilesize + 2 * buffer` (e.g 0.5 = 257x257, 1.0 = 258x258)." }, "description": "Buffer on each side of the given tile. It must be a multiple of `0.5`. Output **tilesize** will be expanded to `tilesize + 2 * buffer` (e.g 0.5 = 257x257, 1.0 = 258x258)." }, { "name": "padding", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "integer", "exclusiveMinimum": 0 }, { "type": "null" } ], "title": "Tile padding.", "description": "Padding to apply to each tile edge. Helps reduce resampling artefacts along edges. Defaults to `0`." }, "description": "Padding to apply to each tile edge. Helps reduce resampling artefacts along edges. Defaults to `0`." }, { "name": "algorithm", "in": "query", "required": false, "schema": { "enum": [ "hillshade", "slope", "contours", "normalizedIndex", "terrarium", "terrainrgb", "cast", "ceil", "floor", "min", "max", "median", "mean", "std", "var", "sum", "grayscale", "bitonal" ], "type": "string", "description": "Algorithm name", "title": "Algorithm" }, "description": "Algorithm name" }, { "name": "algorithm_params", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Algorithm parameter", "title": "Algorithm Params" }, "description": "Algorithm parameter" }, { "name": "colormap_name", "in": "query", "required": false, "schema": { "enum": [ "jet_r", "haline", "gist_ncar_r", "algae", "cividis_r", "seismic_r", "pink_r", "rdylbu", "inferno_r", "deep", "rdgy_r", "tab10", "bugn_r", "ocean_r", "purples", "pastel1_r", "thermal_r", "ylorrd_r", "wistia_r", "cmrmap", "pubu", "rain", "ylgnbu", "gnuplot", "gnbu", "gist_gray_r", "greens", "purd_r", "oxy_r", "matter", "summer_r", "gnuplot_r", "gnuplot2", "solar", "jet", "ylgn_r", "dark2_r", "spring", "tab20c", "gist_stern", "bwr", "ylgn", "plasma", "pastel2", "blues_r", "rain_r", "set1", "topo_r", "gist_ncar", "turbid", "magma_r", "pastel2_r", "purd", "gnbu_r", "spring_r", "rdbu_r", "ylorbr", "twilight_shifted", "rplumbo", "winter_r", "tab20b", "ylorrd", "copper", "flag_r", "afmhot", "twilight_shifted_r", "oranges_r", "bone", "seismic", "gray_r", "tarn_r", "bwr_r", "magma", "paired_r", "dark2", "binary", "set3", "viridis_r", "spectral", "prgn", "diff", "hot", "gist_earth", "cubehelix", "dense_r", "coolwarm", "pubugn_r", "autumn_r", "gnuplot2_r", "cividis", "bugn", "deep_r", "prgn_r", "gist_rainbow", "gist_heat_r", "nipy_spectral_r", "tab20", "turbo_r", "pubugn", "set2_r", "gist_yarg_r", "spectral_r", "binary_r", "greys", "rainbow_r", "haline_r", "curl", "tab20c_r", "blues", "prism", "rdgy", "gist_gray", "set2", "cool", "afmhot_r", "bone_r", "paired", "oranges", "orrd", "puor", "autumn", "delta_r", "pubu_r", "piyg_r", "turbo", "greys_r", "accent", "turbid_r", "algae_r", "solar_r", "topo", "cool_r", "inferno", "balance", "tempo_r", "amp_r", "flag", "speed", "gist_heat", "balance_r", "viridis", "cubehelix_r", "ylorbr_r", "summer", "coolwarm_r", "diff_r", "rdylgn_r", "gist_stern_r", "plasma_r", "copper_r", "oxy", "gist_yarg", "twilight", "winter", "brbg", "reds_r", "speed_r", "rainbow", "ice", "nipy_spectral", "piyg", "gray", "reds", "terrain", "tab20_r", "wistia", "accent_r", "thermal", "ocean", "twilight_r", "hot_r", "set3_r", "hsv_r", "brg_r", "gist_rainbow_r", "phase", "bupu", "pastel1", "dense", "set1_r", "phase_r", "matter_r", "greens_r", "cfastie", "tab10_r", "rdbu", "brg", "rdpu_r", "brbg_r", "cmrmap_r", "prism_r", "purples_r", "gist_earth_r", "tempo", "schwarzwald", "rdpu", "orrd_r", "tarn", "puor_r", "bupu_r", "rdylgn", "ice_r", "pink", "terrain_r", "amp", "tab20b_r", "rdylbu_r", "hsv", "curl_r", "delta", "ylgnbu_r" ], "type": "string", "description": "Colormap name", "title": "Colormap Name" }, "description": "Colormap name" }, { "name": "colormap", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "JSON encoded custom Colormap", "title": "Colormap" }, "description": "JSON encoded custom Colormap" }, { "name": "rescale", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ], "title": "Min/Max data Rescaling", "description": "comma (',') delimited Min,Max range. Can set multiple time for multiple bands.", "examples": [ "0,2000", "0,1000", "0,10000" ] }, "description": "comma (',') delimited Min,Max range. Can set multiple time for multiple bands." }, { "name": "color_formula", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Color Formula", "description": "rio-color formula (info: https://github.com/mapbox/rio-color)" }, "description": "rio-color formula (info: https://github.com/mapbox/rio-color)" }, { "name": "return_mask", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "Add mask to the output data. Defaults to `True`", "title": "Return Mask" }, "description": "Add mask to the output data. Defaults to `True`" } ], "responses": { "200": { "description": "Return a tilejson", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TileJSON" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/mosaicjson/point/{lon},{lat}": { "get": { "tags": [ "MosaicJSON" ], "summary": "Point", "description": "Get Point value for a Mosaic.", "operationId": ".mosaicjson.getDataForPoint", "parameters": [ { "name": "lon", "in": "path", "required": true, "schema": { "type": "number", "description": "Longitude", "title": "Lon" }, "description": "Longitude" }, { "name": "lat", "in": "path", "required": true, "schema": { "type": "number", "description": "Latitude", "title": "Lat" }, "description": "Latitude" }, { "name": "url", "in": "query", "required": true, "schema": { "type": "string", "description": "Mosaic URL", "title": "Url" }, "description": "Mosaic URL" }, { "name": "coord_crs", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Coordinate Reference System of the input coords. Default to `epsg:4326`.", "title": "Coord Crs" }, "description": "Coordinate Reference System of the input coords. Default to `epsg:4326`." }, { "name": "bidx", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "array", "items": { "type": "integer" } }, { "type": "null" } ], "title": "Band indexes", "description": "Dataset band indexes" }, "description": "Dataset band indexes", "examples": { "user-provided": {}, "one-band": { "value": [ 1 ] }, "multi-bands": { "value": [ 1, 2, 3 ] } } }, { "name": "expression", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Band Math expression", "description": "rio-tiler's band math expression" }, "description": "rio-tiler's band math expression", "examples": { "user-provided": {}, "simple": { "description": "Simple band math.", "value": "b1/b2" }, "multi-bands": { "description": "Semicolon (;) delimited expressions (band1: b1/b2, band2: b2+b3).", "value": "b1/b2;b2+b3" } } }, { "name": "nodata", "in": "query", "required": false, "schema": { "anyOf": [ { "enum": [ "nan", "inf", "-inf" ], "type": "string" }, { "type": "integer" }, { "type": "number" }, { "type": "null" } ], "title": "Nodata value", "description": "Overwrite internal Nodata value; nan or valid float values only." }, "description": "Overwrite internal Nodata value; nan or valid float values only." }, { "name": "unscale", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Apply internal Scale/Offset", "description": "Apply internal Scale/Offset. Defaults to `False`." }, "description": "Apply internal Scale/Offset. Defaults to `False`." }, { "name": "resampling", "in": "query", "required": false, "schema": { "anyOf": [ { "enum": [ "nearest", "bilinear", "cubic", "cubic_spline", "lanczos", "average", "mode", "gauss", "rms" ], "type": "string" }, { "type": "null" } ], "description": "RasterIO resampling algorithm. Defaults to `nearest`.", "title": "Resampling" }, "description": "RasterIO resampling algorithm. Defaults to `nearest`." }, { "name": "reproject", "in": "query", "required": false, "schema": { "anyOf": [ { "enum": [ "nearest", "bilinear", "cubic", "cubic_spline", "lanczos", "average", "mode", "max", "min", "med", "q1", "q3", "sum", "rms" ], "type": "string" }, { "type": "null" } ], "description": "WarpKernel resampling algorithm (only used when doing re-projection). Defaults to `nearest`.", "title": "Reproject" }, "description": "WarpKernel resampling algorithm (only used when doing re-projection). Defaults to `nearest`." } ], "responses": { "200": { "description": "Return a value for a point", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/titiler__mosaic__models__responses__Point" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/mosaicjson/bbox/{minx},{miny},{maxx},{maxy}/assets": { "get": { "tags": [ "MosaicJSON" ], "summary": "Assets For Bbox", "description": "Return a list of assets which overlap a bounding box", "operationId": ".mosaicjson.getAssetsForBoundingBox", "parameters": [ { "name": "minx", "in": "path", "required": true, "schema": { "type": "number", "description": "Bounding box min X", "title": "Minx" }, "description": "Bounding box min X" }, { "name": "miny", "in": "path", "required": true, "schema": { "type": "number", "description": "Bounding box min Y", "title": "Miny" }, "description": "Bounding box min Y" }, { "name": "maxx", "in": "path", "required": true, "schema": { "type": "number", "description": "Bounding box max X", "title": "Maxx" }, "description": "Bounding box max X" }, { "name": "maxy", "in": "path", "required": true, "schema": { "type": "number", "description": "Bounding box max Y", "title": "Maxy" }, "description": "Bounding box max Y" }, { "name": "url", "in": "query", "required": true, "schema": { "type": "string", "description": "Mosaic URL", "title": "Url" }, "description": "Mosaic URL" }, { "name": "coord_crs", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Coordinate Reference System of the input coords. Default to `epsg:4326`.", "title": "Coord Crs" }, "description": "Coordinate Reference System of the input coords. Default to `epsg:4326`." } ], "responses": { "200": { "description": "Return list of COGs in bounding box", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/mosaicjson/point/{lon},{lat}/assets": { "get": { "tags": [ "MosaicJSON" ], "summary": "Assets For Lon Lat", "description": "Return a list of assets which overlap a point", "operationId": ".mosaicjson.getAssetsForPoint", "parameters": [ { "name": "lon", "in": "path", "required": true, "schema": { "type": "number", "description": "Longitude", "title": "Lon" }, "description": "Longitude" }, { "name": "lat", "in": "path", "required": true, "schema": { "type": "number", "description": "Latitude", "title": "Lat" }, "description": "Latitude" }, { "name": "url", "in": "query", "required": true, "schema": { "type": "string", "description": "Mosaic URL", "title": "Url" }, "description": "Mosaic URL" }, { "name": "coord_crs", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Coordinate Reference System of the input coords. Default to `epsg:4326`.", "title": "Coord Crs" }, "description": "Coordinate Reference System of the input coords. Default to `epsg:4326`." } ], "responses": { "200": { "description": "Return list of COGs", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/mosaicjson/tiles/{tileMatrixSetId}/{z}/{x}/{y}/assets": { "get": { "tags": [ "MosaicJSON" ], "summary": "Assets For Tile", "description": "Return a list of assets which overlap a given tile", "operationId": ".mosaicjson.getAssetsForTile", "parameters": [ { "name": "tileMatrixSetId", "in": "path", "required": true, "schema": { "enum": [ "CDB1GlobalGrid", "CanadianNAD83_LCC", "EuropeanETRS89_LAEAQuad", "GNOSISGlobalGrid", "LINZAntarticaMapTilegrid", "NZTM2000Quad", "UPSAntarcticWGS84Quad", "UPSArcticWGS84Quad", "UTM31WGS84Quad", "WGS1984Quad", "WebMercatorQuad", "WorldCRS84Quad", "WorldMercatorWGS84Quad" ], "type": "string", "description": "Identifier selecting one of the TileMatrixSetId supported.", "title": "Tilematrixsetid" }, "description": "Identifier selecting one of the TileMatrixSetId supported." }, { "name": "z", "in": "path", "required": true, "schema": { "type": "integer", "description": "Identifier (Z) selecting one of the scales defined in the TileMatrixSet and representing the scaleDenominator the tile.", "title": "Z" }, "description": "Identifier (Z) selecting one of the scales defined in the TileMatrixSet and representing the scaleDenominator the tile." }, { "name": "x", "in": "path", "required": true, "schema": { "type": "integer", "description": "Column (X) index of the tile on the selected TileMatrix. It cannot exceed the MatrixHeight-1 for the selected TileMatrix.", "title": "X" }, "description": "Column (X) index of the tile on the selected TileMatrix. It cannot exceed the MatrixHeight-1 for the selected TileMatrix." }, { "name": "y", "in": "path", "required": true, "schema": { "type": "integer", "description": "Row (Y) index of the tile on the selected TileMatrix. It cannot exceed the MatrixWidth-1 for the selected TileMatrix.", "title": "Y" }, "description": "Row (Y) index of the tile on the selected TileMatrix. It cannot exceed the MatrixWidth-1 for the selected TileMatrix." }, { "name": "url", "in": "query", "required": true, "schema": { "type": "string", "description": "Mosaic URL", "title": "Url" }, "description": "Mosaic URL" } ], "responses": { "200": { "description": "Return list of COGs", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/mosaicjson/": { "get": { "tags": [ "MosaicJSON" ], "summary": "Read", "description": "Read a MosaicJSON", "operationId": ".mosaicjson.getMosaicJSON", "parameters": [ { "name": "url", "in": "query", "required": true, "schema": { "type": "string", "description": "Mosaic URL", "title": "Url" }, "description": "Mosaic URL" } ], "responses": { "200": { "description": "Return MosaicJSON definition", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MosaicJSON" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/mosaicjson/validate": { "post": { "tags": [ "MosaicJSON" ], "summary": "Validate", "description": "Validate a MosaicJSON", "operationId": ".mosaicjson.validate", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MosaicJSON" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/mosaicjson/WMTSCapabilities.xml": { "get": { "tags": [ "MosaicJSON" ], "summary": "Wmts", "description": "OGC RESTful WMTS endpoint.", "operationId": ".mosaicjson.getWMTS", "parameters": [ { "name": "tile_format", "in": "query", "required": false, "schema": { "$ref": "#/components/schemas/ImageType", "description": "Output image type. Default is png.", "default": "png" }, "description": "Output image type. Default is png." }, { "name": "use_epsg", "in": "query", "required": false, "schema": { "type": "boolean", "description": "Use EPSG code, not opengis.net, for the ows:SupportedCRS in the TileMatrixSet (set to True to enable ArcMap compatability)", "default": false, "title": "Use Epsg" }, "description": "Use EPSG code, not opengis.net, for the ows:SupportedCRS in the TileMatrixSet (set to True to enable ArcMap compatability)" }, { "name": "url", "in": "query", "required": true, "schema": { "type": "string", "description": "Mosaic URL", "title": "Url" }, "description": "Mosaic URL" }, { "name": "bidx", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "array", "items": { "type": "integer" } }, { "type": "null" } ], "title": "Band indexes", "description": "Dataset band indexes" }, "description": "Dataset band indexes", "examples": { "user-provided": {}, "one-band": { "value": [ 1 ] }, "multi-bands": { "value": [ 1, 2, 3 ] } } }, { "name": "expression", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Band Math expression", "description": "rio-tiler's band math expression" }, "description": "rio-tiler's band math expression", "examples": { "user-provided": {}, "simple": { "description": "Simple band math.", "value": "b1/b2" }, "multi-bands": { "description": "Semicolon (;) delimited expressions (band1: b1/b2, band2: b2+b3).", "value": "b1/b2;b2+b3" } } }, { "name": "nodata", "in": "query", "required": false, "schema": { "anyOf": [ { "enum": [ "nan", "inf", "-inf" ], "type": "string" }, { "type": "integer" }, { "type": "number" }, { "type": "null" } ], "title": "Nodata value", "description": "Overwrite internal Nodata value; nan or valid float values only." }, "description": "Overwrite internal Nodata value; nan or valid float values only." }, { "name": "unscale", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Apply internal Scale/Offset", "description": "Apply internal Scale/Offset. Defaults to `False`." }, "description": "Apply internal Scale/Offset. Defaults to `False`." }, { "name": "resampling", "in": "query", "required": false, "schema": { "anyOf": [ { "enum": [ "nearest", "bilinear", "cubic", "cubic_spline", "lanczos", "average", "mode", "gauss", "rms" ], "type": "string" }, { "type": "null" } ], "description": "RasterIO resampling algorithm. Defaults to `nearest`.", "title": "Resampling" }, "description": "RasterIO resampling algorithm. Defaults to `nearest`." }, { "name": "reproject", "in": "query", "required": false, "schema": { "anyOf": [ { "enum": [ "nearest", "bilinear", "cubic", "cubic_spline", "lanczos", "average", "mode", "max", "min", "med", "q1", "q3", "sum", "rms" ], "type": "string" }, { "type": "null" } ], "description": "WarpKernel resampling algorithm (only used when doing re-projection). Defaults to `nearest`.", "title": "Reproject" }, "description": "WarpKernel resampling algorithm (only used when doing re-projection). Defaults to `nearest`." }, { "name": "pixel_selection", "in": "query", "required": false, "schema": { "enum": [ "first", "highest", "lowest", "mean", "median", "stdev", "lastbandlow", "lastbandhigh", "count" ], "type": "string", "description": "Pixel selection method.", "default": "first", "title": "Pixel Selection" }, "description": "Pixel selection method." }, { "name": "algorithm", "in": "query", "required": false, "schema": { "enum": [ "hillshade", "slope", "contours", "normalizedIndex", "terrarium", "terrainrgb", "cast", "ceil", "floor", "min", "max", "median", "mean", "std", "var", "sum", "grayscale", "bitonal" ], "type": "string", "description": "Algorithm name", "title": "Algorithm" }, "description": "Algorithm name" }, { "name": "algorithm_params", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Algorithm parameter", "title": "Algorithm Params" }, "description": "Algorithm parameter" }, { "name": "colormap_name", "in": "query", "required": false, "schema": { "enum": [ "jet_r", "haline", "gist_ncar_r", "algae", "cividis_r", "seismic_r", "pink_r", "rdylbu", "inferno_r", "deep", "rdgy_r", "tab10", "bugn_r", "ocean_r", "purples", "pastel1_r", "thermal_r", "ylorrd_r", "wistia_r", "cmrmap", "pubu", "rain", "ylgnbu", "gnuplot", "gnbu", "gist_gray_r", "greens", "purd_r", "oxy_r", "matter", "summer_r", "gnuplot_r", "gnuplot2", "solar", "jet", "ylgn_r", "dark2_r", "spring", "tab20c", "gist_stern", "bwr", "ylgn", "plasma", "pastel2", "blues_r", "rain_r", "set1", "topo_r", "gist_ncar", "turbid", "magma_r", "pastel2_r", "purd", "gnbu_r", "spring_r", "rdbu_r", "ylorbr", "twilight_shifted", "rplumbo", "winter_r", "tab20b", "ylorrd", "copper", "flag_r", "afmhot", "twilight_shifted_r", "oranges_r", "bone", "seismic", "gray_r", "tarn_r", "bwr_r", "magma", "paired_r", "dark2", "binary", "set3", "viridis_r", "spectral", "prgn", "diff", "hot", "gist_earth", "cubehelix", "dense_r", "coolwarm", "pubugn_r", "autumn_r", "gnuplot2_r", "cividis", "bugn", "deep_r", "prgn_r", "gist_rainbow", "gist_heat_r", "nipy_spectral_r", "tab20", "turbo_r", "pubugn", "set2_r", "gist_yarg_r", "spectral_r", "binary_r", "greys", "rainbow_r", "haline_r", "curl", "tab20c_r", "blues", "prism", "rdgy", "gist_gray", "set2", "cool", "afmhot_r", "bone_r", "paired", "oranges", "orrd", "puor", "autumn", "delta_r", "pubu_r", "piyg_r", "turbo", "greys_r", "accent", "turbid_r", "algae_r", "solar_r", "topo", "cool_r", "inferno", "balance", "tempo_r", "amp_r", "flag", "speed", "gist_heat", "balance_r", "viridis", "cubehelix_r", "ylorbr_r", "summer", "coolwarm_r", "diff_r", "rdylgn_r", "gist_stern_r", "plasma_r", "copper_r", "oxy", "gist_yarg", "twilight", "winter", "brbg", "reds_r", "speed_r", "rainbow", "ice", "nipy_spectral", "piyg", "gray", "reds", "terrain", "tab20_r", "wistia", "accent_r", "thermal", "ocean", "twilight_r", "hot_r", "set3_r", "hsv_r", "brg_r", "gist_rainbow_r", "phase", "bupu", "pastel1", "dense", "set1_r", "phase_r", "matter_r", "greens_r", "cfastie", "tab10_r", "rdbu", "brg", "rdpu_r", "brbg_r", "cmrmap_r", "prism_r", "purples_r", "gist_earth_r", "tempo", "schwarzwald", "rdpu", "orrd_r", "tarn", "puor_r", "bupu_r", "rdylgn", "ice_r", "pink", "terrain_r", "amp", "tab20b_r", "rdylbu_r", "hsv", "curl_r", "delta", "ylgnbu_r" ], "type": "string", "description": "Colormap name", "title": "Colormap Name" }, "description": "Colormap name" }, { "name": "colormap", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "JSON encoded custom Colormap", "title": "Colormap" }, "description": "JSON encoded custom Colormap" }, { "name": "rescale", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ], "title": "Min/Max data Rescaling", "description": "comma (',') delimited Min,Max range. Can set multiple time for multiple bands.", "examples": [ "0,2000", "0,1000", "0,10000" ] }, "description": "comma (',') delimited Min,Max range. Can set multiple time for multiple bands." }, { "name": "color_formula", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Color Formula", "description": "rio-color formula (info: https://github.com/mapbox/rio-color)" }, "description": "rio-color formula (info: https://github.com/mapbox/rio-color)" }, { "name": "return_mask", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "Add mask to the output data. Defaults to `True`", "title": "Return Mask" }, "description": "Add mask to the output data. Defaults to `True`" }, { "name": "buffer", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "number", "exclusiveMinimum": 0 }, { "type": "null" } ], "title": "Tile buffer.", "description": "Buffer on each side of the given tile. It must be a multiple of `0.5`. Output **tilesize** will be expanded to `tilesize + 2 * buffer` (e.g 0.5 = 257x257, 1.0 = 258x258)." }, "description": "Buffer on each side of the given tile. It must be a multiple of `0.5`. Output **tilesize** will be expanded to `tilesize + 2 * buffer` (e.g 0.5 = 257x257, 1.0 = 258x258)." }, { "name": "padding", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "integer", "exclusiveMinimum": 0 }, { "type": "null" } ], "title": "Tile padding.", "description": "Padding to apply to each tile edge. Helps reduce resampling artefacts along edges. Defaults to `0`." }, "description": "Padding to apply to each tile edge. Helps reduce resampling artefacts along edges. Defaults to `0`." } ], "responses": { "200": { "description": "Return RESTful WMTS service capabilities document.", "content": { "application/xml": { "schema": { "type": "string" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/zarr/info": { "get": { "tags": [ "Zarr" ], "summary": "Info Endpoint", "description": "Return dataset's basic info.", "operationId": ".zarr.getInfo", "parameters": [ { "name": "show_times", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "Show info about the time dimension", "title": "Show Times" }, "description": "Show info about the time dimension" }, { "name": "url", "in": "query", "required": true, "schema": { "type": "string", "description": "Dataset URL", "title": "Url" }, "description": "Dataset URL" }, { "name": "variable", "in": "query", "required": true, "schema": { "type": "string", "description": "Xarray Variable name.", "title": "Variable" }, "description": "Xarray Variable name." }, { "name": "sel", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "array", "items": { "type": "string", "pattern": "^[^=]+=((nearest|pad|ffill|backfill|bfill)::)?([^=:]|:[^:])+$" } }, { "type": "null" } ], "description": "Xarray Indexing using dimension names `{dimension}={value}` or `{dimension}={method}::{value}`.", "title": "Sel" }, "description": "Xarray Indexing using dimension names `{dimension}={value}` or `{dimension}={method}::{value}`." }, { "name": "group", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Select a specific zarr group from a zarr hierarchy. Could be associated with a zoom level or dataset.", "title": "Group" }, "description": "Select a specific zarr group from a zarr hierarchy. Could be associated with a zoom level or dataset." }, { "name": "decode_times", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "decode_times", "description": "Whether to decode times" }, "description": "Whether to decode times" } ], "responses": { "200": { "description": "Return dataset's basic info.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rio_tiler__models__Info" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/zarr/info.geojson": { "get": { "tags": [ "Zarr" ], "summary": "Info Geojson", "description": "Return dataset's basic info as a GeoJSON feature.", "operationId": ".zarr.getInfoGeoJSON", "parameters": [ { "name": "show_times", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "Show info about the time dimension", "title": "Show Times" }, "description": "Show info about the time dimension" }, { "name": "url", "in": "query", "required": true, "schema": { "type": "string", "description": "Dataset URL", "title": "Url" }, "description": "Dataset URL" }, { "name": "variable", "in": "query", "required": true, "schema": { "type": "string", "description": "Xarray Variable name.", "title": "Variable" }, "description": "Xarray Variable name." }, { "name": "sel", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "array", "items": { "type": "string", "pattern": "^[^=]+=((nearest|pad|ffill|backfill|bfill)::)?([^=:]|:[^:])+$" } }, { "type": "null" } ], "description": "Xarray Indexing using dimension names `{dimension}={value}` or `{dimension}={method}::{value}`.", "title": "Sel" }, "description": "Xarray Indexing using dimension names `{dimension}={value}` or `{dimension}={method}::{value}`." }, { "name": "group", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Select a specific zarr group from a zarr hierarchy. Could be associated with a zoom level or dataset.", "title": "Group" }, "description": "Select a specific zarr group from a zarr hierarchy. Could be associated with a zoom level or dataset." }, { "name": "decode_times", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "decode_times", "description": "Whether to decode times" }, "description": "Whether to decode times" }, { "name": "crs", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Coordinate Reference System.", "title": "Crs" }, "description": "Coordinate Reference System." } ], "responses": { "200": { "description": "Return dataset's basic info as a GeoJSON feature.", "content": { "application/geo+json": { "schema": { "$ref": "#/components/schemas/Feature_Union_Polygon__MultiPolygon__Info_" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/zarr/statistics": { "post": { "tags": [ "Zarr" ], "summary": "Geojson Statistics", "description": "Get Statistics from a geojson feature or featureCollection.", "operationId": ".zarr.postStatisticsForGeoJSON", "parameters": [ { "name": "url", "in": "query", "required": true, "schema": { "type": "string", "description": "Dataset URL", "title": "Url" }, "description": "Dataset URL" }, { "name": "variable", "in": "query", "required": true, "schema": { "type": "string", "description": "Xarray Variable name.", "title": "Variable" }, "description": "Xarray Variable name." }, { "name": "sel", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "array", "items": { "type": "string", "pattern": "^[^=]+=((nearest|pad|ffill|backfill|bfill)::)?([^=:]|:[^:])+$" } }, { "type": "null" } ], "description": "Xarray Indexing using dimension names `{dimension}={value}` or `{dimension}={method}::{value}`.", "title": "Sel" }, "description": "Xarray Indexing using dimension names `{dimension}={value}` or `{dimension}={method}::{value}`." }, { "name": "group", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Select a specific zarr group from a zarr hierarchy. Could be associated with a zoom level or dataset.", "title": "Group" }, "description": "Select a specific zarr group from a zarr hierarchy. Could be associated with a zoom level or dataset." }, { "name": "decode_times", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "decode_times", "description": "Whether to decode times" }, "description": "Whether to decode times" }, { "name": "coord_crs", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Coordinate Reference System of the input coords. Default to `epsg:4326`.", "title": "Coord Crs" }, "description": "Coordinate Reference System of the input coords. Default to `epsg:4326`." }, { "name": "dst_crs", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Output Coordinate Reference System.", "title": "Dst Crs" }, "description": "Output Coordinate Reference System." }, { "name": "bidx", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "array", "items": { "type": "integer" } }, { "type": "null" } ], "title": "Band indexes", "description": "Dataset band indexes" }, "description": "Dataset band indexes", "examples": { "user-provided": {}, "one-band": { "value": [ 1 ] }, "multi-bands": { "value": [ 1, 2, 3 ] } } }, { "name": "nodata", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "integer" }, { "type": "number" }, { "type": "null" } ], "title": "Nodata value", "description": "Overwrite internal Nodata value" }, "description": "Overwrite internal Nodata value" }, { "name": "reproject", "in": "query", "required": false, "schema": { "anyOf": [ { "enum": [ "nearest", "bilinear", "cubic", "cubic_spline", "lanczos", "average", "mode", "max", "min", "med", "q1", "q3", "sum", "rms" ], "type": "string" }, { "type": "null" } ], "description": "WarpKernel resampling algorithm (only used when doing re-projection). Defaults to `nearest`.", "title": "Reproject" }, "description": "WarpKernel resampling algorithm (only used when doing re-projection). Defaults to `nearest`." }, { "name": "max_size", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "Maximum image size to read onto.", "title": "Max Size" } }, { "name": "height", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "Force output image height.", "title": "Height" } }, { "name": "width", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "Force output image width.", "title": "Width" } }, { "name": "resampling", "in": "query", "required": false, "schema": { "anyOf": [ { "enum": [ "nearest", "bilinear", "cubic", "cubic_spline", "lanczos", "average", "mode", "gauss", "rms" ], "type": "string" }, { "type": "null" } ], "description": "RasterIO resampling algorithm. Defaults to `nearest`.", "title": "Resampling" }, "description": "RasterIO resampling algorithm. Defaults to `nearest`." }, { "name": "cover_scale", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "integer", "maximum": 1000, "exclusiveMinimum": 0 }, { "type": "null" } ], "description": "Scale used when generating coverage estimates of each\n raster cell by vector feature. Coverage is generated by\n rasterizing the feature at a finer resolution than the raster then using a summation to aggregate\n to the raster resolution and dividing by the square of cover_scale\n to get coverage value for each cell. Increasing cover_scale\n will increase the accuracy of coverage values; three orders\n magnitude finer resolution (cover_scale=1000) is usually enough to\n get coverage estimates with <1% error in individual edge cells coverage\n estimates, though much smaller values (e.g., cover_scale=10) are often\n sufficient (<10% error) and require less memory. Defaults to `10`.", "title": "Cover Scale" }, "description": "Scale used when generating coverage estimates of each\n raster cell by vector feature. Coverage is generated by\n rasterizing the feature at a finer resolution than the raster then using a summation to aggregate\n to the raster resolution and dividing by the square of cover_scale\n to get coverage value for each cell. Increasing cover_scale\n will increase the accuracy of coverage values; three orders\n magnitude finer resolution (cover_scale=1000) is usually enough to\n get coverage estimates with <1% error in individual edge cells coverage\n estimates, though much smaller values (e.g., cover_scale=10) are often\n sufficient (<10% error) and require less memory. Defaults to `10`." }, { "name": "algorithm", "in": "query", "required": false, "schema": { "enum": [ "hillshade", "slope", "contours", "normalizedIndex", "terrarium", "terrainrgb", "cast", "ceil", "floor", "min", "max", "median", "mean", "std", "var", "sum", "grayscale", "bitonal" ], "type": "string", "description": "Algorithm name", "title": "Algorithm" }, "description": "Algorithm name" }, { "name": "algorithm_params", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Algorithm parameter", "title": "Algorithm Params" }, "description": "Algorithm parameter" }, { "name": "categorical", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "Return statistics for categorical dataset. Defaults to `False`", "title": "Categorical" }, "description": "Return statistics for categorical dataset. Defaults to `False`" }, { "name": "c", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "array", "items": { "anyOf": [ { "type": "number" }, { "type": "integer" } ] } }, { "type": "null" } ], "title": "Pixels values for categories.", "description": "List of values for which to report counts.", "examples": [ 1, 2, 3 ] }, "description": "List of values for which to report counts." }, { "name": "p", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "array", "items": { "type": "integer" } }, { "type": "null" } ], "title": "Percentile values", "description": "List of percentile values (default to [2, 98]).", "examples": [ 2, 5, 95, 98 ] }, "description": "List of percentile values (default to [2, 98])." }, { "name": "histogram_bins", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "pattern": "^\\d+(,\\d+)*$" }, { "type": "null" } ], "title": "Histogram bins.", "description": "\nDefines the number of equal-width bins in the given range (10, by default).\n\nIf bins is a sequence (comma `,` delimited values), it defines a monotonically increasing array of bin edges, including the rightmost edge, allowing for non-uniform bin widths.\n\nlink: https://numpy.org/doc/stable/reference/generated/numpy.histogram.html\n " }, "description": "\nDefines the number of equal-width bins in the given range (10, by default).\n\nIf bins is a sequence (comma `,` delimited values), it defines a monotonically increasing array of bin edges, including the rightmost edge, allowing for non-uniform bin widths.\n\nlink: https://numpy.org/doc/stable/reference/generated/numpy.histogram.html\n ", "examples": { "user-provided": {}, "simple": { "description": "Defines the number of equal-width bins", "value": 8 }, "array": { "description": "Defines custom bin edges (comma `,` delimited values)", "value": "0,100,200,300" } } }, { "name": "histogram_range", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "pattern": "^\\s*(-)?\\d+((\\.\\d+)(e\\d+)?)?\\s*,\\s*(-)?\\d+((\\.\\d+)(e\\d+)?)?\\s*$" }, { "type": "null" } ], "title": "Histogram range", "description": "\nComma `,` delimited range of the bins.\n\nThe lower and upper range of the bins. If not provided, range is simply (a.min(), a.max()).\n\nValues outside the range are ignored. The first element of the range must be less than or equal to the second.\nrange affects the automatic bin computation as well.\n\nlink: https://numpy.org/doc/stable/reference/generated/numpy.histogram.html\n " }, "description": "\nComma `,` delimited range of the bins.\n\nThe lower and upper range of the bins. If not provided, range is simply (a.min(), a.max()).\n\nValues outside the range are ignored. The first element of the range must be less than or equal to the second.\nrange affects the automatic bin computation as well.\n\nlink: https://numpy.org/doc/stable/reference/generated/numpy.histogram.html\n ", "examples": { "user-provided": {}, "array": { "description": "Defines custom histogram range (comma `,` delimited values)", "value": "0,1000" } } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/FeatureCollection" }, { "$ref": "#/components/schemas/Feature-Input" } ], "description": "GeoJSON Feature or FeatureCollection.", "title": "Geojson" } } } }, "responses": { "200": { "description": "Return dataset's statistics from feature or featureCollection.", "content": { "application/geo+json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/FeatureCollection_Feature_Annotated_Union_Point__MultiPoint__LineString__MultiLineString__Polygon__MultiPolygon__GeometryCollection___FieldInfo_annotation_NoneType__required_True__discriminator__type_____StatisticsInGeoJSON__" }, { "$ref": "#/components/schemas/Feature_Annotated_Union_Point__MultiPoint__LineString__MultiLineString__Polygon__MultiPolygon__GeometryCollection___FieldInfo_annotation_NoneType__required_True__discriminator__type____StatisticsInGeoJSON_" } ], "title": "Response .Zarr.Poststatisticsforgeojson" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/zarr/tiles": { "get": { "tags": [ "Zarr" ], "summary": "Retrieve a list of available raster tilesets for the specified dataset.", "description": "Retrieve a list of available raster tilesets for the specified dataset.", "operationId": ".zarr.getTileSetList", "parameters": [ { "name": "f", "in": "query", "required": false, "schema": { "anyOf": [ { "enum": [ "html", "json" ], "type": "string" }, { "type": "null" } ], "description": "Response MediaType. Defaults to endpoint's default or value defined in `accept` header.", "title": "F" }, "description": "Response MediaType. Defaults to endpoint's default or value defined in `accept` header." }, { "name": "url", "in": "query", "required": true, "schema": { "type": "string", "description": "Dataset URL", "title": "Url" }, "description": "Dataset URL" }, { "name": "variable", "in": "query", "required": true, "schema": { "type": "string", "description": "Xarray Variable name.", "title": "Variable" }, "description": "Xarray Variable name." }, { "name": "sel", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "array", "items": { "type": "string", "pattern": "^[^=]+=((nearest|pad|ffill|backfill|bfill)::)?([^=:]|:[^:])+$" } }, { "type": "null" } ], "description": "Xarray Indexing using dimension names `{dimension}={value}` or `{dimension}={method}::{value}`.", "title": "Sel" }, "description": "Xarray Indexing using dimension names `{dimension}={value}` or `{dimension}={method}::{value}`." }, { "name": "group", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Select a specific zarr group from a zarr hierarchy. Could be associated with a zoom level or dataset.", "title": "Group" }, "description": "Select a specific zarr group from a zarr hierarchy. Could be associated with a zoom level or dataset." }, { "name": "decode_times", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "decode_times", "description": "Whether to decode times" }, "description": "Whether to decode times" }, { "name": "crs", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Coordinate Reference System.", "title": "Crs" }, "description": "Coordinate Reference System." } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TileSetList" } }, "text/html": {} } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/zarr/tiles/{tileMatrixSetId}": { "get": { "tags": [ "Zarr" ], "summary": "Retrieve the raster tileset metadata for the specified dataset and tiling scheme (tile matrix set).", "description": "Retrieve the raster tileset metadata for the specified dataset and tiling scheme (tile matrix set).", "operationId": ".zarr.getTileSet", "parameters": [ { "name": "tileMatrixSetId", "in": "path", "required": true, "schema": { "enum": [ "CDB1GlobalGrid", "CanadianNAD83_LCC", "EuropeanETRS89_LAEAQuad", "GNOSISGlobalGrid", "LINZAntarticaMapTilegrid", "NZTM2000Quad", "UPSAntarcticWGS84Quad", "UPSArcticWGS84Quad", "UTM31WGS84Quad", "WGS1984Quad", "WebMercatorQuad", "WorldCRS84Quad", "WorldMercatorWGS84Quad" ], "type": "string", "description": "Identifier selecting one of the TileMatrixSetId supported.", "title": "Tilematrixsetid" }, "description": "Identifier selecting one of the TileMatrixSetId supported." }, { "name": "minzoom", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "Overwrite default minzoom.", "title": "Minzoom" }, "description": "Overwrite default minzoom." }, { "name": "maxzoom", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "Overwrite default maxzoom.", "title": "Maxzoom" }, "description": "Overwrite default maxzoom." }, { "name": "f", "in": "query", "required": false, "schema": { "anyOf": [ { "enum": [ "html", "json" ], "type": "string" }, { "type": "null" } ], "description": "Response MediaType. Defaults to endpoint's default or value defined in `accept` header.", "title": "F" }, "description": "Response MediaType. Defaults to endpoint's default or value defined in `accept` header." }, { "name": "url", "in": "query", "required": true, "schema": { "type": "string", "description": "Dataset URL", "title": "Url" }, "description": "Dataset URL" }, { "name": "variable", "in": "query", "required": true, "schema": { "type": "string", "description": "Xarray Variable name.", "title": "Variable" }, "description": "Xarray Variable name." }, { "name": "sel", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "array", "items": { "type": "string", "pattern": "^[^=]+=((nearest|pad|ffill|backfill|bfill)::)?([^=:]|:[^:])+$" } }, { "type": "null" } ], "description": "Xarray Indexing using dimension names `{dimension}={value}` or `{dimension}={method}::{value}`.", "title": "Sel" }, "description": "Xarray Indexing using dimension names `{dimension}={value}` or `{dimension}={method}::{value}`." }, { "name": "group", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Select a specific zarr group from a zarr hierarchy. Could be associated with a zoom level or dataset.", "title": "Group" }, "description": "Select a specific zarr group from a zarr hierarchy. Could be associated with a zoom level or dataset." }, { "name": "decode_times", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "decode_times", "description": "Whether to decode times" }, "description": "Whether to decode times" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TileSet" } }, "text/html": {} } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/zarr/tiles/{tileMatrixSetId}/{z}/{x}/{y}.{format}": { "get": { "tags": [ "Zarr" ], "summary": "Tile", "description": "Create map tile from a dataset.", "operationId": ".zarr.getTileWithFormat", "parameters": [ { "name": "z", "in": "path", "required": true, "schema": { "type": "integer", "description": "Identifier (Z) selecting one of the scales defined in the TileMatrixSet and representing the scaleDenominator the tile.", "title": "Z" }, "description": "Identifier (Z) selecting one of the scales defined in the TileMatrixSet and representing the scaleDenominator the tile." }, { "name": "x", "in": "path", "required": true, "schema": { "type": "integer", "description": "Column (X) index of the tile on the selected TileMatrix. It cannot exceed the MatrixHeight-1 for the selected TileMatrix.", "title": "X" }, "description": "Column (X) index of the tile on the selected TileMatrix. It cannot exceed the MatrixHeight-1 for the selected TileMatrix." }, { "name": "y", "in": "path", "required": true, "schema": { "type": "integer", "description": "Row (Y) index of the tile on the selected TileMatrix. It cannot exceed the MatrixWidth-1 for the selected TileMatrix.", "title": "Y" }, "description": "Row (Y) index of the tile on the selected TileMatrix. It cannot exceed the MatrixWidth-1 for the selected TileMatrix." }, { "name": "tileMatrixSetId", "in": "path", "required": true, "schema": { "enum": [ "CDB1GlobalGrid", "CanadianNAD83_LCC", "EuropeanETRS89_LAEAQuad", "GNOSISGlobalGrid", "LINZAntarticaMapTilegrid", "NZTM2000Quad", "UPSAntarcticWGS84Quad", "UPSArcticWGS84Quad", "UTM31WGS84Quad", "WGS1984Quad", "WebMercatorQuad", "WorldCRS84Quad", "WorldMercatorWGS84Quad" ], "type": "string", "description": "Identifier selecting one of the TileMatrixSetId supported.", "title": "Tilematrixsetid" }, "description": "Identifier selecting one of the TileMatrixSetId supported." }, { "name": "format", "in": "path", "required": true, "schema": { "anyOf": [ { "$ref": "#/components/schemas/ImageType" }, { "type": "null" } ], "description": "Default will be automatically defined if the output image needs a mask (png) or not (jpeg).", "title": "Format" } }, { "name": "tilesize", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "integer", "exclusiveMinimum": 0 }, { "type": "null" } ], "description": "Tilesize in pixels.", "title": "Tilesize" }, "description": "Tilesize in pixels." }, { "name": "url", "in": "query", "required": true, "schema": { "type": "string", "description": "Dataset URL", "title": "Url" }, "description": "Dataset URL" }, { "name": "variable", "in": "query", "required": true, "schema": { "type": "string", "description": "Xarray Variable name.", "title": "Variable" }, "description": "Xarray Variable name." }, { "name": "sel", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "array", "items": { "type": "string", "pattern": "^[^=]+=((nearest|pad|ffill|backfill|bfill)::)?([^=:]|:[^:])+$" } }, { "type": "null" } ], "description": "Xarray Indexing using dimension names `{dimension}={value}` or `{dimension}={method}::{value}`.", "title": "Sel" }, "description": "Xarray Indexing using dimension names `{dimension}={value}` or `{dimension}={method}::{value}`." }, { "name": "group", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Select a specific zarr group from a zarr hierarchy. Could be associated with a zoom level or dataset.", "title": "Group" }, "description": "Select a specific zarr group from a zarr hierarchy. Could be associated with a zoom level or dataset." }, { "name": "decode_times", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "decode_times", "description": "Whether to decode times" }, "description": "Whether to decode times" }, { "name": "bidx", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "array", "items": { "type": "integer" } }, { "type": "null" } ], "title": "Band indexes", "description": "Dataset band indexes" }, "description": "Dataset band indexes", "examples": { "user-provided": {}, "one-band": { "value": [ 1 ] }, "multi-bands": { "value": [ 1, 2, 3 ] } } }, { "name": "nodata", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "integer" }, { "type": "number" }, { "type": "null" } ], "title": "Nodata value", "description": "Overwrite internal Nodata value" }, "description": "Overwrite internal Nodata value" }, { "name": "reproject", "in": "query", "required": false, "schema": { "anyOf": [ { "enum": [ "nearest", "bilinear", "cubic", "cubic_spline", "lanczos", "average", "mode", "max", "min", "med", "q1", "q3", "sum", "rms" ], "type": "string" }, { "type": "null" } ], "description": "WarpKernel resampling algorithm (only used when doing re-projection). Defaults to `nearest`.", "title": "Reproject" }, "description": "WarpKernel resampling algorithm (only used when doing re-projection). Defaults to `nearest`." }, { "name": "algorithm", "in": "query", "required": false, "schema": { "enum": [ "hillshade", "slope", "contours", "normalizedIndex", "terrarium", "terrainrgb", "cast", "ceil", "floor", "min", "max", "median", "mean", "std", "var", "sum", "grayscale", "bitonal" ], "type": "string", "description": "Algorithm name", "title": "Algorithm" }, "description": "Algorithm name" }, { "name": "algorithm_params", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Algorithm parameter", "title": "Algorithm Params" }, "description": "Algorithm parameter" }, { "name": "colormap_name", "in": "query", "required": false, "schema": { "enum": [ "jet_r", "haline", "gist_ncar_r", "algae", "cividis_r", "seismic_r", "pink_r", "rdylbu", "inferno_r", "deep", "rdgy_r", "tab10", "bugn_r", "ocean_r", "purples", "pastel1_r", "thermal_r", "ylorrd_r", "wistia_r", "cmrmap", "pubu", "rain", "ylgnbu", "gnuplot", "gnbu", "gist_gray_r", "greens", "purd_r", "oxy_r", "matter", "summer_r", "gnuplot_r", "gnuplot2", "solar", "jet", "ylgn_r", "dark2_r", "spring", "tab20c", "gist_stern", "bwr", "ylgn", "plasma", "pastel2", "blues_r", "rain_r", "set1", "topo_r", "gist_ncar", "turbid", "magma_r", "pastel2_r", "purd", "gnbu_r", "spring_r", "rdbu_r", "ylorbr", "twilight_shifted", "rplumbo", "winter_r", "tab20b", "ylorrd", "copper", "flag_r", "afmhot", "twilight_shifted_r", "oranges_r", "bone", "seismic", "gray_r", "tarn_r", "bwr_r", "magma", "paired_r", "dark2", "binary", "set3", "viridis_r", "spectral", "prgn", "diff", "hot", "gist_earth", "cubehelix", "dense_r", "coolwarm", "pubugn_r", "autumn_r", "gnuplot2_r", "cividis", "bugn", "deep_r", "prgn_r", "gist_rainbow", "gist_heat_r", "nipy_spectral_r", "tab20", "turbo_r", "pubugn", "set2_r", "gist_yarg_r", "spectral_r", "binary_r", "greys", "rainbow_r", "haline_r", "curl", "tab20c_r", "blues", "prism", "rdgy", "gist_gray", "set2", "cool", "afmhot_r", "bone_r", "paired", "oranges", "orrd", "puor", "autumn", "delta_r", "pubu_r", "piyg_r", "turbo", "greys_r", "accent", "turbid_r", "algae_r", "solar_r", "topo", "cool_r", "inferno", "balance", "tempo_r", "amp_r", "flag", "speed", "gist_heat", "balance_r", "viridis", "cubehelix_r", "ylorbr_r", "summer", "coolwarm_r", "diff_r", "rdylgn_r", "gist_stern_r", "plasma_r", "copper_r", "oxy", "gist_yarg", "twilight", "winter", "brbg", "reds_r", "speed_r", "rainbow", "ice", "nipy_spectral", "piyg", "gray", "reds", "terrain", "tab20_r", "wistia", "accent_r", "thermal", "ocean", "twilight_r", "hot_r", "set3_r", "hsv_r", "brg_r", "gist_rainbow_r", "phase", "bupu", "pastel1", "dense", "set1_r", "phase_r", "matter_r", "greens_r", "cfastie", "tab10_r", "rdbu", "brg", "rdpu_r", "brbg_r", "cmrmap_r", "prism_r", "purples_r", "gist_earth_r", "tempo", "schwarzwald", "rdpu", "orrd_r", "tarn", "puor_r", "bupu_r", "rdylgn", "ice_r", "pink", "terrain_r", "amp", "tab20b_r", "rdylbu_r", "hsv", "curl_r", "delta", "ylgnbu_r" ], "type": "string", "description": "Colormap name", "title": "Colormap Name" }, "description": "Colormap name" }, { "name": "colormap", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "JSON encoded custom Colormap", "title": "Colormap" }, "description": "JSON encoded custom Colormap" }, { "name": "rescale", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ], "title": "Min/Max data Rescaling", "description": "comma (',') delimited Min,Max range. Can set multiple time for multiple bands.", "examples": [ "0,2000", "0,1000", "0,10000" ] }, "description": "comma (',') delimited Min,Max range. Can set multiple time for multiple bands." }, { "name": "color_formula", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Color Formula", "description": "rio-color formula (info: https://github.com/mapbox/rio-color)" }, "description": "rio-color formula (info: https://github.com/mapbox/rio-color)" }, { "name": "return_mask", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "Add mask to the output data. Defaults to `True`", "title": "Return Mask" }, "description": "Add mask to the output data. Defaults to `True`" } ], "responses": { "200": { "description": "Return an image.", "content": { "image/png": {}, "image/jpeg": {}, "image/jpg": {}, "image/webp": {}, "image/jp2": {}, "image/tiff; application=geotiff": {}, "application/x-binary": {} } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/zarr/tiles/{tileMatrixSetId}/{z}/{x}/{y}": { "get": { "tags": [ "Zarr" ], "summary": "Tile", "description": "Create map tile from a dataset.", "operationId": ".zarr.getTile", "parameters": [ { "name": "z", "in": "path", "required": true, "schema": { "type": "integer", "description": "Identifier (Z) selecting one of the scales defined in the TileMatrixSet and representing the scaleDenominator the tile.", "title": "Z" }, "description": "Identifier (Z) selecting one of the scales defined in the TileMatrixSet and representing the scaleDenominator the tile." }, { "name": "x", "in": "path", "required": true, "schema": { "type": "integer", "description": "Column (X) index of the tile on the selected TileMatrix. It cannot exceed the MatrixHeight-1 for the selected TileMatrix.", "title": "X" }, "description": "Column (X) index of the tile on the selected TileMatrix. It cannot exceed the MatrixHeight-1 for the selected TileMatrix." }, { "name": "y", "in": "path", "required": true, "schema": { "type": "integer", "description": "Row (Y) index of the tile on the selected TileMatrix. It cannot exceed the MatrixWidth-1 for the selected TileMatrix.", "title": "Y" }, "description": "Row (Y) index of the tile on the selected TileMatrix. It cannot exceed the MatrixWidth-1 for the selected TileMatrix." }, { "name": "tileMatrixSetId", "in": "path", "required": true, "schema": { "enum": [ "CDB1GlobalGrid", "CanadianNAD83_LCC", "EuropeanETRS89_LAEAQuad", "GNOSISGlobalGrid", "LINZAntarticaMapTilegrid", "NZTM2000Quad", "UPSAntarcticWGS84Quad", "UPSArcticWGS84Quad", "UTM31WGS84Quad", "WGS1984Quad", "WebMercatorQuad", "WorldCRS84Quad", "WorldMercatorWGS84Quad" ], "type": "string", "description": "Identifier selecting one of the TileMatrixSetId supported.", "title": "Tilematrixsetid" }, "description": "Identifier selecting one of the TileMatrixSetId supported." }, { "name": "format", "in": "query", "required": false, "schema": { "anyOf": [ { "$ref": "#/components/schemas/ImageType" }, { "type": "null" } ], "description": "Default will be automatically defined if the output image needs a mask (png) or not (jpeg).", "title": "Format" } }, { "name": "tilesize", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "integer", "exclusiveMinimum": 0 }, { "type": "null" } ], "description": "Tilesize in pixels.", "title": "Tilesize" }, "description": "Tilesize in pixels." }, { "name": "url", "in": "query", "required": true, "schema": { "type": "string", "description": "Dataset URL", "title": "Url" }, "description": "Dataset URL" }, { "name": "variable", "in": "query", "required": true, "schema": { "type": "string", "description": "Xarray Variable name.", "title": "Variable" }, "description": "Xarray Variable name." }, { "name": "sel", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "array", "items": { "type": "string", "pattern": "^[^=]+=((nearest|pad|ffill|backfill|bfill)::)?([^=:]|:[^:])+$" } }, { "type": "null" } ], "description": "Xarray Indexing using dimension names `{dimension}={value}` or `{dimension}={method}::{value}`.", "title": "Sel" }, "description": "Xarray Indexing using dimension names `{dimension}={value}` or `{dimension}={method}::{value}`." }, { "name": "group", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Select a specific zarr group from a zarr hierarchy. Could be associated with a zoom level or dataset.", "title": "Group" }, "description": "Select a specific zarr group from a zarr hierarchy. Could be associated with a zoom level or dataset." }, { "name": "decode_times", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "decode_times", "description": "Whether to decode times" }, "description": "Whether to decode times" }, { "name": "bidx", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "array", "items": { "type": "integer" } }, { "type": "null" } ], "title": "Band indexes", "description": "Dataset band indexes" }, "description": "Dataset band indexes", "examples": { "user-provided": {}, "one-band": { "value": [ 1 ] }, "multi-bands": { "value": [ 1, 2, 3 ] } } }, { "name": "nodata", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "integer" }, { "type": "number" }, { "type": "null" } ], "title": "Nodata value", "description": "Overwrite internal Nodata value" }, "description": "Overwrite internal Nodata value" }, { "name": "reproject", "in": "query", "required": false, "schema": { "anyOf": [ { "enum": [ "nearest", "bilinear", "cubic", "cubic_spline", "lanczos", "average", "mode", "max", "min", "med", "q1", "q3", "sum", "rms" ], "type": "string" }, { "type": "null" } ], "description": "WarpKernel resampling algorithm (only used when doing re-projection). Defaults to `nearest`.", "title": "Reproject" }, "description": "WarpKernel resampling algorithm (only used when doing re-projection). Defaults to `nearest`." }, { "name": "algorithm", "in": "query", "required": false, "schema": { "enum": [ "hillshade", "slope", "contours", "normalizedIndex", "terrarium", "terrainrgb", "cast", "ceil", "floor", "min", "max", "median", "mean", "std", "var", "sum", "grayscale", "bitonal" ], "type": "string", "description": "Algorithm name", "title": "Algorithm" }, "description": "Algorithm name" }, { "name": "algorithm_params", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Algorithm parameter", "title": "Algorithm Params" }, "description": "Algorithm parameter" }, { "name": "colormap_name", "in": "query", "required": false, "schema": { "enum": [ "jet_r", "haline", "gist_ncar_r", "algae", "cividis_r", "seismic_r", "pink_r", "rdylbu", "inferno_r", "deep", "rdgy_r", "tab10", "bugn_r", "ocean_r", "purples", "pastel1_r", "thermal_r", "ylorrd_r", "wistia_r", "cmrmap", "pubu", "rain", "ylgnbu", "gnuplot", "gnbu", "gist_gray_r", "greens", "purd_r", "oxy_r", "matter", "summer_r", "gnuplot_r", "gnuplot2", "solar", "jet", "ylgn_r", "dark2_r", "spring", "tab20c", "gist_stern", "bwr", "ylgn", "plasma", "pastel2", "blues_r", "rain_r", "set1", "topo_r", "gist_ncar", "turbid", "magma_r", "pastel2_r", "purd", "gnbu_r", "spring_r", "rdbu_r", "ylorbr", "twilight_shifted", "rplumbo", "winter_r", "tab20b", "ylorrd", "copper", "flag_r", "afmhot", "twilight_shifted_r", "oranges_r", "bone", "seismic", "gray_r", "tarn_r", "bwr_r", "magma", "paired_r", "dark2", "binary", "set3", "viridis_r", "spectral", "prgn", "diff", "hot", "gist_earth", "cubehelix", "dense_r", "coolwarm", "pubugn_r", "autumn_r", "gnuplot2_r", "cividis", "bugn", "deep_r", "prgn_r", "gist_rainbow", "gist_heat_r", "nipy_spectral_r", "tab20", "turbo_r", "pubugn", "set2_r", "gist_yarg_r", "spectral_r", "binary_r", "greys", "rainbow_r", "haline_r", "curl", "tab20c_r", "blues", "prism", "rdgy", "gist_gray", "set2", "cool", "afmhot_r", "bone_r", "paired", "oranges", "orrd", "puor", "autumn", "delta_r", "pubu_r", "piyg_r", "turbo", "greys_r", "accent", "turbid_r", "algae_r", "solar_r", "topo", "cool_r", "inferno", "balance", "tempo_r", "amp_r", "flag", "speed", "gist_heat", "balance_r", "viridis", "cubehelix_r", "ylorbr_r", "summer", "coolwarm_r", "diff_r", "rdylgn_r", "gist_stern_r", "plasma_r", "copper_r", "oxy", "gist_yarg", "twilight", "winter", "brbg", "reds_r", "speed_r", "rainbow", "ice", "nipy_spectral", "piyg", "gray", "reds", "terrain", "tab20_r", "wistia", "accent_r", "thermal", "ocean", "twilight_r", "hot_r", "set3_r", "hsv_r", "brg_r", "gist_rainbow_r", "phase", "bupu", "pastel1", "dense", "set1_r", "phase_r", "matter_r", "greens_r", "cfastie", "tab10_r", "rdbu", "brg", "rdpu_r", "brbg_r", "cmrmap_r", "prism_r", "purples_r", "gist_earth_r", "tempo", "schwarzwald", "rdpu", "orrd_r", "tarn", "puor_r", "bupu_r", "rdylgn", "ice_r", "pink", "terrain_r", "amp", "tab20b_r", "rdylbu_r", "hsv", "curl_r", "delta", "ylgnbu_r" ], "type": "string", "description": "Colormap name", "title": "Colormap Name" }, "description": "Colormap name" }, { "name": "colormap", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "JSON encoded custom Colormap", "title": "Colormap" }, "description": "JSON encoded custom Colormap" }, { "name": "rescale", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ], "title": "Min/Max data Rescaling", "description": "comma (',') delimited Min,Max range. Can set multiple time for multiple bands.", "examples": [ "0,2000", "0,1000", "0,10000" ] }, "description": "comma (',') delimited Min,Max range. Can set multiple time for multiple bands." }, { "name": "color_formula", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Color Formula", "description": "rio-color formula (info: https://github.com/mapbox/rio-color)" }, "description": "rio-color formula (info: https://github.com/mapbox/rio-color)" }, { "name": "return_mask", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "Add mask to the output data. Defaults to `True`", "title": "Return Mask" }, "description": "Add mask to the output data. Defaults to `True`" } ], "responses": { "200": { "description": "Return an image.", "content": { "image/png": {}, "image/jpeg": {}, "image/jpg": {}, "image/webp": {}, "image/jp2": {}, "image/tiff; application=geotiff": {}, "application/x-binary": {} } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/zarr/{tileMatrixSetId}/map.html": { "get": { "tags": [ "Zarr" ], "summary": "Map Viewer", "description": "Return TileJSON document for a dataset.", "operationId": ".zarr.getMapViewer", "parameters": [ { "name": "tileMatrixSetId", "in": "path", "required": true, "schema": { "enum": [ "CDB1GlobalGrid", "CanadianNAD83_LCC", "EuropeanETRS89_LAEAQuad", "GNOSISGlobalGrid", "LINZAntarticaMapTilegrid", "NZTM2000Quad", "UPSAntarcticWGS84Quad", "UPSArcticWGS84Quad", "UTM31WGS84Quad", "WGS1984Quad", "WebMercatorQuad", "WorldCRS84Quad", "WorldMercatorWGS84Quad" ], "type": "string", "description": "Identifier selecting one of the TileMatrixSetId supported.", "title": "Tilematrixsetid" }, "description": "Identifier selecting one of the TileMatrixSetId supported." }, { "name": "tile_format", "in": "query", "required": false, "schema": { "anyOf": [ { "$ref": "#/components/schemas/ImageType" }, { "type": "null" } ], "description": "Default will be automatically defined if the output image needs a mask (png) or not (jpeg).", "title": "Tile Format" }, "description": "Default will be automatically defined if the output image needs a mask (png) or not (jpeg)." }, { "name": "tilesize", "in": "query", "required": false, "schema": { "type": "integer", "exclusiveMinimum": 0, "description": "Tilesize in pixels. Default to 256.", "default": 256, "title": "Tilesize" }, "description": "Tilesize in pixels. Default to 256." }, { "name": "minzoom", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "Overwrite default minzoom.", "title": "Minzoom" }, "description": "Overwrite default minzoom." }, { "name": "maxzoom", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "Overwrite default maxzoom.", "title": "Maxzoom" }, "description": "Overwrite default maxzoom." }, { "name": "url", "in": "query", "required": true, "schema": { "type": "string", "description": "Dataset URL", "title": "Url" }, "description": "Dataset URL" }, { "name": "variable", "in": "query", "required": true, "schema": { "type": "string", "description": "Xarray Variable name.", "title": "Variable" }, "description": "Xarray Variable name." }, { "name": "sel", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "array", "items": { "type": "string", "pattern": "^[^=]+=((nearest|pad|ffill|backfill|bfill)::)?([^=:]|:[^:])+$" } }, { "type": "null" } ], "description": "Xarray Indexing using dimension names `{dimension}={value}` or `{dimension}={method}::{value}`.", "title": "Sel" }, "description": "Xarray Indexing using dimension names `{dimension}={value}` or `{dimension}={method}::{value}`." }, { "name": "group", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Select a specific zarr group from a zarr hierarchy. Could be associated with a zoom level or dataset.", "title": "Group" }, "description": "Select a specific zarr group from a zarr hierarchy. Could be associated with a zoom level or dataset." }, { "name": "decode_times", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "decode_times", "description": "Whether to decode times" }, "description": "Whether to decode times" }, { "name": "bidx", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "array", "items": { "type": "integer" } }, { "type": "null" } ], "title": "Band indexes", "description": "Dataset band indexes" }, "description": "Dataset band indexes", "examples": { "user-provided": {}, "one-band": { "value": [ 1 ] }, "multi-bands": { "value": [ 1, 2, 3 ] } } }, { "name": "nodata", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "integer" }, { "type": "number" }, { "type": "null" } ], "title": "Nodata value", "description": "Overwrite internal Nodata value" }, "description": "Overwrite internal Nodata value" }, { "name": "reproject", "in": "query", "required": false, "schema": { "anyOf": [ { "enum": [ "nearest", "bilinear", "cubic", "cubic_spline", "lanczos", "average", "mode", "max", "min", "med", "q1", "q3", "sum", "rms" ], "type": "string" }, { "type": "null" } ], "description": "WarpKernel resampling algorithm (only used when doing re-projection). Defaults to `nearest`.", "title": "Reproject" }, "description": "WarpKernel resampling algorithm (only used when doing re-projection). Defaults to `nearest`." }, { "name": "algorithm", "in": "query", "required": false, "schema": { "enum": [ "hillshade", "slope", "contours", "normalizedIndex", "terrarium", "terrainrgb", "cast", "ceil", "floor", "min", "max", "median", "mean", "std", "var", "sum", "grayscale", "bitonal" ], "type": "string", "description": "Algorithm name", "title": "Algorithm" }, "description": "Algorithm name" }, { "name": "algorithm_params", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Algorithm parameter", "title": "Algorithm Params" }, "description": "Algorithm parameter" }, { "name": "colormap_name", "in": "query", "required": false, "schema": { "enum": [ "jet_r", "haline", "gist_ncar_r", "algae", "cividis_r", "seismic_r", "pink_r", "rdylbu", "inferno_r", "deep", "rdgy_r", "tab10", "bugn_r", "ocean_r", "purples", "pastel1_r", "thermal_r", "ylorrd_r", "wistia_r", "cmrmap", "pubu", "rain", "ylgnbu", "gnuplot", "gnbu", "gist_gray_r", "greens", "purd_r", "oxy_r", "matter", "summer_r", "gnuplot_r", "gnuplot2", "solar", "jet", "ylgn_r", "dark2_r", "spring", "tab20c", "gist_stern", "bwr", "ylgn", "plasma", "pastel2", "blues_r", "rain_r", "set1", "topo_r", "gist_ncar", "turbid", "magma_r", "pastel2_r", "purd", "gnbu_r", "spring_r", "rdbu_r", "ylorbr", "twilight_shifted", "rplumbo", "winter_r", "tab20b", "ylorrd", "copper", "flag_r", "afmhot", "twilight_shifted_r", "oranges_r", "bone", "seismic", "gray_r", "tarn_r", "bwr_r", "magma", "paired_r", "dark2", "binary", "set3", "viridis_r", "spectral", "prgn", "diff", "hot", "gist_earth", "cubehelix", "dense_r", "coolwarm", "pubugn_r", "autumn_r", "gnuplot2_r", "cividis", "bugn", "deep_r", "prgn_r", "gist_rainbow", "gist_heat_r", "nipy_spectral_r", "tab20", "turbo_r", "pubugn", "set2_r", "gist_yarg_r", "spectral_r", "binary_r", "greys", "rainbow_r", "haline_r", "curl", "tab20c_r", "blues", "prism", "rdgy", "gist_gray", "set2", "cool", "afmhot_r", "bone_r", "paired", "oranges", "orrd", "puor", "autumn", "delta_r", "pubu_r", "piyg_r", "turbo", "greys_r", "accent", "turbid_r", "algae_r", "solar_r", "topo", "cool_r", "inferno", "balance", "tempo_r", "amp_r", "flag", "speed", "gist_heat", "balance_r", "viridis", "cubehelix_r", "ylorbr_r", "summer", "coolwarm_r", "diff_r", "rdylgn_r", "gist_stern_r", "plasma_r", "copper_r", "oxy", "gist_yarg", "twilight", "winter", "brbg", "reds_r", "speed_r", "rainbow", "ice", "nipy_spectral", "piyg", "gray", "reds", "terrain", "tab20_r", "wistia", "accent_r", "thermal", "ocean", "twilight_r", "hot_r", "set3_r", "hsv_r", "brg_r", "gist_rainbow_r", "phase", "bupu", "pastel1", "dense", "set1_r", "phase_r", "matter_r", "greens_r", "cfastie", "tab10_r", "rdbu", "brg", "rdpu_r", "brbg_r", "cmrmap_r", "prism_r", "purples_r", "gist_earth_r", "tempo", "schwarzwald", "rdpu", "orrd_r", "tarn", "puor_r", "bupu_r", "rdylgn", "ice_r", "pink", "terrain_r", "amp", "tab20b_r", "rdylbu_r", "hsv", "curl_r", "delta", "ylgnbu_r" ], "type": "string", "description": "Colormap name", "title": "Colormap Name" }, "description": "Colormap name" }, { "name": "colormap", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "JSON encoded custom Colormap", "title": "Colormap" }, "description": "JSON encoded custom Colormap" }, { "name": "rescale", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ], "title": "Min/Max data Rescaling", "description": "comma (',') delimited Min,Max range. Can set multiple time for multiple bands.", "examples": [ "0,2000", "0,1000", "0,10000" ] }, "description": "comma (',') delimited Min,Max range. Can set multiple time for multiple bands." }, { "name": "color_formula", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Color Formula", "description": "rio-color formula (info: https://github.com/mapbox/rio-color)" }, "description": "rio-color formula (info: https://github.com/mapbox/rio-color)" }, { "name": "return_mask", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "Add mask to the output data. Defaults to `True`", "title": "Return Mask" }, "description": "Add mask to the output data. Defaults to `True`" } ], "responses": { "200": { "description": "Successful Response", "content": { "text/html": { "schema": { "type": "string" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/zarr/{tileMatrixSetId}/tilejson.json": { "get": { "tags": [ "Zarr" ], "summary": "Tilejson", "description": "Return TileJSON document for a dataset.", "operationId": ".zarr.getTileJSON", "parameters": [ { "name": "tileMatrixSetId", "in": "path", "required": true, "schema": { "enum": [ "CDB1GlobalGrid", "CanadianNAD83_LCC", "EuropeanETRS89_LAEAQuad", "GNOSISGlobalGrid", "LINZAntarticaMapTilegrid", "NZTM2000Quad", "UPSAntarcticWGS84Quad", "UPSArcticWGS84Quad", "UTM31WGS84Quad", "WGS1984Quad", "WebMercatorQuad", "WorldCRS84Quad", "WorldMercatorWGS84Quad" ], "type": "string", "description": "Identifier selecting one of the TileMatrixSetId supported.", "title": "Tilematrixsetid" }, "description": "Identifier selecting one of the TileMatrixSetId supported." }, { "name": "tilesize", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "integer", "exclusiveMinimum": 0 }, { "type": "null" } ], "description": "Tilesize in pixels. Default to 512.", "default": 512, "title": "Tilesize" }, "description": "Tilesize in pixels. Default to 512." }, { "name": "tile_format", "in": "query", "required": false, "schema": { "anyOf": [ { "$ref": "#/components/schemas/ImageType" }, { "type": "null" } ], "description": "Default will be automatically defined if the output image needs a mask (png) or not (jpeg).", "title": "Tile Format" }, "description": "Default will be automatically defined if the output image needs a mask (png) or not (jpeg)." }, { "name": "minzoom", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "Overwrite default minzoom.", "title": "Minzoom" }, "description": "Overwrite default minzoom." }, { "name": "maxzoom", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "Overwrite default maxzoom.", "title": "Maxzoom" }, "description": "Overwrite default maxzoom." }, { "name": "url", "in": "query", "required": true, "schema": { "type": "string", "description": "Dataset URL", "title": "Url" }, "description": "Dataset URL" }, { "name": "variable", "in": "query", "required": true, "schema": { "type": "string", "description": "Xarray Variable name.", "title": "Variable" }, "description": "Xarray Variable name." }, { "name": "sel", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "array", "items": { "type": "string", "pattern": "^[^=]+=((nearest|pad|ffill|backfill|bfill)::)?([^=:]|:[^:])+$" } }, { "type": "null" } ], "description": "Xarray Indexing using dimension names `{dimension}={value}` or `{dimension}={method}::{value}`.", "title": "Sel" }, "description": "Xarray Indexing using dimension names `{dimension}={value}` or `{dimension}={method}::{value}`." }, { "name": "group", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Select a specific zarr group from a zarr hierarchy. Could be associated with a zoom level or dataset.", "title": "Group" }, "description": "Select a specific zarr group from a zarr hierarchy. Could be associated with a zoom level or dataset." }, { "name": "decode_times", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "decode_times", "description": "Whether to decode times" }, "description": "Whether to decode times" }, { "name": "bidx", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "array", "items": { "type": "integer" } }, { "type": "null" } ], "title": "Band indexes", "description": "Dataset band indexes" }, "description": "Dataset band indexes", "examples": { "user-provided": {}, "one-band": { "value": [ 1 ] }, "multi-bands": { "value": [ 1, 2, 3 ] } } }, { "name": "nodata", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "integer" }, { "type": "number" }, { "type": "null" } ], "title": "Nodata value", "description": "Overwrite internal Nodata value" }, "description": "Overwrite internal Nodata value" }, { "name": "reproject", "in": "query", "required": false, "schema": { "anyOf": [ { "enum": [ "nearest", "bilinear", "cubic", "cubic_spline", "lanczos", "average", "mode", "max", "min", "med", "q1", "q3", "sum", "rms" ], "type": "string" }, { "type": "null" } ], "description": "WarpKernel resampling algorithm (only used when doing re-projection). Defaults to `nearest`.", "title": "Reproject" }, "description": "WarpKernel resampling algorithm (only used when doing re-projection). Defaults to `nearest`." }, { "name": "algorithm", "in": "query", "required": false, "schema": { "enum": [ "hillshade", "slope", "contours", "normalizedIndex", "terrarium", "terrainrgb", "cast", "ceil", "floor", "min", "max", "median", "mean", "std", "var", "sum", "grayscale", "bitonal" ], "type": "string", "description": "Algorithm name", "title": "Algorithm" }, "description": "Algorithm name" }, { "name": "algorithm_params", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Algorithm parameter", "title": "Algorithm Params" }, "description": "Algorithm parameter" }, { "name": "colormap_name", "in": "query", "required": false, "schema": { "enum": [ "jet_r", "haline", "gist_ncar_r", "algae", "cividis_r", "seismic_r", "pink_r", "rdylbu", "inferno_r", "deep", "rdgy_r", "tab10", "bugn_r", "ocean_r", "purples", "pastel1_r", "thermal_r", "ylorrd_r", "wistia_r", "cmrmap", "pubu", "rain", "ylgnbu", "gnuplot", "gnbu", "gist_gray_r", "greens", "purd_r", "oxy_r", "matter", "summer_r", "gnuplot_r", "gnuplot2", "solar", "jet", "ylgn_r", "dark2_r", "spring", "tab20c", "gist_stern", "bwr", "ylgn", "plasma", "pastel2", "blues_r", "rain_r", "set1", "topo_r", "gist_ncar", "turbid", "magma_r", "pastel2_r", "purd", "gnbu_r", "spring_r", "rdbu_r", "ylorbr", "twilight_shifted", "rplumbo", "winter_r", "tab20b", "ylorrd", "copper", "flag_r", "afmhot", "twilight_shifted_r", "oranges_r", "bone", "seismic", "gray_r", "tarn_r", "bwr_r", "magma", "paired_r", "dark2", "binary", "set3", "viridis_r", "spectral", "prgn", "diff", "hot", "gist_earth", "cubehelix", "dense_r", "coolwarm", "pubugn_r", "autumn_r", "gnuplot2_r", "cividis", "bugn", "deep_r", "prgn_r", "gist_rainbow", "gist_heat_r", "nipy_spectral_r", "tab20", "turbo_r", "pubugn", "set2_r", "gist_yarg_r", "spectral_r", "binary_r", "greys", "rainbow_r", "haline_r", "curl", "tab20c_r", "blues", "prism", "rdgy", "gist_gray", "set2", "cool", "afmhot_r", "bone_r", "paired", "oranges", "orrd", "puor", "autumn", "delta_r", "pubu_r", "piyg_r", "turbo", "greys_r", "accent", "turbid_r", "algae_r", "solar_r", "topo", "cool_r", "inferno", "balance", "tempo_r", "amp_r", "flag", "speed", "gist_heat", "balance_r", "viridis", "cubehelix_r", "ylorbr_r", "summer", "coolwarm_r", "diff_r", "rdylgn_r", "gist_stern_r", "plasma_r", "copper_r", "oxy", "gist_yarg", "twilight", "winter", "brbg", "reds_r", "speed_r", "rainbow", "ice", "nipy_spectral", "piyg", "gray", "reds", "terrain", "tab20_r", "wistia", "accent_r", "thermal", "ocean", "twilight_r", "hot_r", "set3_r", "hsv_r", "brg_r", "gist_rainbow_r", "phase", "bupu", "pastel1", "dense", "set1_r", "phase_r", "matter_r", "greens_r", "cfastie", "tab10_r", "rdbu", "brg", "rdpu_r", "brbg_r", "cmrmap_r", "prism_r", "purples_r", "gist_earth_r", "tempo", "schwarzwald", "rdpu", "orrd_r", "tarn", "puor_r", "bupu_r", "rdylgn", "ice_r", "pink", "terrain_r", "amp", "tab20b_r", "rdylbu_r", "hsv", "curl_r", "delta", "ylgnbu_r" ], "type": "string", "description": "Colormap name", "title": "Colormap Name" }, "description": "Colormap name" }, { "name": "colormap", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "JSON encoded custom Colormap", "title": "Colormap" }, "description": "JSON encoded custom Colormap" }, { "name": "rescale", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ], "title": "Min/Max data Rescaling", "description": "comma (',') delimited Min,Max range. Can set multiple time for multiple bands.", "examples": [ "0,2000", "0,1000", "0,10000" ] }, "description": "comma (',') delimited Min,Max range. Can set multiple time for multiple bands." }, { "name": "color_formula", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Color Formula", "description": "rio-color formula (info: https://github.com/mapbox/rio-color)" }, "description": "rio-color formula (info: https://github.com/mapbox/rio-color)" }, { "name": "return_mask", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "Add mask to the output data. Defaults to `True`", "title": "Return Mask" }, "description": "Add mask to the output data. Defaults to `True`" } ], "responses": { "200": { "description": "Return a tilejson", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TileJSON" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/zarr/point/{lon},{lat}": { "get": { "tags": [ "Zarr" ], "summary": "Point", "description": "Get Point value for a dataset.", "operationId": ".zarr.getDataForPoint", "parameters": [ { "name": "lon", "in": "path", "required": true, "schema": { "type": "number", "description": "Longitude", "title": "Lon" }, "description": "Longitude" }, { "name": "lat", "in": "path", "required": true, "schema": { "type": "number", "description": "Latitude", "title": "Lat" }, "description": "Latitude" }, { "name": "url", "in": "query", "required": true, "schema": { "type": "string", "description": "Dataset URL", "title": "Url" }, "description": "Dataset URL" }, { "name": "variable", "in": "query", "required": true, "schema": { "type": "string", "description": "Xarray Variable name.", "title": "Variable" }, "description": "Xarray Variable name." }, { "name": "sel", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "array", "items": { "type": "string", "pattern": "^[^=]+=((nearest|pad|ffill|backfill|bfill)::)?([^=:]|:[^:])+$" } }, { "type": "null" } ], "description": "Xarray Indexing using dimension names `{dimension}={value}` or `{dimension}={method}::{value}`.", "title": "Sel" }, "description": "Xarray Indexing using dimension names `{dimension}={value}` or `{dimension}={method}::{value}`." }, { "name": "group", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Select a specific zarr group from a zarr hierarchy. Could be associated with a zoom level or dataset.", "title": "Group" }, "description": "Select a specific zarr group from a zarr hierarchy. Could be associated with a zoom level or dataset." }, { "name": "decode_times", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "decode_times", "description": "Whether to decode times" }, "description": "Whether to decode times" }, { "name": "coord_crs", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Coordinate Reference System of the input coords. Default to `epsg:4326`.", "title": "Coord Crs" }, "description": "Coordinate Reference System of the input coords. Default to `epsg:4326`." }, { "name": "bidx", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "array", "items": { "type": "integer" } }, { "type": "null" } ], "title": "Band indexes", "description": "Dataset band indexes" }, "description": "Dataset band indexes", "examples": { "user-provided": {}, "one-band": { "value": [ 1 ] }, "multi-bands": { "value": [ 1, 2, 3 ] } } }, { "name": "nodata", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "integer" }, { "type": "number" }, { "type": "null" } ], "title": "Nodata value", "description": "Overwrite internal Nodata value" }, "description": "Overwrite internal Nodata value" }, { "name": "reproject", "in": "query", "required": false, "schema": { "anyOf": [ { "enum": [ "nearest", "bilinear", "cubic", "cubic_spline", "lanczos", "average", "mode", "max", "min", "med", "q1", "q3", "sum", "rms" ], "type": "string" }, { "type": "null" } ], "description": "WarpKernel resampling algorithm (only used when doing re-projection). Defaults to `nearest`.", "title": "Reproject" }, "description": "WarpKernel resampling algorithm (only used when doing re-projection). Defaults to `nearest`." } ], "responses": { "200": { "description": "Return a value for a point", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/titiler__core__models__responses__Point" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/zarr/bbox/{minx},{miny},{maxx},{maxy}/{width}x{height}.{format}": { "get": { "tags": [ "Zarr" ], "summary": "Bbox Image", "description": "Create image from a bbox.", "operationId": ".zarr.getDataForBoundingBoxWithSizesAndFormat", "parameters": [ { "name": "minx", "in": "path", "required": true, "schema": { "type": "number", "description": "Bounding box min X", "title": "Minx" }, "description": "Bounding box min X" }, { "name": "miny", "in": "path", "required": true, "schema": { "type": "number", "description": "Bounding box min Y", "title": "Miny" }, "description": "Bounding box min Y" }, { "name": "maxx", "in": "path", "required": true, "schema": { "type": "number", "description": "Bounding box max X", "title": "Maxx" }, "description": "Bounding box max X" }, { "name": "maxy", "in": "path", "required": true, "schema": { "type": "number", "description": "Bounding box max Y", "title": "Maxy" }, "description": "Bounding box max Y" }, { "name": "format", "in": "path", "required": true, "schema": { "anyOf": [ { "$ref": "#/components/schemas/ImageType" }, { "type": "null" } ], "description": "Default will be automatically defined if the output image needs a mask (png) or not (jpeg).", "title": "Format" } }, { "name": "height", "in": "path", "required": true, "schema": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "Force output image height.", "title": "Height" } }, { "name": "width", "in": "path", "required": true, "schema": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "Force output image width.", "title": "Width" } }, { "name": "url", "in": "query", "required": true, "schema": { "type": "string", "description": "Dataset URL", "title": "Url" }, "description": "Dataset URL" }, { "name": "variable", "in": "query", "required": true, "schema": { "type": "string", "description": "Xarray Variable name.", "title": "Variable" }, "description": "Xarray Variable name." }, { "name": "sel", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "array", "items": { "type": "string", "pattern": "^[^=]+=((nearest|pad|ffill|backfill|bfill)::)?([^=:]|:[^:])+$" } }, { "type": "null" } ], "description": "Xarray Indexing using dimension names `{dimension}={value}` or `{dimension}={method}::{value}`.", "title": "Sel" }, "description": "Xarray Indexing using dimension names `{dimension}={value}` or `{dimension}={method}::{value}`." }, { "name": "group", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Select a specific zarr group from a zarr hierarchy. Could be associated with a zoom level or dataset.", "title": "Group" }, "description": "Select a specific zarr group from a zarr hierarchy. Could be associated with a zoom level or dataset." }, { "name": "decode_times", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "decode_times", "description": "Whether to decode times" }, "description": "Whether to decode times" }, { "name": "bidx", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "array", "items": { "type": "integer" } }, { "type": "null" } ], "title": "Band indexes", "description": "Dataset band indexes" }, "description": "Dataset band indexes", "examples": { "user-provided": {}, "one-band": { "value": [ 1 ] }, "multi-bands": { "value": [ 1, 2, 3 ] } } }, { "name": "nodata", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "integer" }, { "type": "number" }, { "type": "null" } ], "title": "Nodata value", "description": "Overwrite internal Nodata value" }, "description": "Overwrite internal Nodata value" }, { "name": "reproject", "in": "query", "required": false, "schema": { "anyOf": [ { "enum": [ "nearest", "bilinear", "cubic", "cubic_spline", "lanczos", "average", "mode", "max", "min", "med", "q1", "q3", "sum", "rms" ], "type": "string" }, { "type": "null" } ], "description": "WarpKernel resampling algorithm (only used when doing re-projection). Defaults to `nearest`.", "title": "Reproject" }, "description": "WarpKernel resampling algorithm (only used when doing re-projection). Defaults to `nearest`." }, { "name": "max_size", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "Maximum image size to read onto.", "title": "Max Size" } }, { "name": "resampling", "in": "query", "required": false, "schema": { "anyOf": [ { "enum": [ "nearest", "bilinear", "cubic", "cubic_spline", "lanczos", "average", "mode", "gauss", "rms" ], "type": "string" }, { "type": "null" } ], "description": "RasterIO resampling algorithm. Defaults to `nearest`.", "title": "Resampling" }, "description": "RasterIO resampling algorithm. Defaults to `nearest`." }, { "name": "dst_crs", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Output Coordinate Reference System.", "title": "Dst Crs" }, "description": "Output Coordinate Reference System." }, { "name": "coord_crs", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Coordinate Reference System of the input coords. Default to `epsg:4326`.", "title": "Coord Crs" }, "description": "Coordinate Reference System of the input coords. Default to `epsg:4326`." }, { "name": "algorithm", "in": "query", "required": false, "schema": { "enum": [ "hillshade", "slope", "contours", "normalizedIndex", "terrarium", "terrainrgb", "cast", "ceil", "floor", "min", "max", "median", "mean", "std", "var", "sum", "grayscale", "bitonal" ], "type": "string", "description": "Algorithm name", "title": "Algorithm" }, "description": "Algorithm name" }, { "name": "algorithm_params", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Algorithm parameter", "title": "Algorithm Params" }, "description": "Algorithm parameter" }, { "name": "colormap_name", "in": "query", "required": false, "schema": { "enum": [ "jet_r", "haline", "gist_ncar_r", "algae", "cividis_r", "seismic_r", "pink_r", "rdylbu", "inferno_r", "deep", "rdgy_r", "tab10", "bugn_r", "ocean_r", "purples", "pastel1_r", "thermal_r", "ylorrd_r", "wistia_r", "cmrmap", "pubu", "rain", "ylgnbu", "gnuplot", "gnbu", "gist_gray_r", "greens", "purd_r", "oxy_r", "matter", "summer_r", "gnuplot_r", "gnuplot2", "solar", "jet", "ylgn_r", "dark2_r", "spring", "tab20c", "gist_stern", "bwr", "ylgn", "plasma", "pastel2", "blues_r", "rain_r", "set1", "topo_r", "gist_ncar", "turbid", "magma_r", "pastel2_r", "purd", "gnbu_r", "spring_r", "rdbu_r", "ylorbr", "twilight_shifted", "rplumbo", "winter_r", "tab20b", "ylorrd", "copper", "flag_r", "afmhot", "twilight_shifted_r", "oranges_r", "bone", "seismic", "gray_r", "tarn_r", "bwr_r", "magma", "paired_r", "dark2", "binary", "set3", "viridis_r", "spectral", "prgn", "diff", "hot", "gist_earth", "cubehelix", "dense_r", "coolwarm", "pubugn_r", "autumn_r", "gnuplot2_r", "cividis", "bugn", "deep_r", "prgn_r", "gist_rainbow", "gist_heat_r", "nipy_spectral_r", "tab20", "turbo_r", "pubugn", "set2_r", "gist_yarg_r", "spectral_r", "binary_r", "greys", "rainbow_r", "haline_r", "curl", "tab20c_r", "blues", "prism", "rdgy", "gist_gray", "set2", "cool", "afmhot_r", "bone_r", "paired", "oranges", "orrd", "puor", "autumn", "delta_r", "pubu_r", "piyg_r", "turbo", "greys_r", "accent", "turbid_r", "algae_r", "solar_r", "topo", "cool_r", "inferno", "balance", "tempo_r", "amp_r", "flag", "speed", "gist_heat", "balance_r", "viridis", "cubehelix_r", "ylorbr_r", "summer", "coolwarm_r", "diff_r", "rdylgn_r", "gist_stern_r", "plasma_r", "copper_r", "oxy", "gist_yarg", "twilight", "winter", "brbg", "reds_r", "speed_r", "rainbow", "ice", "nipy_spectral", "piyg", "gray", "reds", "terrain", "tab20_r", "wistia", "accent_r", "thermal", "ocean", "twilight_r", "hot_r", "set3_r", "hsv_r", "brg_r", "gist_rainbow_r", "phase", "bupu", "pastel1", "dense", "set1_r", "phase_r", "matter_r", "greens_r", "cfastie", "tab10_r", "rdbu", "brg", "rdpu_r", "brbg_r", "cmrmap_r", "prism_r", "purples_r", "gist_earth_r", "tempo", "schwarzwald", "rdpu", "orrd_r", "tarn", "puor_r", "bupu_r", "rdylgn", "ice_r", "pink", "terrain_r", "amp", "tab20b_r", "rdylbu_r", "hsv", "curl_r", "delta", "ylgnbu_r" ], "type": "string", "description": "Colormap name", "title": "Colormap Name" }, "description": "Colormap name" }, { "name": "colormap", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "JSON encoded custom Colormap", "title": "Colormap" }, "description": "JSON encoded custom Colormap" }, { "name": "rescale", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ], "title": "Min/Max data Rescaling", "description": "comma (',') delimited Min,Max range. Can set multiple time for multiple bands.", "examples": [ "0,2000", "0,1000", "0,10000" ] }, "description": "comma (',') delimited Min,Max range. Can set multiple time for multiple bands." }, { "name": "color_formula", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Color Formula", "description": "rio-color formula (info: https://github.com/mapbox/rio-color)" }, "description": "rio-color formula (info: https://github.com/mapbox/rio-color)" }, { "name": "return_mask", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "Add mask to the output data. Defaults to `True`", "title": "Return Mask" }, "description": "Add mask to the output data. Defaults to `True`" } ], "responses": { "200": { "description": "Return an image.", "content": { "image/png": {}, "image/jpeg": {}, "image/jpg": {}, "image/webp": {}, "image/jp2": {}, "image/tiff; application=geotiff": {}, "application/x-binary": {} } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/zarr/bbox/{minx},{miny},{maxx},{maxy}.{format}": { "get": { "tags": [ "Zarr" ], "summary": "Bbox Image", "description": "Create image from a bbox.", "operationId": ".zarr.getDataForBoundingBoxWithFormat", "parameters": [ { "name": "minx", "in": "path", "required": true, "schema": { "type": "number", "description": "Bounding box min X", "title": "Minx" }, "description": "Bounding box min X" }, { "name": "miny", "in": "path", "required": true, "schema": { "type": "number", "description": "Bounding box min Y", "title": "Miny" }, "description": "Bounding box min Y" }, { "name": "maxx", "in": "path", "required": true, "schema": { "type": "number", "description": "Bounding box max X", "title": "Maxx" }, "description": "Bounding box max X" }, { "name": "maxy", "in": "path", "required": true, "schema": { "type": "number", "description": "Bounding box max Y", "title": "Maxy" }, "description": "Bounding box max Y" }, { "name": "format", "in": "path", "required": true, "schema": { "anyOf": [ { "$ref": "#/components/schemas/ImageType" }, { "type": "null" } ], "description": "Default will be automatically defined if the output image needs a mask (png) or not (jpeg).", "title": "Format" } }, { "name": "url", "in": "query", "required": true, "schema": { "type": "string", "description": "Dataset URL", "title": "Url" }, "description": "Dataset URL" }, { "name": "variable", "in": "query", "required": true, "schema": { "type": "string", "description": "Xarray Variable name.", "title": "Variable" }, "description": "Xarray Variable name." }, { "name": "sel", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "array", "items": { "type": "string", "pattern": "^[^=]+=((nearest|pad|ffill|backfill|bfill)::)?([^=:]|:[^:])+$" } }, { "type": "null" } ], "description": "Xarray Indexing using dimension names `{dimension}={value}` or `{dimension}={method}::{value}`.", "title": "Sel" }, "description": "Xarray Indexing using dimension names `{dimension}={value}` or `{dimension}={method}::{value}`." }, { "name": "group", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Select a specific zarr group from a zarr hierarchy. Could be associated with a zoom level or dataset.", "title": "Group" }, "description": "Select a specific zarr group from a zarr hierarchy. Could be associated with a zoom level or dataset." }, { "name": "decode_times", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "decode_times", "description": "Whether to decode times" }, "description": "Whether to decode times" }, { "name": "bidx", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "array", "items": { "type": "integer" } }, { "type": "null" } ], "title": "Band indexes", "description": "Dataset band indexes" }, "description": "Dataset band indexes", "examples": { "user-provided": {}, "one-band": { "value": [ 1 ] }, "multi-bands": { "value": [ 1, 2, 3 ] } } }, { "name": "nodata", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "integer" }, { "type": "number" }, { "type": "null" } ], "title": "Nodata value", "description": "Overwrite internal Nodata value" }, "description": "Overwrite internal Nodata value" }, { "name": "reproject", "in": "query", "required": false, "schema": { "anyOf": [ { "enum": [ "nearest", "bilinear", "cubic", "cubic_spline", "lanczos", "average", "mode", "max", "min", "med", "q1", "q3", "sum", "rms" ], "type": "string" }, { "type": "null" } ], "description": "WarpKernel resampling algorithm (only used when doing re-projection). Defaults to `nearest`.", "title": "Reproject" }, "description": "WarpKernel resampling algorithm (only used when doing re-projection). Defaults to `nearest`." }, { "name": "max_size", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "Maximum image size to read onto.", "title": "Max Size" } }, { "name": "height", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "Force output image height.", "title": "Height" } }, { "name": "width", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "Force output image width.", "title": "Width" } }, { "name": "resampling", "in": "query", "required": false, "schema": { "anyOf": [ { "enum": [ "nearest", "bilinear", "cubic", "cubic_spline", "lanczos", "average", "mode", "gauss", "rms" ], "type": "string" }, { "type": "null" } ], "description": "RasterIO resampling algorithm. Defaults to `nearest`.", "title": "Resampling" }, "description": "RasterIO resampling algorithm. Defaults to `nearest`." }, { "name": "dst_crs", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Output Coordinate Reference System.", "title": "Dst Crs" }, "description": "Output Coordinate Reference System." }, { "name": "coord_crs", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Coordinate Reference System of the input coords. Default to `epsg:4326`.", "title": "Coord Crs" }, "description": "Coordinate Reference System of the input coords. Default to `epsg:4326`." }, { "name": "algorithm", "in": "query", "required": false, "schema": { "enum": [ "hillshade", "slope", "contours", "normalizedIndex", "terrarium", "terrainrgb", "cast", "ceil", "floor", "min", "max", "median", "mean", "std", "var", "sum", "grayscale", "bitonal" ], "type": "string", "description": "Algorithm name", "title": "Algorithm" }, "description": "Algorithm name" }, { "name": "algorithm_params", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Algorithm parameter", "title": "Algorithm Params" }, "description": "Algorithm parameter" }, { "name": "colormap_name", "in": "query", "required": false, "schema": { "enum": [ "jet_r", "haline", "gist_ncar_r", "algae", "cividis_r", "seismic_r", "pink_r", "rdylbu", "inferno_r", "deep", "rdgy_r", "tab10", "bugn_r", "ocean_r", "purples", "pastel1_r", "thermal_r", "ylorrd_r", "wistia_r", "cmrmap", "pubu", "rain", "ylgnbu", "gnuplot", "gnbu", "gist_gray_r", "greens", "purd_r", "oxy_r", "matter", "summer_r", "gnuplot_r", "gnuplot2", "solar", "jet", "ylgn_r", "dark2_r", "spring", "tab20c", "gist_stern", "bwr", "ylgn", "plasma", "pastel2", "blues_r", "rain_r", "set1", "topo_r", "gist_ncar", "turbid", "magma_r", "pastel2_r", "purd", "gnbu_r", "spring_r", "rdbu_r", "ylorbr", "twilight_shifted", "rplumbo", "winter_r", "tab20b", "ylorrd", "copper", "flag_r", "afmhot", "twilight_shifted_r", "oranges_r", "bone", "seismic", "gray_r", "tarn_r", "bwr_r", "magma", "paired_r", "dark2", "binary", "set3", "viridis_r", "spectral", "prgn", "diff", "hot", "gist_earth", "cubehelix", "dense_r", "coolwarm", "pubugn_r", "autumn_r", "gnuplot2_r", "cividis", "bugn", "deep_r", "prgn_r", "gist_rainbow", "gist_heat_r", "nipy_spectral_r", "tab20", "turbo_r", "pubugn", "set2_r", "gist_yarg_r", "spectral_r", "binary_r", "greys", "rainbow_r", "haline_r", "curl", "tab20c_r", "blues", "prism", "rdgy", "gist_gray", "set2", "cool", "afmhot_r", "bone_r", "paired", "oranges", "orrd", "puor", "autumn", "delta_r", "pubu_r", "piyg_r", "turbo", "greys_r", "accent", "turbid_r", "algae_r", "solar_r", "topo", "cool_r", "inferno", "balance", "tempo_r", "amp_r", "flag", "speed", "gist_heat", "balance_r", "viridis", "cubehelix_r", "ylorbr_r", "summer", "coolwarm_r", "diff_r", "rdylgn_r", "gist_stern_r", "plasma_r", "copper_r", "oxy", "gist_yarg", "twilight", "winter", "brbg", "reds_r", "speed_r", "rainbow", "ice", "nipy_spectral", "piyg", "gray", "reds", "terrain", "tab20_r", "wistia", "accent_r", "thermal", "ocean", "twilight_r", "hot_r", "set3_r", "hsv_r", "brg_r", "gist_rainbow_r", "phase", "bupu", "pastel1", "dense", "set1_r", "phase_r", "matter_r", "greens_r", "cfastie", "tab10_r", "rdbu", "brg", "rdpu_r", "brbg_r", "cmrmap_r", "prism_r", "purples_r", "gist_earth_r", "tempo", "schwarzwald", "rdpu", "orrd_r", "tarn", "puor_r", "bupu_r", "rdylgn", "ice_r", "pink", "terrain_r", "amp", "tab20b_r", "rdylbu_r", "hsv", "curl_r", "delta", "ylgnbu_r" ], "type": "string", "description": "Colormap name", "title": "Colormap Name" }, "description": "Colormap name" }, { "name": "colormap", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "JSON encoded custom Colormap", "title": "Colormap" }, "description": "JSON encoded custom Colormap" }, { "name": "rescale", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ], "title": "Min/Max data Rescaling", "description": "comma (',') delimited Min,Max range. Can set multiple time for multiple bands.", "examples": [ "0,2000", "0,1000", "0,10000" ] }, "description": "comma (',') delimited Min,Max range. Can set multiple time for multiple bands." }, { "name": "color_formula", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Color Formula", "description": "rio-color formula (info: https://github.com/mapbox/rio-color)" }, "description": "rio-color formula (info: https://github.com/mapbox/rio-color)" }, { "name": "return_mask", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "Add mask to the output data. Defaults to `True`", "title": "Return Mask" }, "description": "Add mask to the output data. Defaults to `True`" } ], "responses": { "200": { "description": "Return an image.", "content": { "image/png": {}, "image/jpeg": {}, "image/jpg": {}, "image/webp": {}, "image/jp2": {}, "image/tiff; application=geotiff": {}, "application/x-binary": {} } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/zarr/feature/{width}x{height}.{format}": { "post": { "tags": [ "Zarr" ], "summary": "Feature Image", "description": "Create image from a geojson feature.", "operationId": ".zarr.postDataForGeoJSONWithSizesAndFormat", "parameters": [ { "name": "format", "in": "path", "required": true, "schema": { "anyOf": [ { "$ref": "#/components/schemas/ImageType" }, { "type": "null" } ], "description": "Default will be automatically defined if the output image needs a mask (png) or not (jpeg).", "title": "Format" } }, { "name": "height", "in": "path", "required": true, "schema": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "Force output image height.", "title": "Height" } }, { "name": "width", "in": "path", "required": true, "schema": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "Force output image width.", "title": "Width" } }, { "name": "url", "in": "query", "required": true, "schema": { "type": "string", "description": "Dataset URL", "title": "Url" }, "description": "Dataset URL" }, { "name": "variable", "in": "query", "required": true, "schema": { "type": "string", "description": "Xarray Variable name.", "title": "Variable" }, "description": "Xarray Variable name." }, { "name": "sel", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "array", "items": { "type": "string", "pattern": "^[^=]+=((nearest|pad|ffill|backfill|bfill)::)?([^=:]|:[^:])+$" } }, { "type": "null" } ], "description": "Xarray Indexing using dimension names `{dimension}={value}` or `{dimension}={method}::{value}`.", "title": "Sel" }, "description": "Xarray Indexing using dimension names `{dimension}={value}` or `{dimension}={method}::{value}`." }, { "name": "group", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Select a specific zarr group from a zarr hierarchy. Could be associated with a zoom level or dataset.", "title": "Group" }, "description": "Select a specific zarr group from a zarr hierarchy. Could be associated with a zoom level or dataset." }, { "name": "decode_times", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "decode_times", "description": "Whether to decode times" }, "description": "Whether to decode times" }, { "name": "bidx", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "array", "items": { "type": "integer" } }, { "type": "null" } ], "title": "Band indexes", "description": "Dataset band indexes" }, "description": "Dataset band indexes", "examples": { "user-provided": {}, "one-band": { "value": [ 1 ] }, "multi-bands": { "value": [ 1, 2, 3 ] } } }, { "name": "nodata", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "integer" }, { "type": "number" }, { "type": "null" } ], "title": "Nodata value", "description": "Overwrite internal Nodata value" }, "description": "Overwrite internal Nodata value" }, { "name": "reproject", "in": "query", "required": false, "schema": { "anyOf": [ { "enum": [ "nearest", "bilinear", "cubic", "cubic_spline", "lanczos", "average", "mode", "max", "min", "med", "q1", "q3", "sum", "rms" ], "type": "string" }, { "type": "null" } ], "description": "WarpKernel resampling algorithm (only used when doing re-projection). Defaults to `nearest`.", "title": "Reproject" }, "description": "WarpKernel resampling algorithm (only used when doing re-projection). Defaults to `nearest`." }, { "name": "max_size", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "Maximum image size to read onto.", "title": "Max Size" } }, { "name": "resampling", "in": "query", "required": false, "schema": { "anyOf": [ { "enum": [ "nearest", "bilinear", "cubic", "cubic_spline", "lanczos", "average", "mode", "gauss", "rms" ], "type": "string" }, { "type": "null" } ], "description": "RasterIO resampling algorithm. Defaults to `nearest`.", "title": "Resampling" }, "description": "RasterIO resampling algorithm. Defaults to `nearest`." }, { "name": "coord_crs", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Coordinate Reference System of the input coords. Default to `epsg:4326`.", "title": "Coord Crs" }, "description": "Coordinate Reference System of the input coords. Default to `epsg:4326`." }, { "name": "dst_crs", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Output Coordinate Reference System.", "title": "Dst Crs" }, "description": "Output Coordinate Reference System." }, { "name": "algorithm", "in": "query", "required": false, "schema": { "enum": [ "hillshade", "slope", "contours", "normalizedIndex", "terrarium", "terrainrgb", "cast", "ceil", "floor", "min", "max", "median", "mean", "std", "var", "sum", "grayscale", "bitonal" ], "type": "string", "description": "Algorithm name", "title": "Algorithm" }, "description": "Algorithm name" }, { "name": "algorithm_params", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Algorithm parameter", "title": "Algorithm Params" }, "description": "Algorithm parameter" }, { "name": "colormap_name", "in": "query", "required": false, "schema": { "enum": [ "jet_r", "haline", "gist_ncar_r", "algae", "cividis_r", "seismic_r", "pink_r", "rdylbu", "inferno_r", "deep", "rdgy_r", "tab10", "bugn_r", "ocean_r", "purples", "pastel1_r", "thermal_r", "ylorrd_r", "wistia_r", "cmrmap", "pubu", "rain", "ylgnbu", "gnuplot", "gnbu", "gist_gray_r", "greens", "purd_r", "oxy_r", "matter", "summer_r", "gnuplot_r", "gnuplot2", "solar", "jet", "ylgn_r", "dark2_r", "spring", "tab20c", "gist_stern", "bwr", "ylgn", "plasma", "pastel2", "blues_r", "rain_r", "set1", "topo_r", "gist_ncar", "turbid", "magma_r", "pastel2_r", "purd", "gnbu_r", "spring_r", "rdbu_r", "ylorbr", "twilight_shifted", "rplumbo", "winter_r", "tab20b", "ylorrd", "copper", "flag_r", "afmhot", "twilight_shifted_r", "oranges_r", "bone", "seismic", "gray_r", "tarn_r", "bwr_r", "magma", "paired_r", "dark2", "binary", "set3", "viridis_r", "spectral", "prgn", "diff", "hot", "gist_earth", "cubehelix", "dense_r", "coolwarm", "pubugn_r", "autumn_r", "gnuplot2_r", "cividis", "bugn", "deep_r", "prgn_r", "gist_rainbow", "gist_heat_r", "nipy_spectral_r", "tab20", "turbo_r", "pubugn", "set2_r", "gist_yarg_r", "spectral_r", "binary_r", "greys", "rainbow_r", "haline_r", "curl", "tab20c_r", "blues", "prism", "rdgy", "gist_gray", "set2", "cool", "afmhot_r", "bone_r", "paired", "oranges", "orrd", "puor", "autumn", "delta_r", "pubu_r", "piyg_r", "turbo", "greys_r", "accent", "turbid_r", "algae_r", "solar_r", "topo", "cool_r", "inferno", "balance", "tempo_r", "amp_r", "flag", "speed", "gist_heat", "balance_r", "viridis", "cubehelix_r", "ylorbr_r", "summer", "coolwarm_r", "diff_r", "rdylgn_r", "gist_stern_r", "plasma_r", "copper_r", "oxy", "gist_yarg", "twilight", "winter", "brbg", "reds_r", "speed_r", "rainbow", "ice", "nipy_spectral", "piyg", "gray", "reds", "terrain", "tab20_r", "wistia", "accent_r", "thermal", "ocean", "twilight_r", "hot_r", "set3_r", "hsv_r", "brg_r", "gist_rainbow_r", "phase", "bupu", "pastel1", "dense", "set1_r", "phase_r", "matter_r", "greens_r", "cfastie", "tab10_r", "rdbu", "brg", "rdpu_r", "brbg_r", "cmrmap_r", "prism_r", "purples_r", "gist_earth_r", "tempo", "schwarzwald", "rdpu", "orrd_r", "tarn", "puor_r", "bupu_r", "rdylgn", "ice_r", "pink", "terrain_r", "amp", "tab20b_r", "rdylbu_r", "hsv", "curl_r", "delta", "ylgnbu_r" ], "type": "string", "description": "Colormap name", "title": "Colormap Name" }, "description": "Colormap name" }, { "name": "colormap", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "JSON encoded custom Colormap", "title": "Colormap" }, "description": "JSON encoded custom Colormap" }, { "name": "rescale", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ], "title": "Min/Max data Rescaling", "description": "comma (',') delimited Min,Max range. Can set multiple time for multiple bands.", "examples": [ "0,2000", "0,1000", "0,10000" ] }, "description": "comma (',') delimited Min,Max range. Can set multiple time for multiple bands." }, { "name": "color_formula", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Color Formula", "description": "rio-color formula (info: https://github.com/mapbox/rio-color)" }, "description": "rio-color formula (info: https://github.com/mapbox/rio-color)" }, { "name": "return_mask", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "Add mask to the output data. Defaults to `True`", "title": "Return Mask" }, "description": "Add mask to the output data. Defaults to `True`" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Feature-Input", "description": "GeoJSON Feature." } } } }, "responses": { "200": { "description": "Return an image.", "content": { "image/png": {}, "image/jpeg": {}, "image/jpg": {}, "image/webp": {}, "image/jp2": {}, "image/tiff; application=geotiff": {}, "application/x-binary": {} } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/zarr/feature.{format}": { "post": { "tags": [ "Zarr" ], "summary": "Feature Image", "description": "Create image from a geojson feature.", "operationId": ".zarr.postDataForGeoJSONWithFormat", "parameters": [ { "name": "format", "in": "path", "required": true, "schema": { "anyOf": [ { "$ref": "#/components/schemas/ImageType" }, { "type": "null" } ], "description": "Default will be automatically defined if the output image needs a mask (png) or not (jpeg).", "title": "Format" } }, { "name": "url", "in": "query", "required": true, "schema": { "type": "string", "description": "Dataset URL", "title": "Url" }, "description": "Dataset URL" }, { "name": "variable", "in": "query", "required": true, "schema": { "type": "string", "description": "Xarray Variable name.", "title": "Variable" }, "description": "Xarray Variable name." }, { "name": "sel", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "array", "items": { "type": "string", "pattern": "^[^=]+=((nearest|pad|ffill|backfill|bfill)::)?([^=:]|:[^:])+$" } }, { "type": "null" } ], "description": "Xarray Indexing using dimension names `{dimension}={value}` or `{dimension}={method}::{value}`.", "title": "Sel" }, "description": "Xarray Indexing using dimension names `{dimension}={value}` or `{dimension}={method}::{value}`." }, { "name": "group", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Select a specific zarr group from a zarr hierarchy. Could be associated with a zoom level or dataset.", "title": "Group" }, "description": "Select a specific zarr group from a zarr hierarchy. Could be associated with a zoom level or dataset." }, { "name": "decode_times", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "decode_times", "description": "Whether to decode times" }, "description": "Whether to decode times" }, { "name": "bidx", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "array", "items": { "type": "integer" } }, { "type": "null" } ], "title": "Band indexes", "description": "Dataset band indexes" }, "description": "Dataset band indexes", "examples": { "user-provided": {}, "one-band": { "value": [ 1 ] }, "multi-bands": { "value": [ 1, 2, 3 ] } } }, { "name": "nodata", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "integer" }, { "type": "number" }, { "type": "null" } ], "title": "Nodata value", "description": "Overwrite internal Nodata value" }, "description": "Overwrite internal Nodata value" }, { "name": "reproject", "in": "query", "required": false, "schema": { "anyOf": [ { "enum": [ "nearest", "bilinear", "cubic", "cubic_spline", "lanczos", "average", "mode", "max", "min", "med", "q1", "q3", "sum", "rms" ], "type": "string" }, { "type": "null" } ], "description": "WarpKernel resampling algorithm (only used when doing re-projection). Defaults to `nearest`.", "title": "Reproject" }, "description": "WarpKernel resampling algorithm (only used when doing re-projection). Defaults to `nearest`." }, { "name": "max_size", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "Maximum image size to read onto.", "title": "Max Size" } }, { "name": "height", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "Force output image height.", "title": "Height" } }, { "name": "width", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "Force output image width.", "title": "Width" } }, { "name": "resampling", "in": "query", "required": false, "schema": { "anyOf": [ { "enum": [ "nearest", "bilinear", "cubic", "cubic_spline", "lanczos", "average", "mode", "gauss", "rms" ], "type": "string" }, { "type": "null" } ], "description": "RasterIO resampling algorithm. Defaults to `nearest`.", "title": "Resampling" }, "description": "RasterIO resampling algorithm. Defaults to `nearest`." }, { "name": "coord_crs", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Coordinate Reference System of the input coords. Default to `epsg:4326`.", "title": "Coord Crs" }, "description": "Coordinate Reference System of the input coords. Default to `epsg:4326`." }, { "name": "dst_crs", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Output Coordinate Reference System.", "title": "Dst Crs" }, "description": "Output Coordinate Reference System." }, { "name": "algorithm", "in": "query", "required": false, "schema": { "enum": [ "hillshade", "slope", "contours", "normalizedIndex", "terrarium", "terrainrgb", "cast", "ceil", "floor", "min", "max", "median", "mean", "std", "var", "sum", "grayscale", "bitonal" ], "type": "string", "description": "Algorithm name", "title": "Algorithm" }, "description": "Algorithm name" }, { "name": "algorithm_params", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Algorithm parameter", "title": "Algorithm Params" }, "description": "Algorithm parameter" }, { "name": "colormap_name", "in": "query", "required": false, "schema": { "enum": [ "jet_r", "haline", "gist_ncar_r", "algae", "cividis_r", "seismic_r", "pink_r", "rdylbu", "inferno_r", "deep", "rdgy_r", "tab10", "bugn_r", "ocean_r", "purples", "pastel1_r", "thermal_r", "ylorrd_r", "wistia_r", "cmrmap", "pubu", "rain", "ylgnbu", "gnuplot", "gnbu", "gist_gray_r", "greens", "purd_r", "oxy_r", "matter", "summer_r", "gnuplot_r", "gnuplot2", "solar", "jet", "ylgn_r", "dark2_r", "spring", "tab20c", "gist_stern", "bwr", "ylgn", "plasma", "pastel2", "blues_r", "rain_r", "set1", "topo_r", "gist_ncar", "turbid", "magma_r", "pastel2_r", "purd", "gnbu_r", "spring_r", "rdbu_r", "ylorbr", "twilight_shifted", "rplumbo", "winter_r", "tab20b", "ylorrd", "copper", "flag_r", "afmhot", "twilight_shifted_r", "oranges_r", "bone", "seismic", "gray_r", "tarn_r", "bwr_r", "magma", "paired_r", "dark2", "binary", "set3", "viridis_r", "spectral", "prgn", "diff", "hot", "gist_earth", "cubehelix", "dense_r", "coolwarm", "pubugn_r", "autumn_r", "gnuplot2_r", "cividis", "bugn", "deep_r", "prgn_r", "gist_rainbow", "gist_heat_r", "nipy_spectral_r", "tab20", "turbo_r", "pubugn", "set2_r", "gist_yarg_r", "spectral_r", "binary_r", "greys", "rainbow_r", "haline_r", "curl", "tab20c_r", "blues", "prism", "rdgy", "gist_gray", "set2", "cool", "afmhot_r", "bone_r", "paired", "oranges", "orrd", "puor", "autumn", "delta_r", "pubu_r", "piyg_r", "turbo", "greys_r", "accent", "turbid_r", "algae_r", "solar_r", "topo", "cool_r", "inferno", "balance", "tempo_r", "amp_r", "flag", "speed", "gist_heat", "balance_r", "viridis", "cubehelix_r", "ylorbr_r", "summer", "coolwarm_r", "diff_r", "rdylgn_r", "gist_stern_r", "plasma_r", "copper_r", "oxy", "gist_yarg", "twilight", "winter", "brbg", "reds_r", "speed_r", "rainbow", "ice", "nipy_spectral", "piyg", "gray", "reds", "terrain", "tab20_r", "wistia", "accent_r", "thermal", "ocean", "twilight_r", "hot_r", "set3_r", "hsv_r", "brg_r", "gist_rainbow_r", "phase", "bupu", "pastel1", "dense", "set1_r", "phase_r", "matter_r", "greens_r", "cfastie", "tab10_r", "rdbu", "brg", "rdpu_r", "brbg_r", "cmrmap_r", "prism_r", "purples_r", "gist_earth_r", "tempo", "schwarzwald", "rdpu", "orrd_r", "tarn", "puor_r", "bupu_r", "rdylgn", "ice_r", "pink", "terrain_r", "amp", "tab20b_r", "rdylbu_r", "hsv", "curl_r", "delta", "ylgnbu_r" ], "type": "string", "description": "Colormap name", "title": "Colormap Name" }, "description": "Colormap name" }, { "name": "colormap", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "JSON encoded custom Colormap", "title": "Colormap" }, "description": "JSON encoded custom Colormap" }, { "name": "rescale", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ], "title": "Min/Max data Rescaling", "description": "comma (',') delimited Min,Max range. Can set multiple time for multiple bands.", "examples": [ "0,2000", "0,1000", "0,10000" ] }, "description": "comma (',') delimited Min,Max range. Can set multiple time for multiple bands." }, { "name": "color_formula", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Color Formula", "description": "rio-color formula (info: https://github.com/mapbox/rio-color)" }, "description": "rio-color formula (info: https://github.com/mapbox/rio-color)" }, { "name": "return_mask", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "Add mask to the output data. Defaults to `True`", "title": "Return Mask" }, "description": "Add mask to the output data. Defaults to `True`" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Feature-Input", "description": "GeoJSON Feature." } } } }, "responses": { "200": { "description": "Return an image.", "content": { "image/png": {}, "image/jpeg": {}, "image/jpg": {}, "image/webp": {}, "image/jp2": {}, "image/tiff; application=geotiff": {}, "application/x-binary": {} } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/zarr/feature": { "post": { "tags": [ "Zarr" ], "summary": "Feature Image", "description": "Create image from a geojson feature.", "operationId": ".zarr.postDataForGeoJSON", "parameters": [ { "name": "format", "in": "query", "required": false, "schema": { "anyOf": [ { "$ref": "#/components/schemas/ImageType" }, { "type": "null" } ], "description": "Default will be automatically defined if the output image needs a mask (png) or not (jpeg).", "title": "Format" } }, { "name": "url", "in": "query", "required": true, "schema": { "type": "string", "description": "Dataset URL", "title": "Url" }, "description": "Dataset URL" }, { "name": "variable", "in": "query", "required": true, "schema": { "type": "string", "description": "Xarray Variable name.", "title": "Variable" }, "description": "Xarray Variable name." }, { "name": "sel", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "array", "items": { "type": "string", "pattern": "^[^=]+=((nearest|pad|ffill|backfill|bfill)::)?([^=:]|:[^:])+$" } }, { "type": "null" } ], "description": "Xarray Indexing using dimension names `{dimension}={value}` or `{dimension}={method}::{value}`.", "title": "Sel" }, "description": "Xarray Indexing using dimension names `{dimension}={value}` or `{dimension}={method}::{value}`." }, { "name": "group", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Select a specific zarr group from a zarr hierarchy. Could be associated with a zoom level or dataset.", "title": "Group" }, "description": "Select a specific zarr group from a zarr hierarchy. Could be associated with a zoom level or dataset." }, { "name": "decode_times", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "decode_times", "description": "Whether to decode times" }, "description": "Whether to decode times" }, { "name": "bidx", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "array", "items": { "type": "integer" } }, { "type": "null" } ], "title": "Band indexes", "description": "Dataset band indexes" }, "description": "Dataset band indexes", "examples": { "user-provided": {}, "one-band": { "value": [ 1 ] }, "multi-bands": { "value": [ 1, 2, 3 ] } } }, { "name": "nodata", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "integer" }, { "type": "number" }, { "type": "null" } ], "title": "Nodata value", "description": "Overwrite internal Nodata value" }, "description": "Overwrite internal Nodata value" }, { "name": "reproject", "in": "query", "required": false, "schema": { "anyOf": [ { "enum": [ "nearest", "bilinear", "cubic", "cubic_spline", "lanczos", "average", "mode", "max", "min", "med", "q1", "q3", "sum", "rms" ], "type": "string" }, { "type": "null" } ], "description": "WarpKernel resampling algorithm (only used when doing re-projection). Defaults to `nearest`.", "title": "Reproject" }, "description": "WarpKernel resampling algorithm (only used when doing re-projection). Defaults to `nearest`." }, { "name": "max_size", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "Maximum image size to read onto.", "title": "Max Size" } }, { "name": "height", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "Force output image height.", "title": "Height" } }, { "name": "width", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "Force output image width.", "title": "Width" } }, { "name": "resampling", "in": "query", "required": false, "schema": { "anyOf": [ { "enum": [ "nearest", "bilinear", "cubic", "cubic_spline", "lanczos", "average", "mode", "gauss", "rms" ], "type": "string" }, { "type": "null" } ], "description": "RasterIO resampling algorithm. Defaults to `nearest`.", "title": "Resampling" }, "description": "RasterIO resampling algorithm. Defaults to `nearest`." }, { "name": "coord_crs", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Coordinate Reference System of the input coords. Default to `epsg:4326`.", "title": "Coord Crs" }, "description": "Coordinate Reference System of the input coords. Default to `epsg:4326`." }, { "name": "dst_crs", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Output Coordinate Reference System.", "title": "Dst Crs" }, "description": "Output Coordinate Reference System." }, { "name": "algorithm", "in": "query", "required": false, "schema": { "enum": [ "hillshade", "slope", "contours", "normalizedIndex", "terrarium", "terrainrgb", "cast", "ceil", "floor", "min", "max", "median", "mean", "std", "var", "sum", "grayscale", "bitonal" ], "type": "string", "description": "Algorithm name", "title": "Algorithm" }, "description": "Algorithm name" }, { "name": "algorithm_params", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Algorithm parameter", "title": "Algorithm Params" }, "description": "Algorithm parameter" }, { "name": "colormap_name", "in": "query", "required": false, "schema": { "enum": [ "jet_r", "haline", "gist_ncar_r", "algae", "cividis_r", "seismic_r", "pink_r", "rdylbu", "inferno_r", "deep", "rdgy_r", "tab10", "bugn_r", "ocean_r", "purples", "pastel1_r", "thermal_r", "ylorrd_r", "wistia_r", "cmrmap", "pubu", "rain", "ylgnbu", "gnuplot", "gnbu", "gist_gray_r", "greens", "purd_r", "oxy_r", "matter", "summer_r", "gnuplot_r", "gnuplot2", "solar", "jet", "ylgn_r", "dark2_r", "spring", "tab20c", "gist_stern", "bwr", "ylgn", "plasma", "pastel2", "blues_r", "rain_r", "set1", "topo_r", "gist_ncar", "turbid", "magma_r", "pastel2_r", "purd", "gnbu_r", "spring_r", "rdbu_r", "ylorbr", "twilight_shifted", "rplumbo", "winter_r", "tab20b", "ylorrd", "copper", "flag_r", "afmhot", "twilight_shifted_r", "oranges_r", "bone", "seismic", "gray_r", "tarn_r", "bwr_r", "magma", "paired_r", "dark2", "binary", "set3", "viridis_r", "spectral", "prgn", "diff", "hot", "gist_earth", "cubehelix", "dense_r", "coolwarm", "pubugn_r", "autumn_r", "gnuplot2_r", "cividis", "bugn", "deep_r", "prgn_r", "gist_rainbow", "gist_heat_r", "nipy_spectral_r", "tab20", "turbo_r", "pubugn", "set2_r", "gist_yarg_r", "spectral_r", "binary_r", "greys", "rainbow_r", "haline_r", "curl", "tab20c_r", "blues", "prism", "rdgy", "gist_gray", "set2", "cool", "afmhot_r", "bone_r", "paired", "oranges", "orrd", "puor", "autumn", "delta_r", "pubu_r", "piyg_r", "turbo", "greys_r", "accent", "turbid_r", "algae_r", "solar_r", "topo", "cool_r", "inferno", "balance", "tempo_r", "amp_r", "flag", "speed", "gist_heat", "balance_r", "viridis", "cubehelix_r", "ylorbr_r", "summer", "coolwarm_r", "diff_r", "rdylgn_r", "gist_stern_r", "plasma_r", "copper_r", "oxy", "gist_yarg", "twilight", "winter", "brbg", "reds_r", "speed_r", "rainbow", "ice", "nipy_spectral", "piyg", "gray", "reds", "terrain", "tab20_r", "wistia", "accent_r", "thermal", "ocean", "twilight_r", "hot_r", "set3_r", "hsv_r", "brg_r", "gist_rainbow_r", "phase", "bupu", "pastel1", "dense", "set1_r", "phase_r", "matter_r", "greens_r", "cfastie", "tab10_r", "rdbu", "brg", "rdpu_r", "brbg_r", "cmrmap_r", "prism_r", "purples_r", "gist_earth_r", "tempo", "schwarzwald", "rdpu", "orrd_r", "tarn", "puor_r", "bupu_r", "rdylgn", "ice_r", "pink", "terrain_r", "amp", "tab20b_r", "rdylbu_r", "hsv", "curl_r", "delta", "ylgnbu_r" ], "type": "string", "description": "Colormap name", "title": "Colormap Name" }, "description": "Colormap name" }, { "name": "colormap", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "JSON encoded custom Colormap", "title": "Colormap" }, "description": "JSON encoded custom Colormap" }, { "name": "rescale", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ], "title": "Min/Max data Rescaling", "description": "comma (',') delimited Min,Max range. Can set multiple time for multiple bands.", "examples": [ "0,2000", "0,1000", "0,10000" ] }, "description": "comma (',') delimited Min,Max range. Can set multiple time for multiple bands." }, { "name": "color_formula", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Color Formula", "description": "rio-color formula (info: https://github.com/mapbox/rio-color)" }, "description": "rio-color formula (info: https://github.com/mapbox/rio-color)" }, { "name": "return_mask", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "Add mask to the output data. Defaults to `True`", "title": "Return Mask" }, "description": "Add mask to the output data. Defaults to `True`" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Feature-Input", "description": "GeoJSON Feature." } } } }, "responses": { "200": { "description": "Return an image.", "content": { "image/png": {}, "image/jpeg": {}, "image/jpg": {}, "image/webp": {}, "image/jp2": {}, "image/tiff; application=geotiff": {}, "application/x-binary": {} } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/zarr/dataset/": { "get": { "tags": [ "Zarr" ], "summary": "Dataset Metadata Html", "description": "Returns the HTML representation of the Xarray Dataset.", "operationId": "dataset_metadata_html_zarr_dataset__get", "parameters": [ { "name": "url", "in": "query", "required": true, "schema": { "type": "string", "description": "Dataset URL", "title": "Url" }, "description": "Dataset URL" }, { "name": "group", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Select a specific zarr group from a zarr hierarchy. Could be associated with a zoom level or dataset.", "title": "Group" }, "description": "Select a specific zarr group from a zarr hierarchy. Could be associated with a zoom level or dataset." }, { "name": "decode_times", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "decode_times", "description": "Whether to decode times" }, "description": "Whether to decode times" } ], "responses": { "200": { "description": "Returns the HTML representation of the Xarray Dataset.", "content": { "text/html": { "schema": { "type": "string" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/zarr/dataset/dict": { "get": { "tags": [ "Zarr" ], "summary": "Dataset Metadata Dict", "description": "Returns the full Xarray dataset as a dictionary.", "operationId": "dataset_metadata_dict_zarr_dataset_dict_get", "parameters": [ { "name": "url", "in": "query", "required": true, "schema": { "type": "string", "description": "Dataset URL", "title": "Url" }, "description": "Dataset URL" }, { "name": "group", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Select a specific zarr group from a zarr hierarchy. Could be associated with a zoom level or dataset.", "title": "Group" }, "description": "Select a specific zarr group from a zarr hierarchy. Could be associated with a zoom level or dataset." }, { "name": "decode_times", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "decode_times", "description": "Whether to decode times" }, "description": "Whether to decode times" } ], "responses": { "200": { "description": "Returns the full Xarray dataset as a dictionary.", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/zarr/dataset/keys": { "get": { "tags": [ "Zarr" ], "summary": "Dataset Variables", "description": "Returns the list of keys/variables in the Dataset.", "operationId": "dataset_variables_zarr_dataset_keys_get", "parameters": [ { "name": "url", "in": "query", "required": true, "schema": { "type": "string", "description": "Dataset URL", "title": "Url" }, "description": "Dataset URL" }, { "name": "group", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Select a specific zarr group from a zarr hierarchy. Could be associated with a zoom level or dataset.", "title": "Group" }, "description": "Select a specific zarr group from a zarr hierarchy. Could be associated with a zoom level or dataset." }, { "name": "decode_times", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "decode_times", "description": "Whether to decode times" }, "description": "Whether to decode times" } ], "responses": { "200": { "description": "Returns the list of keys/variables in the Dataset.", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "string" }, "title": "Response Dataset Variables Zarr Dataset Keys Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/zarr/validate": { "get": { "tags": [ "Zarr" ], "summary": "Validate Dataset", "description": "Returns the HTML representation of the Xarray Dataset.", "operationId": "validate_dataset_zarr_validate_get", "parameters": [ { "name": "variables", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ], "description": "Xarray Variable name.", "title": "Variables" }, "description": "Xarray Variable name." }, { "name": "url", "in": "query", "required": true, "schema": { "type": "string", "description": "Dataset URL", "title": "Url" }, "description": "Dataset URL" }, { "name": "group", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Select a specific zarr group from a zarr hierarchy. Could be associated with a zoom level or dataset.", "title": "Group" }, "description": "Select a specific zarr group from a zarr hierarchy. Could be associated with a zoom level or dataset." }, { "name": "decode_times", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "decode_times", "description": "Whether to decode times" }, "description": "Whether to decode times" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/ValidationInfo" }, "title": "Response Validate Dataset Zarr Validate Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/tileMatrixSets": { "get": { "tags": [ "Tiling Schemes" ], "summary": "Retrieve the list of available tiling schemes (tile matrix sets).", "description": "OGC Specification: http://docs.opengeospatial.org/per/19-069.html#_tilematrixsets", "operationId": "getTileMatrixSetsList", "parameters": [ { "name": "f", "in": "query", "required": false, "schema": { "anyOf": [ { "enum": [ "html", "json" ], "type": "string" }, { "type": "null" } ], "description": "Response MediaType. Defaults to endpoint's default or value defined in `accept` header.", "title": "F" }, "description": "Response MediaType. Defaults to endpoint's default or value defined in `accept` header." } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TileMatrixSetList" } }, "text/html": {} } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/tileMatrixSets/{tileMatrixSetId}": { "get": { "tags": [ "Tiling Schemes" ], "summary": "Retrieve the definition of the specified tiling scheme (tile matrix set).", "description": "OGC Specification: http://docs.opengeospatial.org/per/19-069.html#_tilematrixset", "operationId": "getTileMatrixSet", "parameters": [ { "name": "tileMatrixSetId", "in": "path", "required": true, "schema": { "enum": [ "CDB1GlobalGrid", "CanadianNAD83_LCC", "EuropeanETRS89_LAEAQuad", "GNOSISGlobalGrid", "LINZAntarticaMapTilegrid", "NZTM2000Quad", "UPSAntarcticWGS84Quad", "UPSArcticWGS84Quad", "UTM31WGS84Quad", "WGS1984Quad", "WebMercatorQuad", "WorldCRS84Quad", "WorldMercatorWGS84Quad" ], "type": "string", "description": "Identifier for a supported TileMatrixSet.", "title": "Tilematrixsetid" }, "description": "Identifier for a supported TileMatrixSet." }, { "name": "f", "in": "query", "required": false, "schema": { "anyOf": [ { "enum": [ "html", "json" ], "type": "string" }, { "type": "null" } ], "description": "Response MediaType. Defaults to endpoint's default or value defined in `accept` header.", "title": "F" }, "description": "Response MediaType. Defaults to endpoint's default or value defined in `accept` header." } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TileMatrixSet" } }, "text/html": {} } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/algorithms": { "get": { "tags": [ "Algorithms" ], "summary": "Retrieve the list of available Algorithms.", "description": "Retrieve the list of available Algorithms.", "operationId": "getAlgorithmList", "parameters": [ { "name": "f", "in": "query", "required": false, "schema": { "anyOf": [ { "enum": [ "html", "json" ], "type": "string" }, { "type": "null" } ], "description": "Response MediaType. Defaults to endpoint's default or value defined in `accept` header.", "title": "F" }, "description": "Response MediaType. Defaults to endpoint's default or value defined in `accept` header." } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AlgorithmtList" } }, "text/html": {} } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/algorithms/{algorithmId}": { "get": { "tags": [ "Algorithms" ], "summary": "Retrieve the metadata of the specified algorithm.", "description": "Retrieve the metadata of the specified algorithm.", "operationId": "getAlgorithm", "parameters": [ { "name": "algorithmId", "in": "path", "required": true, "schema": { "enum": [ "hillshade", "slope", "contours", "normalizedIndex", "terrarium", "terrainrgb", "cast", "ceil", "floor", "min", "max", "median", "mean", "std", "var", "sum", "grayscale", "bitonal" ], "type": "string", "description": "Algorithm name", "title": "Algorithmid" }, "description": "Algorithm name" }, { "name": "f", "in": "query", "required": false, "schema": { "anyOf": [ { "enum": [ "html", "json" ], "type": "string" }, { "type": "null" } ], "description": "Response MediaType. Defaults to endpoint's default or value defined in `accept` header.", "title": "F" }, "description": "Response MediaType. Defaults to endpoint's default or value defined in `accept` header." } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AlgorithmMetadata" } }, "text/html": {} } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/colorMaps": { "get": { "tags": [ "ColorMaps" ], "summary": "Retrieve the list of available colormaps.", "description": "Retrieve the list of available colormaps.", "operationId": "getColorMapList", "parameters": [ { "name": "f", "in": "query", "required": false, "schema": { "anyOf": [ { "enum": [ "html", "json" ], "type": "string" }, { "type": "null" } ], "description": "Response MediaType. Defaults to endpoint's default or value defined in `accept` header.", "title": "F" }, "description": "Response MediaType. Defaults to endpoint's default or value defined in `accept` header." } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ColorMapList" } }, "text/html": {} } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/colorMaps/{colorMapId}": { "get": { "tags": [ "ColorMaps" ], "summary": "Retrieve the colorMap metadata or image.", "description": "Retrieve the metadata of the specified colormap.", "operationId": "getColorMap", "parameters": [ { "name": "colorMapId", "in": "path", "required": true, "schema": { "enum": [ "jet_r", "haline", "gist_ncar_r", "algae", "cividis_r", "seismic_r", "pink_r", "rdylbu", "inferno_r", "deep", "rdgy_r", "tab10", "bugn_r", "ocean_r", "purples", "pastel1_r", "thermal_r", "ylorrd_r", "wistia_r", "cmrmap", "pubu", "rain", "ylgnbu", "gnuplot", "gnbu", "gist_gray_r", "greens", "purd_r", "oxy_r", "matter", "summer_r", "gnuplot_r", "gnuplot2", "solar", "jet", "ylgn_r", "dark2_r", "spring", "tab20c", "gist_stern", "bwr", "ylgn", "plasma", "pastel2", "blues_r", "rain_r", "set1", "topo_r", "gist_ncar", "turbid", "magma_r", "pastel2_r", "purd", "gnbu_r", "spring_r", "rdbu_r", "ylorbr", "twilight_shifted", "rplumbo", "winter_r", "tab20b", "ylorrd", "copper", "flag_r", "afmhot", "twilight_shifted_r", "oranges_r", "bone", "seismic", "gray_r", "tarn_r", "bwr_r", "magma", "paired_r", "dark2", "binary", "set3", "viridis_r", "spectral", "prgn", "diff", "hot", "gist_earth", "cubehelix", "dense_r", "coolwarm", "pubugn_r", "autumn_r", "gnuplot2_r", "cividis", "bugn", "deep_r", "prgn_r", "gist_rainbow", "gist_heat_r", "nipy_spectral_r", "tab20", "turbo_r", "pubugn", "set2_r", "gist_yarg_r", "spectral_r", "binary_r", "greys", "rainbow_r", "haline_r", "curl", "tab20c_r", "blues", "prism", "rdgy", "gist_gray", "set2", "cool", "afmhot_r", "bone_r", "paired", "oranges", "orrd", "puor", "autumn", "delta_r", "pubu_r", "piyg_r", "turbo", "greys_r", "accent", "turbid_r", "algae_r", "solar_r", "topo", "cool_r", "inferno", "balance", "tempo_r", "amp_r", "flag", "speed", "gist_heat", "balance_r", "viridis", "cubehelix_r", "ylorbr_r", "summer", "coolwarm_r", "diff_r", "rdylgn_r", "gist_stern_r", "plasma_r", "copper_r", "oxy", "gist_yarg", "twilight", "winter", "brbg", "reds_r", "speed_r", "rainbow", "ice", "nipy_spectral", "piyg", "gray", "reds", "terrain", "tab20_r", "wistia", "accent_r", "thermal", "ocean", "twilight_r", "hot_r", "set3_r", "hsv_r", "brg_r", "gist_rainbow_r", "phase", "bupu", "pastel1", "dense", "set1_r", "phase_r", "matter_r", "greens_r", "cfastie", "tab10_r", "rdbu", "brg", "rdpu_r", "brbg_r", "cmrmap_r", "prism_r", "purples_r", "gist_earth_r", "tempo", "schwarzwald", "rdpu", "orrd_r", "tarn", "puor_r", "bupu_r", "rdylgn", "ice_r", "pink", "terrain_r", "amp", "tab20b_r", "rdylbu_r", "hsv", "curl_r", "delta", "ylgnbu_r" ], "type": "string", "description": "ColorMap name", "title": "Colormapid" }, "description": "ColorMap name" }, { "name": "f", "in": "query", "required": false, "schema": { "anyOf": [ { "enum": [ "html", "json", "png", "npy", "tif", "tiff", "jpeg", "jpg", "jp2", "webp", "pngraw" ], "type": "string" }, { "type": "null" } ], "description": "Response MediaType. Defaults to endpoint's default or value defined in `accept` header.", "title": "F" }, "description": "Response MediaType. Defaults to endpoint's default or value defined in `accept` header." }, { "name": "orientation", "in": "query", "required": false, "schema": { "anyOf": [ { "enum": [ "vertical", "horizontal" ], "type": "string" }, { "type": "null" } ], "description": "Image Orientation.", "title": "Orientation" }, "description": "Image Orientation." }, { "name": "height", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "Image Height (default to 20px for horizontal or 256px for vertical).", "title": "Height" }, "description": "Image Height (default to 20px for horizontal or 256px for vertical)." }, { "name": "width", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "Image Width (default to 256px for horizontal or 20px for vertical).", "title": "Width" }, "description": "Image Width (default to 256px for horizontal or 20px for vertical)." } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "anyOf": [ { "type": "object", "additionalProperties": { "type": "array", "prefixItems": [ { "type": "integer" }, { "type": "integer" }, { "type": "integer" }, { "type": "integer" } ], "minItems": 4, "maxItems": 4 } }, { "type": "array", "items": { "type": "array", "prefixItems": [ { "type": "array", "prefixItems": [ { "anyOf": [ { "type": "number" }, { "type": "integer" } ] }, { "anyOf": [ { "type": "number" }, { "type": "integer" } ] } ], "minItems": 2, "maxItems": 2 }, { "type": "array", "prefixItems": [ { "type": "integer" }, { "type": "integer" }, { "type": "integer" }, { "type": "integer" } ], "minItems": 4, "maxItems": 4 } ], "minItems": 2, "maxItems": 2 } } ], "title": "Response Getcolormap" } }, "image/png": {}, "image/jpeg": {}, "image/jpg": {}, "image/webp": {}, "image/jp2": {}, "image/tiff; application=geotiff": {}, "application/x-binary": {}, "text/html": {} } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/healthz": { "get": { "tags": [ "Health Check" ], "summary": "Health Check.", "description": "Health Check.", "operationId": "healthCheck", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } } } } }, "/": { "get": { "tags": [ "OGC Common" ], "summary": "Landing", "description": "TiTiler landing page.", "operationId": "landing__get", "parameters": [ { "name": "f", "in": "query", "required": false, "schema": { "anyOf": [ { "enum": [ "html", "json" ], "type": "string" }, { "type": "null" } ], "description": "Response MediaType. Defaults to endpoint's default or value defined in `accept` header.", "title": "F" }, "description": "Response MediaType. Defaults to endpoint's default or value defined in `accept` header." } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Landing" } }, "text/html": {} } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/conformance": { "get": { "tags": [ "OGC Common" ], "summary": "Conformance", "description": "Conformance classes.\n\nCalled with `GET /conformance`.\n\nReturns:\n Conformance classes which the server conforms to.", "operationId": "conformance_conformance_get", "parameters": [ { "name": "f", "in": "query", "required": false, "schema": { "anyOf": [ { "enum": [ "html", "json" ], "type": "string" }, { "type": "null" } ], "description": "Response MediaType. Defaults to endpoint's default or value defined in `accept` header.", "title": "F" }, "description": "Response MediaType. Defaults to endpoint's default or value defined in `accept` header." } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Conformance" } }, "text/html": {} } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } } }, "components": { "schemas": { "AlgorithmMetadata": { "properties": { "title": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Title" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Description" }, "inputs": { "additionalProperties": true, "type": "object", "title": "Inputs" }, "outputs": { "additionalProperties": true, "type": "object", "title": "Outputs" }, "parameters": { "additionalProperties": true, "type": "object", "title": "Parameters" } }, "type": "object", "required": [ "inputs", "outputs", "parameters" ], "title": "AlgorithmMetadata", "description": "Algorithm metadata." }, "AlgorithmRef": { "properties": { "id": { "type": "string", "title": "Id" }, "title": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Title" }, "links": { "items": { "$ref": "#/components/schemas/Link" }, "type": "array", "title": "Links" } }, "type": "object", "required": [ "id", "links" ], "title": "AlgorithmRef", "description": "AlgorithmRef model." }, "AlgorithmtList": { "properties": { "algorithms": { "items": { "$ref": "#/components/schemas/AlgorithmRef" }, "type": "array", "title": "Algorithms" } }, "type": "object", "required": [ "algorithms" ], "title": "AlgorithmtList", "description": "AlgorithmList model." }, "AssetPoint": { "properties": { "name": { "type": "string", "title": "Name" }, "values": { "items": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "type": "array", "title": "Values" }, "band_names": { "items": { "type": "string" }, "type": "array", "title": "Band Names" }, "band_descriptions": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "title": "Band Descriptions" } }, "type": "object", "required": [ "name", "values", "band_names" ], "title": "AssetPoint", "description": "Model for Point value per asset" }, "BandMetadata": { "properties": { "Description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Description" }, "ColorInterp": { "type": "string", "title": "Colorinterp" }, "Offset": { "type": "number", "title": "Offset" }, "Scale": { "type": "number", "title": "Scale" }, "Metadata": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Metadata" } }, "type": "object", "required": [ "ColorInterp", "Offset", "Scale" ], "title": "BandMetadata", "description": "Band metadata." }, "BandStatistics": { "properties": { "min": { "type": "number", "title": "Min" }, "max": { "type": "number", "title": "Max" }, "mean": { "type": "number", "title": "Mean" }, "count": { "type": "number", "title": "Count" }, "sum": { "type": "number", "title": "Sum" }, "std": { "type": "number", "title": "Std" }, "median": { "type": "number", "title": "Median" }, "majority": { "type": "number", "title": "Majority" }, "minority": { "type": "number", "title": "Minority" }, "unique": { "type": "number", "title": "Unique" }, "histogram": { "items": { "items": { "anyOf": [ { "type": "number" }, { "type": "integer" } ] }, "type": "array" }, "type": "array", "title": "Histogram" }, "valid_percent": { "type": "number", "title": "Valid Percent" }, "masked_pixels": { "type": "number", "title": "Masked Pixels" }, "valid_pixels": { "type": "number", "title": "Valid Pixels" }, "description": { "type": "string", "title": "Description" } }, "additionalProperties": true, "type": "object", "required": [ "min", "max", "mean", "count", "sum", "std", "median", "majority", "minority", "unique", "histogram", "valid_percent", "masked_pixels", "valid_pixels", "description" ], "title": "BandStatistics", "description": "Band statistics" }, "BaseModel": { "properties": {}, "type": "object", "title": "BaseModel" }, "BoundingBox": { "properties": { "lowerLeft": { "items": { "type": "number" }, "type": "array", "maxItems": 2, "minItems": 2, "title": "Lowerleft", "description": "A 2D Point in the CRS indicated elsewhere" }, "upperRight": { "items": { "type": "number" }, "type": "array", "maxItems": 2, "minItems": 2, "title": "Upperright", "description": "A 2D Point in the CRS indicated elsewhere" }, "crs": { "anyOf": [ { "$ref": "#/components/schemas/CRS" }, { "type": "null" } ], "title": "CRS" }, "orderedAxes": { "anyOf": [ { "items": { "type": "string" }, "type": "array", "maxItems": 2, "minItems": 2 }, { "type": "null" } ], "title": "Orderedaxes" } }, "type": "object", "required": [ "lowerLeft", "upperRight" ], "title": "BoundingBox", "description": "BoundingBox model.\n\nRef: https://github.com/opengeospatial/ogcapi-tiles/blob/master/openapi/schemas/tms/2DBoundingBox.yaml\n\nCode generated using https://github.com/koxudaxi/datamodel-code-generator/" }, "CRS": { "anyOf": [ { "type": "string" }, { "$ref": "#/components/schemas/CRSUri" }, { "$ref": "#/components/schemas/CRSWKT" }, { "$ref": "#/components/schemas/CRSRef" } ], "title": "CRS", "description": "CRS model.\n\nRef: https://github.com/opengeospatial/ogcapi-tiles/blob/master/openapi/schemas/common-geodata/crs.yaml\n\nCode generated using https://github.com/koxudaxi/datamodel-code-generator/" }, "CRSRef": { "properties": { "referenceSystem": { "additionalProperties": true, "type": "object", "title": "Referencesystem", "description": "A reference system data structure as defined in the MD_ReferenceSystem of the ISO 19115" } }, "type": "object", "required": [ "referenceSystem" ], "title": "CRSRef", "description": "CRS from referenceSystem." }, "CRSUri": { "properties": { "uri": { "type": "string", "minLength": 1, "format": "uri", "title": "Uri", "description": "Reference to one coordinate reference system (CRS) as URI", "exemples": [ "http://www.opengis.net/def/crs/EPSG/0/3978", "urn:ogc:def:crs:EPSG::2193" ] } }, "type": "object", "required": [ "uri" ], "title": "CRSUri", "description": "Coordinate Reference System (CRS) from URI." }, "CRSWKT": { "properties": { "wkt": { "additionalProperties": true, "type": "object", "title": "Wkt", "description": "An object defining the CRS using the JSON encoding for Well-known text representation of coordinate reference systems 2.0" } }, "type": "object", "required": [ "wkt" ], "title": "CRSWKT", "description": "Coordinate Reference System (CRS) from WKT encoded as PROJJSON Object." }, "ColorMapList": { "properties": { "colormaps": { "items": { "$ref": "#/components/schemas/ColorMapRef" }, "type": "array", "title": "Colormaps" } }, "type": "object", "required": [ "colormaps" ], "title": "ColorMapList", "description": "Model for colormap list." }, "ColorMapRef": { "properties": { "id": { "type": "string", "title": "Id" }, "title": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Title" }, "links": { "items": { "$ref": "#/components/schemas/Link" }, "type": "array", "title": "Links" } }, "type": "object", "required": [ "id", "links" ], "title": "ColorMapRef", "description": "ColorMapRef model." }, "Conformance": { "properties": { "conformsTo": { "items": { "type": "string" }, "type": "array", "title": "Conformsto" } }, "type": "object", "required": [ "conformsTo" ], "title": "Conformance", "description": "Conformance model.\n\nRef: http://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/schemas/confClasses.yaml" }, "Feature-Input": { "properties": { "bbox": { "anyOf": [ { "prefixItems": [ { "type": "number" }, { "type": "number" }, { "type": "number" }, { "type": "number" } ], "type": "array", "maxItems": 4, "minItems": 4 }, { "prefixItems": [ { "type": "number" }, { "type": "number" }, { "type": "number" }, { "type": "number" }, { "type": "number" }, { "type": "number" } ], "type": "array", "maxItems": 6, "minItems": 6 }, { "type": "null" } ], "title": "Bbox" }, "type": { "type": "string", "const": "Feature", "title": "Type" }, "geometry": { "anyOf": [ { "oneOf": [ { "$ref": "#/components/schemas/Point-Input" }, { "$ref": "#/components/schemas/MultiPoint" }, { "$ref": "#/components/schemas/LineString" }, { "$ref": "#/components/schemas/MultiLineString" }, { "$ref": "#/components/schemas/Polygon" }, { "$ref": "#/components/schemas/MultiPolygon" }, { "$ref": "#/components/schemas/GeometryCollection-Input" } ], "discriminator": { "propertyName": "type", "mapping": { "GeometryCollection": "#/components/schemas/GeometryCollection-Input", "LineString": "#/components/schemas/LineString", "MultiLineString": "#/components/schemas/MultiLineString", "MultiPoint": "#/components/schemas/MultiPoint", "MultiPolygon": "#/components/schemas/MultiPolygon", "Point": "#/components/schemas/Point-Input", "Polygon": "#/components/schemas/Polygon" } } }, { "type": "null" } ], "title": "Geometry" }, "properties": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "$ref": "#/components/schemas/BaseModel" }, { "type": "null" } ], "title": "Properties" }, "id": { "anyOf": [ { "type": "integer" }, { "type": "string" }, { "type": "null" } ], "title": "Id" } }, "type": "object", "required": [ "type", "geometry", "properties" ], "title": "Feature", "description": "Feature Model" }, "Feature-Output": { "properties": { "bbox": { "anyOf": [ { "prefixItems": [ { "type": "number" }, { "type": "number" }, { "type": "number" }, { "type": "number" } ], "type": "array", "maxItems": 4, "minItems": 4 }, { "prefixItems": [ { "type": "number" }, { "type": "number" }, { "type": "number" }, { "type": "number" }, { "type": "number" }, { "type": "number" } ], "type": "array", "maxItems": 6, "minItems": 6 }, { "type": "null" } ], "title": "Bbox" }, "type": { "type": "string", "const": "Feature", "title": "Type" }, "geometry": { "anyOf": [ { "oneOf": [ { "$ref": "#/components/schemas/geojson_pydantic__geometries__Point" }, { "$ref": "#/components/schemas/MultiPoint" }, { "$ref": "#/components/schemas/LineString" }, { "$ref": "#/components/schemas/MultiLineString" }, { "$ref": "#/components/schemas/Polygon" }, { "$ref": "#/components/schemas/MultiPolygon" }, { "$ref": "#/components/schemas/GeometryCollection-Output" } ], "discriminator": { "propertyName": "type", "mapping": { "GeometryCollection": "#/components/schemas/GeometryCollection-Output", "LineString": "#/components/schemas/LineString", "MultiLineString": "#/components/schemas/MultiLineString", "MultiPoint": "#/components/schemas/MultiPoint", "MultiPolygon": "#/components/schemas/MultiPolygon", "Point": "#/components/schemas/geojson_pydantic__geometries__Point", "Polygon": "#/components/schemas/Polygon" } } }, { "type": "null" } ], "title": "Geometry" }, "properties": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "$ref": "#/components/schemas/BaseModel" }, { "type": "null" } ], "title": "Properties" }, "id": { "anyOf": [ { "type": "integer" }, { "type": "string" }, { "type": "null" } ], "title": "Id" } }, "type": "object", "required": [ "type", "geometry", "properties" ], "title": "Feature", "description": "Feature Model" }, "FeatureCollection": { "properties": { "bbox": { "anyOf": [ { "prefixItems": [ { "type": "number" }, { "type": "number" }, { "type": "number" }, { "type": "number" } ], "type": "array", "maxItems": 4, "minItems": 4 }, { "prefixItems": [ { "type": "number" }, { "type": "number" }, { "type": "number" }, { "type": "number" }, { "type": "number" }, { "type": "number" } ], "type": "array", "maxItems": 6, "minItems": 6 }, { "type": "null" } ], "title": "Bbox" }, "type": { "type": "string", "const": "FeatureCollection", "title": "Type" }, "features": { "items": { "$ref": "#/components/schemas/Feature-Input" }, "type": "array", "title": "Features" } }, "type": "object", "required": [ "type", "features" ], "title": "FeatureCollection", "description": "FeatureCollection Model" }, "FeatureCollection_Feature_Annotated_Union_Point__MultiPoint__LineString__MultiLineString__Polygon__MultiPolygon__GeometryCollection___FieldInfo_annotation_NoneType__required_True__discriminator__type_____StatisticsInGeoJSON__": { "properties": { "bbox": { "anyOf": [ { "prefixItems": [ { "type": "number" }, { "type": "number" }, { "type": "number" }, { "type": "number" } ], "type": "array", "maxItems": 4, "minItems": 4 }, { "prefixItems": [ { "type": "number" }, { "type": "number" }, { "type": "number" }, { "type": "number" }, { "type": "number" }, { "type": "number" } ], "type": "array", "maxItems": 6, "minItems": 6 }, { "type": "null" } ], "title": "Bbox" }, "type": { "type": "string", "const": "FeatureCollection", "title": "Type" }, "features": { "items": { "$ref": "#/components/schemas/Feature_Annotated_Union_Point__MultiPoint__LineString__MultiLineString__Polygon__MultiPolygon__GeometryCollection___FieldInfo_annotation_NoneType__required_True__discriminator__type____StatisticsInGeoJSON_" }, "type": "array", "title": "Features" } }, "type": "object", "required": [ "type", "features" ], "title": "FeatureCollection[Feature[Annotated[Union[Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection], FieldInfo(annotation=NoneType, required=True, discriminator='type')], StatisticsInGeoJSON]]" }, "Feature_Annotated_Union_Point__MultiPoint__LineString__MultiLineString__Polygon__MultiPolygon__GeometryCollection___FieldInfo_annotation_NoneType__required_True__discriminator__type____StatisticsInGeoJSON_": { "properties": { "bbox": { "anyOf": [ { "prefixItems": [ { "type": "number" }, { "type": "number" }, { "type": "number" }, { "type": "number" } ], "type": "array", "maxItems": 4, "minItems": 4 }, { "prefixItems": [ { "type": "number" }, { "type": "number" }, { "type": "number" }, { "type": "number" }, { "type": "number" }, { "type": "number" } ], "type": "array", "maxItems": 6, "minItems": 6 }, { "type": "null" } ], "title": "Bbox" }, "type": { "type": "string", "const": "Feature", "title": "Type" }, "geometry": { "anyOf": [ { "oneOf": [ { "$ref": "#/components/schemas/geojson_pydantic__geometries__Point" }, { "$ref": "#/components/schemas/MultiPoint" }, { "$ref": "#/components/schemas/LineString" }, { "$ref": "#/components/schemas/MultiLineString" }, { "$ref": "#/components/schemas/Polygon" }, { "$ref": "#/components/schemas/MultiPolygon" }, { "$ref": "#/components/schemas/GeometryCollection-Output" } ], "discriminator": { "propertyName": "type", "mapping": { "GeometryCollection": "#/components/schemas/GeometryCollection-Output", "LineString": "#/components/schemas/LineString", "MultiLineString": "#/components/schemas/MultiLineString", "MultiPoint": "#/components/schemas/MultiPoint", "MultiPolygon": "#/components/schemas/MultiPolygon", "Point": "#/components/schemas/geojson_pydantic__geometries__Point", "Polygon": "#/components/schemas/Polygon" } } }, { "type": "null" } ], "title": "Geometry" }, "properties": { "anyOf": [ { "$ref": "#/components/schemas/StatisticsInGeoJSON" }, { "type": "null" } ] }, "id": { "anyOf": [ { "type": "integer" }, { "type": "string" }, { "type": "null" } ], "title": "Id" } }, "type": "object", "required": [ "type", "geometry", "properties" ], "title": "Feature[Annotated[Union[Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection], FieldInfo(annotation=NoneType, required=True, discriminator='type')], StatisticsInGeoJSON]" }, "Feature_Polygon_MosaicInfo_": { "properties": { "bbox": { "anyOf": [ { "prefixItems": [ { "type": "number" }, { "type": "number" }, { "type": "number" }, { "type": "number" } ], "type": "array", "maxItems": 4, "minItems": 4 }, { "prefixItems": [ { "type": "number" }, { "type": "number" }, { "type": "number" }, { "type": "number" }, { "type": "number" }, { "type": "number" } ], "type": "array", "maxItems": 6, "minItems": 6 }, { "type": "null" } ], "title": "Bbox" }, "type": { "type": "string", "const": "Feature", "title": "Type" }, "geometry": { "anyOf": [ { "$ref": "#/components/schemas/Polygon" }, { "type": "null" } ] }, "properties": { "anyOf": [ { "$ref": "#/components/schemas/MosaicInfo" }, { "type": "null" } ] }, "id": { "anyOf": [ { "type": "integer" }, { "type": "string" }, { "type": "null" } ], "title": "Id" } }, "type": "object", "required": [ "type", "geometry", "properties" ], "title": "Feature[Polygon, MosaicInfo]" }, "Feature_Union_Polygon__MultiPolygon__Info_": { "properties": { "bbox": { "anyOf": [ { "prefixItems": [ { "type": "number" }, { "type": "number" }, { "type": "number" }, { "type": "number" } ], "type": "array", "maxItems": 4, "minItems": 4 }, { "prefixItems": [ { "type": "number" }, { "type": "number" }, { "type": "number" }, { "type": "number" }, { "type": "number" }, { "type": "number" } ], "type": "array", "maxItems": 6, "minItems": 6 }, { "type": "null" } ], "title": "Bbox" }, "type": { "type": "string", "const": "Feature", "title": "Type" }, "geometry": { "anyOf": [ { "$ref": "#/components/schemas/Polygon" }, { "$ref": "#/components/schemas/MultiPolygon" }, { "type": "null" } ], "title": "Geometry" }, "properties": { "anyOf": [ { "$ref": "#/components/schemas/rio_tiler__models__Info" }, { "type": "null" } ] }, "id": { "anyOf": [ { "type": "integer" }, { "type": "string" }, { "type": "null" } ], "title": "Id" } }, "type": "object", "required": [ "type", "geometry", "properties" ], "title": "Feature[Union[Polygon, MultiPolygon], Info]" }, "Feature_Union_Polygon__MultiPolygon__dict_str__Info__": { "properties": { "bbox": { "anyOf": [ { "prefixItems": [ { "type": "number" }, { "type": "number" }, { "type": "number" }, { "type": "number" } ], "type": "array", "maxItems": 4, "minItems": 4 }, { "prefixItems": [ { "type": "number" }, { "type": "number" }, { "type": "number" }, { "type": "number" }, { "type": "number" }, { "type": "number" } ], "type": "array", "maxItems": 6, "minItems": 6 }, { "type": "null" } ], "title": "Bbox" }, "type": { "type": "string", "const": "Feature", "title": "Type" }, "geometry": { "anyOf": [ { "$ref": "#/components/schemas/Polygon" }, { "$ref": "#/components/schemas/MultiPolygon" }, { "type": "null" } ], "title": "Geometry" }, "properties": { "anyOf": [ { "additionalProperties": { "$ref": "#/components/schemas/rio_tiler__models__Info" }, "type": "object" }, { "type": "null" } ], "title": "Properties" }, "id": { "anyOf": [ { "type": "integer" }, { "type": "string" }, { "type": "null" } ], "title": "Id" } }, "type": "object", "required": [ "type", "geometry", "properties" ], "title": "Feature[Union[Polygon, MultiPolygon], dict[str, Info]]" }, "Geo": { "properties": { "CRS": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Crs" }, "BoundingBox": { "prefixItems": [ { "type": "number" }, { "type": "number" }, { "type": "number" }, { "type": "number" } ], "type": "array", "maxItems": 4, "minItems": 4, "title": "Boundingbox" }, "Origin": { "prefixItems": [ { "type": "number" }, { "type": "number" } ], "type": "array", "maxItems": 2, "minItems": 2, "title": "Origin" }, "Resolution": { "prefixItems": [ { "type": "number" }, { "type": "number" } ], "type": "array", "maxItems": 2, "minItems": 2, "title": "Resolution" }, "MinZoom": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Minzoom" }, "MaxZoom": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Maxzoom" } }, "type": "object", "required": [ "BoundingBox", "Origin", "Resolution" ], "title": "Geo", "description": "rio-cogeo validation GEO information." }, "GeometryCollection-Input": { "properties": { "bbox": { "anyOf": [ { "prefixItems": [ { "type": "number" }, { "type": "number" }, { "type": "number" }, { "type": "number" } ], "type": "array", "maxItems": 4, "minItems": 4 }, { "prefixItems": [ { "type": "number" }, { "type": "number" }, { "type": "number" }, { "type": "number" }, { "type": "number" }, { "type": "number" } ], "type": "array", "maxItems": 6, "minItems": 6 }, { "type": "null" } ], "title": "Bbox" }, "type": { "type": "string", "const": "GeometryCollection", "title": "Type" }, "geometries": { "items": { "oneOf": [ { "$ref": "#/components/schemas/Point-Input" }, { "$ref": "#/components/schemas/MultiPoint" }, { "$ref": "#/components/schemas/LineString" }, { "$ref": "#/components/schemas/MultiLineString" }, { "$ref": "#/components/schemas/Polygon" }, { "$ref": "#/components/schemas/MultiPolygon" }, { "$ref": "#/components/schemas/GeometryCollection-Input" } ], "discriminator": { "propertyName": "type", "mapping": { "GeometryCollection": "#/components/schemas/GeometryCollection-Input", "LineString": "#/components/schemas/LineString", "MultiLineString": "#/components/schemas/MultiLineString", "MultiPoint": "#/components/schemas/MultiPoint", "MultiPolygon": "#/components/schemas/MultiPolygon", "Point": "#/components/schemas/Point-Input", "Polygon": "#/components/schemas/Polygon" } } }, "type": "array", "title": "Geometries" } }, "type": "object", "required": [ "type", "geometries" ], "title": "GeometryCollection", "description": "GeometryCollection Model" }, "GeometryCollection-Output": { "properties": { "bbox": { "anyOf": [ { "prefixItems": [ { "type": "number" }, { "type": "number" }, { "type": "number" }, { "type": "number" } ], "type": "array", "maxItems": 4, "minItems": 4 }, { "prefixItems": [ { "type": "number" }, { "type": "number" }, { "type": "number" }, { "type": "number" }, { "type": "number" }, { "type": "number" } ], "type": "array", "maxItems": 6, "minItems": 6 }, { "type": "null" } ], "title": "Bbox" }, "type": { "type": "string", "const": "GeometryCollection", "title": "Type" }, "geometries": { "items": { "oneOf": [ { "$ref": "#/components/schemas/geojson_pydantic__geometries__Point" }, { "$ref": "#/components/schemas/MultiPoint" }, { "$ref": "#/components/schemas/LineString" }, { "$ref": "#/components/schemas/MultiLineString" }, { "$ref": "#/components/schemas/Polygon" }, { "$ref": "#/components/schemas/MultiPolygon" }, { "$ref": "#/components/schemas/GeometryCollection-Output" } ], "discriminator": { "propertyName": "type", "mapping": { "GeometryCollection": "#/components/schemas/GeometryCollection-Output", "LineString": "#/components/schemas/LineString", "MultiLineString": "#/components/schemas/MultiLineString", "MultiPoint": "#/components/schemas/MultiPoint", "MultiPolygon": "#/components/schemas/MultiPolygon", "Point": "#/components/schemas/geojson_pydantic__geometries__Point", "Polygon": "#/components/schemas/Polygon" } } }, "type": "array", "title": "Geometries" } }, "type": "object", "required": [ "type", "geometries" ], "title": "GeometryCollection", "description": "GeometryCollection Model" }, "GeospatialData": { "properties": { "title": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Title", "description": "Title of this tile matrix set, normally used for display to a human" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Description", "description": "Brief narrative description of this tile matrix set, normally available for display to a human" }, "keywords": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Keywords", "description": "Unordered list of one or more commonly used or formalized word(s) or phrase(s) used to describe this layer" }, "id": { "type": "string", "title": "Id", "description": "Unique identifier of the Layer. Implementation of 'identifier'" }, "dataType": { "type": "string", "enum": [ "map", "vector", "coverage" ], "title": "Datatype", "description": "Type of data represented in the tileset" }, "geometryDimension": { "anyOf": [ { "type": "integer", "maximum": 3.0, "minimum": 0.0 }, { "type": "null" } ], "title": "Geometrydimension", "description": "The geometry dimension of the features shown in this layer (0: points, 1: curves, 2: surfaces, 3: solids), unspecified: mixed or unknown" }, "featureType": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Featuretype", "description": "Feature type identifier. Only applicable to layers of datatype 'geometries'" }, "attribution": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Attribution", "description": "Short reference to recognize the author or provider" }, "license": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "License", "description": "License applicable to the tiles" }, "pointOfContact": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Pointofcontact", "description": "Useful information to contact the authors or custodians for the layer (e.g. e-mail address, a physical address, phone numbers, etc)" }, "publisher": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Publisher", "description": "Organization or individual responsible for making the layer available" }, "theme": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Theme", "description": "Category where the layer can be grouped" }, "crs": { "anyOf": [ { "$ref": "#/components/schemas/CRS" }, { "type": "null" } ], "title": "CRS" }, "epoch": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Epoch", "description": "Epoch of the Coordinate Reference System (CRS)" }, "minScaleDenominator": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Minscaledenominator", "description": "Minimum scale denominator for usage of the layer" }, "maxScaleDenominator": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Maxscaledenominator", "description": "Maximum scale denominator for usage of the layer" }, "minCellSize": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Mincellsize", "description": "Minimum cell size for usage of the layer" }, "maxCellSize": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Maxcellsize", "description": "Maximum cell size for usage of the layer" }, "maxTileMatrix": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Maxtilematrix", "description": "TileMatrix identifier associated with the minScaleDenominator" }, "minTileMatrix": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Mintilematrix", "description": "TileMatrix identifier associated with the maxScaleDenominator" }, "boundingBox": { "anyOf": [ { "$ref": "#/components/schemas/BoundingBox" }, { "type": "null" } ] }, "created": { "anyOf": [ { "$ref": "#/components/schemas/TimeStamp" }, { "type": "null" } ] }, "updated": { "anyOf": [ { "$ref": "#/components/schemas/TimeStamp" }, { "type": "null" } ] }, "style": { "anyOf": [ { "$ref": "#/components/schemas/Style" }, { "type": "null" } ] }, "geoDataClasses": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "title": "Geodataclasses", "description": "URI identifying a class of data contained in this layer (useful to determine compatibility with styles or processes)" }, "propertiesSchema": { "anyOf": [ { "$ref": "#/components/schemas/PropertiesSchema" }, { "type": "null" } ] }, "links": { "anyOf": [ { "items": { "$ref": "#/components/schemas/Link" }, "type": "array", "minItems": 1 }, { "type": "null" } ], "title": "Links", "description": "Links related to this layer. Possible link 'rel' values are: 'geodata' for a URL pointing to the collection of geospatial data." } }, "type": "object", "required": [ "id", "dataType" ], "title": "GeospatialData", "description": "Geospatial model.\n\nRef: https://github.com/opengeospatial/ogcapi-tiles/blob/master/openapi/schemas/tms/geospatialData.yaml\n\nCode generated using https://github.com/koxudaxi/datamodel-code-generator/" }, "HTTPValidationError": { "properties": { "detail": { "items": { "$ref": "#/components/schemas/ValidationError" }, "type": "array", "title": "Detail" } }, "type": "object", "title": "HTTPValidationError" }, "IFD": { "properties": { "Level": { "type": "integer", "title": "Level" }, "Width": { "type": "integer", "title": "Width" }, "Height": { "type": "integer", "title": "Height" }, "Blocksize": { "prefixItems": [ { "type": "integer" }, { "type": "integer" } ], "type": "array", "maxItems": 2, "minItems": 2, "title": "Blocksize" }, "Decimation": { "type": "integer", "title": "Decimation" } }, "type": "object", "required": [ "Level", "Width", "Height", "Blocksize", "Decimation" ], "title": "IFD", "description": "ImageFileDirectory info." }, "ImageType": { "type": "string", "enum": [ "png", "npy", "tif", "tiff", "jpeg", "jpg", "jp2", "webp", "pngraw" ], "title": "ImageType", "description": "Available Output image type." }, "Item": { "properties": { "type": { "type": "string", "title": "Type" }, "stac_version": { "type": "string", "title": "Stac Version" }, "stac_extensions": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "title": "Stac Extensions" }, "id": { "type": "string", "title": "Id" }, "geometry": { "additionalProperties": true, "type": "object", "title": "Geometry" }, "bbox": { "items": { "type": "number" }, "type": "array", "title": "Bbox" }, "properties": { "additionalProperties": true, "type": "object", "title": "Properties" }, "links": { "items": { "additionalProperties": true, "type": "object" }, "type": "array", "title": "Links" }, "assets": { "additionalProperties": true, "type": "object", "title": "Assets" }, "collection": { "type": "string", "title": "Collection" } }, "type": "object", "title": "Item", "description": "STAC Item." }, "Landing": { "properties": { "title": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Title" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Description" }, "links": { "items": { "$ref": "#/components/schemas/Link" }, "type": "array", "title": "Links" } }, "type": "object", "required": [ "links" ], "title": "Landing", "description": "Landing page model.\n\nRef: http://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/schemas/landingPage.yaml" }, "LayerJSON": { "properties": { "id": { "type": "string", "title": "Id" }, "fields": { "additionalProperties": true, "type": "object", "title": "Fields" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Description" }, "minzoom": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Minzoom" }, "maxzoom": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Maxzoom" } }, "type": "object", "required": [ "id" ], "title": "LayerJSON", "description": "https://github.com/mapbox/tilejson-spec/tree/master/3.0.0#33-vector_layers" }, "LineString": { "properties": { "bbox": { "anyOf": [ { "prefixItems": [ { "type": "number" }, { "type": "number" }, { "type": "number" }, { "type": "number" } ], "type": "array", "maxItems": 4, "minItems": 4 }, { "prefixItems": [ { "type": "number" }, { "type": "number" }, { "type": "number" }, { "type": "number" }, { "type": "number" }, { "type": "number" } ], "type": "array", "maxItems": 6, "minItems": 6 }, { "type": "null" } ], "title": "Bbox" }, "type": { "type": "string", "const": "LineString", "title": "Type" }, "coordinates": { "items": { "anyOf": [ { "$ref": "#/components/schemas/Position2D" }, { "$ref": "#/components/schemas/Position3D" } ] }, "type": "array", "minItems": 2, "title": "Coordinates" } }, "type": "object", "required": [ "type", "coordinates" ], "title": "LineString", "description": "LineString Model" }, "Link": { "properties": { "href": { "type": "string", "minLength": 1, "format": "uri", "title": "Href", "description": "Supplies the URI to a remote resource (or resource fragment).", "examples": [ "http://data.example.com/buildings/123" ] }, "rel": { "type": "string", "title": "Rel", "description": "The type or semantics of the relation.", "examples": [ "alternate" ] }, "type": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Type", "description": "A hint indicating what the media type of the result of dereferencing the link should be.", "examples": [ "application/geo+json" ] }, "templated": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Templated", "description": "This flag set to true if the link is a URL template." }, "varBase": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Varbase", "description": "A base path to retrieve semantic information about the variables used in URL template.", "examples": [ "/ogcapi/vars/" ] }, "hreflang": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Hreflang", "description": "A hint indicating what the language of the result of dereferencing the link should be.", "examples": [ "en" ] }, "title": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Title", "description": "Used to label the destination of a link such that it can be used as a human-readable identifier.", "examples": [ "Trierer Strasse 70, 53115 Bonn" ] }, "length": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Length" } }, "type": "object", "required": [ "href", "rel" ], "title": "Link", "description": "Link model.\n\nRef: https://github.com/opengeospatial/ogcapi-tiles/blob/master/openapi/schemas/common-core/link.yaml\n\nCode generated using https://github.com/koxudaxi/datamodel-code-generator/" }, "MosaicInfo": { "properties": { "bounds": { "prefixItems": [ { "type": "number" }, { "type": "number" }, { "type": "number" }, { "type": "number" } ], "type": "array", "maxItems": 4, "minItems": 4, "title": "Bounds", "default": [ -180, -90, 180, 90 ] }, "crs": { "type": "string", "title": "Crs" } }, "additionalProperties": true, "type": "object", "required": [ "crs" ], "title": "MosaicInfo", "description": "Mosaic info responses." }, "MosaicJSON": { "properties": { "mosaicjson": { "type": "string", "title": "Mosaicjson" }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Name" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Description" }, "version": { "type": "string", "title": "Version", "default": "1.0.0" }, "attribution": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Attribution" }, "minzoom": { "type": "integer", "maximum": 30.0, "minimum": 0.0, "title": "Minzoom", "default": 0 }, "maxzoom": { "type": "integer", "maximum": 30.0, "minimum": 0.0, "title": "Maxzoom", "default": 30 }, "quadkey_zoom": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Quadkey Zoom" }, "bounds": { "prefixItems": [ { "type": "number" }, { "type": "number" }, { "type": "number" }, { "type": "number" } ], "type": "array", "maxItems": 4, "minItems": 4, "title": "Bounds", "default": [ -180, -90, 180, 90 ] }, "center": { "anyOf": [ { "prefixItems": [ { "type": "number" }, { "type": "number" }, { "type": "integer" } ], "type": "array", "maxItems": 3, "minItems": 3 }, { "type": "null" } ], "title": "Center" }, "tiles": { "additionalProperties": { "items": { "type": "string" }, "type": "array" }, "type": "object", "title": "Tiles" }, "tilematrixset": { "anyOf": [ { "$ref": "#/components/schemas/TileMatrixSet" }, { "type": "null" } ] }, "asset_type": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Asset Type" }, "asset_prefix": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Asset Prefix" }, "data_type": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Data Type" }, "colormap": { "anyOf": [ { "additionalProperties": { "prefixItems": [ { "type": "integer" }, { "type": "integer" }, { "type": "integer" }, { "type": "integer" } ], "type": "array", "maxItems": 4, "minItems": 4 }, "type": "object" }, { "type": "null" } ], "title": "Colormap" }, "layers": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Layers" } }, "type": "object", "required": [ "mosaicjson", "tiles" ], "title": "MosaicJSON", "description": "MosaicJSON model.\n\nBased on https://github.com/developmentseed/mosaicjson-spec" }, "MultiLineString": { "properties": { "bbox": { "anyOf": [ { "prefixItems": [ { "type": "number" }, { "type": "number" }, { "type": "number" }, { "type": "number" } ], "type": "array", "maxItems": 4, "minItems": 4 }, { "prefixItems": [ { "type": "number" }, { "type": "number" }, { "type": "number" }, { "type": "number" }, { "type": "number" }, { "type": "number" } ], "type": "array", "maxItems": 6, "minItems": 6 }, { "type": "null" } ], "title": "Bbox" }, "type": { "type": "string", "const": "MultiLineString", "title": "Type" }, "coordinates": { "items": { "items": { "anyOf": [ { "$ref": "#/components/schemas/Position2D" }, { "$ref": "#/components/schemas/Position3D" } ] }, "type": "array", "minItems": 2 }, "type": "array", "title": "Coordinates" } }, "type": "object", "required": [ "type", "coordinates" ], "title": "MultiLineString", "description": "MultiLineString Model" }, "MultiPoint": { "properties": { "bbox": { "anyOf": [ { "prefixItems": [ { "type": "number" }, { "type": "number" }, { "type": "number" }, { "type": "number" } ], "type": "array", "maxItems": 4, "minItems": 4 }, { "prefixItems": [ { "type": "number" }, { "type": "number" }, { "type": "number" }, { "type": "number" }, { "type": "number" }, { "type": "number" } ], "type": "array", "maxItems": 6, "minItems": 6 }, { "type": "null" } ], "title": "Bbox" }, "type": { "type": "string", "const": "MultiPoint", "title": "Type" }, "coordinates": { "items": { "anyOf": [ { "$ref": "#/components/schemas/Position2D" }, { "$ref": "#/components/schemas/Position3D" } ] }, "type": "array", "title": "Coordinates" } }, "type": "object", "required": [ "type", "coordinates" ], "title": "MultiPoint", "description": "MultiPoint Model" }, "MultiPolygon": { "properties": { "bbox": { "anyOf": [ { "prefixItems": [ { "type": "number" }, { "type": "number" }, { "type": "number" }, { "type": "number" } ], "type": "array", "maxItems": 4, "minItems": 4 }, { "prefixItems": [ { "type": "number" }, { "type": "number" }, { "type": "number" }, { "type": "number" }, { "type": "number" }, { "type": "number" } ], "type": "array", "maxItems": 6, "minItems": 6 }, { "type": "null" } ], "title": "Bbox" }, "type": { "type": "string", "const": "MultiPolygon", "title": "Type" }, "coordinates": { "items": { "items": { "items": { "anyOf": [ { "$ref": "#/components/schemas/Position2D" }, { "$ref": "#/components/schemas/Position3D" } ] }, "type": "array", "minItems": 4 }, "type": "array" }, "type": "array", "title": "Coordinates" } }, "type": "object", "required": [ "type", "coordinates" ], "title": "MultiPolygon", "description": "MultiPolygon Model" }, "Point-Input": { "properties": { "bbox": { "anyOf": [ { "prefixItems": [ { "type": "number" }, { "type": "number" }, { "type": "number" }, { "type": "number" } ], "type": "array", "maxItems": 4, "minItems": 4 }, { "prefixItems": [ { "type": "number" }, { "type": "number" }, { "type": "number" }, { "type": "number" }, { "type": "number" }, { "type": "number" } ], "type": "array", "maxItems": 6, "minItems": 6 }, { "type": "null" } ], "title": "Bbox" }, "type": { "type": "string", "const": "Point", "title": "Type" }, "coordinates": { "anyOf": [ { "$ref": "#/components/schemas/Position2D" }, { "$ref": "#/components/schemas/Position3D" } ], "title": "Coordinates" } }, "type": "object", "required": [ "type", "coordinates" ], "title": "Point", "description": "Point Model" }, "Polygon": { "properties": { "bbox": { "anyOf": [ { "prefixItems": [ { "type": "number" }, { "type": "number" }, { "type": "number" }, { "type": "number" } ], "type": "array", "maxItems": 4, "minItems": 4 }, { "prefixItems": [ { "type": "number" }, { "type": "number" }, { "type": "number" }, { "type": "number" }, { "type": "number" }, { "type": "number" } ], "type": "array", "maxItems": 6, "minItems": 6 }, { "type": "null" } ], "title": "Bbox" }, "type": { "type": "string", "const": "Polygon", "title": "Type" }, "coordinates": { "items": { "items": { "anyOf": [ { "$ref": "#/components/schemas/Position2D" }, { "$ref": "#/components/schemas/Position3D" } ] }, "type": "array", "minItems": 4 }, "type": "array", "title": "Coordinates" } }, "type": "object", "required": [ "type", "coordinates" ], "title": "Polygon", "description": "Polygon Model" }, "Position2D": { "prefixItems": [ { "type": "number", "title": "Longitude" }, { "type": "number", "title": "Latitude" } ], "type": "array", "maxItems": 2, "minItems": 2 }, "Position3D": { "prefixItems": [ { "type": "number", "title": "Longitude" }, { "type": "number", "title": "Latitude" }, { "type": "number", "title": "Altitude" } ], "type": "array", "maxItems": 3, "minItems": 3 }, "Profile": { "properties": { "Bands": { "type": "integer", "title": "Bands" }, "Width": { "type": "integer", "title": "Width" }, "Height": { "type": "integer", "title": "Height" }, "Tiled": { "type": "boolean", "title": "Tiled" }, "Dtype": { "type": "string", "title": "Dtype" }, "Interleave": { "type": "string", "title": "Interleave" }, "AlphaBand": { "type": "boolean", "title": "Alphaband" }, "InternalMask": { "type": "boolean", "title": "Internalmask" }, "Nodata": { "title": "Nodata" }, "ColorInterp": { "items": { "type": "string" }, "type": "array", "title": "Colorinterp" }, "ColorMap": { "type": "boolean", "title": "Colormap" }, "Scales": { "items": { "type": "number" }, "type": "array", "title": "Scales" }, "Offsets": { "items": { "type": "number" }, "type": "array", "title": "Offsets" } }, "type": "object", "required": [ "Bands", "Width", "Height", "Tiled", "Dtype", "Interleave", "AlphaBand", "InternalMask", "ColorInterp", "ColorMap", "Scales", "Offsets" ], "title": "Profile", "description": "rio-cogeo validation Profile information." }, "Properties": { "properties": { "title": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Title" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Description", "description": "Implements 'description'" }, "type": { "anyOf": [ { "type": "string", "enum": [ "array", "boolean", "integer", "null", "number", "object", "string" ] }, { "type": "null" } ], "title": "Type" }, "enum": { "anyOf": [ { "items": {}, "type": "array", "minItems": 1, "uniqueItems": true }, { "type": "null" } ], "title": "Enum", "description": "Implements 'acceptedValues'" }, "format": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Format", "description": "Complements implementation of 'type'" }, "contentMediaType": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Contentmediatype", "description": "Implements 'mediaType'" }, "maximum": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Maximum", "description": "Implements 'range'" }, "exclusiveMaximum": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Exclusivemaximum", "description": "Implements 'range'" }, "minimum": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Minimum", "description": "Implements 'range'" }, "exclusiveMinimum": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Exclusiveminimum", "description": "Implements 'range'" }, "pattern": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Pattern" }, "maxItems": { "anyOf": [ { "type": "integer", "minimum": 0.0 }, { "type": "null" } ], "title": "Maxitems", "description": "Implements 'upperMultiplicity'" }, "minItems": { "anyOf": [ { "type": "integer", "minimum": 0.0 }, { "type": "null" } ], "title": "Minitems", "description": "Implements 'lowerMultiplicity'", "default": 0 }, "observedProperty": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Observedproperty" }, "observedPropertyURI": { "anyOf": [ { "type": "string", "minLength": 1, "format": "uri" }, { "type": "null" } ], "title": "Observedpropertyuri" }, "uom": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Uom" }, "uomURI": { "anyOf": [ { "type": "string", "minLength": 1, "format": "uri" }, { "type": "null" } ], "title": "Uomuri" } }, "type": "object", "title": "Properties", "description": "Properties model.\n\nRef: https://github.com/opengeospatial/ogcapi-tiles/blob/master/openapi/schemas/tms/propertiesSchema.yaml\n\nCode generated using https://github.com/koxudaxi/datamodel-code-generator/" }, "PropertiesSchema": { "properties": { "type": { "type": "string", "const": "object", "title": "Type" }, "required": { "anyOf": [ { "items": { "type": "string" }, "type": "array", "minItems": 1 }, { "type": "null" } ], "title": "Required", "description": "Implements 'multiplicity' by citing property 'name' defined as 'additionalProperties'" }, "properties": { "additionalProperties": { "$ref": "#/components/schemas/Properties" }, "type": "object", "title": "Properties" } }, "type": "object", "required": [ "type", "properties" ], "title": "PropertiesSchema", "description": "PropertiesSchema model.\n\nRef: https://github.com/opengeospatial/ogcapi-tiles/blob/master/openapi/schemas/tms/propertiesSchema.yaml\n\nCode generated using https://github.com/koxudaxi/datamodel-code-generator/" }, "RenderItem": { "properties": { "title": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Title" }, "assets": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "title": "Assets" }, "expression": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Expression" }, "rescale": { "anyOf": [ { "items": { "items": { "type": "number" }, "type": "array" }, "type": "array" }, { "type": "null" } ], "title": "Rescale" }, "nodata": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Nodata" }, "colormap_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Colormap Name" }, "colormap": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Colormap" }, "color_formula": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Color Formula" }, "resampling": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Resampling" }, "minmax_zoom": { "anyOf": [ { "items": { "type": "integer" }, "type": "array" }, { "type": "null" } ], "title": "Minmax Zoom" } }, "additionalProperties": true, "type": "object", "title": "RenderItem", "description": "Render item for stac render extension." }, "RenderItemList": { "properties": { "renders": { "additionalProperties": { "$ref": "#/components/schemas/RenderItemWithLinks" }, "type": "object", "title": "Renders" }, "links": { "items": { "$ref": "#/components/schemas/Link" }, "type": "array", "title": "Links" } }, "type": "object", "required": [ "renders", "links" ], "title": "RenderItemList", "description": "List of Render Items with links." }, "RenderItemWithLinks": { "properties": { "valid": { "type": "boolean", "title": "Valid" }, "params": { "$ref": "#/components/schemas/RenderItem" }, "links": { "items": { "$ref": "#/components/schemas/Link" }, "type": "array", "title": "Links" } }, "type": "object", "required": [ "valid", "params", "links" ], "title": "RenderItemWithLinks", "description": "Same as RenderItem with url and params." }, "StatisticsInGeoJSON": { "properties": { "statistics": { "additionalProperties": { "$ref": "#/components/schemas/BandStatistics" }, "type": "object", "title": "Statistics" } }, "additionalProperties": true, "type": "object", "required": [ "statistics" ], "title": "StatisticsInGeoJSON", "description": "Statistics model in geojson response." }, "Style": { "properties": { "id": { "type": "string", "title": "Id", "description": "An identifier for this style. Implementation of 'identifier'" }, "title": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Title", "description": "A title for this style" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Description", "description": "Brief narrative description of this style" }, "keywords": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "title": "Keywords", "description": "keywords about this style" }, "links": { "anyOf": [ { "items": { "$ref": "#/components/schemas/Link" }, "type": "array", "minItems": 1 }, { "type": "null" } ], "title": "Links", "description": "Links to style related resources. Possible link 'rel' values are: 'style' for a URL pointing to the style description, 'styleSpec' for a URL pointing to the specification or standard used to define the style." } }, "type": "object", "required": [ "id" ], "title": "Style", "description": "Style model.\n\nRef: https://github.com/opengeospatial/ogcapi-tiles/blob/master/openapi/schemas/tms/style.yaml\n\nCode generated using https://github.com/koxudaxi/datamodel-code-generator/" }, "TMSBoundingBox": { "properties": { "lowerLeft": { "prefixItems": [ { "anyOf": [ { "type": "number" }, { "type": "integer" } ] }, { "anyOf": [ { "type": "number" }, { "type": "integer" } ] } ], "type": "array", "maxItems": 2, "minItems": 2, "title": "Lowerleft", "description": "A 2D Point in the CRS indicated elsewhere" }, "upperRight": { "prefixItems": [ { "anyOf": [ { "type": "number" }, { "type": "integer" } ] }, { "anyOf": [ { "type": "number" }, { "type": "integer" } ] } ], "type": "array", "maxItems": 2, "minItems": 2, "title": "Upperright", "description": "A 2D Point in the CRS indicated elsewhere" }, "crs": { "anyOf": [ { "$ref": "#/components/schemas/CRS" }, { "type": "null" } ], "description": "Coordinate Reference System (CRS)" }, "orderedAxes": { "anyOf": [ { "items": { "type": "string" }, "type": "array", "maxItems": 2, "minItems": 2 }, { "type": "null" } ], "title": "Orderedaxes", "description": "Ordered list of names of the dimensions defined in the CRS" } }, "type": "object", "required": [ "lowerLeft", "upperRight" ], "title": "TMSBoundingBox", "description": "Bounding box\n\nref: https://github.com/opengeospatial/2D-Tile-Matrix-Set/blob/master/schemas/tms/2.0/json/2DBoundingBox.json" }, "TileJSON": { "properties": { "tilejson": { "type": "string", "title": "Tilejson", "default": "3.0.0" }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Name" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Description" }, "version": { "type": "string", "title": "Version", "default": "1.0.0" }, "attribution": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Attribution" }, "template": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Template" }, "legend": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Legend" }, "scheme": { "type": "string", "enum": [ "xyz", "tms" ], "title": "Scheme", "default": "xyz" }, "tiles": { "items": { "type": "string" }, "type": "array", "title": "Tiles" }, "vector_layers": { "anyOf": [ { "items": { "$ref": "#/components/schemas/LayerJSON" }, "type": "array" }, { "type": "null" } ], "title": "Vector Layers" }, "grids": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "title": "Grids" }, "data": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "title": "Data" }, "minzoom": { "type": "integer", "title": "Minzoom", "default": 0 }, "maxzoom": { "type": "integer", "title": "Maxzoom", "default": 30 }, "fillzoom": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Fillzoom" }, "bounds": { "items": { "type": "number" }, "type": "array", "title": "Bounds", "default": [ -180, -85.0511287798066, 180, 85.0511287798066 ] }, "center": { "anyOf": [ { "prefixItems": [ { "type": "number" }, { "type": "number" }, { "type": "integer" } ], "type": "array", "maxItems": 3, "minItems": 3 }, { "type": "null" } ], "title": "Center" } }, "additionalProperties": true, "type": "object", "required": [ "tiles" ], "title": "TileJSON", "description": "TileJSON model.\n\nBased on https://github.com/mapbox/tilejson-spec/tree/master/3.0.0" }, "TileMatrix": { "properties": { "title": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Title", "description": "Title of this tile matrix, normally used for display to a human" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Description", "description": "Brief narrative description of this tile matrix set, normally available for display to a human" }, "keywords": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "title": "Keywords", "description": "Unordered list of one or more commonly used or formalized word(s) or phrase(s) used to describe this dataset" }, "id": { "type": "string", "pattern": "^\\-?[0-9]+$", "title": "Id", "description": "Identifier selecting one of the scales defined in the TileMatrixSet and representing the scaleDenominator the tile. Implementation of 'identifier'" }, "scaleDenominator": { "type": "number", "title": "Scaledenominator", "description": "Scale denominator of this tile matrix" }, "cellSize": { "type": "number", "title": "Cellsize", "description": "Cell size of this tile matrix" }, "cornerOfOrigin": { "type": "string", "enum": [ "topLeft", "bottomLeft" ], "title": "Corneroforigin", "description": "The corner of the tile matrix (_topLeft_ or _bottomLeft_) used as the origin for numbering tile rows and columns. This corner is also a corner of the (0, 0) tile.", "default": "topLeft" }, "pointOfOrigin": { "prefixItems": [ { "anyOf": [ { "type": "number" }, { "type": "integer" } ] }, { "anyOf": [ { "type": "number" }, { "type": "integer" } ] } ], "type": "array", "maxItems": 2, "minItems": 2, "title": "Pointoforigin", "description": "Precise position in CRS coordinates of the corner of origin (e.g. the top-left corner) for this tile matrix. This position is also a corner of the (0, 0) tile. In previous version, this was 'topLeftCorner' and 'cornerOfOrigin' did not exist." }, "tileWidth": { "type": "integer", "multipleOf": 1.0, "minimum": 1.0, "title": "Tilewidth", "description": "Width of each tile of this tile matrix in pixels" }, "tileHeight": { "type": "integer", "multipleOf": 1.0, "minimum": 1.0, "title": "Tileheight", "description": "Height of each tile of this tile matrix in pixels" }, "matrixWidth": { "type": "integer", "multipleOf": 1.0, "minimum": 1.0, "title": "Matrixwidth", "description": "Width of the matrix (number of tiles in width)" }, "matrixHeight": { "type": "integer", "multipleOf": 1.0, "minimum": 1.0, "title": "Matrixheight", "description": "Height of the matrix (number of tiles in height)" }, "variableMatrixWidths": { "anyOf": [ { "items": { "$ref": "#/components/schemas/variableMatrixWidth" }, "type": "array" }, { "type": "null" } ], "title": "Variablematrixwidths", "description": "Describes the rows that has variable matrix width" } }, "additionalProperties": false, "type": "object", "required": [ "id", "scaleDenominator", "cellSize", "pointOfOrigin", "tileWidth", "tileHeight", "matrixWidth", "matrixHeight" ], "title": "TileMatrix", "description": "Tile Matrix Definition\n\nA tile matrix, usually corresponding to a particular zoom level of a TileMatrixSet.\n\nref: https://github.com/opengeospatial/2D-Tile-Matrix-Set/blob/master/schemas/tms/2.0/json/tileMatrix.json" }, "TileMatrixLimits": { "properties": { "tileMatrix": { "type": "string", "title": "Tilematrix" }, "minTileRow": { "type": "integer", "minimum": 0.0, "title": "Mintilerow" }, "maxTileRow": { "type": "integer", "minimum": 0.0, "title": "Maxtilerow" }, "minTileCol": { "type": "integer", "minimum": 0.0, "title": "Mintilecol" }, "maxTileCol": { "type": "integer", "minimum": 0.0, "title": "Maxtilecol" } }, "type": "object", "required": [ "tileMatrix", "minTileRow", "maxTileRow", "minTileCol", "maxTileCol" ], "title": "TileMatrixLimits", "description": "The limits for an individual tile matrix of a TileSet's TileMatrixSet, as defined in the OGC 2D TileMatrixSet and TileSet Metadata Standard\n\nBased on https://github.com/opengeospatial/ogcapi-tiles/blob/master/openapi/schemas/tms/tileMatrixLimits.yaml" }, "TileMatrixSet": { "properties": { "title": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Title", "description": "Title of this tile matrix set, normally used for display to a human" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Description", "description": "Brief narrative description of this tile matrix set, normally available for display to a human" }, "keywords": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "title": "Keywords", "description": "Unordered list of one or more commonly used or formalized word(s) or phrase(s) used to describe this tile matrix set" }, "id": { "anyOf": [ { "type": "string", "pattern": "^[\\w\\d_\\-]+$" }, { "type": "null" } ], "title": "Id", "description": "Tile matrix set identifier. Implementation of 'identifier'" }, "uri": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Uri", "description": "Reference to an official source for this tileMatrixSet" }, "orderedAxes": { "anyOf": [ { "items": { "type": "string" }, "type": "array", "maxItems": 2, "minItems": 2 }, { "type": "null" } ], "title": "Orderedaxes", "description": "Ordered list of names of the dimensions defined in the CRS" }, "crs": { "$ref": "#/components/schemas/CRS", "description": "Coordinate Reference System (CRS)" }, "wellKnownScaleSet": { "anyOf": [ { "type": "string", "minLength": 1, "format": "uri" }, { "type": "null" } ], "title": "Wellknownscaleset", "description": "Reference to a well-known scale set" }, "boundingBox": { "anyOf": [ { "$ref": "#/components/schemas/TMSBoundingBox" }, { "type": "null" } ], "description": "Minimum bounding rectangle surrounding the tile matrix set, in the supported CRS" }, "tileMatrices": { "items": { "$ref": "#/components/schemas/TileMatrix" }, "type": "array", "title": "Tilematrices", "description": "Describes scale levels and its tile matrices" } }, "type": "object", "required": [ "crs", "tileMatrices" ], "title": "TileMatrixSet", "description": "Tile Matrix Set Definition\n\nA definition of a tile matrix set following the Tile Matrix Set standard.\nFor tileset metadata, such a description (in `tileMatrixSet` property) is only required for offline use,\nas an alternative to a link with a `http://www.opengis.net/def/rel/ogc/1.0/tiling-scheme` relation type.\n\nref: https://github.com/opengeospatial/2D-Tile-Matrix-Set/blob/master/schemas/tms/2.0/json/tileMatrixSet.json" }, "TileMatrixSetList": { "properties": { "tileMatrixSets": { "items": { "$ref": "#/components/schemas/TileMatrixSetRef" }, "type": "array", "title": "Tilematrixsets" } }, "type": "object", "required": [ "tileMatrixSets" ], "title": "TileMatrixSetList", "description": "TileMatrixSetList model.\n\nBased on http://docs.opengeospatial.org/per/19-069.html#_tilematrixsets" }, "TileMatrixSetRef": { "properties": { "id": { "type": "string", "title": "Id" }, "title": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Title" }, "links": { "items": { "$ref": "#/components/schemas/Link" }, "type": "array", "title": "Links" } }, "type": "object", "required": [ "id", "links" ], "title": "TileMatrixSetRef", "description": "TileMatrixSetRef model.\n\nBased on http://docs.opengeospatial.org/per/19-069.html#_tilematrixsets" }, "TilePoint": { "properties": { "coordinates": { "items": { "type": "number" }, "type": "array", "maxItems": 2, "minItems": 2, "title": "Coordinates" }, "crs": { "anyOf": [ { "$ref": "#/components/schemas/CRS" }, { "type": "null" } ], "title": "CRS" }, "tileMatrix": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Tilematrix", "description": "TileMatrix identifier associated with the scaleDenominator" }, "scaleDenominator": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Scaledenominator", "description": "Scale denominator of the tile matrix selected" }, "cellSize": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Cellsize", "description": "Cell size of the tile matrix selected" } }, "type": "object", "required": [ "coordinates", "crs" ], "title": "TilePoint", "description": "TilePoint model.\n\nRef: https://github.com/opengeospatial/ogcapi-tiles/blob/master/openapi/schemas/tms/tilePoint.yaml\n\nCode generated using https://github.com/koxudaxi/datamodel-code-generator/" }, "TileSet": { "properties": { "title": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Title", "description": "A title for this tileset" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Description", "description": "Brief narrative description of this tile set" }, "dataType": { "type": "string", "enum": [ "map", "vector", "coverage" ], "title": "Datatype", "description": "Type of data represented in the tileset" }, "crs": { "$ref": "#/components/schemas/CRS" }, "tileMatrixSetURI": { "anyOf": [ { "type": "string", "minLength": 1, "format": "uri" }, { "type": "null" } ], "title": "Tilematrixseturi", "description": "Reference to a Tile Matrix Set on an official source for Tile Matrix Sets" }, "links": { "items": { "$ref": "#/components/schemas/Link" }, "type": "array", "title": "Links", "description": "Links to related resources" }, "tileMatrixSetLimits": { "anyOf": [ { "items": { "$ref": "#/components/schemas/TileMatrixLimits" }, "type": "array" }, { "type": "null" } ], "title": "Tilematrixsetlimits", "description": "Limits for the TileRow and TileCol values for each TileMatrix in the tileMatrixSet. If missing, there are no limits other that the ones imposed by the TileMatrixSet. If present the TileMatrices listed are limited and the rest not available at all" }, "epoch": { "anyOf": [ { "type": "number" }, { "type": "integer" }, { "type": "null" } ], "title": "Epoch", "description": "Epoch of the Coordinate Reference System (CRS)" }, "layers": { "anyOf": [ { "items": { "$ref": "#/components/schemas/GeospatialData" }, "type": "array", "minItems": 1 }, { "type": "null" } ], "title": "Layers" }, "boundingBox": { "anyOf": [ { "$ref": "#/components/schemas/BoundingBox" }, { "type": "null" } ] }, "centerPoint": { "anyOf": [ { "$ref": "#/components/schemas/TilePoint" }, { "type": "null" } ] }, "style": { "anyOf": [ { "$ref": "#/components/schemas/Style" }, { "type": "null" } ] }, "attribution": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Attribution", "description": "Short reference to recognize the author or provider" }, "license": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "License", "description": "License applicable to the tiles" }, "accessConstraints": { "anyOf": [ { "type": "string", "enum": [ "unclassified", "restricted", "confidential", "secret", "topSecret" ] }, { "type": "null" } ], "title": "Accessconstraints", "description": "Restrictions on the availability of the Tile Set that the user needs to be aware of before using or redistributing the Tile Set", "default": "unclassified" }, "keywords": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "title": "Keywords", "description": "keywords about this tileset" }, "version": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Version", "description": "Version of the Tile Set. Changes if the data behind the tiles has been changed" }, "created": { "anyOf": [ { "$ref": "#/components/schemas/TimeStamp" }, { "type": "null" } ] }, "updated": { "anyOf": [ { "$ref": "#/components/schemas/TimeStamp" }, { "type": "null" } ] }, "pointOfContact": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Pointofcontact", "description": "Useful information to contact the authors or custodians for the Tile Set" }, "mediaTypes": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "title": "Mediatypes", "description": "Media types available for the tiles" } }, "type": "object", "required": [ "dataType", "crs", "links" ], "title": "TileSet", "description": "TileSet model.\n\nBased on https://github.com/opengeospatial/ogcapi-tiles/blob/master/openapi/schemas/tms/tileSet.yaml" }, "TileSetList": { "properties": { "tilesets": { "items": { "$ref": "#/components/schemas/TileSet" }, "type": "array", "title": "Tilesets" } }, "type": "object", "required": [ "tilesets" ], "title": "TileSetList", "description": "TileSetList model.\n\nBased on https://docs.ogc.org/is/20-057/20-057.html#toc34" }, "TimeStamp": { "type": "string", "format": "date-time", "title": "TimeStamp", "description": "This property indicates the time and date when the response was generated using RFC 3339 notation.", "examples": [ "2017-08-17T08:05:32Z" ] }, "ValidationError": { "properties": { "loc": { "items": { "anyOf": [ { "type": "string" }, { "type": "integer" } ] }, "type": "array", "title": "Location" }, "msg": { "type": "string", "title": "Message" }, "type": { "type": "string", "title": "Error Type" }, "input": { "title": "Input" }, "ctx": { "type": "object", "title": "Context" } }, "type": "object", "required": [ "loc", "msg", "type" ], "title": "ValidationError" }, "ValidationInfo": { "properties": { "compatible_with_titiler": { "type": "boolean", "title": "Compatible With Titiler" }, "errors": { "items": { "type": "string" }, "type": "array", "title": "Errors" }, "warnings": { "items": { "type": "string" }, "type": "array", "title": "Warnings" } }, "type": "object", "required": [ "compatible_with_titiler", "errors", "warnings" ], "title": "ValidationInfo", "description": "Variable Validation model." }, "geojson_pydantic__geometries__Point": { "properties": { "bbox": { "anyOf": [ { "prefixItems": [ { "type": "number" }, { "type": "number" }, { "type": "number" }, { "type": "number" } ], "type": "array", "maxItems": 4, "minItems": 4 }, { "prefixItems": [ { "type": "number" }, { "type": "number" }, { "type": "number" }, { "type": "number" }, { "type": "number" }, { "type": "number" } ], "type": "array", "maxItems": 6, "minItems": 6 }, { "type": "null" } ], "title": "Bbox" }, "type": { "type": "string", "const": "Point", "title": "Type" }, "coordinates": { "anyOf": [ { "$ref": "#/components/schemas/Position2D" }, { "$ref": "#/components/schemas/Position3D" } ], "title": "Coordinates" } }, "type": "object", "required": [ "type", "coordinates" ], "title": "Point", "description": "Point Model" }, "rio_cogeo__models__Info": { "properties": { "Path": { "type": "string", "title": "Path" }, "Driver": { "type": "string", "title": "Driver" }, "COG": { "type": "boolean", "title": "Cog" }, "Compression": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Compression" }, "ColorSpace": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Colorspace" }, "COG_errors": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "title": "Cog Errors" }, "COG_warnings": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "title": "Cog Warnings" }, "Profile": { "$ref": "#/components/schemas/Profile" }, "GEO": { "$ref": "#/components/schemas/Geo" }, "Tags": { "additionalProperties": { "additionalProperties": true, "type": "object" }, "type": "object", "title": "Tags" }, "Band Metadata": { "additionalProperties": { "$ref": "#/components/schemas/BandMetadata" }, "type": "object", "title": "Band Metadata" }, "IFD": { "items": { "$ref": "#/components/schemas/IFD" }, "type": "array", "title": "Ifd" } }, "type": "object", "required": [ "Path", "Driver", "COG", "Profile", "GEO", "Tags", "IFD" ], "title": "Info", "description": "rio-cogeo Info." }, "rio_tiler__models__Info": { "properties": { "bounds": { "prefixItems": [ { "type": "number" }, { "type": "number" }, { "type": "number" }, { "type": "number" } ], "type": "array", "maxItems": 4, "minItems": 4, "title": "Bounds" }, "crs": { "type": "string", "title": "Crs" }, "band_metadata": { "items": { "prefixItems": [ { "type": "string" }, { "additionalProperties": true, "type": "object" } ], "type": "array", "maxItems": 2, "minItems": 2 }, "type": "array", "title": "Band Metadata" }, "band_descriptions": { "items": { "prefixItems": [ { "type": "string" }, { "type": "string" } ], "type": "array", "maxItems": 2, "minItems": 2 }, "type": "array", "title": "Band Descriptions" }, "dtype": { "type": "string", "title": "Dtype" }, "nodata_type": { "type": "string", "enum": [ "Alpha", "Mask", "Internal", "Nodata", "None" ], "title": "Nodata Type" }, "colorinterp": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "title": "Colorinterp" }, "scales": { "anyOf": [ { "items": { "type": "number" }, "type": "array" }, { "type": "null" } ], "title": "Scales" }, "offsets": { "anyOf": [ { "items": { "type": "number" }, "type": "array" }, { "type": "null" } ], "title": "Offsets" }, "colormap": { "anyOf": [ { "additionalProperties": { "prefixItems": [ { "type": "integer" }, { "type": "integer" }, { "type": "integer" }, { "type": "integer" } ], "type": "array", "maxItems": 4, "minItems": 4 }, "type": "object" }, { "type": "null" } ], "title": "Colormap" } }, "additionalProperties": true, "type": "object", "required": [ "bounds", "crs", "band_metadata", "band_descriptions", "dtype", "nodata_type" ], "title": "Info", "description": "Dataset Info." }, "titiler__core__models__responses__Point": { "properties": { "coordinates": { "items": { "type": "number" }, "type": "array", "title": "Coordinates" }, "values": { "items": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "type": "array", "title": "Values" }, "band_names": { "items": { "type": "string" }, "type": "array", "title": "Band Names" }, "band_descriptions": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "title": "Band Descriptions" } }, "type": "object", "required": [ "coordinates", "values", "band_names" ], "title": "Point", "description": "Point model.\n\nresponse model for `/point` endpoints" }, "titiler__mosaic__models__responses__Point": { "properties": { "coordinates": { "items": { "type": "number" }, "type": "array", "title": "Coordinates" }, "assets": { "items": { "$ref": "#/components/schemas/AssetPoint" }, "type": "array", "title": "Assets" } }, "type": "object", "required": [ "coordinates", "assets" ], "title": "Point", "description": "Point model.\n\nresponse model for `/point` endpoints" }, "variableMatrixWidth": { "properties": { "coalesce": { "type": "integer", "multipleOf": 1.0, "minimum": 2.0, "title": "Coalesce", "description": "Number of tiles in width that coalesce in a single tile for these rows" }, "minTileRow": { "type": "integer", "multipleOf": 1.0, "minimum": 0.0, "title": "Mintilerow", "description": "First tile row where the coalescence factor applies for this tilematrix" }, "maxTileRow": { "type": "integer", "multipleOf": 1.0, "minimum": 0.0, "title": "Maxtilerow", "description": "Last tile row where the coalescence factor applies for this tilematrix" } }, "type": "object", "required": [ "coalesce", "minTileRow", "maxTileRow" ], "title": "variableMatrixWidth", "description": "Variable Matrix Width Definition\n\nref: https://github.com/opengeospatial/2D-Tile-Matrix-Set/blob/master/schemas/tms/2.0/json/variableMatrixWidth.json" } } } }