Backstage
    Preparing search index...

    Interface TechDocsDocument

    TechDocs indexable document interface

    interface TechDocsDocument {
        authorization?: { resourceRef: string };
        kind: string;
        lifecycle: string;
        location: string;
        name: string;
        namespace: string;
        owner: string;
        path: string;
        text: string;
        title: string;
    }

    Hierarchy (View Summary)

    Index

    Properties

    authorization? kind lifecycle location name namespace owner path text title

    Properties

    authorization?: { resourceRef: string }

    Optional authorization information to be used when determining whether this search result should be visible to a given user.

    Type Declaration

    • resourceRef: string

      Identifier for the resource.

    kind: string

    Entity kind

    lifecycle: string

    Entity lifecycle

    location: string

    The relative or absolute URL of the document (target when a search result is clicked).

    name: string

    Entity metadata name

    namespace: string

    Entity metadata namespace

    owner: string

    Entity owner

    path: string

    Entity path

    text

    text: string

    Free-form text of the document (e.g. description, content, etc).

    title: string

    The primary name of the document (e.g. name, title, identifier, etc).

    Settings

    Member Visibility

    On This Page

    Properties