Bugsnag · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Bugsnag Data Access Collaborators API

6 actions 6 updates phrasing extends openapi/bugsnag-collaborators-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['/organizations/{organization_id}/collaborators'].get

$.paths['/organizations/{organization_id}/collaborators'].post

$.paths['/organizations/{organization_id}/collaborators/{collaborator_id}'].get

$.paths['/organizations/{organization_id}/collaborators/{collaborator_id}'].delete

$.paths['/organizations/{organization_id}/collaborators/{collaborator_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 Collaborators API
  version: 1.0.0
extends: openapi/bugsnag-collaborators-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['/organizations/{organization_id}/collaborators'].get
  update:
    x-apievangelist-phrasing:
      intent: List an organization's collaborators
      effect: read
      questions:
      - Who has access to my BugSnag organization?
      - Can I see each collaborator's permissions across the organization?
      instructions:
      - text: List the collaborators in organization {organization_id}.
        slots:
          organization_id: path.organization_id
      - text: Show {per_page} collaborators per page for organization {organization_id}.
        slots:
          per_page: query.per_page
          organization_id: path.organization_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/organizations/{organization_id}/collaborators'].post
  update:
    x-apievangelist-phrasing:
      intent: Invite a collaborator by email
      effect: write
      questions:
      - How do I invite a teammate to my organization by email?
      - Can I make a new invitee an admin or limit them to certain projects?
      instructions:
      - text: Invite {email} to organization {organization_id}.
        slots:
          email: requestBody.email
          organization_id: path.organization_id
      - text: Invite {email} to organization {organization_id} with access only to projects {project_ids}.
        slots:
          email: requestBody.email
          organization_id: path.organization_id
          project_ids: requestBody.project_ids
      method: generated
      generated: '2026-09-26'
- target: $.paths['/organizations/{organization_id}/collaborators/{collaborator_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a collaborator's role and access
      effect: read
      questions:
      - What role and project access does a specific collaborator have?
      - Is a given teammate an admin in the organization?
      instructions:
      - text: Show collaborator {collaborator_id} in organization {organization_id}.
        slots:
          collaborator_id: path.collaborator_id
          organization_id: path.organization_id
      - text: Check which projects collaborator {collaborator_id} can reach in organization {organization_id}.
        slots:
          collaborator_id: path.collaborator_id
          organization_id: path.organization_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/organizations/{organization_id}/collaborators/{collaborator_id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove a collaborator from an organization
      effect: destructive
      questions:
      - How do I revoke someone's access to every project in my organization?
      - What happens to a collaborator's project access when I remove them?
      instructions:
      - text: Remove collaborator {collaborator_id} from organization {organization_id}.
        slots:
          collaborator_id: path.collaborator_id
          organization_id: path.organization_id
      - text: Offboard {collaborator_id} so they lose access to organization {organization_id}.
        slots:
          collaborator_id: path.collaborator_id
          organization_id: path.organization_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/organizations/{organization_id}/collaborators/{collaborator_id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Change a collaborator's permissions
      effect: write
      questions:
      - Can I promote an existing collaborator to admin?
      - How do I change which projects a current teammate can access?
      instructions:
      - text: 'Make collaborator {collaborator_id} an admin of organization {organization_id}: {is_admin}.'
        slots:
          collaborator_id: path.collaborator_id
          organization_id: path.organization_id
          is_admin: requestBody.is_admin
      - text: Set collaborator {collaborator_id}'s projects in organization {organization_id} to {project_ids}.
        slots:
          collaborator_id: path.collaborator_id
          organization_id: path.organization_id
          project_ids: requestBody.project_ids
      method: generated
      generated: '2026-09-26'