Skip to content
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.

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

Adopt PagerDuty's new API 2.0 #52

Closed
wants to merge 1 commit into from
Closed

Adopt PagerDuty's new API 2.0 #52

wants to merge 1 commit into from

Conversation

reidcooper
Copy link
Contributor

Starting April 28th, PagerDuty will stop issuing API tokens for their v1 API service.

On October 19th, PagerDuty will decommission their v1 API service.

https://v2.developer.pagerduty.com/docs/v1-rest-api-decommissioning-faq

I have adapted the current gem code to support the new syntax of PagerDuty's API v2 service.

Update Readme and docs
Copy link

@majormoses majormoses left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Will try to give it a more thorough review some time this weekend when I have had a chance to read through the changes in the api docs but from a quick look everything made sense.

@orien
Copy link
Member

orien commented Sep 18, 2018

Thanks @reidcooper. It looks like a lot of work went into this!

I think it's important to point out that this gem uses the Events API, not the Rest API. V1 of the Events API is not deprecated and will be available post October 19, as noted in the FAQ.

WILL THE V1 EVENTS API STILL BE SUPPORTED?
This change only affects the v1 REST API. You can continue to use the v1 Events API as you do today.

I'm concerned about introducing a backwards incompatible change. Are we able to support both Pagerduty Event versions in some way?

@majormoses
Copy link

@orien good catch on the events api still gonna be accessible, I did see that a v1 token should still be possible against a v2 api. I think in light of this we could make new v2 methods and have them opt-in on the integration side preventing a breaking change while allowing projects to upgrade to newer APIs for longer term support as I imagine that they won't keep the events v1 API around forever. It's a bit more work but I think it might be worth it since there is no immediate need to update to keep things working.

@majormoses
Copy link

I think we should look at doing this as there are things that can't be set in v1 api such as Severity that defaults to Critical for all events that do not have it attached.

https://v2.developer.pagerduty.com/docs/events-api-v2

@reidcooper
Copy link
Contributor Author

reidcooper commented Oct 19, 2018 via email

@reidcooper
Copy link
Contributor Author

I am going to close this PR. Feel free to use my branch in the future :) Keep up the great work :)

@reidcooper reidcooper closed this Jun 18, 2019
@orien
Copy link
Member

orien commented Jun 18, 2019

Thanks for the contribution @reidcooper. I'll use this as a base, but with additions to maintain backwards compatibility.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants