Sigma Computing · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Sigma Computing Organizations API

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

$.info

$.paths['/v2/organizations/settings'].patch

$.paths['/v2/organizations/settings/bulkCopy'].get

$.paths['/v2/organizations/settings/bulkCopy'].patch

$.paths['/v2/organizations/settings/licenseUpgradeRequests'].get

$.paths['/v2/organizations/settings/licenseUpgradeRequests'].patch

$.paths['/v2/organizations/settings/publicEmbeds'].get

$.paths['/v2/organizations/settings/publicEmbeds'].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 Organizations API
  version: 1.0.0
extends: openapi/sigma-computing-organizations-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: 7
- target: $.paths['/v2/organizations/settings'].patch
  update:
    x-apievangelist-phrasing:
      intent: Change the organization's timezone
      effect: write
      questions:
      - How do I set the default timezone for my Sigma organization?
      - Can I update a tenant organization's timezone through impersonation?
      instructions:
      - text: Set the organization timezone to {timezone}.
        slots:
          timezone: requestBody.timezone
      - text: Update our org settings so the timezone is {timezone}.
        slots:
          timezone: requestBody.timezone
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v2/organizations/settings/bulkCopy'].get
  update:
    x-apievangelist-phrasing:
      intent: Check if members can bulk copy table data
      effect: read
      questions:
      - Are members allowed to bulk copy data out of tables?
      - Is bulk copy turned on for this organization?
      instructions:
      - text: Check whether bulk copy is enabled for the organization.
      - text: Tell me if users can bulk copy table data.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v2/organizations/settings/bulkCopy'].patch
  update:
    x-apievangelist-phrasing:
      intent: Turn bulk copy on or off
      effect: write
      questions:
      - How do I stop members from bulk copying table data?
      - Can an admin re-enable bulk copy for the organization?
      instructions:
      - text: Set bulk copy for the organization to {enabled}.
        slots:
          enabled: requestBody.enabled
      - text: 'Change whether members may bulk copy table data: {enabled}.'
        slots:
          enabled: requestBody.enabled
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v2/organizations/settings/licenseUpgradeRequests'].get
  update:
    x-apievangelist-phrasing:
      intent: Check if users can request license upgrades
      effect: read
      questions:
      - Can members of my organization request a license upgrade?
      - Is the license upgrade request option enabled?
      instructions:
      - text: Check whether license upgrade requests are allowed.
      - text: Tell me if members can ask for a license upgrade.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v2/organizations/settings/licenseUpgradeRequests'].patch
  update:
    x-apievangelist-phrasing:
      intent: Allow or block license upgrade requests
      effect: write
      questions:
      - How do I stop members from requesting license upgrades?
      - Can I let users request a higher license from inside Sigma?
      instructions:
      - text: Set license upgrade requests to {enabled}.
        slots:
          enabled: requestBody.enabled
      - text: 'Change whether members may request license upgrades: {enabled}.'
        slots:
          enabled: requestBody.enabled
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v2/organizations/settings/publicEmbeds'].get
  update:
    x-apievangelist-phrasing:
      intent: Check if public embeds are allowed
      effect: read
      questions:
      - Does my organization allow workbooks to be embedded publicly?
      - Is public embedding switched on for this org?
      instructions:
      - text: Check whether public workbook embeds are allowed.
      - text: Tell me the organization's public embeds setting.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v2/organizations/settings/publicEmbeds'].patch
  update:
    x-apievangelist-phrasing:
      intent: Allow or block public workbook embeds
      effect: write
      questions:
      - How do I disable public embedding of workbooks?
      - Can an admin turn public embeds back on?
      instructions:
      - text: Set public workbook embeds to {enabled}.
        slots:
          enabled: requestBody.enabled
      - text: 'Change whether workbooks may be embedded publicly: {enabled}.'
        slots:
          enabled: requestBody.enabled
      method: generated
      generated: '2026-09-26'