Backstage
    Preparing search index...

    Interface ToolDocument

    Extended IndexableDocument with explore tool specific properties

    This entire package is deprecated and has been moved to the Backstage community repository; please use the @backstage-community/plugin-search-backend-module-explore package instead.

    interface ToolDocument {
        authorization?: { resourceRef: string };
        description?: string;
        image: string;
        lifecycle?: string;
        location: string;
        tags?: string[];
        text: string;
        title: string;
        url: string;
    }

    Hierarchy (View Summary)

    Index

    Properties

    authorization? description? image lifecycle? location tags? text title url

    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.

    description?: string
    image: string
    lifecycle?: string
    location: string

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

    tags?: 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).

    url: string

    Settings

    Member Visibility

    On This Page

    Properties