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. Endpoints come in two flavors:

  • Root endpoints — /, /keys, /dict, /info — operate on the root node of the underlying xarray.DataTree. For a flat dataset this is just the dataset itself; for a DataTree it is the root group.

  • Group-aware endpoints — /groups/{group_path:path}/, /groups/{group_path:path}/keys, /groups/{group_path:path}/dict, and /groups/{group_path:path}/info — return the same information for the node at the given group path in the tree.

In addition, two tree-shaped endpoints expose the DataTree directly:

  • /tree — HTML representation of the full DataTree.

  • /groups — JSON list of every group path in the tree (e.g. ["/", "/a", "/a/b"]).

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:
GET /datasets/{dataset_id}/tree#

Tree Html

Returns the xarray HTML representation of the full DataTree.

Parameters:

  • dataset_id (string) – Unique ID of dataset

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

Groups

List of all group paths in the DataTree.

Parameters:

  • dataset_id (string) – Unique ID of dataset

Status Codes:
GET /datasets/{dataset_id}/groups/{group_path}#

Html Representation Group

Returns the xarray HTML representation of the dataset.

Parameters:

  • dataset_id (string) – Unique ID of dataset

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

List Keys Group

List of the keys in a dataset.

Parameters:

  • dataset_id (string) – Unique ID of dataset

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

To Dict Group

The full dataset as a dictionary.

Parameters:

  • dataset_id (string) – Unique ID of dataset

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

Info Group

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

Returns a dict with 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 the currently loaded plugins and their versions.
GET /plugins#

Get Plugins

Return the source and version of the currently loaded plugins.

Status Codes:

  • 200 OK – Successful Response

Zarr#

Note

The built-in Zarr plugin has moved to its own package, xpublish-zarr. Install it separately (e.g. pip install xpublish-zarr) to restore the previous /zarr/* endpoints.