Sigma Computing · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Sigma Computing Templates API

5 actions 5 updates phrasing extends openapi/sigma-computing-templates-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 5

$.info

$.paths['/v2/templates'].get

$.paths['/v2/templates/{templateId}'].get

$.paths['/v2/templates/{templateId}/swapSources'].post

$.paths['/v2/templates/save_workbook'].post

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 Templates API
  version: 1.0.0
extends: openapi/sigma-computing-templates-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: 4
- target: $.paths['/v2/templates'].get
  update:
    x-apievangelist-phrasing:
      intent: List workbook templates
      effect: read
      questions:
      - Which workbook templates are available to me?
      - Can I search templates or show only official Sigma ones?
      instructions:
      - text: List available templates.
      - text: Search templates for {search}.
        slots:
          search: query.search
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v2/templates/{templateId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a template
      effect: read
      questions:
      - How do I look up one template by its ID?
      - What details are stored for a workbook template?
      instructions:
      - text: Get template {templateId}.
        slots:
          templateId: path.templateId
      - text: Show the details of template {templateId}.
        slots:
          templateId: path.templateId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v2/templates/{templateId}/swapSources'].post
  update:
    x-apievangelist-phrasing:
      intent: Swap a template's data sources
      effect: write
      questions:
      - How do I point a workbook template at a different connection?
      - Can I swap the datasets behind a template and keep input table data?
      instructions:
      - text: Swap template {templateId}'s connections using {connectionMapping}.
        slots:
          templateId: path.templateId
          connectionMapping: requestBody.connectionMapping
      - text: Remap the sources of template {templateId} per {sourceMapping}.
        slots:
          templateId: path.templateId
          sourceMapping: requestBody.sourceMapping
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v2/templates/save_workbook'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a workbook from a template
      effect: write
      questions:
      - How do I make a new workbook from a template?
      - Can a workbook created from a template update automatically when the template changes?
      instructions:
      - text: Create a workbook from template {templateId} in folder {folderId}.
        slots:
          templateId: requestBody.templateId
          folderId: requestBody.folderId
      - text: 'Save template {templateId} as workbook {name} in {folderId}, auto-updating: {updateAutomatically}.'
        slots:
          templateId: requestBody.templateId
          name: requestBody.name
          folderId: requestBody.folderId
          updateAutomatically: requestBody.updateAutomatically
      method: generated
      generated: '2026-09-26'