TechDocsStorageClient

Home > @backstage/plugin-techdocs > TechDocsStorageClient

API which talks to TechDocs storage to fetch files to render.

Signature:

class TechDocsStorageClient implements TechDocsStorageApi 

Implements: TechDocsStorageApi

Constructors

Constructor	Modifiers	Description
(constructor)(options)		Constructs a new instance of the TechDocsStorageClient class

Properties

Property	Modifiers	Type	Description
configApi		Config
discoveryApi		DiscoveryApi

Methods

Method	Modifiers	Description
getApiOrigin()
getBaseUrl(oldBaseUrl, entityId, path)
getBuilder()
getEntityDocs(entityId, path)		Fetch HTML content as text for an individual docs page in an entity's docs site.
getStorageUrl()
syncEntityDocs(entityId, logHandler)		Check if docs are on the latest version and trigger rebuild if not