diff --git a/plugins/gcp-projects/api-report.md b/plugins/gcp-projects/api-report.md index 46c8dd2c2f..5b7604c935 100644 --- a/plugins/gcp-projects/api-report.md +++ b/plugins/gcp-projects/api-report.md @@ -10,8 +10,6 @@ import { BackstagePlugin } from '@backstage/core-plugin-api'; import { OAuthApi } from '@backstage/core-plugin-api'; import { RouteRef } from '@backstage/core-plugin-api'; -// Warning: (ae-missing-release-tag) "GcpApi" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal) -// // @public (undocumented) export type GcpApi = { listProjects(): Promise; @@ -22,13 +20,9 @@ export type GcpApi = { }): Promise; }; -// Warning: (ae-missing-release-tag) "gcpApiRef" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal) -// // @public (undocumented) export const gcpApiRef: ApiRef; -// Warning: (ae-missing-release-tag) "GcpClient" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal) -// // @public (undocumented) export class GcpClient implements GcpApi { constructor(googleAuthApi: OAuthApi); @@ -45,13 +39,9 @@ export class GcpClient implements GcpApi { listProjects(): Promise; } -// Warning: (ae-missing-release-tag) "GcpProjectsPage" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal) -// // @public (undocumented) export const GcpProjectsPage: () => JSX.Element; -// Warning: (ae-missing-release-tag) "gcpProjectsPlugin" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal) -// // @public (undocumented) const gcpProjectsPlugin: BackstagePlugin< { @@ -63,8 +53,6 @@ const gcpProjectsPlugin: BackstagePlugin< export { gcpProjectsPlugin }; export { gcpProjectsPlugin as plugin }; -// Warning: (ae-missing-release-tag) "Operation" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal) -// // @public (undocumented) export type Operation = { name: string; @@ -74,8 +62,6 @@ export type Operation = { response: string; }; -// Warning: (ae-missing-release-tag) "Project" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal) -// // @public (undocumented) export type Project = { name: string; @@ -85,15 +71,11 @@ export type Project = { createTime?: string; }; -// Warning: (ae-missing-release-tag) "ProjectDetails" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal) -// // @public (undocumented) export type ProjectDetails = { details: string; }; -// Warning: (ae-missing-release-tag) "Status" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal) -// // @public (undocumented) export type Status = { code: number; diff --git a/plugins/gcp-projects/src/api/GcpApi.ts b/plugins/gcp-projects/src/api/GcpApi.ts index 9167d2983f..434da5fd28 100644 --- a/plugins/gcp-projects/src/api/GcpApi.ts +++ b/plugins/gcp-projects/src/api/GcpApi.ts @@ -17,10 +17,12 @@ import { Project, Operation } from './types'; import { createApiRef } from '@backstage/core-plugin-api'; +/** @public */ export const gcpApiRef = createApiRef({ id: 'plugin.gcpprojects.service', }); +/** @public */ export type GcpApi = { listProjects(): Promise; getProject(projectId: string): Promise; diff --git a/plugins/gcp-projects/src/api/GcpClient.ts b/plugins/gcp-projects/src/api/GcpClient.ts index f226e3b20c..10dcb5a4c8 100644 --- a/plugins/gcp-projects/src/api/GcpClient.ts +++ b/plugins/gcp-projects/src/api/GcpClient.ts @@ -21,6 +21,7 @@ import { OAuthApi } from '@backstage/core-plugin-api'; const BASE_URL = 'https://content-cloudresourcemanager.googleapis.com/v1/projects'; +/** @public */ export class GcpClient implements GcpApi { constructor(private readonly googleAuthApi: OAuthApi) {} diff --git a/plugins/gcp-projects/src/api/types.ts b/plugins/gcp-projects/src/api/types.ts index 6b70c627d2..8e3dd39519 100644 --- a/plugins/gcp-projects/src/api/types.ts +++ b/plugins/gcp-projects/src/api/types.ts @@ -14,6 +14,7 @@ * limitations under the License. */ +/** @public */ export type Project = { name: string; projectNumber?: string; @@ -22,10 +23,12 @@ export type Project = { createTime?: string; }; +/** @public */ export type ProjectDetails = { details: string; }; +/** @public */ export type Operation = { name: string; metadata: string; @@ -34,6 +37,7 @@ export type Operation = { response: string; }; +/** @public */ export type Status = { code: number; message: string; diff --git a/plugins/gcp-projects/src/plugin.ts b/plugins/gcp-projects/src/plugin.ts index 080d051ee3..fede29e3b5 100644 --- a/plugins/gcp-projects/src/plugin.ts +++ b/plugins/gcp-projects/src/plugin.ts @@ -23,6 +23,7 @@ import { googleAuthApiRef, } from '@backstage/core-plugin-api'; +/** @public */ export const gcpProjectsPlugin = createPlugin({ id: 'gcp-projects', routes: { @@ -39,6 +40,7 @@ export const gcpProjectsPlugin = createPlugin({ ], }); +/** @public */ export const GcpProjectsPage = gcpProjectsPlugin.provide( createRoutableExtension({ name: 'GcpProjectsPage', diff --git a/scripts/api-extractor.ts b/scripts/api-extractor.ts index fbd5b71196..7e79e14ade 100644 --- a/scripts/api-extractor.ts +++ b/scripts/api-extractor.ts @@ -215,7 +215,6 @@ const ALLOW_WARNINGS = [ 'plugins/explore', 'plugins/explore-react', 'plugins/firehydrant', - 'plugins/gcp-projects', 'plugins/git-release-manager', 'plugins/github-actions', 'plugins/github-deployments',