plugins: generate api reports

Signed-off-by: Patrik Oldsberg <poldsberg@gmail.com>
This commit is contained in:
Patrik Oldsberg
2021-06-17 11:00:16 +02:00
parent 5429bfa69e
commit d8d7226fce
54 changed files with 5209 additions and 0 deletions
+68
View File
@@ -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)
```