Skip to content

/compatibility or /info endpoints #72

@negin513

Description

@negin513

Add /compatibility or /info endpoint to return dataset compatibility, metadata, and some other useful information

Description
As suggested in NASA-IMPACT/veda-odd#219, it would be helpful to introduce an /info endpoint to TiTiler-CMR. This endpoint would be similar to /tilejson, but instead of returning tiling metadata, it would provide backend configuration and high-level dataset information.

The goal is to make it easier for users to:

  • Quickly discover available variables and parameters for a dataset.
  • Understand native temporal and spatial ranges.
  • Check for compatibility of underlying CMR data
  • Inspect backend configuration without needing to parse TileJSONs or launch notebooks.

Example Response

{
  "backend": "xarray",
  "concept_id": "C1234567890-NSIDC_ECS",
  "variables": ["sea_ice_fraction", "analysed_sst"],
  "temporal_extent": ["2020-01-01T00:00:00Z", "2024-01-01T00:00:00Z"],
  "spatial_extent": [-180, -90, 180, 90],
  "zoom_levels": {
    "min": 0,
    "max": 14
  },
  "crs": "EPSG:4326"
}

Suggested Metadata to Include

  • Backend config (e.g., xarray, rio-tiler)
  • Variables/bands available in the dataset
  • Temporal range (start/end dates)
  • Spatial extent (bounding box)
  • Zoom levels (min/max)
  • Compatibility status (compatible | issues_detected)

At some points we discussed the compatibility check should also include some statistics including percent valid, masked, min, max, etc too.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions