From 3049109f4f74c5ea8ecefa845e7893c0922c54b2 Mon Sep 17 00:00:00 2001 From: aramissennyeydd Date: Tue, 13 May 2025 17:54:55 -0400 Subject: [PATCH] fix api reports for realz Signed-off-by: aramissennyeydd --- packages/backend-defaults/package.json | 4 ++++ .../backend-defaults/src/entrypoints/alpha.ts | 16 -------------- .../lib/DefaultSystemMetadataService.ts | 2 +- .../lib/createSystemMetadataRouter.ts | 6 ++--- packages/backend-plugin-api/report.api.md | 22 +++++++++++++++++++ .../definitions/SystemMetadataService.ts | 4 ++-- .../src/services/definitions/index.ts | 4 ++++ 7 files changed, 35 insertions(+), 23 deletions(-) delete mode 100644 packages/backend-defaults/src/entrypoints/alpha.ts diff --git a/packages/backend-defaults/package.json b/packages/backend-defaults/package.json index 042b9497b9..3e9c5f57cb 100644 --- a/packages/backend-defaults/package.json +++ b/packages/backend-defaults/package.json @@ -37,6 +37,7 @@ "./rootLifecycle": "./src/entrypoints/rootLifecycle/index.ts", "./rootLogger": "./src/entrypoints/rootLogger/index.ts", "./scheduler": "./src/entrypoints/scheduler/index.ts", + "./systemMetadata": "./src/entrypoints/systemMetadata/index.ts", "./urlReader": "./src/entrypoints/urlReader/index.ts", "./userInfo": "./src/entrypoints/userInfo/index.ts", "./alpha": "./src/alpha/index.ts", @@ -97,6 +98,9 @@ "scheduler": [ "src/entrypoints/scheduler/index.ts" ], + "systemMetadata": [ + "src/entrypoints/systemMetadata/index.ts" + ], "urlReader": [ "src/entrypoints/urlReader/index.ts" ], diff --git a/packages/backend-defaults/src/entrypoints/alpha.ts b/packages/backend-defaults/src/entrypoints/alpha.ts deleted file mode 100644 index a26522c228..0000000000 --- a/packages/backend-defaults/src/entrypoints/alpha.ts +++ /dev/null @@ -1,16 +0,0 @@ -/* - * Copyright 2024 The Backstage Authors - * - * Licensed under the Apache License, Version 2.0 (the "License"); - * you may not use this file except in compliance with the License. - * You may obtain a copy of the License at - * - * http://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, - * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the License for the specific language governing permissions and - * limitations under the License. - */ -export * from './systemMetadata'; diff --git a/packages/backend-defaults/src/entrypoints/systemMetadata/lib/DefaultSystemMetadataService.ts b/packages/backend-defaults/src/entrypoints/systemMetadata/lib/DefaultSystemMetadataService.ts index 41fd4aa0a2..5277e05cae 100644 --- a/packages/backend-defaults/src/entrypoints/systemMetadata/lib/DefaultSystemMetadataService.ts +++ b/packages/backend-defaults/src/entrypoints/systemMetadata/lib/DefaultSystemMetadataService.ts @@ -21,7 +21,7 @@ import { import { BackstageInstance, SystemMetadataService, -} from '@backstage/backend-plugin-api/alpha'; +} from '@backstage/backend-plugin-api'; import z from 'zod'; const targetObjectSchema = z.object({ diff --git a/packages/backend-defaults/src/entrypoints/systemMetadata/lib/createSystemMetadataRouter.ts b/packages/backend-defaults/src/entrypoints/systemMetadata/lib/createSystemMetadataRouter.ts index 6da27958c0..fb7add8ed6 100644 --- a/packages/backend-defaults/src/entrypoints/systemMetadata/lib/createSystemMetadataRouter.ts +++ b/packages/backend-defaults/src/entrypoints/systemMetadata/lib/createSystemMetadataRouter.ts @@ -15,10 +15,8 @@ */ import { LoggerService } from '@backstage/backend-plugin-api'; -import { - BackendFeatureMeta, - SystemMetadataService, -} from '@backstage/backend-plugin-api/alpha'; +import { BackendFeatureMeta } from '@backstage/backend-plugin-api/alpha'; +import type { SystemMetadataService } from '@backstage/backend-plugin-api'; import Router from 'express-promise-router'; export async function createSystemMetadataRouter(options: { diff --git a/packages/backend-plugin-api/report.api.md b/packages/backend-plugin-api/report.api.md index c46ed254c8..17e52caf63 100644 --- a/packages/backend-plugin-api/report.api.md +++ b/packages/backend-plugin-api/report.api.md @@ -137,6 +137,14 @@ export type BackstageCredentials = { principal: TPrincipal; }; +// @public (undocumented) +export interface BackstageInstance { + // (undocumented) + externalUrl: string; + // (undocumented) + internalUrl: string; +} + // @public export type BackstageNonePrincipal = { type: 'none'; @@ -237,6 +245,12 @@ export namespace coreServices { 'root', 'singleton' >; + const // @alpha + systemMetadataServiceRef: ServiceRef< + SystemMetadataService, + 'root', + 'singleton' + >; } // @public @@ -744,6 +758,14 @@ export interface ServiceRefOptions< scope?: TScope; } +// @public (undocumented) +export interface SystemMetadataService { + // (undocumented) + introspect(): Promise<{ + instances: BackstageInstance[]; + }>; +} + // @public export interface UrlReaderService { readTree( diff --git a/packages/backend-plugin-api/src/services/definitions/SystemMetadataService.ts b/packages/backend-plugin-api/src/services/definitions/SystemMetadataService.ts index ebbb07b25a..83066225fe 100644 --- a/packages/backend-plugin-api/src/services/definitions/SystemMetadataService.ts +++ b/packages/backend-plugin-api/src/services/definitions/SystemMetadataService.ts @@ -15,7 +15,7 @@ */ /** - * @alpha + * @public */ export interface BackstageInstance { internalUrl: string; @@ -23,7 +23,7 @@ export interface BackstageInstance { } /** - * @alpha + * @public */ export interface SystemMetadataService { introspect(): Promise<{ instances: BackstageInstance[] }>; diff --git a/packages/backend-plugin-api/src/services/definitions/index.ts b/packages/backend-plugin-api/src/services/definitions/index.ts index 6bcee4b043..4e01553a76 100644 --- a/packages/backend-plugin-api/src/services/definitions/index.ts +++ b/packages/backend-plugin-api/src/services/definitions/index.ts @@ -72,6 +72,10 @@ export type { SchedulerServiceTaskScheduleDefinition, SchedulerServiceTaskScheduleDefinitionConfig, } from './SchedulerService'; +export type { + BackstageInstance, + SystemMetadataService, +} from './SystemMetadataService'; export type { UrlReaderService, UrlReaderServiceReadTreeOptions,