Added api reports for octopus deploy plugin

Signed-off-by: Graeme Christie <gchristie@bunnings.com.au>
This commit is contained in:
Graeme Christie
2023-10-25 11:49:31 +08:00
parent 38b0c8f44c
commit c41f48bcc7
+29 -1
View File
@@ -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<OctopusPluginConfig>;
// (undocumented)
getProjectInfo(projectReference: ProjectReference): Promise<OctopusProject>;
// (undocumented)
getReleaseProgression(opts: {
projectReference: ProjectReference;
@@ -38,11 +43,16 @@ export const octopusDeployApiRef: ApiRef<OctopusDeployApi>;
// @public (undocumented)
export class OctopusDeployClient implements OctopusDeployApi {
constructor(options: {
configApi: ConfigApi;
discoveryApi: DiscoveryApi;
fetchApi: FetchApi;
proxyPathBase?: string;
});
// (undocumented)
getConfig(): Promise<OctopusPluginConfig>;
// (undocumented)
getProjectInfo(projectReference: ProjectReference): Promise<OctopusProject>;
// (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;