From f7f9da7797bb20b503e3855240317a2cdae9f780 Mon Sep 17 00:00:00 2001 From: Jacob Floyd Date: Mon, 8 Feb 2021 11:55:25 -0600 Subject: [PATCH] Reformat API list for Github This changes the formatting of the API list so that it is easy to read on Github. It looked fine in plain text, but ended up in a big blob when Github formatted it. Also, I opted for `X` instead of [X] so that github wouldn't format some of the bullets as checkboxes but not others. I considered using emoji, but then the plaintext doesn't read well. --- README.md | 253 +++++++++++++++++++++++++++--------------------------- 1 file changed, 127 insertions(+), 126 deletions(-) diff --git a/README.md b/README.md index e5b9d56..a8bd055 100755 --- a/README.md +++ b/README.md @@ -50,129 +50,130 @@ configured in the OpsGenie web interface. ## Coverage of OpsGenie API -Key: -- [X] Completed. -- [-] Partial coverage. -- [?] Not currently planned. -- [ ] Outstanding for current version. - -[-] Alert API - [-] Create Alert - [X] Close Alert - [X] Delete Alert - [?] Get Alert - [X] List Alerts - [X] Count - [?] List Alert Notes - [?] Get Alert Activity Log - [?] List Alert Recipients - [?] Acknowledge - [?] Snooze - [?] Renotify - [?] Take Ownership - [?] Assign - [?] Add Team - [?] Add Recipient - [?] Add Note - [?] Add Tags - [?] Remove Tags - [?] Add Details - [?] Remove Details - [?] Execute Action - [?] Attach File -[-] User API - [?] Create User - [?] Update User - [?] Delete User - [?] Get User - [X] List Users - [?] Copy Notification Rules To Other Users -[-] Group API - [?] Create Group - [?] Update Group - [?] Add Member - [?] Remove Member - [?] Delete Group - [?] Get Group - [X] List Groups -[-] Team API - [?] Create Team - [?] Add Team Member - [?] Remove Team Member - [?] Update Team - [?] Delete Team - [?] Get Team - [X] List Teams - [?] List Team Logs -[?] Escalation API - [?] Create Escalation - [?] Update Escalation - [?] Delete Escalation - [?] Get Escalation - [?] List Escalations -[-] Schedule API - [?] Create Schedule - [?] Update Schedule - [?] Delete Schedule - [?] Get Schedule - [?] Get Schedule Timeline - [?] List Schedules - [?] Who is on-call - [?] List Who is on-call - [X] Who is on-call Next - [?] Export Schedule -[?] Schedule Override API - [?] Add Schedule Override - [?] Update Schedule Override - [?] Delete Schedule Override - [?] Get Schedule Override - [?] List Schedule Overrides -[?] Forwarding Rule API - [?] Add Forwarding Rule - [?] Update Forwarding Rule - [?] Delete Forwarding Rule - [?] Get Forwarding Rule - [?] List Forwarding Rules - [?] List Forwarding Rules for a User -[X] Heartbeat API - [X] Add Heartbeat - [X] Update Heartbeat - [X] Enable Heartbeat - [X] Disable Heartbeat - [X] Delete Heartbeat - [X] Get Heartbeat - [X] List Heartbeats - [X] Send Heartbeat -[?] Notification Rule API - [?] Notification Rule API Requests - [?] Add Notification Rule - [?] Update Notification Rule - [?] Delete Notification Rule - [?] Enable Notification Rule - [?] Disable Notification Rule - [?] Change Notification Rule Order - [?] Repeat Notification Rule - [?] Get Notification Rule - [?] List Notification Rules - [?] Notification Rule Step API Requests - [?] Add Notification Rule Step - [?] Update Notification Rule Step - [?] Delete Notification Rule Step - [?] Enable Notification Rule Step - [?] Disable Notification Rule Step -[?] Contacts API - [?] Add Contact - [?] Update Contact - [?] Delete Contact - [?] Enable Contact - [?] Disable Contact - [?] Get Contact - [?] List Contact -[X] Integration API - [X] Enable Integration - [X] Disable Integration -[X] Policy API - [X] Enable Policy - [X] Disable Policy -[X] Account API - [X] Get Account Info +### Key: +- `X` Completed. +- `-` Partial coverage. +- `?` Not currently planned. +- ` ` Outstanding for current version. + +### APIs +- `-` Alert API + - `-` Create Alert + - `X` Close Alert + - `X` Delete Alert + - `?` Get Alert + - `X` List Alerts + - `X` Count + - `?` List Alert Notes + - `?` Get Alert Activity Log + - `?` List Alert Recipients + - `?` Acknowledge + - `?` Snooze + - `?` Renotify + - `?` Take Ownership + - `?` Assign + - `?` Add Team + - `?` Add Recipient + - `?` Add Note + - `?` Add Tags + - `?` Remove Tags + - `?` Add Details + - `?` Remove Details + - `?` Execute Action + - `?` Attach File +- `-` User API + - `?` Create User + - `?` Update User + - `?` Delete User + - `?` Get User + - `X` List Users + - `?` Copy Notification Rules To Other Users +- `-` Group API + - `?` Create Group + - `?` Update Group + - `?` Add Member + - `?` Remove Member + - `?` Delete Group + - `?` Get Group + - `X` List Groups +- `-` Team API + - `?` Create Team + - `?` Add Team Member + - `?` Remove Team Member + - `?` Update Team + - `?` Delete Team + - `?` Get Team + - `X` List Teams + - `?` List Team Logs +- `?` Escalation API + - `?` Create Escalation + - `?` Update Escalation + - `?` Delete Escalation + - `?` Get Escalation + - `?` List Escalations +- `-` Schedule API + - `?` Create Schedule + - `?` Update Schedule + - `?` Delete Schedule + - `?` Get Schedule + - `?` Get Schedule Timeline + - `?` List Schedules + - `?` Who is on-call + - `?` List Who is on-call + - `X` Who is on-call Next + - `?` Export Schedule +- `?` Schedule Override API + - `?` Add Schedule Override + - `?` Update Schedule Override + - `?` Delete Schedule Override + - `?` Get Schedule Override + - `?` List Schedule Overrides +- `?` Forwarding Rule API + - `?` Add Forwarding Rule + - `?` Update Forwarding Rule + - `?` Delete Forwarding Rule + - `?` Get Forwarding Rule + - `?` List Forwarding Rules + - `?` List Forwarding Rules for a User +- `X` Heartbeat API + - `X` Add Heartbeat + - `X` Update Heartbeat + - `X` Enable Heartbeat + - `X` Disable Heartbeat + - `X` Delete Heartbeat + - `X` Get Heartbeat + - `X` List Heartbeats + - `X` Send Heartbeat +- `?` Notification Rule API + - `?` Notification Rule API Requests + - `?` Add Notification Rule + - `?` Update Notification Rule + - `?` Delete Notification Rule + - `?` Enable Notification Rule + - `?` Disable Notification Rule + - `?` Change Notification Rule Order + - `?` Repeat Notification Rule + - `?` Get Notification Rule + - `?` List Notification Rules + - `?` Notification Rule Step API Requests + - `?` Add Notification Rule Step + - `?` Update Notification Rule Step + - `?` Delete Notification Rule Step + - `?` Enable Notification Rule Step + - `?` Disable Notification Rule Step +- `?` Contacts API + - `?` Add Contact + - `?` Update Contact + - `?` Delete Contact + - `?` Enable Contact + - `?` Disable Contact + - `?` Get Contact + - `?` List Contact +- `X` Integration API + - `X` Enable Integration + - `X` Disable Integration +- `X` Policy API + - `X` Enable Policy + - `X` Disable Policy +- `X` Account API + - `X` Get Account Info