Sigma Computing · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Sigma Computing Account Types API

5 actions 5 updates phrasing extends openapi/sigma-computing-account-types-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/accountTypes'].get
$.paths['/v2/accountTypes'].post
$.paths['/v2/accountTypes/{accountTypeId}'].delete
$.paths['/v2/accountTypes/{accountTypeId}/permissions'].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 Account Types API
  version: 1.0.0
extends: openapi/sigma-computing-account-types-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: 4
- target: $.paths['/v2/accountTypes'].get
  update:
    x-apievangelist-phrasing:
      intent: List account types
      effect: read
      questions:
      - What account types exist in my Sigma organization?
      - How do I get account type IDs to look up their permissions?
      instructions:
      - text: List all account types.
      - text: List account types, {pageSize} per page.
        slots:
          pageSize: query.pageSize
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v2/accountTypes'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a custom account type
      effect: write
      questions:
      - How do I create a custom account type with specific permissions?
      - Who is allowed to create new account types?
      instructions:
      - text: Create account type {name} described as {description} with permissions {permissions}.
        slots:
          name: requestBody.name
          description: requestBody.description
          permissions: requestBody.permissions
      - text: Add a custom role {name} ({description}) granting {permissions}.
        slots:
          name: requestBody.name
          description: requestBody.description
          permissions: requestBody.permissions
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v2/accountTypes/{accountTypeId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a custom account type
      effect: destructive
      questions:
      - Can default Sigma account types be deleted?
      - What happens to users on an account type I delete?
      instructions:
      - text: Delete account type {accountTypeId}.
        slots:
          accountTypeId: path.accountTypeId
      - text: Delete account type {accountTypeId} and move its users to {reassignToAccountTypeId}.
        slots:
          accountTypeId: path.accountTypeId
          reassignToAccountTypeId: query.reassignToAccountTypeId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v2/accountTypes/{accountTypeId}/permissions'].get
  update:
    x-apievangelist-phrasing:
      intent: List an account type's permissions
      effect: read
      questions:
      - Which feature permissions does an account type grant?
      - How do I compare what two account types are allowed to do?
      instructions:
      - text: List permissions for account type {accountTypeId}.
        slots:
          accountTypeId: path.accountTypeId
      - text: Show which features account type {accountTypeId} can use.
        slots:
          accountTypeId: path.accountTypeId
      method: generated
      generated: '2026-10-01'