Skip to content

Latest commit

 

History

History
529 lines (422 loc) · 51.2 KB

CHANGELOG.md

File metadata and controls

529 lines (422 loc) · 51.2 KB
Raw

Changelog

What's Changed

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

New Contributors

Full Changelog: https://github.com/PagerDuty/go-pagerduty/compare/v1.6.0...v1.7.0

v1.6.0 (2022-09-21)

Full Changelog Milestone

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 PagerDuty#419
  • List notifications API now works when using includes by @jaimegago in PagerDuty#439
  • Improves support for macOS builds by @mjlshen in PagerDuty#434
  • Fix potential panic when debug request captures are enabled by @theckman in PagerDuty#443
  • Fixes memory leak by @attilakunelwood in PagerDuty#453
  • Prevent leak on error responses by @ChuckCrawford in PagerDuty#454

Breaking Changes

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

New Contributors

v1.5.1 (2022-04-24) - Bug Fixes

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

v1.5.0 (2022-01-22) - 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

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 (2f47dfc62321b) #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)

v1.4.3 (2021-11-13)

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

v1.4.2 (2021-08-30)

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)

v1.4.1 (2021-05-13)

Milestone Full Changelog

Highlights

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

Merged pull requests

v1.4.0 (2021-04-23)

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

v1.3.0 (2020-09-08)

Full Changelog

Closed issues:

  • ListIncidents pagination #238

Merged pull requests:

v1.2.0 (2020-06-04)

Full Changelog

Closed issues:

  • Allowing custom API endpoint in NewClient config #198
  • service: SupportHours creation not supported #188
  • The "Channel" field doesn't expose all possible data fields #153

Merged pull requests:

v1.1.2 (2020-02-21)

Full Changelog

Closed issues:

  • EventV2Response doesn't match API response #186
  • List escalation policy with current on call members using include current\_oncall #181
  • Create service extension (like slack extension) over API #149
  • Mock Client? #148
  • Make a release? #146
  • Priority field should be optional according to API spec #135
  • Missing Services Extensions available over API #129
  • Missing ContactMethod operations #125
  • Add A CODEOWNERS file for easier review requests. #124
  • missing severity in create_event.json object? #100
  • Assignment struct has no json conversion #92
  • Publish CLI binaries as releases #81
  • Package test coverage is lacking #70
  • Create releases with built binaries #50

Merged pull requests:

1.1.1 (2020-02-05)

Full Changelog

Merged pull requests:

1.1.0 (2020-02-03)

Full Changelog

Closed issues:

  • listOverrides result in JSON unmarshall failure #180
  • How to create incident via command pd? #171
  • Poorly documented, library code broken, please step it up. #170
  • failed to create an incident #165
  • I need create incident function, Can we release the latest master? #163
  • Update logrus imports to github.com/sirupsen/logrus #160
  • build error cannot find package #144
  • Missing ListIncidentAlerts #141
  • ListIncidentsOptions Example #139
  • Support for V2 Event Management in the CLI #136
  • Custom connection settings #110
  • Missing the "From" parameter in Create note on an incident function #107
  • Support V2 events #83
  • Support Event Transformer Code? #67
  • Fix help flag behavior #18

Merged pull requests:

1.0.4 (2018-05-28)

Full Changelog

1.0.3 (2018-05-28)

Full Changelog

1.0.2 (2018-05-28)

Full Changelog

Merged pull requests:

1.0.1 (2018-05-28)

Full Changelog

1.0.0 (2018-05-28)

Full Changelog

Fixed bugs:

  • Escalation Policy's repeat_enabled Is Ignored #57
  • Problems running freshly built pd utility #39
  • Manage Incident gives error #32
  • Added missing slash to delete integration method url #59 (reybard)

Closed issues:

  • Trouble creating an integration #102
  • Client does not trigger events #101
  • Paging help #94
  • Help with incident creation API #89
  • Memory leak because of response body is not closed #66
  • Since and Until don't work for log_entries #61
  • service: auto_resolve_timeout & acknowledgement_timeout cannot be set to null #51
  • Possible to create new service and integration together #42
  • Documentation does not match code #16
  • Typo in repo description #15
  • Webhook decoder #14
  • incident_key for create_event #13

Merged pull requests:

  • Fix pagination for ListOnCalls #90 (IainCole)
  • Revert "Fix inconsistency with some REST Options objects passed by reference …" #88 (mimato)
  • Adding travis config, fixup Makefile #87 (mimato)
  • Fixed invalid JSON descriptor for FirstTriggerLogEntry #86 (mwisniewski0)
  • [incidents] fix entries typo in a few places #85 (joeyparsons)
  • Fix inconsistency with some REST Options objects passed by reference … #79 (lowesoftware)
  • Explicit JSON reference to schedules #77 (domudall)
  • Adding AlertCreation to Service struct #76 (domudall)
  • Add support for escalation rules #71 (heimweh)
  • Fix maintenance window JSON #69 (domudall)
  • Fixing Maintenance typo #68 (domudall)
  • Update event.go - fix a memory leak #65 (AngelRefael)
  • Add query to vendor #64 (heimweh)
  • Fix JSON decode (errorObject) #63 (heimweh)
  • fix since and until by adding them to url scheme #60 (ethansommer)
  • fix webhook struct member name #58 (pgray)
  • Incident - Add status field to incident #56 (heimweh)
  • enable fetch log entries via incident api #55 (flyinprogrammer)
  • Allow service timeouts to be disabled #53 (heimweh)
  • Schedule restriction - Add support for start_day_of_week #52 (heimweh)
  • Add vendor support #49 (heimweh)
  • Add schedules listing #46 (Marc-Morata-Fite)
  • dont declare main twice in examples #45 (ranjib)
  • add service show #44 (cmluciano)
  • (feat)implement integration creation #43 (ranjib)
  • (chore)add create event example #41 (ranjib)
  • (bug)Add test. fix version issue #40 (ranjib)
  • Remove subdomain argument from escalation_policy example. #38 (cmluciano)
  • Skip JSON encoding if no payload was given #37 (heimweh)
  • (feat)add ability API and CLI #36 (ranjib)
  • Make updates to Escalation Policies work #35 (heimweh)
  • Fix misspelling in User struct and add JSON tags #34 (heimweh)
  • (bug)allow passing headers in http do call. fix manage incident call #33 (ranjib)
  • (chore)get rid of logrus from all core structs except CLI entries. fix schedule override command #31 (ranjib)
  • (bug)rename override struct #30 (ranjib)
  • (bug)implement schedule override #29 (ranjib)
  • fix misspelling in trigger_summary_data's JSON key. #28 (tomwans)
  • Correctly set meta flag for incident list #26 (afirth)
  • Add *.swp to gitignore #25 (afirth)
  • Support the /oncalls endpoint in the CLI #24 (afirth)
  • Refactor to work correctly with V2 API #23 (dthagard)
  • (feat)Add webhook decoding capability #22 (ranjib)
  • (chore)Decode event API response. #21 (ranjib)
  • (bug)add incident_key field in event api client #20 (ranjib)
  • (chore)nuke sub domain, v2 api does not need one #19 (ranjib)
  • Implement list users CLI #17 (ranjib)
  • Add team_ids[] query string arg #12 (marklap)
  • Incidents fix #11 (jareksm)
  • Added APIListObject to Option types to allow setting offset and #10 (jareksm)
  • fix typo #9 (sjansen)
  • implement incident list cli. event posting api #8 (ranjib)
  • CLI for create escalation policy, maintainenance window , schedule ov… #7 (ranjib)
  • (feat)implement create service cli #6 (ranjib)
  • (feat)list service cli #5 (ranjib)
  • (feat)implement addon update/delete #4 (ranjib)
  • (feat)Show addon cli #3 (ranjib)
  • (feat) addon list api. create cli #2 (ranjib)
  • (chore) list addon #1 (ranjib)

* This Changelog was automatically generated by github_changelog_generator