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,68 @@
+## API Report File for "@backstage/plugin-splunk-on-call"
+
+> 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 { ConfigApi } from '@backstage/core';
+import { DiscoveryApi } from '@backstage/core';
+import { Entity } from '@backstage/catalog-model';
+import { RouteRef } from '@backstage/core';
+
+// @public (undocumented)
+export const EntitySplunkOnCallCard: () => JSX.Element;
+
+// @public (undocumented)
+export const isSplunkOnCallAvailable: (entity: Entity) => boolean;
+
+// @public (undocumented)
+export const splunkOnCallApiRef: ApiRef<SplunkOnCallApi>;
+
+// @public (undocumented)
+export class SplunkOnCallClient implements SplunkOnCallApi {
+    constructor(config: ClientApiConfig);
+    // (undocumented)
+    static fromConfig(configApi: ConfigApi, discoveryApi: DiscoveryApi): SplunkOnCallClient;
+    // (undocumented)
+    getEscalationPolicies(): Promise<EscalationPolicyInfo[]>;
+    // (undocumented)
+    getIncidents(): Promise<Incident[]>;
+    // (undocumented)
+    getOnCallUsers(): Promise<OnCall[]>;
+    // (undocumented)
+    getTeams(): Promise<Team[]>;
+    // (undocumented)
+    getUsers(): Promise<User[]>;
+    // (undocumented)
+    incidentAction({ routingKey, incidentType, incidentId, incidentDisplayName, incidentMessage, incidentStartTime, }: TriggerAlarmRequest): Promise<Response>;
+    }
+
+// @public (undocumented)
+export const SplunkOnCallPage: {
+    ({ title, subtitle, pageTitle, }: SplunkOnCallPageProps): JSX.Element;
+    defaultProps: {
+        title: string;
+        subtitle: string;
+        pageTitle: string;
+    };
+};
+
+// @public (undocumented)
+const splunkOnCallPlugin: BackstagePlugin<{
+    root: RouteRef<undefined>;
+}, {}>;
+
+export { splunkOnCallPlugin as plugin }
+
+export { splunkOnCallPlugin }
+
+// @public (undocumented)
+export class UnauthorizedError extends Error {
+}
+
+
+// (No @packageDocumentation comment for this package)
+
+```