TechDocsClient.getTechDocsMetadata()
Home > @backstage/plugin-techdocs
> TechDocsClient
> getTechDocsMetadata
Retrieve TechDocs metadata.
When docs are built, we generate a techdocs_metadata.json and store it along with the generated static files. It includes necessary data about the docs site. This method requests techdocs-backend which retrieves the TechDocs metadata.
Signature:
getTechDocsMetadata(entityId: CompoundEntityRef): Promise<TechDocsMetadata>;
Parameters
Parameter | Type | Description |
---|---|---|
entityId | CompoundEntityRef | Object containing entity data like name, namespace, etc. |
Returns:
Promise<TechDocsMetadata>