config-schema

Signed-off-by: Fredrik Adelöw <freben@gmail.com>

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<ConfigSchemaResult>;
 }
 
-// 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<ConfigSchemaApi>;
 
-// 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 });

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';

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<ConfigSchemaResult>;
 }
 
+/** @public */
 export const configSchemaApiRef = createApiRef<ConfigSchemaApi>({
   id: 'plugin.config-schema',
 });

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',

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',