Sigma Computing · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Sigma Computing Public REST API Connectors API

6 actions 6 updates phrasing extends openapi/sigma-computing-api-connectors-api-openapi.yml

Generated by API Evangelist Written by API Evangelist tooling for Sigma Computing's API. It is a proposal applied on top of the contract, not a document Sigma Computing publishes.

View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 6

$.info

$.paths['/v2/api-connectors'].get

$.paths['/v2/api-connectors'].post

$.paths['/v2/api-connectors/{apiConnectorId}'].get

$.paths['/v2/api-connectors/{apiConnectorId}'].delete

$.paths['/v2/api-connectors/{apiConnectorId}'].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 Sigma Computing Public REST API Connectors API
  version: 1.0.0
extends: openapi/sigma-computing-api-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['/v2/api-connectors'].get
  update:
    x-apievangelist-phrasing:
      intent: List API connectors
      effect: read
      questions:
      - Which API connectors can I see in Sigma?
      - Can I filter API connectors by name and sort them?
      instructions:
      - text: List the API connectors I can view.
      - text: Find API connectors named {name}.
        slots:
          name: query.name
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v2/api-connectors'].post
  update:
    x-apievangelist-phrasing:
      intent: Create an API connector
      effect: write
      questions:
      - How do I set up Sigma to call an external HTTP endpoint from a workbook action?
      - Can an API connector reuse stored API credentials?
      instructions:
      - text: Create an API connector named {name} with request parameters {params}.
        slots:
          name: requestBody.name
          params: requestBody.params
      - text: Create connector {name} with params {params} authenticated by credential {authId}.
        slots:
          name: requestBody.name
          params: requestBody.params
          authId: requestBody.authId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v2/api-connectors/{apiConnectorId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an API connector's configuration
      effect: read
      questions:
      - What request parameters and config does an API connector use?
      - How do I inspect one API connector in full?
      instructions:
      - text: Get API connector {apiConnectorId}.
        slots:
          apiConnectorId: path.apiConnectorId
      - text: Show the parameters and config of connector {apiConnectorId}.
        slots:
          apiConnectorId: path.apiConnectorId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v2/api-connectors/{apiConnectorId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Archive an API connector
      effect: destructive
      questions:
      - How do I stop an API connector from being used in new workbook actions?
      - Does deleting an API connector archive it?
      instructions:
      - text: Archive API connector {apiConnectorId}.
        slots:
          apiConnectorId: path.apiConnectorId
      - text: Delete the {apiConnectorId} connector so no new actions use it.
        slots:
          apiConnectorId: path.apiConnectorId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v2/api-connectors/{apiConnectorId}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update an API connector
      effect: write
      questions:
      - Can I change the credential an existing API connector uses?
      - How do I edit an API connector's request parameters?
      instructions:
      - text: Rename API connector {apiConnectorId} to {name}.
        slots:
          apiConnectorId: path.apiConnectorId
          name: requestBody.name
      - text: Switch connector {apiConnectorId} to credential {authId}.
        slots:
          apiConnectorId: path.apiConnectorId
          authId: requestBody.authId
      method: generated
      generated: '2026-09-26'