From bb256781b07cfc7abd0a503d0fc34f88fe127ee5 Mon Sep 17 00:00:00 2001 From: Andre Wanlin Date: Fri, 17 Sep 2021 16:42:34 -0500 Subject: [PATCH] Fixed up API Report Signed-off-by: Andre Wanlin --- plugins/azure-devops-backend/api-report.md | 41 ++++++++++++++++++- plugins/azure-devops-backend/src/api/index.ts | 1 + plugins/azure-devops-backend/src/index.ts | 3 +- 3 files changed, 42 insertions(+), 3 deletions(-) diff --git a/plugins/azure-devops-backend/api-report.md b/plugins/azure-devops-backend/api-report.md index 35f4ff606d..513fd64f04 100644 --- a/plugins/azure-devops-backend/api-report.md +++ b/plugins/azure-devops-backend/api-report.md @@ -4,23 +4,60 @@ ```ts import { Build } from 'azure-devops-node-api/interfaces/BuildInterfaces'; +import { BuildResult } from 'azure-devops-node-api/interfaces/BuildInterfaces'; +import { BuildStatus } from 'azure-devops-node-api/interfaces/BuildInterfaces'; import { Config } from '@backstage/config'; import express from 'express'; import { GitRepository } from 'azure-devops-node-api/interfaces/GitInterfaces'; import { Logger as Logger_2 } from 'winston'; import { WebApi } from 'azure-devops-node-api'; +// Warning: (ae-missing-release-tag) "AzureDevOpsApi" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal) +// +// @public (undocumented) +export class AzureDevOpsApi { + constructor(logger: Logger_2, webApi: WebApi); + // (undocumented) + getBuildList( + projectName: string, + repoId: string, + top: string, + ): Promise; + // (undocumented) + getGitRepository( + projectName: string, + repoName: string, + ): Promise; + // (undocumented) + getRepoBuilds( + projectName: string, + repoName: string, + top: string, + ): Promise; +} + // Warning: (ae-missing-release-tag) "createRouter" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal) // // @public (undocumented) export function createRouter(options: RouterOptions): Promise; +// Warning: (ae-missing-release-tag) "RepoBuild" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal) +// +// @public (undocumented) +export type RepoBuild = { + id?: number; + title: string; + link: string; + status?: BuildStatus; + result?: BuildResult; + queueTime?: Date; + source: string; +}; + // Warning: (ae-missing-release-tag) "RouterOptions" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal) // // @public (undocumented) export interface RouterOptions { - // Warning: (ae-forgotten-export) The symbol "AzureDevOpsApi" needs to be exported by the entry point index.d.ts - // // (undocumented) azureDevOpsApi?: AzureDevOpsApi; // (undocumented) diff --git a/plugins/azure-devops-backend/src/api/index.ts b/plugins/azure-devops-backend/src/api/index.ts index 903c1bdb6a..8faf37fe4e 100644 --- a/plugins/azure-devops-backend/src/api/index.ts +++ b/plugins/azure-devops-backend/src/api/index.ts @@ -15,3 +15,4 @@ */ export { AzureDevOpsApi } from './AzureDevOpsApi'; +export type { RepoBuild } from './types'; diff --git a/plugins/azure-devops-backend/src/index.ts b/plugins/azure-devops-backend/src/index.ts index f2c8407292..a7004ec73e 100644 --- a/plugins/azure-devops-backend/src/index.ts +++ b/plugins/azure-devops-backend/src/index.ts @@ -13,5 +13,6 @@ * See the License for the specific language governing permissions and * limitations under the License. */ - +export { AzureDevOpsApi } from './api'; +export type { RepoBuild } from './api'; export * from './service/router';