Skip to content

Reformat API list for Github #17

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
cognifloyd wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Reformat API list for Github #17

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
253 changes: 127 additions & 126 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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