plugins: generate api reports

Signed-off-by: Patrik Oldsberg <poldsberg@gmail.com>
2021-06-17 11:00:16 +02:00
parent 5429bfa69e
commit d8d7226fce
54 changed files with 5209 additions and 0 deletions
@@ -0,0 +1,81 @@
+## API Report File for "@backstage/plugin-circleci"
+
+> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
+
+```ts
+
+import { ApiRef } from '@backstage/core';
+import { BackstagePlugin } from '@backstage/core';
+import { BuildStepAction } from 'circleci-api';
+import { BuildSummary } from 'circleci-api';
+import { BuildSummaryResponse } from 'circleci-api';
+import { BuildWithSteps } from 'circleci-api';
+import { CircleCIOptions } from 'circleci-api';
+import { DiscoveryApi } from '@backstage/core';
+import { Entity } from '@backstage/catalog-model';
+import { GitType } from 'circleci-api';
+import { Me } from 'circleci-api';
+import { RouteRef } from '@backstage/core';
+
+export { BuildStepAction }
+
+export { BuildSummary }
+
+export { BuildWithSteps }
+
+// @public (undocumented)
+export const CIRCLECI_ANNOTATION = "circleci.com/project-slug";
+
+// @public (undocumented)
+export class CircleCIApi {
+    constructor(options: Options);
+    // (undocumented)
+    getBuild(buildNumber: number, options: Partial<CircleCIOptions>): Promise<BuildWithSteps>;
+    // (undocumented)
+    getBuilds({ limit, offset }: {
+        limit: number;
+        offset: number;
+    }, options: Partial<CircleCIOptions>): Promise<BuildSummaryResponse>;
+    // (undocumented)
+    getUser(options: Partial<CircleCIOptions>): Promise<Me>;
+    // (undocumented)
+    retry(buildNumber: number, options: Partial<CircleCIOptions>): Promise<BuildSummary>;
+}
+
+// @public (undocumented)
+export const circleCIApiRef: ApiRef<CircleCIApi>;
+
+// @public (undocumented)
+export const circleCIBuildRouteRef: RouteRef<undefined>;
+
+// @public (undocumented)
+const circleCIPlugin: BackstagePlugin<{}, {}>;
+
+export { circleCIPlugin }
+
+export { circleCIPlugin as plugin }
+
+// @public (undocumented)
+export const circleCIRouteRef: RouteRef<undefined>;
+
+// @public (undocumented)
+export const EntityCircleCIContent: (_props: {
+    entity?: Entity| undefined;
+}) => JSX.Element;
+
+export { GitType }
+
+// @public (undocumented)
+const isCircleCIAvailable: (entity: Entity) => boolean;
+
+export { isCircleCIAvailable }
+
+export { isCircleCIAvailable as isPluginApplicableToEntity }
+
+// @public (undocumented)
+export const Router: (_props: Props) => JSX.Element;
+
+
+// (No @packageDocumentation comment for this package)
+
+```