EntityFieldsQuery

Home > @backstage/catalog-client > EntityFieldsQuery

A set of dot-separated paths into an entity's keys, showing what parts of an entity to include in a response, and excluding all others.

Signature:

export type EntityFieldsQuery = string[];

Remarks

Example: For an input of ['kind', 'metadata.annotations'], then response objects will be shaped like

{
  "kind": "Component",
  "metadata": {
    "annotations": {
      "foo": "bar"
    }
  }
}