diff --git a/plugins/octopus-deploy/api-report.md b/plugins/octopus-deploy/api-report.md index 3d65e40c64..7295239c28 100644 --- a/plugins/octopus-deploy/api-report.md +++ b/plugins/octopus-deploy/api-report.md @@ -7,6 +7,7 @@ import { ApiRef } from '@backstage/core-plugin-api'; import { BackstagePlugin } from '@backstage/core-plugin-api'; +import { ConfigApi } from '@backstage/core-plugin-api'; import { DiscoveryApi } from '@backstage/core-plugin-api'; import { Entity } from '@backstage/catalog-model'; import { FetchApi } from '@backstage/core-plugin-api'; @@ -25,6 +26,10 @@ export const OCTOPUS_DEPLOY_PROJECT_ID_ANNOTATION = 'octopus.com/project-id'; // @public (undocumented) export interface OctopusDeployApi { + // (undocumented) + getConfig(): Promise; + // (undocumented) + getProjectInfo(projectReference: ProjectReference): Promise; // (undocumented) getReleaseProgression(opts: { projectReference: ProjectReference; @@ -38,11 +43,16 @@ export const octopusDeployApiRef: ApiRef; // @public (undocumented) export class OctopusDeployClient implements OctopusDeployApi { constructor(options: { + configApi: ConfigApi; discoveryApi: DiscoveryApi; fetchApi: FetchApi; proxyPathBase?: string; }); // (undocumented) + getConfig(): Promise; + // (undocumented) + getProjectInfo(projectReference: ProjectReference): Promise; + // (undocumented) getReleaseProgression(opts: { projectReference: ProjectReference; releaseHistoryCount: number; @@ -55,7 +65,7 @@ export type OctopusDeployment = { }; // @public (undocumented) -export const octopusDeployPlugin: BackstagePlugin<{}, {}>; +export const octopusDeployPlugin: BackstagePlugin<{}, {}, {}>; // @public (undocumented) export type OctopusEnvironment = { @@ -63,12 +73,30 @@ export type OctopusEnvironment = { Name: string; }; +// @public (undocumented) +export type OctopusLinks = { + Self: string; + Web: string; +}; + +// @public (undocumented) +export type OctopusPluginConfig = { + WebUiBaseUrl: string; +}; + // @public (undocumented) export type OctopusProgression = { Environments: OctopusEnvironment[]; Releases: OctopusReleaseProgression[]; }; +// @public (undocumented) +export type OctopusProject = { + Name: string; + Slug: string; + Links: OctopusLinks; +}; + // @public (undocumented) export type OctopusRelease = { Id: string;