Backstage
    Preparing search index...

    Interface ApiEntity

    Backstage API kind Entity. APIs describe the interfaces for Components to communicate.

    See https://backstage.io/docs/features/software-catalog/system-model

    interface ApiEntity {
        apiVersion: "backstage.io/v1alpha1" | "backstage.io/v1beta1";
        kind: "API";
        metadata: EntityMeta;
        relations?: EntityRelation[];
        spec: {
            definition: string;
            lifecycle: string;
            owner: string;
            system?: string;
            type: string;
        };
    }

    Hierarchy (View Summary)

    Index

    Properties

    apiVersion kind metadata relations? spec

    Properties

    apiVersion: "backstage.io/v1alpha1" | "backstage.io/v1beta1"

    The version of specification format for this particular entity that this is written against.

    kind: "API"

    The high level entity type being described.

    metadata: EntityMeta

    Metadata related to the entity.

    relations?: EntityRelation[]

    The relations that this entity has with other entities.

    spec: {
        definition: string;
        lifecycle: string;
        owner: string;
        system?: string;
        type: string;
    }

    The specification data describing the entity itself.

    Settings

    Member Visibility

    On This Page

    Properties