Add schedule annotation

docs/who-is-on-call-on-component-page.md

@@ -44,3 +44,12 @@ annotations:
 ```
 
 This annotation accepts any valid OpsGenie team name.
+
+If your OpsGenie teams do not directly own schedules (ie. shared schedule), specify the schedule name instead of a team
+name and add an annotation to specify that the team name is actually a schedule:
+
+```yml
+annotations:
+  opsgenie.com/team: 'Awesome Schedule'
+  opsgenie.com/isSchedule: 'true'
+```

src/api.ts

@@ -30,6 +30,7 @@ export interface Opsgenie {
 
   getSchedules(): Promise<Schedule[]>;
   getSchedulesForTeam(name: string): Promise<Schedule[]>;
+  getSchedulesByName(name: string): Promise<Schedule[]>;
   getOnCall(scheduleId: string): Promise<OnCallParticipantRef[]>;
 
   getTeams(): Promise<Team[]>;
@@ -177,6 +178,12 @@ export class OpsgenieApi implements Opsgenie {
     return response.data.filter(schedule => schedule.ownerTeam && schedule.ownerTeam.name === name);
   }
 
+  async getSchedulesByName(name: string): Promise<Schedule[]> {
+    const response = await this.fetch<SchedulesResponse>("/v2/schedules");
+
+    return response.data.filter(schedule => schedule.name === name);
+  }
+
   async getTeams(): Promise<Team[]> {
     const response = await this.fetch<TeamsResponse>("/v2/teams");
 

src/components/Entity/OnCallListCard.tsx

@@ -1,7 +1,7 @@
 import React from 'react';
 import { useEntity } from '@backstage/plugin-catalog-react';
 import { InfoCard, InfoCardVariants, MissingAnnotationEmptyState } from '@backstage/core-components';
-import { OPSGENIE_TEAM_ANNOTATION } from '../../integration';
+import { OPSGENIE_IS_SCHEDULE_ANNOTATION, OPSGENIE_TEAM_ANNOTATION } from '../../integration';
 import { opsgenieApiRef } from '../../api';
 import { OnCallForScheduleList } from '../OnCallList/OnCallList';
 import { Progress } from '@backstage/core-components';
@@ -16,11 +16,18 @@ type OnCallListCardProps = {
 
 type OnCallListContentProps = {
     teamName: string;
+    isSchedule: boolean;
 }
 
-const OnCallListCardContent = ({teamName}: OnCallListContentProps) => {
+const OnCallListCardContent = ({teamName, isSchedule}: OnCallListContentProps) => {
     const opsgenieApi = useApi(opsgenieApiRef);
-    const { value, loading, error } = useAsync(async () => await opsgenieApi.getSchedulesForTeam(teamName));
+
+    const {value, loading, error} = useAsync(async () => {
+        if (isSchedule) {
+            return await opsgenieApi.getSchedulesByName(teamName);
+        }
+        return await opsgenieApi.getSchedulesForTeam(teamName);
+    });
 
     if (loading) {
         return <Progress />;
@@ -42,14 +49,15 @@ const OnCallListCardContent = ({teamName}: OnCallListContentProps) => {
 export const OnCallListCard = ({ title, variant }: OnCallListCardProps) => {
     const { entity } = useEntity();
     const teamName = entity.metadata.annotations?.[OPSGENIE_TEAM_ANNOTATION];
+    const isSchedule = entity.metadata.annotations?.[OPSGENIE_IS_SCHEDULE_ANNOTATION]?.toLowerCase() === 'true' || false;
 
     if (!teamName) {
         return <MissingAnnotationEmptyState annotation={OPSGENIE_TEAM_ANNOTATION} />;
     }
 
     return (
         <InfoCard title={title || "Opsgenie – Who is on-call?"} variant={variant || "gridItem"}>
-            <OnCallListCardContent teamName={teamName} />
+            <OnCallListCardContent teamName={teamName} isSchedule={isSchedule}/>
         </InfoCard>
     )
 };

src/integration.ts

@@ -2,6 +2,7 @@ import { Entity } from "@backstage/catalog-model";
 
 export const OPSGENIE_ANNOTATION = 'opsgenie.com/component-selector';
 export const OPSGENIE_TEAM_ANNOTATION = 'opsgenie.com/team';
+export const OPSGENIE_IS_SCHEDULE_ANNOTATION = 'opsgenie.com/isSchedule';
 
 export const isOpsgenieAvailable = (entity: Entity) => Boolean(entity.metadata.annotations?.[OPSGENIE_ANNOTATION]);
 export const isOpsgenieOnCallListAvailable = (entity: Entity) => Boolean(entity.metadata.annotations?.[OPSGENIE_TEAM_ANNOTATION]);