Bugsnag · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Bugsnag Data Access Comments API

6 actions 6 updates phrasing extends openapi/bugsnag-comments-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 6

$.info

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

$.paths['/projects/{project_id}/errors/{error_id}/comments'].post

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

$.paths['/projects/{project_id}/errors/{error_id}/comments/{comment_id}'].delete

$.paths['/projects/{project_id}/errors/{error_id}/comments/{comment_id}'].patch

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 Comments API
  version: 1.0.0
extends: openapi/bugsnag-comments-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: 5
- target: $.paths['/projects/{project_id}/errors/{error_id}/comments'].get
  update:
    x-apievangelist-phrasing:
      intent: List comments on an error
      effect: read
      questions:
      - What has my team said about this error?
      - Can I read all the discussion notes left on an error?
      instructions:
      - text: List comments on error {error_id} in project {project_id}.
        slots:
          error_id: path.error_id
          project_id: path.project_id
      - text: Show the team discussion for error {error_id} in project {project_id}.
        slots:
          error_id: path.error_id
          project_id: path.project_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/projects/{project_id}/errors/{error_id}/comments'].post
  update:
    x-apievangelist-phrasing:
      intent: Comment on an error
      effect: write
      questions:
      - How do I leave a note on an error for my teammates?
      - Can comments on errors include formatting or only plain text?
      instructions:
      - text: Comment "{message}" on error {error_id} in project {project_id}.
        slots:
          message: requestBody.message
          error_id: path.error_id
          project_id: path.project_id
      - text: Add a note to error {error_id} in project {project_id} saying {message}.
        slots:
          error_id: path.error_id
          project_id: path.project_id
          message: requestBody.message
      method: generated
      generated: '2026-09-26'
- target: $.paths['/projects/{project_id}/errors/{error_id}/comments/{comment_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a single error comment
      effect: read
      questions:
      - How do I fetch one specific comment on an error?
      - Can I see who wrote a particular comment and when?
      instructions:
      - text: Show comment {comment_id} on error {error_id} in project {project_id}.
        slots:
          comment_id: path.comment_id
          error_id: path.error_id
          project_id: path.project_id
      - text: Open comment {comment_id} from error {error_id} of project {project_id}.
        slots:
          comment_id: path.comment_id
          error_id: path.error_id
          project_id: path.project_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/projects/{project_id}/errors/{error_id}/comments/{comment_id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a comment on a project's error
      effect: destructive
      questions:
      - Can I permanently remove a comment I posted on an error?
      - Is deleting an error comment reversible?
      instructions:
      - text: Delete comment {comment_id} on error {error_id} in project {project_id}.
        slots:
          comment_id: path.comment_id
          error_id: path.error_id
          project_id: path.project_id
      - text: Remove the comment {comment_id} from error {error_id} in project {project_id} for good.
        slots:
          comment_id: path.comment_id
          error_id: path.error_id
          project_id: path.project_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/projects/{project_id}/errors/{error_id}/comments/{comment_id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Edit a comment on a project's error
      effect: write
      questions:
      - How do I fix a typo in a comment I left on an error?
      - Can I change the text of an existing error comment?
      instructions:
      - text: Change comment {comment_id} on error {error_id} in project {project_id} to {message}.
        slots:
          comment_id: path.comment_id
          error_id: path.error_id
          project_id: path.project_id
          message: requestBody.message
      - text: Edit comment {comment_id} under error {error_id} of project {project_id} to read {message}.
        slots:
          comment_id: path.comment_id
          error_id: path.error_id
          project_id: path.project_id
          message: requestBody.message
      method: generated
      generated: '2026-09-26'