v1.8.0

See CHANGELOG.md.

v1.7.0

What's Changed

• Upgades Go and dependencies by @ChuckCrawford in #466
• Add Incident Notification Subscribers by @caveman280 in #461
• Implement Event Orchestrations API by @EronWright in #450

New Contributors

• @caveman280 made their first contribution in #461
• @EronWright made their first contribution in #450

Full Changelog: v1.6.0...v1.7.0

1.6.0

A Quick Word from Us

Hello there! We just wanted to drop in and address the elephant in the room. In a previous release we made a promise to maintain API compatibility for future v1 releases. This release contains a few changes that may require minor updates to the way your code interacts with API request and response objects. These changes are necessary in order to make these APIs work properly for as many of you as possible.

One of our goals with this client library is to provide a working client that properly interacts with the PagerDuty Public API. While we remain committed to not breaking API compatibility for reasons such as "making the library [better | easier to use | etc.]"; we believe it is in all of our best interest to make this client library work.

As always, we welcome your feedback on this decision via a GitHub issue.

Highlights

• Returns custom error type EventsAPIV2Error for errors that occur with Events API (V2) calls by @theckman in #419
• List notifications API now works when using includes by @jaimegago in #439
• Improves support for macOS builds by @mjlshen in #434
• Fix potential panic when debug request captures are enabled by @theckman in #443
• Fixes memory leak by @attilakunelwood in #453
• Prevent leak on error responses by @ChuckCrawford in #454
• This project has a new primary branch. Long live the main branch!

Breaking Changes

• Fix unmarshaling error with AlertGroupingParameters timeout by @mjlshen in #459
• Fix parsing bug for AlertGroupingParameters by @mjlshen in #448
• Fix ResponderRequest regression by @ehlerorngard in #452

New Contributors

• @jaimegago made their first contribution in #439
• @mjlshen made their first contribution in #434
• @attilakunelwood made their first contribution in #453
• @ChuckCrawford made their first contribution in #454
• @ehlerorngard made their first contribution in #452

Full Changelog: v1.5.0...1.6.0
Milestone: Milestone 1.6.0

1.5.1

Milestone
Full Changelog

Highlights

• Fix panic that would occur when debug request capturing is enabled, and request has a nil HTTP body (GET request)
• Fix options for ListNotifications, where URL parameters weren't being set correctly.

Closed issues

None

Merged pull requests

• Backport fix for panic when debug request captures are enabled #444 (theckman)
• Backport: Fix list notifications options #445 (jaimegago, backported by theckman)

1.5.0 - BREAKING CHANGES

Milestone
Full Changelog

NOTICE

This release is special, and intentionally includes breaking API changes without
bumping the module's major version. We apologize for any inconveience this
causes, but we felt this approach was better than incurring the cost of
releasing v2 today. Specifically, we believed it was best to break the API, so
that you became aware of features you depended on that were not working as you
expected. We welcome your feedback on this decision via a GitHub issue.

These changes largely fix API issues that would have made it impossible for the
this module to be used correctly. Most often this is due to incorrect or invalid
struct fields, others were a lack of required inputs to specific actions.

We commit henceforth to maintaining API compatibility for future v1 releases.

Highlights

• Add support for handling signature verification of V3 Webhook requests.
• Update APIError type to provide more helpful error strings.
• Add support for API debugging, by allowing capture of the request/response from the API.
• Added various missing fields to different structs.
• Add support for response plays, fetching audit records, and setting up email filters.

Breaking changes

• Fix the ResponderRequest input/output structures #328 (CerealBoy)
• Fix overlapping struct fields in Incident, Service, and User types #332 (theckman)
• Remove *http.Response return from different API methods. #357 #358 #359 #360 #361 (theckman)
• Add missing required From parameter to ManageIncidentAlerts #380 (theckman)
• Fix mismatches between REST API and struct definitions #396 #414 (theckman)
• Update pagination query params to conform to API spec #405 (theckman)

Closed issues

• incident.ID or incident.Id #218 (mblaschke)
• Improper unmarshalling #232 (Erog38)
• Update initialisms / acronyms to be capitalized #268 (theckman)
• Add IncidentDetails.Title field and mark IncidentDetails.Description as deprecated #277 (theckman)
• Remove *http.Response returns from API methods #305 (theckman)
• Add ability to create or update integrations with email filter rules #315 (gerardocorea)
• EscalationRule struct should accept a slice of APIReference rather then APIObject for Targets #316 (gerardocorea)
• User slice fields missing omitempty #343 (theckman)
• Should all fields in Service type be omitempty #348 (callumj)
• ManageIncidentsOptions doesn't take EscalationLevel #364 (sim1s)
• Setting conference information in new incident #373 (bparlidoordash)
• Validate that all structure formats and method signatures work with PagerDuty API #389 (theckman)
• When creating an incident, consumers shouldn't need to set the Type field #390 (theckman)
• Reduce code duplication in analytics.go #393 (theckman)
• Add support for fetching Audit Records #394 (theckman)

Merged pull requests

• Add assignees to log entry #237 (tautvydass)
• Add support for better API debugging; start v1.5.0 development #325 (theckman)
• Fix the ResponderRequest input/output structures #328 (CerealBoy)
• Fix overlapping struct fields & last golint errors #332 (theckman)
• Add comment indicating IncidentDetails.Description is deprecated #333 (theckman)
• Update APIError.Error() to provide more helpful error messages #334 (theckman)
• Add comment above IncidentDetails.Alerts field explaining behaviors #335 (theckman)
• Correct formatting of deprecation notices. #340 (dsymonds)
• Fix pd schedule override create. #341 (dsymonds)
• allow setting suppress to false #345 (cluarkhpe)
• Swap two transposed words in the README file #350 (theckman)
• Fixing link to PD API Reference #356 (stmcallister)
• Remove returned *http.Response from incident-related methods #357 (theckman)
• Remove returned *http.Response from business svc related methods #358 (theckman)
• Remove returned *http.Response from svc dependency related methods #359 (theckman)
• Remove returned *http.Response from tag-related methods #360 (theckman)
• Remove returned *http.Response from ruleset-related methods #361 (theckman)
• implement missing maintenance-window subcommands #363 (Hsn723)
• Add json field incidents_responders to Incident struct #365 (sostakas)
• Adding escalation level to ManageIncidentOptions #366 (sim1s)
• Add v3 webhook signature verification #370 (theckman)
• Fix test after merging #332 (2f47dfc) #371 (theckman)
• Add title to ManageIncidentOptions #372 (d33d33)
• Add Service and User to LogEntry #377 (theckman)
• Add missing required parameeter to ManageIncidentAlerts #380 (theckman)
• Handle unexpected type changes in PagerDuty REST API error responses #382 (theckman)
• Add omitempty JSON tag to User slice fields #383 (theckman)
• Add omitempty JSON tag to specific Service fields #384(theckman)
• Add support for adding email filters for Generic Email Integrations #385 (theckman)
• Support adding conference bridge when creating or managing incidents #391 (theckman)
• Mark Type struct field deprecated, for incident creation + management #392 ([theckman](https://github.com/theckma...

1.4.3

Milestone
Full Changelog

Highlights

• Mitigate PagerDuty REST API bug that would result in a JSON parsing failure when reading an error response from the API. Prior to v1.4.0 our error parsing logic was not impacted by the bug.

Merged pull requests

• Handle unexpected type changes in PagerDuty REST API error responses #382 [backported via #386] (theckman)

Closed issues

• APIError unmarshaling broken in 1.4 #339 (dsymonds)

1.4.2

Milestone
Full Changelog

Highlights

• Fix bug that prevented CreateService() from working when SupportHours and ScheduledActions were unset.

Merged pull requests

• Add omitempty on Service.SupportHours and Service.ScheduledActions #352 (theckman)

Closed issues

• Backward incompatability - CreateService - existing setup works in 1.3.0 but not in 1.4.x #346 (onikroo)

1.4.1

Milestone
Full Changelog

Highlights

• Fix bugs that impacted pagination of both tags and business services

Merged pull requests

• Fix query params on tags #329 (jfmyers9)
• Fix pagination within ListBusinessServices + Paginated #330 (theckman)

1.4.0

Milestone
Full Changelog

Highlights

• Add support for passing a context.Context to all methods in package (in non-breaking way)
• Add new APIError type, that allows for richer inspection of errors returned from API.
• Add support for the V2 Events API, Analytics, and Change Events.
• Miscellaneous bug fixes, including some that may result in incorrect API request/response handling.

Closed issues

• CreateEventWithHTTPClient nil pointer dereference #274 (blockpane)
• ManageIncidents - support set resolution #243 (hagaishapira)
• Exposing context.Context in exported API without requiring major version bump #267 (theckman)
• Fix any linter issues and add missing GoDoc comments #317 (theckman)

Merged pull requests

• Fix rulset rule not respecting position "0" #236 (zane-deg)
• Event v2 client #241 (goatherder)
• Add Support For Change Events #246 (Sjeanpierre)
• Correct namespacing of Change Event resource #248 (Sjeanpierre)
• add tag and tag_test #252 (stmcallister)
• allow creating services with no scheduled actions #234 (cluarkhpe)
• business_service: clean b.ID before calling UPDATE #253 (GiedriusS)
• service_dependency: fix (dis-)associate operations #254 (GiedriusS)
• ruleset: remove omitempty from Route #256 (GiedriusS)
• add service.alert_grouping_params field #257 (stmcallister)
• fix creating services that don't use support hours #255 (cluarkhpe)
• Provide a method for ferryign API errors back to the caller #265 (theckman)
• Prepare internals for exposing context.Context in exported API #266 (theckman)
• Update APIError struct to use new NullAPIErrorObject type for safety #272 (theckman)
• Update internal HTTP methods to not take pointer to map as argument #269 (theckman)
• Fix tags on log entry options struct #275 (evnsio)
• Add alerts to IncidentDetails struct #276 (StupidScience)
• Fix logentry.channel json marshaling/unmarshaling #264 (StupidScience)
• Fixed CreateRuleSet docs typo #281 (neufeldtech)
• Omitting EndpointURL from Extension if empty #282 (au-akash)
• add ListServicesPaginated to services api (and tests) #260 (c6h12o6)
• return nil instead of resp on error #278 (fixes #274) (blockpane)
• Analytics #261 (melchiormoulin)
• Add context.Context support to * (fixes #267) (theckman)
  • #283, #284, #285, #286, #287, #288
  • #289, #290, #291, #292, #293, #294
  • #297, #298, #299, #300, #301, #303
  • #306, #307, #308, #309, #322
• Add support for Service Event Rules #304 (mrzacarias)
• teams and services analytics endpoints #312 (newbootz)
• Add Resolution string to ManageIncidentsOptions struct #313 (fixes #243) (theckman)
• Fix invalid JSON struct tag, other linter issues #319 (fixes #317) (theckman)
• Add ability to set Escalation Policy when managing incidents #323 (theckman) superseded: #273 (evnsio)

Business Service and Service Dependencies, Get Incident Alert and Manage Incident Endpoints, and Supporting Empty Values for Ruleset Rule Positions.

Merge pull request #239 from PagerDuty/changelog-v1-3-0

update changelog for v1.3.0