Bugsnag · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Bugsnag Traces API

3 actions 3 updates phrasing extends openapi/bugsnag-traces-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['/v1/traces'].post
$.paths['/traces/v1'].post

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 Traces API
  version: 1.0.0
extends: openapi/bugsnag-traces-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-10-02'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 2
- target: $.paths['/v1/traces'].post
  update:
    x-apievangelist-phrasing:
      intent: Send OpenTelemetry trace spans
      effect: write
      questions:
      - Can I send OpenTelemetry spans to BugSnag over OTLP HTTP?
      - Does the trace ingestion endpoint accept both JSON and protobuf payloads?
      instructions:
      - text: 'Send these OTLP resource spans to BugSnag: {resourceSpans}.'
        slots:
          resourceSpans: requestBody.resourceSpans
      - text: Export my OpenTelemetry trace data to BugSnag performance monitoring.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/traces/v1'].post
  update:
    x-apievangelist-phrasing:
      intent: Send a sampled trace report to a project
      effect: write
      questions:
      - How do I post a trace report to BugSnag's /traces/v1 endpoint with my project API key?
      - What goes in the span sampling header when I upload a trace report?
      - Can I attach a SHA1 integrity hash so the trace payload is checked for tampering in transit?
      instructions:
      - text: Send trace report {resourceSpans} to the project with API key {api_key}, sampling header {span_sampling}.
        slots:
          resourceSpans: requestBody.resourceSpans
          api_key: header.Bugsnag-Api-Key
          span_sampling: header.Bugsnag-Span-Sampling
      - text: Upload trace report {resourceSpans} under project key {api_key} with span sampling {span_sampling} and integrity hash {integrity}.
        slots:
          resourceSpans: requestBody.resourceSpans
          api_key: header.Bugsnag-Api-Key
          span_sampling: header.Bugsnag-Span-Sampling
          integrity: header.Bugsnag-Integrity
      method: generated
      generated: '2026-10-02'