Backstage
    Preparing search index...

    Interface CatalogEntityDocument

    The Document format for an Entity in the Catalog for search

    interface CatalogEntityDocument {
        authorization?: { resourceRef: string };
        componentType: string;
        kind: string;
        lifecycle: string;
        location: string;
        namespace: string;
        owner: string;
        text: string;
        title: string;
        type: string;
    }

    Hierarchy (View Summary)

    Index

    Properties

    authorization? componentType kind lifecycle location namespace owner text title type

    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.

    componentType: string

    componentType is being renamed to type. During the transition both of these fields should be set to the same value, in order to avoid issues with indexing.

    kind: string
    lifecycle: string
    location: string

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

    namespace: string
    owner: string

    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).

    type: string

    Settings

    Member Visibility

    On This Page

    Properties