diff --git a/CHANGELOG.md b/CHANGELOG.md index 195c9fc..2f0a82a 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -6,6 +6,11 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0 ## [Unreleased] +### Fixed + +- Document `bidx`: 1-based band index into the referenced assets, with no required correspondence to any + STAC band metadata ([#18](https://github.com/stac-extensions/render/issues/18)) + ## [2.1.0] - 2026-09-22 ### Added diff --git a/README.md b/README.md index cac4064..0cf7422 100644 --- a/README.md +++ b/README.md @@ -46,6 +46,7 @@ The fields in the table below can be used in these parts of STAC documents: | resampling | string | Resampling algorithm to apply to the referenced assets. See [GDAL resampling algorithm](https://gdal.org/programs/gdalwarp.html#cmdoption-gdalwarp-r) for some examples. | | expression | string, object, array | Band arithmetic formula to apply to the referenced assets. The format is defined by the rendering application, e.g. a [TiTiler](https://developmentseed.org/titiler/) band math string or a [MapLibre](https://maplibre.org/maplibre-style-spec/expressions/) style expression array. | | minmax_zoom | \[int] | Zoom levels range applicable for the visualization | +| bidx | \[int] | 1-based band indexes into the referenced assets (matching the GDAL/rio-tiler/titiler convention: the first band is `1`, not `0`). Only meaningful if you already know how the asset's bands are physically ordered — there is no required correspondence to any STAC band metadata (`eo:bands`, `raster:bands`, or the common `bands` construct). | | asset_as_band | boolean | Treat assets in `expression` as single bands. Required when expression uses multiple assets | The `render` object is open ended, so additional fields can be provided according to the needs of the rendering application.