Add an api-report file

Signed-off-by: Jonathan Mezach <jonathan.mezach@rr-wfm.com>
2023-02-16 08:26:47 +01:00
parent d85c4ae7c0
commit 350ee5dcb6
1 changed files with 100 additions and 0 deletions
@@ -0,0 +1,100 @@
+## API Report File for "@backstage/plugin-octopus-deploy"
+
+> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
+
+```ts
+/// <reference types="react" />
+
+import { ApiRef } from '@backstage/core-plugin-api';
+import { BackstagePlugin } from '@backstage/core-plugin-api';
+import { DiscoveryApi } from '@backstage/core-plugin-api';
+import { Entity } from '@backstage/catalog-model';
+import { IdentityApi } from '@backstage/core-plugin-api';
+
+// Warning: (ae-missing-release-tag) "EntityOctopusDeployContent" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal)
+//
+// @public (undocumented)
+export const EntityOctopusDeployContent: (props: {
+  defaultLimit?: number | undefined;
+}) => JSX.Element;
+
+// @public (undocumented)
+export const isOctopusDeployAvailable: (entity: Entity) => boolean;
+
+// Warning: (ae-missing-release-tag) "OctopusDeployApi" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal)
+//
+// @public (undocumented)
+export interface OctopusDeployApi {
+  // (undocumented)
+  getReleaseProgression(
+    projectId: string,
+    releaseHistoryCount: number,
+  ): Promise<OctopusProgression>;
+}
+
+// Warning: (ae-missing-release-tag) "octopusDeployApiRef" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal)
+//
+// @public (undocumented)
+export const octopusDeployApiRef: ApiRef<OctopusDeployApi>;
+
+// Warning: (ae-missing-release-tag) "OctopusDeployClient" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal)
+//
+// @public (undocumented)
+export class OctopusDeployClient implements OctopusDeployApi {
+  // Warning: (ae-forgotten-export) The symbol "Options" needs to be exported by the entry point index.d.ts
+  constructor(options: Options);
+  // (undocumented)
+  getReleaseProgression(
+    projectId: string,
+    releaseHistoryCount: number,
+  ): Promise<OctopusProgression>;
+}
+
+// Warning: (ae-missing-release-tag) "OctopusDeployment" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal)
+//
+// @public (undocumented)
+export type OctopusDeployment = {
+  State: string;
+};
+
+// Warning: (ae-missing-release-tag) "octopusDeployPlugin" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal)
+//
+// @public (undocumented)
+export const octopusDeployPlugin: BackstagePlugin<{}, {}, {}>;
+
+// Warning: (ae-missing-release-tag) "OctopusEnvironment" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal)
+//
+// @public (undocumented)
+export type OctopusEnvironment = {
+  Id: string;
+  Name: string;
+};
+
+// Warning: (ae-missing-release-tag) "OctopusProgression" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal)
+//
+// @public (undocumented)
+export type OctopusProgression = {
+  Environments: OctopusEnvironment[];
+  Releases: OctopusReleaseProgression[];
+};
+
+// Warning: (ae-missing-release-tag) "OctopusRelease" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal)
+//
+// @public (undocumented)
+export type OctopusRelease = {
+  Id: string;
+  Version: string;
+};
+
+// Warning: (ae-missing-release-tag) "OctopusReleaseProgression" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal)
+//
+// @public (undocumented)
+export type OctopusReleaseProgression = {
+  Release: OctopusRelease;
+  Deployments: {
+    [key: string]: OctopusDeployment[];
+  };
+};
+
+// (No @packageDocumentation comment for this package)
+```