BigPanda · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for BigPanda Data Connectors API

6 actions 6 updates phrasing extends openapi/bigpanda-data-connectors-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.0/data-connectors/{connector_id}/auth-uri'].post
$.paths['/resources/v2.0/data-connectors'].get
$.paths['/resources/v2.0/data-connectors'].post
$.paths['/resources/v2.0/data-connectors/{connector_id}'].get
$.paths['/resources/v2.0/data-connectors/{connector_id}'].delete

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 Data Connectors API
  version: 1.0.0
extends: openapi/bigpanda-data-connectors-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.0/data-connectors/{connector_id}/auth-uri'].post
  update:
    x-apievangelist-phrasing:
      intent: Get the auth setup link for a data connector
      effect: write
      questions:
      - Where do I finish authenticating a data connector I just created?
      - Can I get a secure URI to configure a connector's credentials?
      instructions:
      - text: Get the authentication setup URI for data connector {connector_id}.
        slots:
          connector_id: path.connector_id
      - text: Start auth configuration for connector {connector_id}.
        slots:
          connector_id: path.connector_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/resources/v2.0/data-connectors'].get
  update:
    x-apievangelist-phrasing:
      intent: List data connectors
      effect: read
      questions:
      - Which data connectors do I have access to in BigPanda?
      - Can I see all the data connector integrations set up for our org?
      instructions:
      - text: List all data connectors.
      - text: Show the data connectors I can access.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/resources/v2.0/data-connectors'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a data connector
      effect: write
      questions:
      - How do I add a new data connector integration?
      - What schema does a new data connector need?
      instructions:
      - text: Create a data connector with schema {schema}.
        slots:
          schema: requestBody.schema
      - text: Set up a new data connector integration.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/resources/v2.0/data-connectors/{connector_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a data connector
      effect: read
      questions:
      - How is a specific data connector configured?
      - Can I look up one data connector by ID?
      instructions:
      - text: Get data connector {connector_id}.
        slots:
          connector_id: path.connector_id
      - text: Show the configuration of connector {connector_id}.
        slots:
          connector_id: path.connector_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/resources/v2.0/data-connectors/{connector_id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a data connector
      effect: destructive
      questions:
      - How do I remove a data connector integration I no longer use?
      - Can I delete a data connector by ID?
      instructions:
      - text: Delete data connector {connector_id}.
        slots:
          connector_id: path.connector_id
      - text: Remove the connector integration {connector_id}.
        slots:
          connector_id: path.connector_id
      method: generated
      generated: '2026-09-26'