Skip to content

1.5.0 - BREAKING CHANGES
Compare
Choose a tag to compare
@theckman theckman released this 22 Jan 22:08
v1.5.0
This tag was signed with the committer’s verified signature. The key has expired.
theckman Tim Heckman
GPG key ID: 9B800DBDE3FA5355
Expired
Learn about vigilant mode.
2d51a3e
This commit was signed with the committer’s verified signature. The key has expired.
theckman Tim Heckman
GPG key ID: 9B800DBDE3FA5355
Expired
Learn about vigilant mode.

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)
  • Fix some mismatches between REST API and struct definitions #396 (theckman)
  • refactor: Reduce code duplication in analytics.go #397 (t-junjie)
  • Add support for escalation_policy.on_call_handoff_notifications field #401 (zonorti)
  • Missing incident fields #402 (zonorti)
  • Add extension enable #403 (zonorti)
  • Add support for response_plays #404 (petetanton)
  • Update pagination query to conform to API spec #405 (theckman)
  • add createStatusUpdate #406 (kkawamura)
  • feat: Add support for fetching Audit Records #408 (t-junjie)
  • Fix linter issues, update ResponsePlays API before v1.5.0 release #410 (theckman)
  • Second batch of fixes for API incompatibilities #414 (theckman)
  • Find a way to gracefully avoid one breaking change in #405 #416 (theckman)
  • Fix linter issues introduced by final PR merges #417 (theckman)
Assets 2