Bugsnag · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for BugSnag - Error Reporting Minidump API

2 actions 2 updates phrasing extends openapi/bugsnag-minidump-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['/minidump'].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 - Error Reporting Minidump API
  version: 1.0.0
extends: openapi/bugsnag-minidump-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['/minidump'].post
  update:
    x-apievangelist-phrasing:
      intent: Upload a crash minidump
      effect: write
      questions:
      - How do I send a Breakpad or Crashpad minidump to BugSnag as a crash report?
      - Can I attach extra event details when I upload a minidump file?
      instructions:
      - text: Upload minidump file {upload_file_minidump} using API key {api_key}.
        slots:
          upload_file_minidump: requestBody.upload_file_minidump
          api_key: query.api_key
      - text: Report crash dump {upload_file_minidump} with event payload {event}.
        slots:
          upload_file_minidump: requestBody.upload_file_minidump
          event: requestBody.event
      method: generated
      generated: '2026-09-26'