Sigma Computing · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Sigma Computing Public REST User Attributes API

17 actions 17 updates phrasing extends openapi/sigma-computing-user-attributes-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 17 · first 16 shown; the file carries all of them

$.info

$.paths['/v2/user-attributes'].get

$.paths['/v2/user-attributes'].post

$.paths['/v2/user-attributes/{userAttributeId}'].get

$.paths['/v2/user-attributes/{userAttributeId}'].delete

$.paths['/v2/user-attributes/{userAttributeId}/teams'].get

$.paths['/v2/user-attributes/{userAttributeId}/teams'].post

$.paths['/v2/user-attributes/{userAttributeId}/teams'].patch

$.paths['/v2/user-attributes/{userAttributeId}/teams/{teamId}'].delete

$.paths['/v2/user-attributes/{userAttributeId}/tenants'].get

$.paths['/v2/user-attributes/{userAttributeId}/tenants'].post

$.paths['/v2/user-attributes/{userAttributeId}/tenants'].patch

$.paths['/v2/user-attributes/{userAttributeId}/tenants/{tenantOrganizationId}'].delete

$.paths['/v2/user-attributes/{userAttributeId}/users'].get

$.paths['/v2/user-attributes/{userAttributeId}/users'].post

$.paths['/v2/user-attributes/{userAttributeId}/users'].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 Public REST User Attributes API
  version: 1.0.0
extends: openapi/sigma-computing-user-attributes-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: 16
- target: $.paths['/v2/user-attributes'].get
  update:
    x-apievangelist-phrasing:
      intent: List user attributes
      effect: read
      questions:
      - What user attributes are defined in my Sigma organization?
      - Can I search user attributes by name?
      instructions:
      - text: List all user attributes with their values and owners.
      - text: Find user attributes named {name}.
        slots:
          name: query.name
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v2/user-attributes'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a user attribute
      effect: write
      questions:
      - How do I define a new user attribute for row-level security?
      - Can a new user attribute have a default value?
      instructions:
      - text: Create a user attribute called {name}.
        slots:
          name: requestBody.name
      - text: Create user attribute {name} with default value {defaultValue}.
        slots:
          name: requestBody.name
          defaultValue: requestBody.defaultValue
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v2/user-attributes/{userAttributeId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a user attribute
      effect: read
      questions:
      - How do I look up the details of one user attribute?
      - What is the default value of a specific user attribute?
      instructions:
      - text: Get user attribute {userAttributeId}.
        slots:
          userAttributeId: path.userAttributeId
      - text: Show the description and default of user attribute {userAttributeId}.
        slots:
          userAttributeId: path.userAttributeId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v2/user-attributes/{userAttributeId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a user attribute permanently
      effect: destructive
      questions:
      - Who is allowed to delete a user attribute entirely?
      - Does deleting a user attribute remove it from the whole organization?
      instructions:
      - text: Permanently delete user attribute {userAttributeId}.
        slots:
          userAttributeId: path.userAttributeId
      - text: Remove the {userAttributeId} attribute from the organization.
        slots:
          userAttributeId: path.userAttributeId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v2/user-attributes/{userAttributeId}/teams'].get
  update:
    x-apievangelist-phrasing:
      intent: List teams assigned a user attribute
      effect: read
      questions:
      - Which teams have a value set for a given user attribute?
      - What value does each team get for this user attribute?
      instructions:
      - text: List teams assigned user attribute {userAttributeId}.
        slots:
          userAttributeId: path.userAttributeId
      - text: Show team values for user attribute {userAttributeId}.
        slots:
          userAttributeId: path.userAttributeId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v2/user-attributes/{userAttributeId}/teams'].post
  update:
    x-apievangelist-phrasing:
      intent: Assign a user attribute value to teams
      effect: write
      questions:
      - How do I set a user attribute value for several teams at once?
      - Can I give each team a different value for the same attribute?
      instructions:
      - text: 'Set user attribute {userAttributeId} for teams: {assignments}.'
        slots:
          userAttributeId: path.userAttributeId
          assignments: requestBody.assignments
      - text: Assign team values {assignments} to attribute {userAttributeId}.
        slots:
          assignments: requestBody.assignments
          userAttributeId: path.userAttributeId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v2/user-attributes/{userAttributeId}/teams'].patch
  update:
    x-apievangelist-phrasing:
      intent: Bulk-remove a user attribute from teams
      effect: destructive
      questions:
      - Can I clear a user attribute from many teams in one request?
      - What does the team user-attribute update support right now?
      instructions:
      - text: Remove user attribute {userAttributeId} from teams {delete}.
        slots:
          userAttributeId: path.userAttributeId
          delete: requestBody.delete
      - text: Bulk-unassign attribute {userAttributeId} for the teams in {delete}.
        slots:
          userAttributeId: path.userAttributeId
          delete: requestBody.delete
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v2/user-attributes/{userAttributeId}/teams/{teamId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove a user attribute from one team
      effect: destructive
      questions:
      - How do I unset a user attribute for a single team?
      - Can I drop one team's attribute value without touching other teams?
      instructions:
      - text: Delete user attribute {userAttributeId} for team {teamId}.
        slots:
          userAttributeId: path.userAttributeId
          teamId: path.teamId
      - text: Unset team {teamId}'s value for attribute {userAttributeId}.
        slots:
          teamId: path.teamId
          userAttributeId: path.userAttributeId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v2/user-attributes/{userAttributeId}/tenants'].get
  update:
    x-apievangelist-phrasing:
      intent: List tenants assigned a user attribute
      effect: read
      questions:
      - Which tenant organizations have a value for this user attribute?
      - What value does each tenant hold for a user attribute?
      instructions:
      - text: List tenants assigned user attribute {userAttributeId}.
        slots:
          userAttributeId: path.userAttributeId
      - text: Show tenant values for user attribute {userAttributeId}.
        slots:
          userAttributeId: path.userAttributeId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v2/user-attributes/{userAttributeId}/tenants'].post
  update:
    x-apievangelist-phrasing:
      intent: Assign a user attribute value to tenants
      effect: write
      questions:
      - How do I set a user attribute for my tenant organizations?
      - Can I assign attribute values to several tenants by tenant organization ID?
      instructions:
      - text: 'Set user attribute {userAttributeId} for tenants: {assignments}.'
        slots:
          userAttributeId: path.userAttributeId
          assignments: requestBody.assignments
      - text: Assign tenant values {assignments} to attribute {userAttributeId}.
        slots:
          assignments: requestBody.assignments
          userAttributeId: path.userAttributeId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v2/user-attributes/{userAttributeId}/tenants'].patch
  update:
    x-apievangelist-phrasing:
      intent: Bulk-remove a user attribute from tenants
      effect: destructive
      questions:
      - Can I clear a user attribute from several tenants in one call?
      - Does the tenant user-attribute update do anything besides deleting assignments?
      instructions:
      - text: Remove user attribute {userAttributeId} from tenants {delete}.
        slots:
          userAttributeId: path.userAttributeId
          delete: requestBody.delete
      - text: Bulk-unassign attribute {userAttributeId} for the tenants in {delete}.
        slots:
          userAttributeId: path.userAttributeId
          delete: requestBody.delete
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v2/user-attributes/{userAttributeId}/tenants/{tenantOrganizationId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove a user attribute from one tenant
      effect: destructive
      questions:
      - How do I unset a user attribute for a single tenant organization?
      - Can I drop one tenant's value for an attribute?
      instructions:
      - text: Delete user attribute {userAttributeId} for tenant {tenantOrganizationId}.
        slots:
          userAttributeId: path.userAttributeId
          tenantOrganizationId: path.tenantOrganizationId
      - text: Unset tenant {tenantOrganizationId}'s value for attribute {userAttributeId}.
        slots:
          tenantOrganizationId: path.tenantOrganizationId
          userAttributeId: path.userAttributeId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v2/user-attributes/{userAttributeId}/users'].get
  update:
    x-apievangelist-phrasing:
      intent: List users assigned a user attribute
      effect: read
      questions:
      - Which individual users have a value for this user attribute?
      - What value is each person assigned for an attribute?
      instructions:
      - text: List users assigned user attribute {userAttributeId}.
        slots:
          userAttributeId: path.userAttributeId
      - text: Show per-user values for attribute {userAttributeId}.
        slots:
          userAttributeId: path.userAttributeId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v2/user-attributes/{userAttributeId}/users'].post
  update:
    x-apievangelist-phrasing:
      intent: Assign a user attribute value to users
      effect: write
      questions:
      - How do I set a user attribute value for specific people?
      - Can I assign an attribute to several users by user ID at once?
      instructions:
      - text: 'Set user attribute {userAttributeId} for users: {assignments}.'
        slots:
          userAttributeId: path.userAttributeId
          assignments: requestBody.assignments
      - text: Assign per-user values {assignments} to attribute {userAttributeId}.
        slots:
          assignments: requestBody.assignments
          userAttributeId: path.userAttributeId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v2/user-attributes/{userAttributeId}/users'].patch
  update:
    x-apievangelist-phrasing:
      intent: Bulk-remove a user attribute from users
      effect: destructive
      questions:
      - Can I clear a user attribute from many users at once?
      - Is deleting assignments the only thing the user attribute update for users supports?
      instructions:
      - text: Remove user attribute {userAttributeId} from users {delete}.
        slots:
          userAttributeId: path.userAttributeId
          delete: requestBody.delete
      - text: Bulk-unassign attribute {userAttributeId} for the users in {delete}.
        slots:
          userAttributeId: path.userAttributeId
          delete: requestBody.delete
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v2/user-attributes/{userAttributeId}/users/{userId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove a user attribute from one user
      effect: destructive
      questions:
      - How do I unset a user attribute for a single person?
      - Can I delete just one user's attribute value?
      instructions:
      - text: Delete user attribute {userAttributeId} for user {userId}.
        slots:
          userAttributeId: path.userAttributeId
          userId: path.userId
      - text: Unset user {userId}'s value for attribute {userAttributeId}.
        slots:
          userId: path.userId
          userAttributeId: path.userAttributeId
      method: generated
      generated: '2026-09-26'