paulononato/backstage
1
0
Fork 0
Code Issues Pull Requests Actions 21 Packages Projects Releases Wiki Activity

plugins: generate api reports

Browse Source 
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
Download Patch File Download Diff File Expand all files Collapse all files
plugins/ilert/api-report.md
+205
View File
@@ -0,0 +1,205 @@
## API Report File for "@backstage/plugin-ilert"
> 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 { IconComponent } from '@backstage/core';
import { RouteRef } from '@backstage/core';
// @public (undocumented)
export const EntityILertCard: () => JSX.Element;
// @public (undocumented)
export type GetIncidentsCountOpts = {
states?: IncidentStatus[];
};
// @public (undocumented)
export type GetIncidentsOpts = {
maxResults?: number;
startIndex?: number;
states?: IncidentStatus[];
alertSources?: number[];
};
// @public (undocumented)
export interface ILertApi {
// (undocumented)
acceptIncident(incident: Incident, userName: string): Promise<Incident>;
// (undocumented)
addImmediateMaintenance(alertSourceId: number, minutes: number): Promise<void>;
// (undocumented)
assignIncident(incident: Incident, responder: IncidentResponder): Promise<Incident>;
// (undocumented)
createIncident(eventRequest: EventRequest): Promise<boolean>;
// (undocumented)
disableAlertSource(alertSource: AlertSource): Promise<AlertSource>;
// (undocumented)
enableAlertSource(alertSource: AlertSource): Promise<AlertSource>;
// (undocumented)
fetchAlertSource(idOrIntegrationKey: number | string): Promise<AlertSource>;
// (undocumented)
fetchAlertSourceOnCalls(alertSource: AlertSource): Promise<OnCall[]>;
// (undocumented)
fetchAlertSources(): Promise<AlertSource[]>;
// (undocumented)
fetchIncident(id: number): Promise<Incident>;
// (undocumented)
fetchIncidentActions(incident: Incident): Promise<IncidentAction[]>;
// (undocumented)
fetchIncidentResponders(incident: Incident): Promise<IncidentResponder[]>;
// (undocumented)
fetchIncidents(opts?: GetIncidentsOpts): Promise<Incident[]>;
// (undocumented)
fetchIncidentsCount(opts?: GetIncidentsCountOpts): Promise<number>;
// (undocumented)
fetchOnCallSchedules(): Promise<Schedule[]>;
// (undocumented)
fetchUptimeMonitor(id: number): Promise<UptimeMonitor>;
// (undocumented)
fetchUptimeMonitors(): Promise<UptimeMonitor[]>;
// (undocumented)
fetchUsers(): Promise<User[]>;
// (undocumented)
getAlertSourceDetailsURL(alertSource: AlertSource | null): string;
// (undocumented)
getEscalationPolicyDetailsURL(escalationPolicy: EscalationPolicy): string;
// (undocumented)
getIncidentDetailsURL(incident: Incident): string;
// (undocumented)
getScheduleDetailsURL(schedule: Schedule): string;
// (undocumented)
getUptimeMonitorDetailsURL(uptimeMonitor: UptimeMonitor): string;
// (undocumented)
getUserInitials(user: User | null): string;
// (undocumented)
getUserPhoneNumber(user: User | null): string;
// (undocumented)
overrideShift(scheduleId: number, userId: number, start: string, end: string): Promise<Schedule>;
// (undocumented)
pauseUptimeMonitor(uptimeMonitor: UptimeMonitor): Promise<UptimeMonitor>;
// (undocumented)
resolveIncident(incident: Incident, userName: string): Promise<Incident>;
// (undocumented)
resumeUptimeMonitor(uptimeMonitor: UptimeMonitor): Promise<UptimeMonitor>;
// (undocumented)
triggerIncidentAction(incident: Incident, action: IncidentAction): Promise<void>;
}
// @public (undocumented)
export const ilertApiRef: ApiRef<ILertApi>;
// @public (undocumented)
export const ILertCard: () => JSX.Element;
// @public (undocumented)
export class ILertClient implements ILertApi {
constructor(opts: Options);
// (undocumented)
acceptIncident(incident: Incident, userName: string): Promise<Incident>;
// (undocumented)
addImmediateMaintenance(alertSourceId: number, minutes: number): Promise<void>;
// (undocumented)
assignIncident(incident: Incident, responder: IncidentResponder): Promise<Incident>;
// (undocumented)
createIncident(eventRequest: EventRequest): Promise<boolean>;
// (undocumented)
disableAlertSource(alertSource: AlertSource): Promise<AlertSource>;
// (undocumented)
enableAlertSource(alertSource: AlertSource): Promise<AlertSource>;
// (undocumented)
fetchAlertSource(idOrIntegrationKey: number | string): Promise<AlertSource>;
// (undocumented)
fetchAlertSourceOnCalls(alertSource: AlertSource): Promise<OnCall[]>;
// (undocumented)
fetchAlertSources(): Promise<AlertSource[]>;
// (undocumented)
fetchIncident(id: number): Promise<Incident>;
// (undocumented)
fetchIncidentActions(incident: Incident): Promise<IncidentAction[]>;
// (undocumented)
fetchIncidentResponders(incident: Incident): Promise<IncidentResponder[]>;
// (undocumented)
fetchIncidents(opts?: GetIncidentsOpts): Promise<Incident[]>;
// (undocumented)
fetchIncidentsCount(opts?: GetIncidentsCountOpts): Promise<number>;
// (undocumented)
fetchOnCallSchedules(): Promise<Schedule[]>;
// (undocumented)
fetchUptimeMonitor(id: number): Promise<UptimeMonitor>;
// (undocumented)
fetchUptimeMonitors(): Promise<UptimeMonitor[]>;
// (undocumented)
fetchUsers(): Promise<User[]>;
// (undocumented)
static fromConfig(configApi: ConfigApi, discoveryApi: DiscoveryApi): ILertClient;
// (undocumented)
getAlertSourceDetailsURL(alertSource: AlertSource | null): string;
// (undocumented)
getEscalationPolicyDetailsURL(escalationPolicy: EscalationPolicy): string;
// (undocumented)
getIncidentDetailsURL(incident: Incident): string;
// (undocumented)
getScheduleDetailsURL(schedule: Schedule): string;
// (undocumented)
getUptimeMonitorDetailsURL(uptimeMonitor: UptimeMonitor): string;
// (undocumented)
getUserInitials(user: User | null): string;
// (undocumented)
getUserPhoneNumber(user: User | null): string;
// (undocumented)
overrideShift(scheduleId: number, userId: number, start: string, end: string): Promise<Schedule>;
// (undocumented)
pauseUptimeMonitor(uptimeMonitor: UptimeMonitor): Promise<UptimeMonitor>;
// (undocumented)
resolveIncident(incident: Incident, userName: string): Promise<Incident>;
// (undocumented)
resumeUptimeMonitor(uptimeMonitor: UptimeMonitor): Promise<UptimeMonitor>;
// (undocumented)
triggerIncidentAction(incident: Incident, action: IncidentAction): Promise<void>;
}
// @public (undocumented)
export const ILertIcon: IconComponent;
// @public (undocumented)
export const ILertPage: () => JSX.Element;
// @public (undocumented)
const ilertPlugin: BackstagePlugin<{
root: RouteRef<undefined>;
}, {}>;
export { ilertPlugin }
export { ilertPlugin as plugin }
// @public (undocumented)
export const iLertRouteRef: RouteRef<undefined>;
// @public (undocumented)
const isPluginApplicableToEntity: (entity: Entity) => boolean;
export { isPluginApplicableToEntity as isILertAvailable }
export { isPluginApplicableToEntity }
// @public (undocumented)
export const Router: () => JSX.Element;
// @public (undocumented)
export type TableState = {
page: number;
pageSize: number;
};
// (No @packageDocumentation comment for this package)
```