Sigma Computing · OpenAPI Overlay 1.0.0
API Evangelist conversational phrasing for Sigma Computing Tenants API
10 actions
10 updates
phrasing
extends
openapi/sigma-computing-tenants-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.
What the actions change
x-apievangelist-phrasing
Targets 10
$.info
$.paths['/v2/tenants'].get
$.paths['/v2/tenants'].post
$.paths['/v2/tenants/{tenantOrganizationId}'].get
$.paths['/v2/tenants/{tenantOrganizationId}'].delete
$.paths['/v2/tenants/{tenantOrganizationId}'].patch
$.paths['/v2/tenants/{tenantOrganizationId}/capabilities/deployments'].get
$.paths['/v2/tenants/{tenantOrganizationId}/capabilities/deployments:batchAdd'].post
$.paths['/v2/tenants/{tenantOrganizationId}/capabilities/deployments:batchRemove'].post
$.paths['/v2/tenants/{tenantOrganizationId}/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 Tenants API
version: 1.0.0
extends: openapi/sigma-computing-tenants-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: 9
- target: $.paths['/v2/tenants'].get
update:
x-apievangelist-phrasing:
intent: List tenant organizations
effect: read
questions:
- Which tenant organizations exist under my Sigma parent org?
- Can I search and sort the tenant list?
instructions:
- text: List all tenant organizations.
- text: Search tenants for {search}, sorted by {key} in {order} order.
slots:
search: query.search
key: query.key
order: query.order
method: generated
generated: '2026-09-26'
- target: $.paths['/v2/tenants'].post
update:
x-apievangelist-phrasing:
intent: Create a tenant organization
effect: write
questions:
- How do I spin up a new tenant organization for a customer?
- Can I choose the cloud provider for a new tenant?
instructions:
- text: Create tenant {tenantOrganizationName} with slug {tenantOrganizationSlug}.
slots:
tenantOrganizationName: requestBody.tenantOrganizationName
tenantOrganizationSlug: requestBody.tenantOrganizationSlug
- text: Create tenant {tenantOrganizationName} at slug {tenantOrganizationSlug} on cloud {cloudProvider}.
slots:
tenantOrganizationName: requestBody.tenantOrganizationName
tenantOrganizationSlug: requestBody.tenantOrganizationSlug
cloudProvider: requestBody.cloudProvider
method: generated
generated: '2026-09-26'
- target: $.paths['/v2/tenants/{tenantOrganizationId}'].get
update:
x-apievangelist-phrasing:
intent: Get a tenant organization's details
effect: read
questions:
- What are the name and slug of a specific tenant organization?
- Can I look up one tenant by its ID?
instructions:
- text: Get tenant organization {tenantOrganizationId}.
slots:
tenantOrganizationId: path.tenantOrganizationId
- text: Show details for tenant {tenantOrganizationId}.
slots:
tenantOrganizationId: path.tenantOrganizationId
method: generated
generated: '2026-09-26'
- target: $.paths['/v2/tenants/{tenantOrganizationId}'].delete
update:
x-apievangelist-phrasing:
intent: Delete a tenant organization
effect: destructive
questions:
- How do I remove a tenant organization for an offboarded customer?
- Is admin access required to delete a tenant?
instructions:
- text: Delete tenant organization {tenantOrganizationId}.
slots:
tenantOrganizationId: path.tenantOrganizationId
- text: Remove tenant {tenantOrganizationId} permanently.
slots:
tenantOrganizationId: path.tenantOrganizationId
method: generated
generated: '2026-09-26'
- target: $.paths['/v2/tenants/{tenantOrganizationId}'].patch
update:
x-apievangelist-phrasing:
intent: Rename a tenant or change its slug
effect: write
questions:
- How do I rename a tenant organization?
- Can I change the URL slug of an existing tenant?
instructions:
- text: Rename tenant {tenantOrganizationId} to {tenantOrganizationName}.
slots:
tenantOrganizationId: path.tenantOrganizationId
tenantOrganizationName: requestBody.tenantOrganizationName
- text: Change tenant {tenantOrganizationId}'s slug to {tenantOrganizationSlug}.
slots:
tenantOrganizationId: path.tenantOrganizationId
tenantOrganizationSlug: requestBody.tenantOrganizationSlug
method: generated
generated: '2026-09-26'
- target: $.paths['/v2/tenants/{tenantOrganizationId}/capabilities/deployments'].get
update:
x-apievangelist-phrasing:
intent: List tenants a tenant can deploy to
effect: read
questions:
- Which tenant organizations can a given tenant deploy content to?
- How do I audit a tenant's deployment targets?
instructions:
- text: List the deployment targets of tenant {tenantOrganizationId}.
slots:
tenantOrganizationId: path.tenantOrganizationId
- text: Show which tenants {tenantOrganizationId} is allowed to deploy to.
slots:
tenantOrganizationId: path.tenantOrganizationId
method: generated
generated: '2026-09-26'
- target: $.paths['/v2/tenants/{tenantOrganizationId}/capabilities/deployments:batchAdd'].post
update:
x-apievangelist-phrasing:
intent: Allow a tenant to deploy to other tenants
effect: write
questions:
- How do I let one tenant deploy workbooks to other tenants?
- Can I grant deployment rights to several target tenants at once?
instructions:
- text: Allow tenant {tenantOrganizationId} to deploy to {deployToTenantOrganizationIds}.
slots:
tenantOrganizationId: path.tenantOrganizationId
deployToTenantOrganizationIds: requestBody.deployToTenantOrganizationIds
- text: Add deployment targets {deployToTenantOrganizationIds} for tenant {tenantOrganizationId}.
slots:
deployToTenantOrganizationIds: requestBody.deployToTenantOrganizationIds
tenantOrganizationId: path.tenantOrganizationId
method: generated
generated: '2026-09-26'
- target: $.paths['/v2/tenants/{tenantOrganizationId}/capabilities/deployments:batchRemove'].post
update:
x-apievangelist-phrasing:
intent: Revoke a tenant's deployment rights
effect: destructive
questions:
- How do I stop a tenant from deploying to certain other tenants?
- Can I revoke deploy access to multiple tenants in one call?
instructions:
- text: Stop tenant {tenantOrganizationId} from deploying to {deployToTenantOrganizationIds}.
slots:
tenantOrganizationId: path.tenantOrganizationId
deployToTenantOrganizationIds: requestBody.deployToTenantOrganizationIds
- text: Revoke deployment targets {deployToTenantOrganizationIds} from tenant {tenantOrganizationId}.
slots:
deployToTenantOrganizationIds: requestBody.deployToTenantOrganizationIds
tenantOrganizationId: path.tenantOrganizationId
method: generated
generated: '2026-09-26'
- target: $.paths['/v2/tenants/{tenantOrganizationId}/workbooks'].get
update:
x-apievangelist-phrasing:
intent: Find the workbook deployed to a tenant
effect: read
questions:
- What is the workbook ID of a parent workbook after it was deployed to a tenant?
- Can I look up a tenant's deployed copy by deployment policy?
instructions:
- text: Get the workbook deployed to tenant {tenantOrganizationId} from parent {parentWorkbookId}.
slots:
tenantOrganizationId: path.tenantOrganizationId
parentWorkbookId: query.parentWorkbookId
- text: Find tenant {tenantOrganizationId}'s workbook for deployment policy {deploymentPolicyId}.
slots:
tenantOrganizationId: path.tenantOrganizationId
deploymentPolicyId: query.deploymentPolicyId
method: generated
generated: '2026-09-26'