updating docs

cogeotiff · Aug 23, 2024 · 258cfe0 · 258cfe0
1 parent b64da58
commit 258cfe0
Show file tree

Hide file tree

Showing 2 changed files with 3 additions and 0 deletions.
diff --git a/docs/src/api/rio_tiler/io/stac.md b/docs/src/api/rio_tiler/io/stac.md
@@ -75,6 +75,7 @@ class STACReader(
     exclude_assets: Optional[Set[str]] = None,
     include_asset_types: Set[str] = {'image/tiff; profile=cloud-optimized; application=geotiff', 'image/tiff; application=geotiff', 'image/x.geotiff', 'image/tiff; application=geotiff; profile=cloud-optimized', 'image/vnd.stac.geotiff; cloud-optimized=true', 'application/x-hdf', 'image/jp2', 'application/x-hdf5', 'image/tiff'},
     exclude_asset_types: Optional[Set[str]] = None,
+    default_assets: Optional[Sequence[str]] = attr.ib(default=None),
     reader: Type[rio_tiler.io.base.BaseReader] = <class 'rio_tiler.io.rasterio.Reader'>,
     reader_options: Dict = NOTHING,
     fetch_options: Dict = NOTHING,
@@ -96,6 +97,7 @@ class STACReader(
 | exclude_assets | set of string | Exclude specific assets. | None |
 | include_asset_types | set of string | Only include some assets base on their type. | None |
 | exclude_asset_types | set of string | Exclude some assets base on their type. | None |
+| default_assets | Sequence of string | Default assets to use if none are defined. | None |
 | reader | rio_tiler.io.BaseReader | rio-tiler Reader. Defaults to `rio_tiler.io.Reader`. | `rio_tiler.io.Reader` |
 | reader_options | dict | Additional option to forward to the Reader. Defaults to `{}`. | `{}` |
 | fetch_options | dict | Options to pass to `rio_tiler.io.stac.fetch` function fetching the STAC Items. Defaults to `{}`. | `{}` |

diff --git a/docs/src/readers.md b/docs/src/readers.md
@@ -398,6 +398,7 @@ STACReader.__mro__
 - **exclude_assets** (set, optional): Set of assets to exclude from the `available` asset list
 - **include_asset_types** (set, optional): asset types to consider as valid type for the reader
 - **exclude_asset_types** (set, optional): asset types to consider as invalid type for the reader
+- **default_assets** (sequence, optional): default assets to use for the reader if nothing else is provided.
 - **reader** (BaseReader, optional): Reader to use to read assets (defaults to rio_tiler.io.rasterio.Reader)
 - **reader_options** (dict, optional): Options to forward to the reader init
 - **fetch_options** (dict, optional): Options to pass to the `httpx.get` or `boto3` when fetching the STAC item