Class TechDocsClient

constructor

• new TechDocsClient(
      options: {
          configApi: Config;
          discoveryApi: DiscoveryApi;
          fetchApi: FetchApi;
      },
  ): TechDocsClient

  Parameters

  • options: { configApi: Config; discoveryApi: DiscoveryApi; fetchApi: FetchApi }

  Returns TechDocsClient

configApi

discoveryApi

getApiOrigin

• getApiOrigin(): Promise<string>

  Returns Promise<string>

getCookie

• getCookie(): Promise<{ expiresAt: string }>

  Returns Promise<{ expiresAt: string }>

getEntityMetadata

• getEntityMetadata(entityId: CompoundEntityRef): Promise<TechDocsEntityMetadata>

  Retrieve metadata about an entity.

  This method requests techdocs-backend which uses the catalog APIs to respond with filtered information required here.

  Parameters

  • entityId: CompoundEntityRef

    Object containing entity data like name, namespace, etc.

  Returns Promise<TechDocsEntityMetadata>

getTechDocsMetadata

• getTechDocsMetadata(entityId: CompoundEntityRef): Promise<TechDocsMetadata>

  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.

  Parameters

  • entityId: CompoundEntityRef

    Object containing entity data like name, namespace, etc.

  Returns Promise<TechDocsMetadata>