Merge pull request #6076 from backstage/rugvip/allreports

scripts/api-extractor: create and check API reports for all(most) plugins
2021-06-17 15:46:11 +02:00
parent 79a5fc65a8 d8d7226fce
commit 820de63018
55 changed files with 5261 additions and 22 deletions
@@ -0,0 +1,86 @@
+## API Report File for "@backstage/plugin-gcp-projects"
+
+> 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 { OAuthApi } from '@backstage/core';
+import { RouteRef } from '@backstage/core';
+
+// @public (undocumented)
+export type GcpApi = {
+    listProjects(): Promise<Project[]>;
+    getProject(projectId: string): Promise<Project>;
+    createProject(options: {
+        projectId: string;
+        projectName: string;
+    }): Promise<Operation>;
+};
+
+// @public (undocumented)
+export const gcpApiRef: ApiRef<GcpApi>;
+
+// @public (undocumented)
+export class GcpClient implements GcpApi {
+    constructor(googleAuthApi: OAuthApi);
+    // (undocumented)
+    createProject(options: {
+        projectId: string;
+        projectName: string;
+    }): Promise<Operation>;
+    // (undocumented)
+    getProject(projectId: string): Promise<Project>;
+    // (undocumented)
+    getToken(): Promise<string>;
+    // (undocumented)
+    listProjects(): Promise<Project[]>;
+}
+
+// @public (undocumented)
+export const GcpProjectsPage: () => JSX.Element;
+
+// @public (undocumented)
+const gcpProjectsPlugin: BackstagePlugin<{
+    root: RouteRef<undefined>;
+}, {}>;
+
+export { gcpProjectsPlugin }
+
+export { gcpProjectsPlugin as plugin }
+
+// @public (undocumented)
+export type Operation = {
+    name: string;
+    metadata: string;
+    done: boolean;
+    error: Status;
+    response: string;
+};
+
+// @public (undocumented)
+export type Project = {
+    name: string;
+    projectNumber?: string;
+    projectId: string;
+    lifecycleState?: string;
+    createTime?: string;
+};
+
+// @public (undocumented)
+export type ProjectDetails = {
+    details: string;
+};
+
+// @public (undocumented)
+export type Status = {
+    code: number;
+    message: string;
+    details: string[];
+};
+
+
+// (No @packageDocumentation comment for this package)
+
+```