Interface TechDocsApi

API to talk to techdocs-backend.

Deprecated

Import from @backstage/plugin-techdocs-react instead

interface TechDocsApi {
    getApiOrigin(): Promise<string>;
    getEntityMetadata(
        entityId: CompoundEntityRef,
    ): Promise<TechDocsEntityMetadata>;
    getTechDocsMetadata(entityId: CompoundEntityRef): Promise<TechDocsMetadata>;
}

Index

Methods

getApiOrigin getEntityMetadata getTechDocsMetadata

Methods

getApiOrigin

getApiOrigin(): Promise<string>
Returns Promise<string>
- Defined in plugins/techdocs/src/api.ts:81

getEntityMetadata

getEntityMetadata(entityId: CompoundEntityRef): Promise<TechDocsEntityMetadata>
Parameters
- entityId: CompoundEntityRef
Returns Promise<TechDocsEntityMetadata>
- Defined in plugins/techdocs/src/api.ts:83

getTechDocsMetadata

getTechDocsMetadata(entityId: CompoundEntityRef): Promise<TechDocsMetadata>
Parameters
- entityId: CompoundEntityRef
Returns Promise<TechDocsMetadata>
- Defined in plugins/techdocs/src/api.ts:82