TechDocsClient.getEntityMetadata()
Home > @backstage/plugin-techdocs > TechDocsClient > getEntityMetadata
Retrieve metadata about an entity.
This method requests techdocs-backend which uses the catalog APIs to respond with filtered information required here.
Signature:
getEntityMetadata(entityId: CompoundEntityRef): Promise<TechDocsEntityMetadata>;
Parameters
| Parameter | Type | Description |
|---|---|---|
| entityId | CompoundEntityRef | Object containing entity data like name, namespace, etc. |
Returns:
Promise<TechDocsEntityMetadata>