Sigma Computing · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Sigma Computing Public REST Shared Templates API

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

$.info
$.paths['/v2/shared_templates/{shareId}'].delete
$.paths['/v2/shared_templates/accept'].post
$.paths['/v2/shared_templates/shared_with_you'].get

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 Sigma Computing Public REST Shared Templates API
  version: 1.0.0
extends: openapi/sigma-computing-shared-templates-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-10-01'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 3
- target: $.paths['/v2/shared_templates/{shareId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove a template shared with my organization
      effect: destructive
      questions:
      - How do I get rid of a workbook template another organization shared with us?
      - Can I delete a template share I do not want?
      instructions:
      - text: Delete template share {shareId}.
        slots:
          shareId: path.shareId
      - text: Remove the shared template {shareId} from our organization.
        slots:
          shareId: path.shareId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v2/shared_templates/accept'].post
  update:
    x-apievangelist-phrasing:
      intent: Accept a pending template share
      effect: write
      questions:
      - How do I accept a workbook template shared with my organization?
      - Can I swap data sources while accepting a shared template?
      instructions:
      - text: Accept template share {shareId}.
        slots:
          shareId: requestBody.shareId
      - text: Accept share {shareId} and swap sources using {sourceSwaps}.
        slots:
          shareId: requestBody.shareId
          sourceSwaps: requestBody.sourceSwaps
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v2/shared_templates/shared_with_you'].get
  update:
    x-apievangelist-phrasing:
      intent: List templates shared with my organization
      effect: read
      questions:
      - Which workbook templates have been shared with us?
      - Are there template shares still waiting to be accepted?
      instructions:
      - text: List templates shared with my organization.
      - text: List shared templates where pending is {pending}.
        slots:
          pending: query.pending
      method: generated
      generated: '2026-10-01'