Skip to main content

GetEntityFacetsRequest.facets

Home > @backstage/catalog-client > GetEntityFacetsRequest > facets

Dot separated paths for the facets to extract from each entity.

Signature:

facets: string[];

Remarks​

Example: For an input of ['kind', 'metadata.annotations.backstage.io/orphan'], then the response will be shaped like

{
  "facets": {
    "kind": [
      { "key": "Component", "count": 22 },
      { "key": "API", "count": 13 }
    ],
    "metadata.annotations.backstage.io/orphan": [
      { "key": "true", "count": 2 }
    ]
  }
}