Skip to content

Commit 9dff048

Browse files
authored
link to output format from documented format parameters (#1091)
1 parent 7e33fd7 commit 9dff048

File tree

2 files changed

+12
-12
lines changed

2 files changed

+12
-12
lines changed

docs/src/endpoints/cog.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,7 @@ The `/cog` routes are based on `titiler.core.factory.TilerFactory` but with `cog
4040
- **x** (int): TMS tile's column.
4141
- **y** (int): TMS tile's row.
4242
- **scale** (int): Tile size scale, default is set to 1 (256x256). **Optional**
43-
- **format** (str): Output image format, default is set to None and will be either JPEG or PNG depending on masked value. **Optional**
43+
- **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**
4444

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

7474
- PathParams:
75-
- **format** (str): Output image format, default is set to None and will be either JPEG or PNG depending on masked value. **Optional**
75+
- **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**
7676

7777
- QueryParams:
7878
- **url** (str): Cloud Optimized GeoTIFF URL. **Required**
@@ -110,7 +110,7 @@ Example:
110110

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

@@ -150,7 +150,7 @@ Example:
150150
- PathParams:
151151
- **height** (int): Force output image height. **Optional**
152152
- **width** (int): Force output image width. **Optional**
153-
- **format** (str): Output image format, default is set to None and will be either JPEG or PNG depending on masked value. **Optional**
153+
- **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**
154154

155155
- QueryParams:
156156
- **url** (str): Cloud Optimized GeoTIFF URL. **Required**
@@ -213,7 +213,7 @@ Example:
213213

214214
- QueryParams:
215215
- **url** (str): Cloud Optimized GeoTIFF URL. **Required**
216-
- **tile_format** (str): Output image format, default is set to None and will be either JPEG or PNG depending on masked value.
216+
- **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.
217217
- **tile_scale** (int): Tile size scale, default is set to 1 (256x256).
218218
- **minzoom** (int): Overwrite default minzoom.
219219
- **maxzoom** (int): Overwrite default maxzoom.
@@ -249,7 +249,7 @@ Example:
249249

250250
- QueryParams:
251251
- **url** (str): Cloud Optimized GeoTIFF URL. **Required**
252-
- **tile_format** (str): Output image format, default is set to None and will be either JPEG or PNG depending on masked value.
252+
- **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.
253253
- **tile_scale** (int): Tile size scale, default is set to 1 (256x256).
254254
- **minzoom** (int): Overwrite default minzoom.
255255
- **maxzoom** (int): Overwrite default maxzoom.

docs/src/endpoints/stac.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,7 @@ The `/stac` routes are based on `titiler.core.factory.MultiBaseTilerFactory` but
4040
- **x** (int): TMS tile's column.
4141
- **y** (int): TMS tile's row.
4242
- **scale** (int): Tile size scale, default is set to 1 (256x256). **Optional**
43-
- **format** (str): Output image format, default is set to None and will be either JPEG or PNG depending on masked value. **Optional**
43+
- **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**
4444

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

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

8282
- QueryParams:
8383
- **url** (str): STAC Item URL. **Required**
@@ -122,7 +122,7 @@ Example:
122122
- **minx,miny,maxx,maxy** (str): Comma (',') delimited bounding box in WGS84.
123123
- **height** (int): Force output image height. **Optional**
124124
- **width** (int): Force output image width. **Optional**
125-
- **format** (str): Output image format, default is set to None and will be either JPEG or PNG depending on masked value. **Optional**
125+
- **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**
126126

127127
- QueryParams:
128128
- **url** (str): STAC Item URL. **Required**
@@ -163,7 +163,7 @@ Example:
163163
- PathParams:
164164
- **height** (int): Force output image height. **Optional**
165165
- **width** (int): Force output image width. **Optional**
166-
- **format** (str): Output image format, default is set to None and will be either JPEG or PNG depending on masked value. **Optional**
166+
- **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**
167167

168168
- QueryParams:
169169
- **url** (str): STAC Item URL. **Required**
@@ -235,7 +235,7 @@ Example:
235235
- **expression** (str): rio-tiler's math expression with asset names (e.g `Asset1_b1/Asset2_b1`).
236236
- **asset_as_band** (bool): tell rio-tiler that each asset is a 1 band dataset, so expression `Asset1/Asset2` can be passed.
237237
- **asset_bidx** (array[str]): Per asset band math expression (e.g `Asset1|1,2,3`).
238-
- **tile_format** (str): Output image format, default is set to None and will be either JPEG or PNG depending on masked value.
238+
- **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.
239239
- **tile_scale** (int): Tile size scale, default is set to 1 (256x256).
240240
- **minzoom** (int): Overwrite default minzoom.
241241
- **maxzoom** (int): Overwrite default maxzoom.
@@ -275,7 +275,7 @@ Example:
275275
- **expression** (str): rio-tiler's math expression with asset names (e.g `Asset1_b1/Asset2_b1`).
276276
- **asset_as_band** (bool): tell rio-tiler that each asset is a 1 band dataset, so expression `Asset1/Asset2` can be passed.
277277
- **asset_bidx** (array[str]): Per asset band math expression (e.g `Asset1|1,2,3`).
278-
- **tile_format** (str): Output image format, default is set to None and will be either JPEG or PNG depending on masked value.
278+
- **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.
279279
- **tile_scale** (int): Tile size scale, default is set to 1 (256x256).
280280
- **minzoom** (int): Overwrite default minzoom.
281281
- **maxzoom** (int): Overwrite default maxzoom.

0 commit comments

Comments
 (0)