Sigma Computing · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Sigma Computing Tags API

6 actions 6 updates phrasing extends openapi/sigma-computing-tags-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/tags'].get

$.paths['/v2/tags'].post

$.paths['/v2/tags/{tagId}'].delete

$.paths['/v2/tags/{tagId}'].patch

$.paths['/v2/tags/{tagId}/workbooks'].get

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 Tags API
  version: 1.0.0
extends: openapi/sigma-computing-tags-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/tags'].get
  update:
    x-apievangelist-phrasing:
      intent: List version tags
      effect: read
      questions:
      - What version tags exist in my Sigma organization?
      - Can I search version tags by name?
      instructions:
      - text: List all version tags.
      - text: Search version tags for {search}.
        slots:
          search: query.search
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v2/tags'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a version tag
      effect: write
      questions:
      - How do I create a version tag like Production or Staging?
      - Can I pick a color for a new version tag?
      instructions:
      - text: Create a version tag named {name} with color {color}.
        slots:
          name: requestBody.name
          color: requestBody.color
      - text: Create tag {name} in {color} described as {description}.
        slots:
          name: requestBody.name
          color: requestBody.color
          description: requestBody.description
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v2/tags/{tagId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a version tag
      effect: destructive
      questions:
      - How do I delete a version tag I no longer use?
      - Can I remove a tag from the organization entirely?
      instructions:
      - text: Delete version tag {tagId}.
        slots:
          tagId: path.tagId
      - text: Remove tag {tagId} from the organization.
        slots:
          tagId: path.tagId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v2/tags/{tagId}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Change a version tag's description
      effect: write
      questions:
      - How do I edit the description of a version tag?
      - Is the description the only thing I can update on a tag?
      instructions:
      - text: Update the description of tag {tagId} to {description}.
        slots:
          tagId: path.tagId
          description: requestBody.description
      - text: Describe version tag {tagId} as {description}.
        slots:
          tagId: path.tagId
          description: requestBody.description
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v2/tags/{tagId}/workbooks'].get
  update:
    x-apievangelist-phrasing:
      intent: List workbooks carrying a version tag
      effect: read
      questions:
      - Which workbooks have a particular version tag applied?
      - What is tagged Production right now?
      instructions:
      - text: List workbooks tagged {tagId}.
        slots:
          tagId: path.tagId
      - text: Show every workbook with version tag {tagId}.
        slots:
          tagId: path.tagId
      method: generated
      generated: '2026-09-26'