Bugsnag · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Bugsnag Data Access Events API

4 actions 4 updates phrasing extends openapi/bugsnag-events-api-openapi.yml

Generated by API Evangelist Written by API Evangelist tooling for Bugsnag's API. It is a proposal applied on top of the contract, not a document Bugsnag publishes.

View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 4

$.info

$.paths['/projects/{project_id}/errors/{error_id}/events'].get

$.paths['/projects/{project_id}/errors/{error_id}/events/latest'].get

$.paths['/projects/{project_id}/events/{event_id}'].get

OpenAPI Overlay

# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Bugsnag Data Access Events API
  version: 1.0.0
extends: openapi/bugsnag-events-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-09-26'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 3
- target: $.paths['/projects/{project_id}/errors/{error_id}/events'].get
  update:
    x-apievangelist-phrasing:
      intent: List occurrences of an error
      effect: read
      questions:
      - How can I see every individual occurrence of an error?
      - Can I page through the events recorded for one error?
      instructions:
      - text: List the events for error {error_id} in project {project_id}.
        slots:
          error_id: path.error_id
          project_id: path.project_id
      - text: Show {per_page} occurrences per page of error {error_id} in project {project_id}.
        slots:
          per_page: query.per_page
          error_id: path.error_id
          project_id: path.project_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/projects/{project_id}/errors/{error_id}/events/latest'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the most recent occurrence of an error
      effect: read
      questions:
      - What did the most recent occurrence of this error look like?
      - Can I get the device info and stack trace from the last time an error happened?
      instructions:
      - text: Get the latest event for error {error_id} in project {project_id}.
        slots:
          error_id: path.error_id
          project_id: path.project_id
      - text: Show the newest stack trace for error {error_id} in project {project_id}.
        slots:
          error_id: path.error_id
          project_id: path.project_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/projects/{project_id}/events/{event_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a specific event by ID
      effect: read
      questions:
      - How do I pull the full details of one event I have the ID for?
      - Does a single event include custom metadata and app state?
      instructions:
      - text: Show event {event_id} in project {project_id}.
        slots:
          event_id: path.event_id
          project_id: path.project_id
      - text: Get the stack trace and device data for event {event_id} in project {project_id}.
        slots:
          event_id: path.event_id
          project_id: path.project_id
      method: generated
      generated: '2026-09-26'