Skip to main content

@backstage/plugin-catalog-common

Home > @backstage/plugin-catalog-common

Provides shared objects useful for interacting with the catalog and its entities, such as catalog permissions.

Interfaces

InterfaceDescription
CatalogEntityDocumentThe Document format for an Entity in the Catalog for search

Type Aliases

Type AliasDescription
AnalyzeLocationEntityField
AnalyzeLocationExistingEntityIf the folder pointed to already contained catalog info yaml files, they are read and emitted like this so that the frontend can inform the user that it located them and can make sure to register them as well if they weren't already
AnalyzeLocationGenerateEntityThis is some form of representation of what the analyzer could deduce. We should probably have a chat about how this can best be conveyed to the frontend. It'll probably contain a (possibly incomplete) entity, plus enough info for the frontend to know what form data to show to the user for overriding/completing the info.
AnalyzeLocationRequest
AnalyzeLocationResponse
LocationSpecHolds the entity location information.