Included Plugins#

Xpublish includes a set of built in plugins with associated endpoints.

Dataset Info#

The dataset info plugin provides a handful of default ways to display datasets and their metadata.

plugins.included.dataset_info.DatasetInfoPlugin

Dataset metadata
GET /datasets/{dataset_id}/#

Html Representation

Returns the xarray HTML representation of the dataset.

Parameters:

  • dataset_id (string) – Unique ID of dataset

Status Codes:
GET /datasets/{dataset_id}/keys#

List Keys

List of the keys in a dataset

Parameters:

  • dataset_id (string) – Unique ID of dataset

Status Codes:
GET /datasets/{dataset_id}/dict#

To Dict

The full dataset as a dictionary

Parameters:

  • dataset_id (string) – Unique ID of dataset

Status Codes:
GET /datasets/{dataset_id}/info#

Info

Dataset schema (close to the NCO-JSON schema).

Parameters:

  • dataset_id (string) – Unique ID of dataset

Status Codes:

Module Version#

The module version plugin returns the versions of key libraries powering the Xpublish server.

plugins.included.module_version.ModuleVersionPlugin

Share the currently loaded versions of key libraries
GET /versions#

Get Versions

Currently loaded versions of key libraries

Status Codes:

  • 200 OK – Successful Response

Plugin Info#

Similarly the versions of the plugins currently enabled on the Xpublish server.

plugins.included.plugin_info.PluginInfoPlugin

Expose plugin source and version
GET /plugins#

Get Plugins

Return the source and version of the currently loaded plugins

Status Codes:

  • 200 OK – Successful Response

Zarr#

The Zarr plugin provides consolidated Zarr v2 access to the loaded datasets.

plugins.included.zarr.ZarrPlugin

Adds Zarr-like accessing endpoints for datasets
GET /datasets/{dataset_id}/zarr/.zmetadata#

Get Zarr Metadata

Consolidated Zarr metadata

Parameters:

  • dataset_id (string) – Unique ID of dataset

Status Codes:
GET /datasets/{dataset_id}/zarr/.zgroup#

Get Zarr Group

Zarr group data

Parameters:

  • dataset_id (string) – Unique ID of dataset

Status Codes:
GET /datasets/{dataset_id}/zarr/.zattrs#

Get Zarr Attrs

Zarr attributes

Parameters:

  • dataset_id (string) – Unique ID of dataset

Status Codes:
GET /datasets/{dataset_id}/zarr/{var}/{chunk}#

Get Variable Chunk

Get a zarr array chunk.

This will return cached responses when available.

Parameters:

  • var (string) – Variable in dataset

  • chunk (string) – Zarr chunk

  • dataset_id (string) – Unique ID of dataset

Status Codes: