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,82 @@
+## API Report File for "@backstage/plugin-graphiql"
+
+> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
+
+```ts
+
+import { ApiRef } from '@backstage/core-plugin-api';
+import { BackstagePlugin } from '@backstage/core-plugin-api';
+import { ErrorApi } from '@backstage/core-plugin-api';
+import { IconComponent } from '@backstage/core';
+import { OAuthApi } from '@backstage/core-plugin-api';
+import { RouteRef } from '@backstage/core-plugin-api';
+
+// @public (undocumented)
+export type EndpointConfig = {
+    id: string;
+    title: string;
+    url: string;
+    method?: 'POST';
+    headers?: {
+        [name in string]: string;
+    };
+};
+
+// @public (undocumented)
+export type GithubEndpointConfig = {
+    id: string;
+    title: string;
+    url?: string;
+    errorApi?: ErrorApi;
+    githubAuthApi: OAuthApi;
+};
+
+// @public (undocumented)
+export const GraphiQLIcon: IconComponent;
+
+// @public (undocumented)
+export const GraphiQLPage: () => JSX.Element;
+
+// @public (undocumented)
+const graphiqlPlugin: BackstagePlugin<{}, {}>;
+
+export { graphiqlPlugin }
+
+export { graphiqlPlugin as plugin }
+
+// @public (undocumented)
+export const graphiQLRouteRef: RouteRef<undefined>;
+
+// @public (undocumented)
+export type GraphQLBrowseApi = {
+    getEndpoints(): Promise<GraphQLEndpoint[]>;
+};
+
+// @public (undocumented)
+export const graphQlBrowseApiRef: ApiRef<GraphQLBrowseApi>;
+
+// @public (undocumented)
+export type GraphQLEndpoint = {
+    id: string;
+    title: string;
+    fetcher: (body: any) => Promise<any>;
+};
+
+// @public (undocumented)
+export class GraphQLEndpoints implements GraphQLBrowseApi {
+    // (undocumented)
+    static create(config: EndpointConfig): GraphQLEndpoint;
+    // (undocumented)
+    static from(endpoints: GraphQLEndpoint[]): GraphQLEndpoints;
+    // (undocumented)
+    getEndpoints(): Promise<GraphQLEndpoint[]>;
+    static github(config: GithubEndpointConfig): GraphQLEndpoint;
+}
+
+// @public (undocumented)
+export const Router: () => JSX.Element;
+
+
+// (No @packageDocumentation comment for this package)
+
+```