Sigma Computing · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Sigma Computing Shortcuts API

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

$.info
$.paths['/v2/shortcuts'].post

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 Shortcuts API
  version: 1.0.0
extends: openapi/sigma-computing-shortcuts-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: 1
- target: $.paths['/v2/shortcuts'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a shortcut to a document
      effect: write
      questions:
      - How do I surface a workbook in another folder without copying it?
      - Can I give a shortcut a different name from the item it points to?
      instructions:
      - text: Create a shortcut to {target} in folder {parentId}.
        slots:
          target: requestBody.target
          parentId: requestBody.parentId
      - text: Add a shortcut named {name} in {parentId} pointing to {target}.
        slots:
          name: requestBody.name
          parentId: requestBody.parentId
          target: requestBody.target
      method: generated
      generated: '2026-09-26'