Skip to content

Commit

Permalink
link to output format from documented format parameters (#1091)
Browse files Browse the repository at this point in the history
  • Loading branch information
@andrewharvey
andrewharvey authored Jan 30, 2025
1 parent 7e33fd7 commit 9dff048
Show file tree
Hide file tree
Showing 2 changed files with 12 additions and 12 deletions.
12 changes: 6 additions & 6 deletions docs/src/endpoints/cog.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ The `/cog` routes are based on `titiler.core.factory.TilerFactory` but with `cog
- **x** (int): TMS tile's column.
- **y** (int): TMS tile's row.
- **scale** (int): Tile size scale, default is set to 1 (256x256). **Optional**
- **format** (str): Output image format, default is set to None and will be either JPEG or PNG depending on masked value. **Optional**
- **format** (str): Output [image format](../output_format.md), default is set to None and will be either JPEG or PNG depending on masked value. **Optional**

- QueryParams:
- **url** (str): Cloud Optimized GeoTIFF URL. **Required**
Expand Down Expand Up @@ -72,7 +72,7 @@ Example:
`:endpoint:/cog/preview[.{format}]`

- PathParams:
- **format** (str): Output image format, default is set to None and will be either JPEG or PNG depending on masked value. **Optional**
- **format** (str): Output [image format](../output_format.md), default is set to None and will be either JPEG or PNG depending on masked value. **Optional**

- QueryParams:
- **url** (str): Cloud Optimized GeoTIFF URL. **Required**
Expand Down Expand Up @@ -110,7 +110,7 @@ Example:

- PathParams:
- **minx,miny,maxx,maxy** (str): Comma (',') delimited bounding box in WGS84.
- **format** (str): Output image format.
- **format** (str): Output [image format](../output_format.md).
- **height** (int): Force output image height.
- **width** (int): Force output image width.

Expand Down Expand Up @@ -150,7 +150,7 @@ Example:
- PathParams:
- **height** (int): Force output image height. **Optional**
- **width** (int): Force output image width. **Optional**
- **format** (str): Output image format, default is set to None and will be either JPEG or PNG depending on masked value. **Optional**
- **format** (str): Output [image format](../output_format.md), default is set to None and will be either JPEG or PNG depending on masked value. **Optional**

- QueryParams:
- **url** (str): Cloud Optimized GeoTIFF URL. **Required**
Expand Down Expand Up @@ -213,7 +213,7 @@ Example:

- QueryParams:
- **url** (str): Cloud Optimized GeoTIFF URL. **Required**
- **tile_format** (str): Output image format, default is set to None and will be either JPEG or PNG depending on masked value.
- **tile_format** (str): Output [image format](../output_format.md), default is set to None and will be either JPEG or PNG depending on masked value.
- **tile_scale** (int): Tile size scale, default is set to 1 (256x256).
- **minzoom** (int): Overwrite default minzoom.
- **maxzoom** (int): Overwrite default maxzoom.
Expand Down Expand Up @@ -249,7 +249,7 @@ Example:

- QueryParams:
- **url** (str): Cloud Optimized GeoTIFF URL. **Required**
- **tile_format** (str): Output image format, default is set to None and will be either JPEG or PNG depending on masked value.
- **tile_format** (str): Output [image format](../output_format.md), default is set to None and will be either JPEG or PNG depending on masked value.
- **tile_scale** (int): Tile size scale, default is set to 1 (256x256).
- **minzoom** (int): Overwrite default minzoom.
- **maxzoom** (int): Overwrite default maxzoom.
Expand Down
12 changes: 6 additions & 6 deletions docs/src/endpoints/stac.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ The `/stac` routes are based on `titiler.core.factory.MultiBaseTilerFactory` but
- **x** (int): TMS tile's column.
- **y** (int): TMS tile's row.
- **scale** (int): Tile size scale, default is set to 1 (256x256). **Optional**
- **format** (str): Output image format, default is set to None and will be either JPEG or PNG depending on masked value. **Optional**
- **format** (str): Output [image format](../output_format.md), default is set to None and will be either JPEG or PNG depending on masked value. **Optional**

- QueryParams:
- **url** (str): STAC Item URL. **Required**
Expand Down Expand Up @@ -77,7 +77,7 @@ Example:
`:endpoint:/stac/preview[.{format}]`

- PathParams:
- **format**: Output image format, default is set to None and will be either JPEG or PNG depending on masked value. **Optional**
- **format**: Output [image format](../output_format.md), default is set to None and will be either JPEG or PNG depending on masked value. **Optional**

- QueryParams:
- **url** (str): STAC Item URL. **Required**
Expand Down Expand Up @@ -122,7 +122,7 @@ Example:
- **minx,miny,maxx,maxy** (str): Comma (',') delimited bounding box in WGS84.
- **height** (int): Force output image height. **Optional**
- **width** (int): Force output image width. **Optional**
- **format** (str): Output image format, default is set to None and will be either JPEG or PNG depending on masked value. **Optional**
- **format** (str): Output [image format](../output_format.md), default is set to None and will be either JPEG or PNG depending on masked value. **Optional**

- QueryParams:
- **url** (str): STAC Item URL. **Required**
Expand Down Expand Up @@ -163,7 +163,7 @@ Example:
- PathParams:
- **height** (int): Force output image height. **Optional**
- **width** (int): Force output image width. **Optional**
- **format** (str): Output image format, default is set to None and will be either JPEG or PNG depending on masked value. **Optional**
- **format** (str): Output [image format](../output_format.md), default is set to None and will be either JPEG or PNG depending on masked value. **Optional**

- QueryParams:
- **url** (str): STAC Item URL. **Required**
Expand Down Expand Up @@ -235,7 +235,7 @@ Example:
- **expression** (str): rio-tiler's math expression with asset names (e.g `Asset1_b1/Asset2_b1`).
- **asset_as_band** (bool): tell rio-tiler that each asset is a 1 band dataset, so expression `Asset1/Asset2` can be passed.
- **asset_bidx** (array[str]): Per asset band math expression (e.g `Asset1|1,2,3`).
- **tile_format** (str): Output image format, default is set to None and will be either JPEG or PNG depending on masked value.
- **tile_format** (str): Output [image format](../output_format.md), default is set to None and will be either JPEG or PNG depending on masked value.
- **tile_scale** (int): Tile size scale, default is set to 1 (256x256).
- **minzoom** (int): Overwrite default minzoom.
- **maxzoom** (int): Overwrite default maxzoom.
Expand Down Expand Up @@ -275,7 +275,7 @@ Example:
- **expression** (str): rio-tiler's math expression with asset names (e.g `Asset1_b1/Asset2_b1`).
- **asset_as_band** (bool): tell rio-tiler that each asset is a 1 band dataset, so expression `Asset1/Asset2` can be passed.
- **asset_bidx** (array[str]): Per asset band math expression (e.g `Asset1|1,2,3`).
- **tile_format** (str): Output image format, default is set to None and will be either JPEG or PNG depending on masked value.
- **tile_format** (str): Output [image format](../output_format.md), default is set to None and will be either JPEG or PNG depending on masked value.
- **tile_scale** (int): Tile size scale, default is set to 1 (256x256).
- **minzoom** (int): Overwrite default minzoom.
- **maxzoom** (int): Overwrite default maxzoom.
Expand Down

0 comments on commit 9dff048

Please sign in to comment.