Bugsnag · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Bugsnag Data Access Releases API

3 actions 3 updates phrasing extends openapi/bugsnag-releases-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}/releases'].get
$.paths['/projects/{project_id}/releases/{release_id}'].get

OpenAPI Overlay

Raw ↑ 
# 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 Releases API
  version: 1.0.0
extends: openapi/bugsnag-releases-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}/releases'].get
  update:
    x-apievangelist-phrasing:
      intent: List a project's releases
      effect: read
      questions:
      - Which versions of my app have been deployed in this project?
      - Can I list only production releases?
      instructions:
      - text: List releases for project {project_id}.
        slots:
          project_id: path.project_id
      - text: List releases in the {release_stage} stage for project {project_id}.
        slots:
          release_stage: query.release_stage
          project_id: path.project_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/projects/{project_id}/releases/{release_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one release's details
      effect: read
      questions:
      - What source control and builder info was recorded for a particular release?
      - How many errors are associated with a specific release?
      instructions:
      - text: Show release {release_id} in project {project_id}.
        slots:
          release_id: path.release_id
          project_id: path.project_id
      - text: Get the error statistics for release {release_id} of project {project_id}.
        slots:
          release_id: path.release_id
          project_id: path.project_id
      method: generated
      generated: '2026-09-26'