Bugsnag · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Bugsnag Build Builds API

2 actions 2 updates phrasing extends openapi/bugsnag-builds-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 2

$.info

$.paths['/'].post

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 Build Builds API
  version: 1.0.0
extends: openapi/bugsnag-builds-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: 1
- target: $.paths['/'].post
  update:
    x-apievangelist-phrasing:
      intent: Report a new build or release
      effect: write
      questions:
      - How do I tell BugSnag which release introduced an error?
      - Can I attach source control details and the builder's name to a deploy?
      - What app version information does a build notification require?
      instructions:
      - text: Notify BugSnag of build version {appVersion} in the {releaseStage} release stage.
        slots:
          appVersion: requestBody.appVersion
          releaseStage: requestBody.releaseStage
      - text: Record a deploy of {appVersion} built by {builderName}.
        slots:
          appVersion: requestBody.appVersion
          builderName: requestBody.builderName
      method: generated
      generated: '2026-09-26'