From c16fcd21dec89128b0ab4e7a77c12118944eb79c Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Fredrik=20Adel=C3=B6w?= Date: Fri, 19 Aug 2022 13:17:56 +0200 Subject: [PATCH] config-schema MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: Fredrik Adelöw --- plugins/config-schema/api-report.md | 16 ++++++---------- plugins/config-schema/src/api/index.ts | 2 +- plugins/config-schema/src/api/types.ts | 3 +++ plugins/config-schema/src/plugin.ts | 2 ++ scripts/api-extractor.ts | 1 - 5 files changed, 12 insertions(+), 12 deletions(-) diff --git a/plugins/config-schema/api-report.md b/plugins/config-schema/api-report.md index 4b9f47c950..7d110c34d4 100644 --- a/plugins/config-schema/api-report.md +++ b/plugins/config-schema/api-report.md @@ -11,28 +11,18 @@ import { Observable } from '@backstage/types'; import { RouteRef } from '@backstage/core-plugin-api'; import { Schema } from 'jsonschema'; -// Warning: (ae-missing-release-tag) "ConfigSchemaApi" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal) -// // @public (undocumented) export interface ConfigSchemaApi { - // Warning: (ae-forgotten-export) The symbol "ConfigSchemaResult" needs to be exported by the entry point index.d.ts - // // (undocumented) schema$(): Observable; } -// Warning: (ae-missing-release-tag) "configSchemaApiRef" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal) -// // @public (undocumented) export const configSchemaApiRef: ApiRef; -// Warning: (ae-missing-release-tag) "ConfigSchemaPage" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal) -// // @public (undocumented) export const ConfigSchemaPage: () => JSX.Element; -// Warning: (ae-missing-release-tag) "configSchemaPlugin" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal) -// // @public (undocumented) export const configSchemaPlugin: BackstagePlugin< { @@ -42,6 +32,12 @@ export const configSchemaPlugin: BackstagePlugin< {} >; +// @public (undocumented) +export interface ConfigSchemaResult { + // (undocumented) + schema?: Schema; +} + // @public export class StaticSchemaLoader implements ConfigSchemaApi { constructor(options?: { url?: string }); diff --git a/plugins/config-schema/src/api/index.ts b/plugins/config-schema/src/api/index.ts index 8c1532ed0c..18319a2fe7 100644 --- a/plugins/config-schema/src/api/index.ts +++ b/plugins/config-schema/src/api/index.ts @@ -15,5 +15,5 @@ */ export { configSchemaApiRef } from './types'; -export type { ConfigSchemaApi } from './types'; +export type { ConfigSchemaApi, ConfigSchemaResult } from './types'; export { StaticSchemaLoader } from './StaticSchemaLoader'; diff --git a/plugins/config-schema/src/api/types.ts b/plugins/config-schema/src/api/types.ts index 13cd4f602b..b0c43495cf 100644 --- a/plugins/config-schema/src/api/types.ts +++ b/plugins/config-schema/src/api/types.ts @@ -18,14 +18,17 @@ import { Schema } from 'jsonschema'; import { createApiRef } from '@backstage/core-plugin-api'; import { Observable } from '@backstage/types'; +/** @public */ export interface ConfigSchemaResult { schema?: Schema; } +/** @public */ export interface ConfigSchemaApi { schema$(): Observable; } +/** @public */ export const configSchemaApiRef = createApiRef({ id: 'plugin.config-schema', }); diff --git a/plugins/config-schema/src/plugin.ts b/plugins/config-schema/src/plugin.ts index 91d7daa871..a0ad45f18c 100644 --- a/plugins/config-schema/src/plugin.ts +++ b/plugins/config-schema/src/plugin.ts @@ -20,6 +20,7 @@ import { createRoutableExtension, } from '@backstage/core-plugin-api'; +/** @public */ export const configSchemaPlugin = createPlugin({ id: 'config-schema', routes: { @@ -27,6 +28,7 @@ export const configSchemaPlugin = createPlugin({ }, }); +/** @public */ export const ConfigSchemaPage = configSchemaPlugin.provide( createRoutableExtension({ name: 'ConfigSchemaPage', diff --git a/scripts/api-extractor.ts b/scripts/api-extractor.ts index 5718f7a458..b4fc287c03 100644 --- a/scripts/api-extractor.ts +++ b/scripts/api-extractor.ts @@ -208,7 +208,6 @@ const ALLOW_WARNINGS = [ 'plugins/catalog-import', 'plugins/cicd-statistics', 'plugins/circleci', - 'plugins/config-schema', 'plugins/cost-insights', 'plugins/dynatrace', 'plugins/explore',