diff --git a/plugins/scaffolder-backend/api-report.md b/plugins/scaffolder-backend/api-report.md index 4a8c103906..ef4defcc50 100644 --- a/plugins/scaffolder-backend/api-report.md +++ b/plugins/scaffolder-backend/api-report.md @@ -6,13 +6,17 @@ /// import { CatalogApi } from '@backstage/catalog-client'; +import { CatalogProcessor } from '@backstage/plugin-catalog-backend'; +import { CatalogProcessorEmit } from '@backstage/plugin-catalog-backend'; import { Config } from '@backstage/config'; import { ContainerRunner } from '@backstage/backend-common'; import { createFetchCookiecutterAction } from '@backstage/plugin-scaffolder-backend-module-cookiecutter'; import { createPullRequest } from 'octokit-plugin-create-pull-request'; +import { Entity } from '@backstage/catalog-model'; import express from 'express'; import { JsonObject } from '@backstage/config'; import { JsonValue } from '@backstage/config'; +import { LocationSpec } from '@backstage/catalog-model'; import { Logger as Logger_2 } from 'winston'; import { Octokit } from '@octokit/rest'; import { PluginDatabaseManager } from '@backstage/backend-common'; @@ -244,6 +248,18 @@ export const runCommand: ({ logStream, }: RunCommandOptions) => Promise; +// @public (undocumented) +export class ScaffolderEntitiesProcessor implements CatalogProcessor { + // (undocumented) + postProcessEntity( + entity: Entity, + _location: LocationSpec, + emit: CatalogProcessorEmit, + ): Promise; + // (undocumented) + validateEntityKind(entity: Entity): Promise; +} + // Warning: (ae-missing-release-tag) "TemplateAction" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal) // // @public (undocumented) diff --git a/plugins/scaffolder-common/api-report.md b/plugins/scaffolder-common/api-report.md new file mode 100644 index 0000000000..722e746967 --- /dev/null +++ b/plugins/scaffolder-common/api-report.md @@ -0,0 +1,36 @@ +## API Report File for "@backstage/plugin-scaffolder-common" + +> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/). + +```ts +import { Entity } from '@backstage/catalog-model'; +import { JsonObject } from '@backstage/config'; +import { JSONSchema } from '@backstage/catalog-model'; + +// @public (undocumented) +export interface TemplateEntityV1beta3 extends Entity { + // (undocumented) + apiVersion: 'scaffolder.backstage.io/v1beta3'; + // (undocumented) + kind: 'Template'; + // (undocumented) + spec: { + type: string; + parameters?: JsonObject | JsonObject[]; + steps: Array<{ + id?: string; + name?: string; + action: string; + input?: JsonObject; + if?: string | boolean; + }>; + output?: { + [name: string]: string; + }; + owner?: string; + }; +} + +// @public (undocumented) +export const templateEntityV1beta3Schema: JSONSchema; +``` diff --git a/plugins/scaffolder-common/src/index.ts b/plugins/scaffolder-common/src/index.ts index 5cce1ceded..3b6fa71d7a 100644 --- a/plugins/scaffolder-common/src/index.ts +++ b/plugins/scaffolder-common/src/index.ts @@ -20,8 +20,13 @@ * @packageDocumentation */ -// The `{ default as ...}` re-export does not seem to work for json in tests -import templateEntityV1beta3Schema from './Template.v1beta3.schema.json'; +import { JSONSchema } from '@backstage/catalog-model'; +import v1beta3Schema from './Template.v1beta3.schema.json'; export type { TemplateEntityV1beta3 } from './TemplateEntityV1beta3'; -export { templateEntityV1beta3Schema }; + +/** @public */ +export const templateEntityV1beta3Schema: JSONSchema = v1beta3Schema as Omit< + JSONSchema, + 'examples' +>;