fix api report

Signed-off-by: aramissennyeydd <aramis.sennyey@doordash.com>
This commit is contained in:
aramissennyeydd
2024-12-26 13:51:24 -07:00
parent 54e7bd9a35
commit e6b480badc
7 changed files with 54 additions and 5 deletions
+3 -3
View File
@@ -21,7 +21,7 @@
"exports": {
".": "./src/index.ts",
"./auditor": "./src/entrypoints/auditor/index.ts",
"./alpha/systemMetadata": "./src/entrypoints/systemMetadata/index.ts",
"./alpha": "./src/entrypoints/alpha.ts",
"./auth": "./src/entrypoints/auth/index.ts",
"./cache": "./src/entrypoints/cache/index.ts",
"./database": "./src/entrypoints/database/index.ts",
@@ -50,8 +50,8 @@
"auditor": [
"src/entrypoints/auditor/index.ts"
],
"alpha/systemMetadata": [
"src/entrypoints/systemMetadata/index.ts"
"alpha": [
"src/entrypoints/alpha.ts"
],
"auth": [
"src/entrypoints/auth/index.ts"
@@ -17,6 +17,29 @@ export const actionsRegistryServiceFactory: ServiceFactory<
// @public (undocumented)
export const actionsServiceFactory: ServiceFactory<
ActionsService,
import { BackstageInstance } from '@backstage/backend-plugin-api/alpha';
import { LoggerService } from '@backstage/backend-plugin-api';
import { RootConfigService } from '@backstage/backend-plugin-api';
import { ServiceFactory } from '@backstage/backend-plugin-api';
import { SystemMetadataService } from '@backstage/backend-plugin-api/alpha';
// Warning: (ae-missing-release-tag) "DefaultSystemMetadataService" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal)
//
// @public (undocumented)
export class DefaultSystemMetadataService implements SystemMetadataService {
constructor(options: { logger: LoggerService; config: RootConfigService });
// (undocumented)
static create(pluginEnv: {
logger: LoggerService;
config: RootConfigService;
}): DefaultSystemMetadataService;
// (undocumented)
listInstances(): Promise<BackstageInstance[]>;
}
// @alpha
export const systemMetadataServiceFactory: ServiceFactory<
SystemMetadataService,
'plugin',
'singleton'
>;
@@ -0,0 +1,16 @@
/*
* 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';
@@ -23,6 +23,9 @@ import {
SystemMetadataService,
} from '@backstage/backend-plugin-api/alpha';
/**
* @alpha
*/
export class DefaultSystemMetadataService implements SystemMetadataService {
private readonly logger: LoggerService;
private readonly config: RootConfigService;
@@ -14,12 +14,19 @@
* limitations under the License.
*/
/** @internal */
type Target = string | { internal: string; external: string };
/**
* @alpha
*/
export interface BackstageInstance {
url: Target;
}
/**
* @alpha
*/
export interface SystemMetadataService {
listInstances(): Promise<BackstageInstance[]>;
}
+1 -1
View File
@@ -15,7 +15,7 @@
*/
import { createBackend } from '@backstage/backend-defaults';
import { systemMetadataServiceFactory } from '@backstage/backend-defaults/alpha/systemMetadata';
import { systemMetadataServiceFactory } from '@backstage/backend-defaults/alpha';
const backend = createBackend();
+1 -1
View File
@@ -19,7 +19,7 @@ import {
coreServices,
createBackendFeatureLoader,
} from '@backstage/backend-plugin-api';
import { systemMetadataServiceFactory } from '@backstage/backend-defaults/alpha/systemMetadata';
import { systemMetadataServiceFactory } from '@backstage/backend-defaults/alpha';
const backend = createBackend();