diff --git a/workspaces/tech-insights/.changeset/bright-lies-pump.md b/workspaces/tech-insights/.changeset/bright-lies-pump.md new file mode 100644 index 00000000000..249b1e5c8ca --- /dev/null +++ b/workspaces/tech-insights/.changeset/bright-lies-pump.md @@ -0,0 +1,5 @@ +--- +'@backstage-community/plugin-tech-insights': patch +--- + +Update correct param name in README. diff --git a/workspaces/tech-insights/plugins/tech-insights/README.md b/workspaces/tech-insights/plugins/tech-insights/README.md index de1d0b0e82d..39c7e70bce8 100644 --- a/workspaces/tech-insights/plugins/tech-insights/README.md +++ b/workspaces/tech-insights/plugins/tech-insights/README.md @@ -27,7 +27,7 @@ If you are using Backstage's [new frontend system](https://backstage.io/docs/fro #### Creating custom scorecards with TechInsightsScorecardBlueprint -The `TechInsightsScorecardBlueprint` allows you to create custom scorecard content that can be filtered to specific entities. This is useful when you want different scorecards to appear for different entity types or based on entity metadata. The `filter` parameter uses the same entity predicate format as other Backstage entity filters, allowing you to match on `kind`, `metadata`, `spec` fields, and more. +The `TechInsightsScorecardBlueprint` allows you to create custom scorecard content that can be filtered to specific entities. This is useful when you want different scorecards to appear for different entity types or based on entity metadata. The `entityFilter` parameter uses the same entity predicate format as other Backstage entity filters, allowing you to match on `kind`, `metadata`, `spec` fields, and more. ```ts import { createFrontendModule } from '@backstage/frontend-plugin-api'; @@ -40,7 +40,7 @@ const techInsightsModule = createFrontendModule({ TechInsightsScorecardBlueprint.make({ name: 'apis', params: { - filter: { kind: 'api' }, + entityFilter: { kind: 'api' }, title: 'API Scorecard', description: 'Checks specific to API entities', checkIds: ['apiDefinitionCheck'], @@ -49,7 +49,7 @@ const techInsightsModule = createFrontendModule({ TechInsightsScorecardBlueprint.make({ name: 'production-apis', params: { - filter: { kind: 'api', 'spec.lifecycle': 'production' }, + entityFilter: { kind: 'api', 'spec.lifecycle': 'production' }, title: 'Production API Scorecard', checkIds: ['groupOwnerCheck', 'productionReadinessCheck'], },