Bugsnag · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for BugSnag - Data Access Current User API

8 actions 8 updates phrasing extends openapi/bugsnag-current-user-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 8

$.info

$.paths['/projects/{project_id}/saved_searches'].get

$.paths['/saved_searches'].post

$.paths['/saved_searches/{id}'].get

$.paths['/saved_searches/{id}'].delete

$.paths['/saved_searches/{id}'].patch

$.paths['/saved_searches/{id}/usage_summary'].get

$.paths['/user'].get

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 Current User API
  version: 1.0.0
extends: openapi/bugsnag-current-user-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: 7
- target: $.paths['/projects/{project_id}/saved_searches'].get
  update:
    x-apievangelist-phrasing:
      intent: List a project's saved searches
      effect: read
      questions:
      - What saved error searches exist on my project?
      - Can I list only the saved searches that are shared with the team?
      instructions:
      - text: List saved searches for project {project_id}.
        slots:
          project_id: path.project_id
      - text: 'Show the shared saved searches on project {project_id}: {shared}.'
        slots:
          project_id: path.project_id
          shared: query.shared
      method: generated
      generated: '2026-09-26'
- target: $.paths['/saved_searches'].post
  update:
    x-apievangelist-phrasing:
      intent: Save an error search
      effect: write
      questions:
      - How do I save a set of error filters so I can reuse it?
      - Can I make a saved search the default view for a project?
      instructions:
      - text: Save a search called {name} on project {project_id} with filters {filters}.
        slots:
          name: requestBody.name
          project_id: requestBody.project_id
          filters: requestBody.filters
      - text: 'Create a shared saved search {name} for project {project_id} using filters {filters} and make it the default: {project_default}.'
        slots:
          name: requestBody.name
          project_id: requestBody.project_id
          filters: requestBody.filters
          project_default: requestBody.project_default
      method: generated
      generated: '2026-09-26'
- target: $.paths['/saved_searches/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a saved search
      effect: read
      questions:
      - What filters and sort order does a particular saved search use?
      - How do I look up one saved search by its ID?
      instructions:
      - text: Show saved search {id}.
        slots:
          id: path.id
      - text: Get the filters behind saved search {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/saved_searches/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a saved search
      effect: destructive
      questions:
      - Can I get rid of a saved search nobody uses anymore?
      - How do I remove a saved error search?
      instructions:
      - text: Delete saved search {id}.
        slots:
          id: path.id
      - text: Remove the saved search {id} from its project.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/saved_searches/{id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update a saved search
      effect: write
      questions:
      - Can I rename a saved search or change its filters?
      - How do I share an existing saved search with my team?
      instructions:
      - text: Rename saved search {id} to {name}.
        slots:
          id: path.id
          name: requestBody.name
      - text: Change the filters on saved search {id} to {filters}.
        slots:
          id: path.id
          filters: requestBody.filters
      method: generated
      generated: '2026-09-26'
- target: $.paths['/saved_searches/{id}/usage_summary'].get
  update:
    x-apievangelist-phrasing:
      intent: Get usage summary of a saved search
      effect: read
      questions:
      - Is a saved search being used anywhere before I delete it?
      - Where is a given saved search referenced?
      instructions:
      - text: Show the usage summary for saved search {id}.
        slots:
          id: path.id
      - text: Check how saved search {id} is being used.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/user'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the signed-in user's profile
      effect: read
      questions:
      - Who am I authenticated as with this BugSnag token?
      - Which organizations does my user account belong to?
      instructions:
      - text: Show my BugSnag user profile.
      - text: Get the name and email of the currently authenticated user.
      method: generated
      generated: '2026-10-02'