Bugsnag · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Bugsnag Data Access Trends API

3 actions 3 updates phrasing extends openapi/bugsnag-trends-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 3

$.info

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

$.paths['/projects/{project_id}/trend'].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 Trends API
  version: 1.0.0
extends: openapi/bugsnag-trends-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: 2
- target: $.paths['/projects/{project_id}/errors/{error_id}/trend'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one error's frequency trend
      effect: read
      questions:
      - Is a particular error happening more or less often over time?
      - Can I choose how many time buckets a single error's trend is split into?
      instructions:
      - text: Show the trend for error {error_id} in project {project_id}.
        slots:
          error_id: path.error_id
          project_id: path.project_id
      - text: Get the frequency of error {error_id} in project {project_id} over {buckets_count} buckets.
        slots:
          error_id: path.error_id
          project_id: path.project_id
          buckets_count: query.buckets_count
      method: generated
      generated: '2026-09-26'
- target: $.paths['/projects/{project_id}/trend'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a project's overall error trend
      effect: read
      questions:
      - How is the overall error rate for my whole project trending?
      - Can I see project-wide error and resolution trends at a set resolution?
      instructions:
      - text: Show the overall error trend for project {project_id}.
        slots:
          project_id: path.project_id
      - text: Get project {project_id}'s error trend at {resolution} resolution.
        slots:
          project_id: path.project_id
          resolution: query.resolution
      method: generated
      generated: '2026-09-26'