BigPanda · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for BigPanda Service Accounts API

6 actions 6 updates phrasing extends openapi/bigpanda-service-accounts-api-openapi.yml
Generated by API Evangelist Written by API Evangelist tooling for BigPanda's API. It is a proposal applied on top of the contract, not a document BigPanda publishes.
View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 6

$.info
$.paths['/resources/v2.1/service-accounts'].get
$.paths['/resources/v2.1/service-accounts'].post
$.paths['/resources/v2.1/service-accounts/{service_account_id}'].get
$.paths['/resources/v2.1/service-accounts/{service_account_id}'].delete
$.paths['/resources/v2.1/service-accounts/{service_account_id}'].patch

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 BigPanda Service Accounts API
  version: 1.0.0
extends: openapi/bigpanda-service-accounts-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['/resources/v2.1/service-accounts'].get
  update:
    x-apievangelist-phrasing:
      intent: List service accounts
      effect: read
      questions:
      - Which service accounts exist in our BigPanda organization?
      - Can I list every non-human account used by our integrations?
      instructions:
      - text: List all service accounts.
      - text: Show me every service account in the organization.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/resources/v2.1/service-accounts'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a service account
      effect: write
      questions:
      - How do I create a service account for an automation to use?
      - Can I create a dedicated service account for a new integration?
      instructions:
      - text: Create a new service account for our automation.
      - text: Add a service account with these properties.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/resources/v2.1/service-accounts/{service_account_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a service account
      effect: read
      questions:
      - What are the details of a particular service account?
      - Can I look up a service account by its ID?
      instructions:
      - text: Get service account {service_account_id}.
        slots:
          service_account_id: path.service_account_id
      - text: Show the details of service account {service_account_id}.
        slots:
          service_account_id: path.service_account_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/resources/v2.1/service-accounts/{service_account_id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a service account
      effect: destructive
      questions:
      - Can I permanently delete a service account we no longer need?
      - What happens if I delete a service account — is it recoverable?
      instructions:
      - text: Delete service account {service_account_id}.
        slots:
          service_account_id: path.service_account_id
      - text: Permanently remove service account {service_account_id}.
        slots:
          service_account_id: path.service_account_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/resources/v2.1/service-accounts/{service_account_id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update a service account
      effect: write
      questions:
      - Can I change the details of an existing service account?
      - How do I edit a service account's properties?
      instructions:
      - text: Update service account {service_account_id}.
        slots:
          service_account_id: path.service_account_id
      - text: Modify the properties of service account {service_account_id}.
        slots:
          service_account_id: path.service_account_id
      method: generated
      generated: '2026-09-26'