Sigma Computing · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Sigma Computing Teams API

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

$.info
$.paths['/v2/teams'].get
$.paths['/v2/teams'].post
$.paths['/v2/teams/{teamId}'].get
$.paths['/v2/teams/{teamId}'].delete
$.paths['/v2/teams/{teamId}'].patch
$.paths['/v2/teams/{teamId}/assignedUserAttributes'].post
$.paths['/v2/teams/{teamId}/members'].get
$.paths['/v2/teams/{teamId}/members'].patch
$.paths['/v2/teams/{teamId}/user-attributes'].get
$.paths['/v2.1/teams'].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 Teams API
  version: 1.0.0
extends: openapi/sigma-computing-teams-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: 10
- target: $.paths['/v2/teams'].get
  update:
    x-apievangelist-phrasing:
      intent: List teams (v2)
      effect: read
      questions:
      - Which teams exist in my Sigma organization?
      - Can I filter the v2 team list by name or visibility?
      instructions:
      - text: List all teams with the v2 endpoint.
      - text: List v2 teams named {name} with visibility {visibility}.
        slots:
          name: query.name
          visibility: query.visibility
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v2/teams'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a team
      effect: write
      questions:
      - How do I create a new team and add members to it?
      - Can a team get its own folder when it is created?
      instructions:
      - text: Create a team called {name}.
        slots:
          name: requestBody.name
      - text: Create team {name} with members {members} and a team folder set to {createTeamFolder}.
        slots:
          name: requestBody.name
          members: requestBody.members
          createTeamFolder: requestBody.createTeamFolder
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v2/teams/{teamId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a team and its member IDs
      effect: read
      questions:
      - What are the details of a specific team?
      - Can I look up one team by its ID?
      instructions:
      - text: Get team {teamId}.
        slots:
          teamId: path.teamId
      - text: Show the details and member IDs of team {teamId}.
        slots:
          teamId: path.teamId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v2/teams/{teamId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a team
      effect: destructive
      questions:
      - How do I delete a team I no longer need?
      - Can I remove a team by its ID?
      instructions:
      - text: Delete team {teamId}.
        slots:
          teamId: path.teamId
      - text: Remove team {teamId} from the organization.
        slots:
          teamId: path.teamId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v2/teams/{teamId}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Rename a team or change its visibility
      effect: write
      questions:
      - How do I rename a team or change its description?
      - Can I make a team private or public?
      instructions:
      - text: Rename team {teamId} to {name}.
        slots:
          teamId: path.teamId
          name: requestBody.name
      - text: Set team {teamId}'s visibility to {visibility}.
        slots:
          teamId: path.teamId
          visibility: requestBody.visibility
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v2/teams/{teamId}/assignedUserAttributes'].post
  update:
    x-apievangelist-phrasing:
      intent: Assign user attributes to a team
      effect: write
      questions:
      - How do I give a team several user attribute values at once?
      - Can I assign user attributes starting from the team rather than the attribute?
      instructions:
      - text: Assign user attributes {assignments} to team {teamId}.
        slots:
          assignments: requestBody.assignments
          teamId: path.teamId
      - text: 'Give team {teamId} these attribute values: {assignments}.'
        slots:
          teamId: path.teamId
          assignments: requestBody.assignments
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v2/teams/{teamId}/members'].get
  update:
    x-apievangelist-phrasing:
      intent: List the members of a team
      effect: read
      questions:
      - Who is on a particular team?
      - Can I page through a large team's member list?
      instructions:
      - text: List the members of team {teamId}.
        slots:
          teamId: path.teamId
      - text: Show team {teamId}'s members, {limit} per page.
        slots:
          teamId: path.teamId
          limit: query.limit
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v2/teams/{teamId}/members'].patch
  update:
    x-apievangelist-phrasing:
      intent: Add or remove team members
      effect: write
      questions:
      - How do I add people to or remove people from a team?
      - Can inactive users be added to a team?
      instructions:
      - text: Add {add} to team {teamId}.
        slots:
          add: requestBody.add
          teamId: path.teamId
      - text: Remove {remove} from team {teamId}.
        slots:
          remove: requestBody.remove
          teamId: path.teamId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v2/teams/{teamId}/user-attributes'].get
  update:
    x-apievangelist-phrasing:
      intent: List user attributes assigned to a team
      effect: read
      questions:
      - Which user attributes and values does a team have?
      - What attribute values apply to members of one team?
      instructions:
      - text: List the user attributes assigned to team {teamId}.
        slots:
          teamId: path.teamId
      - text: Show attribute values set on team {teamId}.
        slots:
          teamId: path.teamId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v2.1/teams'].get
  update:
    x-apievangelist-phrasing:
      intent: List teams with pagination (v2.1)
      effect: read
      questions:
      - Is there a paginated-by-default endpoint for listing teams?
      - Can the v2.1 team listing filter by description?
      instructions:
      - text: List teams using the paginated v2.1 endpoint.
      - text: Page through v2.1 teams with description {description}, {limit} per page.
        slots:
          description: query.description
          limit: query.limit
      method: generated
      generated: '2026-09-26'