Skip to content

Commit 0bd9b01

Browse files
vincentsaragovincentsarago
committed
update docs
1 parent b93d74b commit 0bd9b01

2 files changed

Lines changed: 74 additions & 85 deletions

File tree

‎docs/src/endpoints/collections_endpoints.md‎

Lines changed: 22 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -2,19 +2,20 @@
22
### STAC Collections endpoints
33

44

5-
| Method | URL | Output | Description
6-
| ------ | ---------------------------------------------------------------------------------|-----------------------------------------|--------------
7-
| `GET` | `/collections/{collection_id}/info` | JSON | return mosaic's basic info
8-
| `GET` | `/collections/{collection_id}/info.geojson` | GeoJSON | return mosaic's basic info as a GeoJSON feature
9-
| `GET` | `/collections/{collection_id}/tiles` | JSON | List of OGC Tilesets available
10-
| `GET` | `/collections/{collection_id}/tiles/{tileMatrixSetId}` | JSON | OGC Tileset metadata
11-
| `GET` | `/collections/{collection_id}/tiles/{TileMatrixSetId}/{z}/{x}/{y}[@{scale}x][.{format}]` | image/bin | Create a web map tile image for a collection and a tile index
12-
| `GET` | `/collections/{collection_id}/{TileMatrixSetId}/tilejson.json` | JSON ([TileJSON][tilejson_model]) | Return a Mapbox TileJSON document
13-
| `GET` | `/collections/{collection_id}/{TileMatrixSetId}/map.html` | HTML | simple map viewer
14-
| `GET` | `/collections/{collection_id}/point/{lon},{lat}` | JSON | return pixel value from a mosaic assets
15-
| `GET` | `/collections/{collection_id}/bbox/{minx},{miny},{maxx},{maxy}/assets` | JSON | return list of assets intersecting a bounding box
16-
| `GET` | `/collections/{collection_id}/point/{lon},{lat}/assets` | JSON | return list of assets intersecting a point
17-
| `GET` | `/collections/{collection_id}/tiles/{tileMatrixSetId}/{z}/{x}/{y}/assets` | JSON | return list of assets intersecting a XYZ tile
5+
| Method | URL | Output | Description
6+
| ------ | ---------------------------------------------------------------------------------|-----------------------------------|--------------
7+
| `GET` | `/collections/{collection_id}/info` | JSON | return mosaic's basic info
8+
| `GET` | `/collections/{collection_id}/info.geojson` | GeoJSON | return mosaic's basic info as a GeoJSON feature
9+
| `GET` | `/collections/{collection_id}/tiles` | JSON | List of OGC Tilesets available
10+
| `GET` | `/collections/{collection_id}/tiles/{tileMatrixSetId}` | JSON | OGC Tileset metadata
11+
| `GET` | `/collections/{collection_id}/tiles/{TileMatrixSetId}/{z}/{x}/{y}[.{format}]` | image/bin | Create a web map tile image for a collection and a tile index
12+
| `GET` | `/collections/{collection_id}/{TileMatrixSetId}/tilejson.json` | JSON ([TileJSON][tilejson_model]) | Return a Mapbox TileJSON document
13+
| `GET` | `/collections/{collection_id}/{TileMatrixSetId}/map.html` | HTML | simple map viewer
14+
| `GET` | `/collections/{collection_id}/point/{lon},{lat}` | JSON | return pixel value from a mosaic assets
15+
| `GET` | `/collections/{collection_id}/tiles/{tileMatrixSetId}/{z}/{x}/{y}/assets` | JSON | return list of assets intersecting a XYZ tile
16+
| `GET` | `/collections/{collection_id}/bbox/{minx},{miny},{maxx},{maxy}/assets` | JSON | return list of assets intersecting a bounding box
17+
| `GET` | `/collections/{collection_id}/point/{lon},{lat}/assets` | JSON | return list of assets intersecting a point
18+
| `GET` | `/collections/{collection_id}/WMTSCapabilities.xml` | XML | return OGC WMTS Get Capabilities
1819

1920
### Tiles
2021

@@ -26,14 +27,13 @@
2627
- **z**: Tile's zoom level.
2728
- **x**: Tile's column.
2829
- **y**: Tile's row.
29-
- **scale**: Tile size scale, default is set to 1 (256x256). OPTIONAL
3030
- **format**: Output image format, default is set to None and will be either JPEG or PNG depending on masked value. OPTIONAL
3131

3232
- QueryParams:
33-
- **assets** (array[str]): asset names.
34-
- **expression** (str): rio-tiler's math expression with asset names (e.g `Asset1_b1/Asset2_b1`).
35-
- **asset_as_band** (bool): tell rio-tiler that each asset is a 1 band dataset, so expression `Asset1/Asset2` can be passed.
36-
- **asset_bidx** (array[str]): Per asset band index (e.g `Asset1|1;2;3`).
33+
- **assets** (array[str]): asset names. **Required**
34+
- **expression** (str): rio-tiler's math expression with asset names (e.g `b1/b2`).
35+
- **asset_as_band** (bool): tell rio-tiler that each asset is a 1 band dataset.
36+
- **tilesize** (int): overwrite TMS tileWidth x tileHeight with fixed tilesize.
3737
- **nodata**: Overwrite internal Nodata value. OPTIONAL
3838
- **unscale** (bool): Apply dataset internal Scale/Offset.
3939
- **resampling** (str): RasterIO resampling algorithm. Defaults to `nearest`.
@@ -59,9 +59,6 @@
5959
- **limit** (int): The maximum number of results to return (page size). Defaults to 10.
6060
- **max_items** (int): The maximum number of items to used in a mosaic. Defaults to 100.
6161

62-
!!! important
63-
**assets** OR **expression** is required
64-
6562
Example:
6663

6764
- `https://myendpoint/collections/my-collection/tiles/WebMercatorQuad/1/2/3?assets=B01`
@@ -78,13 +75,13 @@ Example:
7875
- **TileMatrixSetId**: TileMatrixSet name (e.g `WebMercatorQuad`).
7976

8077
- QueryParams:
78+
- **assets** (array[str]): asset names. **Required**
8179
- **tile_format**: Output image format, default is set to None and will be either JPEG or PNG depending on masked value.
82-
- **tile_scale**: Tile size scale, default is set to 1 (256x256). OPTIONAL
80+
- **tilesize** (int): overwrite TMS tileWidth x tileHeight with fixed tilesize. Defaults to 512.
8381
- **minzoom**: Overwrite default minzoom. OPTIONAL
8482
- **maxzoom**: Overwrite default maxzoom. OPTIONAL
85-
- **expression** (str): rio-tiler's math expression with asset names (e.g `Asset1_b1/Asset2_b1`).
86-
- **asset_as_band** (bool): tell rio-tiler that each asset is a 1 band dataset, so expression `Asset1/Asset2` can be passed.
87-
- **asset_bidx** (array[str]): Per asset band index (e.g `Asset1|1;2;3`).
83+
- **expression** (str): rio-tiler's math expression with asset names (e.g `b1/b2`).
84+
- **asset_as_band** (bool): tell rio-tiler that each asset is a 1 band dataset.
8885
- **nodata** (str, int, float): Overwrite internal Nodata value.
8986
- **unscale** (bool): Apply dataset internal Scale/Offset.
9087
- **resampling** (str): RasterIO resampling algorithm. Defaults to `nearest`.

0 commit comments

Comments
 (0)