Skip to main content

@backstage/plugin-tech-insights-backend

Home > @backstage/plugin-tech-insights-backend

Functions

FunctionDescription
createFactRetrieverRegistration(options)A helper function to construct fact retriever registrations.
createRouter(options)

Constructs a tech-insights router.

Exposes endpoints to handle facts Exposes optional endpoints to handle checks if a FactChecker implementation is passed in

Interfaces

InterfaceDescription
FactRetrieverEngineFactRetrieverEngine responsible scheduling and running fact retrieval tasks.
RouterOptionsRouterOptions to construct TechInsights endpoints
TechInsightsOptions

Variables

VariableDescription
buildTechInsightsContextConstructs needed persistence context, fact retriever engine and optionally fact checker implementations to be used in the tech insights module.
entityMetadataFactRetrieverGenerates facts which indicate the completeness of entity metadata.
entityOwnershipFactRetrieverGenerates facts which indicate the quality of data in the spec.owner field.
initializePersistenceContextA factory function to construct persistence context for running implementation.
techdocsFactRetrieverGenerates facts related to the completeness of techdocs configuration for entities.
techInsightsPluginThe tech-insights backend plugin.

Type Aliases

Type AliasDescription
FactRetrieverRegistrationOptions
FactRetrieverRegistry
PersistenceContext
PersistenceContextOptionsA Container for persistence context initialization options
TechInsightsContext