Skip to content

v0.13.0: Update OpenAPI spec

Choose a tag to compare

@github-actions github-actions released this 15 Sep 13:31
· 13 commits to master since this release

👻 Maintenance

  • ci: use mixed old/new paths for diffs (#179) @jamietanna, Claude Sonnet 5
  • chore(renovate): match based on human-readable names (#177) @jamietanna
  • chore(renovate): don't automagically raise PRs for Go toolchain in CI (#175) @jamietanna
  • ci: pin Go toolchain + golangci-lint explicitly in CI (#173) @jamietanna
  • chore(renovate): group constraints updates with other Go toolchain updates (#172) @jamietanna
  • chore(renovate): ensure we use a consistent version of Go (#170) @jamietanna
  • build(vendir): remove overly nested OpenAPI spec paths (#149) @jamietanna

📦 Dependency updates

24 changes

OpenAPI spec

This release includes 1323 API change(s) (82 potentially breaking), via oasdiff. The full changelog can be found attached to this release.

Breaking and potentially breaking changes

API Changelog v1 vs. v1

API Changes

GET /v1/alert_events

  • ⚠️ added the new ack_timeout_retriggered enum value to the data/items/attributes/allOf[#/components/schemas/alert_event]/action response property for the response status 200
  • ⚠️ added the new cleared enum value to the data/items/attributes/allOf[#/components/schemas/alert_event]/action response property for the response status 200
  • ⚠️ added the new retrigger_suppressed enum value to the data/items/attributes/allOf[#/components/schemas/alert_event]/action response property for the response status 200
  • ⚠️ added the new team_attached_from_payload enum value to the data/items/attributes/allOf[#/components/schemas/alert_event]/action response property for the response status 200

GET /v1/alert_events/{id}

  • ⚠️ added the new ack_timeout_retriggered enum value to the data/attributes/allOf[#/components/schemas/alert_event]/action response property for the response status 200
  • ⚠️ added the new cleared enum value to the data/attributes/allOf[#/components/schemas/alert_event]/action response property for the response status 200
  • ⚠️ added the new retrigger_suppressed enum value to the data/attributes/allOf[#/components/schemas/alert_event]/action response property for the response status 200
  • ⚠️ added the new team_attached_from_payload enum value to the data/attributes/allOf[#/components/schemas/alert_event]/action response property for the response status 200

PATCH /v1/alert_events/{id}

  • ⚠️ added the new ack_timeout_retriggered enum value to the data/attributes/allOf[#/components/schemas/alert_event]/action response property for the response status 200
  • ⚠️ added the new cleared enum value to the data/attributes/allOf[#/components/schemas/alert_event]/action response property for the response status 200
  • ⚠️ added the new retrigger_suppressed enum value to the data/attributes/allOf[#/components/schemas/alert_event]/action response property for the response status 200
  • ⚠️ added the new team_attached_from_payload enum value to the data/attributes/allOf[#/components/schemas/alert_event]/action response property for the response status 200

GET /v1/alerts/{alert_id}/events

  • ⚠️ added the new ack_timeout_retriggered enum value to the data/items/attributes/allOf[#/components/schemas/alert_event]/action response property for the response status 200
  • ⚠️ added the new cleared enum value to the data/items/attributes/allOf[#/components/schemas/alert_event]/action response property for the response status 200
  • ⚠️ added the new retrigger_suppressed enum value to the data/items/attributes/allOf[#/components/schemas/alert_event]/action response property for the response status 200
  • ⚠️ added the new team_attached_from_payload enum value to the data/items/attributes/allOf[#/components/schemas/alert_event]/action response property for the response status 200

POST /v1/alerts/{alert_id}/events

  • ⚠️ added the new ack_timeout_retriggered enum value to the data/attributes/allOf[#/components/schemas/alert_event]/action response property for the response status 201
  • ⚠️ added the new cleared enum value to the data/attributes/allOf[#/components/schemas/alert_event]/action response property for the response status 201
  • ⚠️ added the new retrigger_suppressed enum value to the data/attributes/allOf[#/components/schemas/alert_event]/action response property for the response status 201
  • ⚠️ added the new team_attached_from_payload enum value to the data/attributes/allOf[#/components/schemas/alert_event]/action response property for the response status 201

DELETE /v1/form_field_positions/{id}

  • ⚠️ added the new slack_task_form enum value to the data/attributes/allOf[#/components/schemas/form_field_position]/form response property for the response status 200
  • ⚠️ added the new web_task_form enum value to the data/attributes/allOf[#/components/schemas/form_field_position]/form response property for the response status 200

GET /v1/form_field_positions/{id}

  • ⚠️ added the new slack_task_form enum value to the data/attributes/allOf[#/components/schemas/form_field_position]/form response property for the response status 200
  • ⚠️ added the new web_task_form enum value to the data/attributes/allOf[#/components/schemas/form_field_position]/form response property for the response status 200

PUT /v1/form_field_positions/{id}

  • ⚠️ added the new slack_task_form enum value to the data/attributes/allOf[#/components/schemas/form_field_position]/form response property for the response status 200
  • ⚠️ added the new web_task_form enum value to the data/attributes/allOf[#/components/schemas/form_field_position]/form response property for the response status 200

GET /v1/form_fields

  • ⚠️ added the new cancellation_message enum value to the data/items/attributes/allOf[#/components/schemas/form_field]/kind response property for the response status 200

POST /v1/form_fields

  • ⚠️ added the new cancellation_message enum value to the data/attributes/allOf[#/components/schemas/form_field]/kind response property for the response status 201

GET /v1/form_fields/{form_field_id}/positions

  • ⚠️ added the new slack_task_form enum value to the data/items/attributes/allOf[#/components/schemas/form_field_position]/form response property for the response status 200
  • ⚠️ added the new web_task_form enum value to the data/items/attributes/allOf[#/components/schemas/form_field_position]/form response property for the response status 200

POST /v1/form_fields/{form_field_id}/positions

  • ⚠️ added the new slack_task_form enum value to the data/attributes/allOf[#/components/schemas/form_field_position]/form response property for the response status 201
  • ⚠️ added the new web_task_form enum value to the data/attributes/allOf[#/components/schemas/form_field_position]/form response property for the response status 201

DELETE /v1/form_fields/{id}

  • ⚠️ added the new cancellation_message enum value to the data/attributes/allOf[#/components/schemas/form_field]/kind response property for the response status 200

GET /v1/form_fields/{id}

  • ⚠️ added the new cancellation_message enum value to the data/attributes/allOf[#/components/schemas/form_field]/kind response property for the response status 200

PUT /v1/form_fields/{id}

  • ⚠️ added the new cancellation_message enum value to the data/attributes/allOf[#/components/schemas/form_field]/kind response property for the response status 200

GET /v1/incidents

  • ⚠️ removed #/components/schemas/severity_response from the data/items/attributes/allOf[#/components/schemas/incident]/severity response property allOf list for the response status 200

POST /v1/incidents

  • ⚠️ removed #/components/schemas/severity_response from the data/attributes/allOf[#/components/schemas/incident]/severity response property allOf list for the response status 201

DELETE /v1/incidents/{id}

  • ⚠️ removed #/components/schemas/severity_response from the data/attributes/allOf[#/components/schemas/incident]/severity response property allOf list for the response status 200

GET /v1/incidents/{id}

  • ⚠️ removed #/components/schemas/severity_response from the data/attributes/allOf[#/components/schemas/incident]/severity response property allOf list for the response status 200

PUT /v1/incidents/{id}

  • ⚠️ removed #/components/schemas/severity_response from the data/attributes/allOf[#/components/schemas/incident]/severity response property allOf list for the response status 200

POST /v1/incidents/{id}/add_subscribers

  • ⚠️ removed #/components/schemas/severity_response from the data/attributes/allOf[#/components/schemas/incident]/severity response property allOf list for the response status 200

POST /v1/incidents/{id}/assign_role_to_user

  • ⚠️ removed #/components/schemas/severity_response from the data/attributes/allOf[#/components/schemas/incident]/severity response property allOf list for the response status 200

PUT /v1/incidents/{id}/cancel

  • ⚠️ removed #/components/schemas/severity_response from the data/attributes/allOf[#/components/schemas/incident]/severity response property allOf list for the response status 200

PUT /v1/incidents/{id}/detach_from_parent

  • ⚠️ removed #/components/schemas/severity_response from the data/attributes/allOf[#/components/schemas/incident]/severity response property allOf list for the response status 200

PUT /v1/incidents/{id}/duplicate

  • ⚠️ removed #/components/schemas/severity_response from the data/attributes/allOf[#/components/schemas/incident]/severity response property allOf list for the response status 200

PUT /v1/incidents/{id}/in_triage

  • ⚠️ removed #/components/schemas/severity_response from the data/attributes/allOf[#/components/schemas/incident]/severity response property allOf list for the response status 200

PUT /v1/incidents/{id}/mitigate

  • ⚠️ removed #/components/schemas/severity_response from the data/attributes/allOf[#/components/schemas/incident]/severity response property allOf list for the response status 200

DELETE /v1/incidents/{id}/remove_subscribers

  • ⚠️ removed #/components/schemas/severity_response from the data/attributes/allOf[#/components/schemas/incident]/severity response property allOf list for the response status 200

PUT /v1/incidents/{id}/resolve

  • ⚠️ removed #/components/schemas/severity_response from the data/attributes/allOf[#/components/schemas/incident]/severity response property allOf list for the response status 200

PUT /v1/incidents/{id}/restart

  • ⚠️ removed #/components/schemas/severity_response from the data/attributes/allOf[#/components/schemas/incident]/severity response property allOf list for the response status 200

DELETE /v1/incidents/{id}/unassign_role_from_user

  • ⚠️ removed #/components/schemas/severity_response from the data/attributes/allOf[#/components/schemas/incident]/severity response property allOf list for the response status 200

PUT /v1/incidents/{id}/unmark_as_duplicate

  • ⚠️ removed #/components/schemas/severity_response from the data/attributes/allOf[#/components/schemas/incident]/severity response property allOf list for the response status 200

DELETE /v1/notification_rules/{id}

  • ⚠️ added the new microsoft_teams enum value to the data/attributes/allOf[#/components/schemas/user_notification_rule]/enabled_contact_types/items/ response property for the response status 200

GET /v1/notification_rules/{id}

  • ⚠️ added the new microsoft_teams enum value to the data/attributes/allOf[#/components/schemas/user_notification_rule]/enabled_contact_types/items/ response property for the response status 200

PUT /v1/notification_rules/{id}

  • ⚠️ added the new microsoft_teams enum value to the data/attributes/allOf[#/components/schemas/user_notification_rule]/enabled_contact_types/items/ response property for the response status 200

GET /v1/users/{user_id}/notification_rules

  • ⚠️ added the new microsoft_teams enum value to the data/items/attributes/allOf[#/components/schemas/user_notification_rule]/enabled_contact_types/items/ response property for the response status 200

POST /v1/users/{user_id}/notification_rules

  • ⚠️ added the new microsoft_teams enum value to the data/attributes/allOf[#/components/schemas/user_notification_rule]/enabled_contact_types/items/ response property for the response status 201

GET /v1/webhooks/endpoints

  • ⚠️ added the new alert.updated enum value to the data/items/attributes/allOf[#/components/schemas/webhooks_endpoint]/event_types/items/ response property for the response status 200
  • ⚠️ added the new shift.ended enum value to the data/items/attributes/allOf[#/components/schemas/webhooks_endpoint]/event_types/items/ response property for the response status 200

POST /v1/webhooks/endpoints

  • ⚠️ added the new alert.updated enum value to the data/attributes/allOf[#/components/schemas/webhooks_endpoint]/event_types/items/ response property for the response status 201
  • ⚠️ added the new shift.ended enum value to the data/attributes/allOf[#/components/schemas/webhooks_endpoint]/event_types/items/ response property for the response status 201

DELETE /v1/webhooks/endpoints/{id}

  • ⚠️ added the new alert.updated enum value to the data/attributes/allOf[#/components/schemas/webhooks_endpoint]/event_types/items/ response property for the response status 200
  • ⚠️ added the new shift.ended enum value to the data/attributes/allOf[#/components/schemas/webhooks_endpoint]/event_types/items/ response property for the response status 200

GET /v1/webhooks/endpoints/{id}

  • ⚠️ added the new alert.updated enum value to the data/attributes/allOf[#/components/schemas/webhooks_endpoint]/event_types/items/ response property for the response status 200
  • ⚠️ added the new shift.ended enum value to the data/attributes/allOf[#/components/schemas/webhooks_endpoint]/event_types/items/ response property for the response status 200

PUT /v1/webhooks/endpoints/{id}

  • ⚠️ added the new alert.updated enum value to the data/attributes/allOf[#/components/schemas/webhooks_endpoint]/event_types/items/ response property for the response status 200
  • ⚠️ added the new shift.ended enum value to the data/attributes/allOf[#/components/schemas/webhooks_endpoint]/event_types/items/ response property for the response status 200

GET /v1/workflow_groups

  • ⚠️ added the new problem enum value to the data/items/attributes/allOf[#/components/schemas/workflow_group]/kind response property for the response status 200

POST /v1/workflow_groups

  • ⚠️ added the new problem enum value to the data/attributes/allOf[#/components/schemas/workflow_group]/kind response property for the response status 201

DELETE /v1/workflow_groups/{id}

  • ⚠️ added the new problem enum value to the data/attributes/allOf[#/components/schemas/workflow_group]/kind response property for the response status 200

GET /v1/workflow_groups/{id}

  • ⚠️ added the new problem enum value to the data/attributes/allOf[#/components/schemas/workflow_group]/kind response property for the response status 200

PUT /v1/workflow_groups/{id}

  • ⚠️ added the new problem enum value to the data/attributes/allOf[#/components/schemas/workflow_group]/kind response property for the response status 200

DELETE /v1/workflow_tasks/{id}

  • ⚠️ added the new problem enum value to the data/attributes/allOf[#/components/schemas/workflow_task]/task_params/oneOf[#/components/schemas/trigger_workflow_task_params]/kind response property for the response status 200
  • ⚠️ added #/components/schemas/attach_retrospective_pdf_to_freshservice_ticket_task_params to the data/attributes/allOf[#/components/schemas/workflow_task]/task_params response property oneOf list for the response status 200

GET /v1/workflow_tasks/{id}

  • ⚠️ added the new problem enum value to the data/attributes/allOf[#/components/schemas/workflow_task]/task_params/oneOf[#/components/schemas/trigger_workflow_task_params]/kind response property for the response status 200
  • ⚠️ added #/components/schemas/attach_retrospective_pdf_to_freshservice_ticket_task_params to the data/attributes/allOf[#/components/schemas/workflow_task]/task_params response property oneOf list for the response status 200

PUT /v1/workflow_tasks/{id}

  • ⚠️ added the new problem enum value to the data/attributes/allOf[#/components/schemas/workflow_task]/task_params/oneOf[#/components/schemas/trigger_workflow_task_params]/kind response property for the response status 200
  • ⚠️ added #/components/schemas/attach_retrospective_pdf_to_freshservice_ticket_task_params to the data/attributes/allOf[#/components/schemas/workflow_task]/task_params response property oneOf list for the response status 200

GET /v1/workflows/{workflow_id}/workflow_tasks

  • ⚠️ added the new problem enum value to the data/items/attributes/allOf[#/components/schemas/workflow_task]/task_params/oneOf[#/components/schemas/trigger_workflow_task_params]/kind response property for the response status 200
  • ⚠️ added #/components/schemas/attach_retrospective_pdf_to_freshservice_ticket_task_params to the data/items/attributes/allOf[#/components/schemas/workflow_task]/task_params response property oneOf list for the response status 200

POST /v1/workflows/{workflow_id}/workflow_tasks

  • ⚠️ added the new problem enum value to the data/attributes/allOf[#/components/schemas/workflow_task]/task_params/oneOf[#/components/schemas/trigger_workflow_task_params]/kind response property for the response status 201
  • ⚠️ added #/components/schemas/attach_retrospective_pdf_to_freshservice_ticket_task_params to the data/attributes/allOf[#/components/schemas/workflow_task]/task_params response property oneOf list for the response status 201