Sigma Computing · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Sigma Computing Credentials API

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

$.info

$.paths['/v2/credentials'].post

$.paths['/v2/credentials/{clientId}'].delete

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 Credentials API
  version: 1.0.0
extends: openapi/sigma-computing-credentials-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: 2
- target: $.paths['/v2/credentials'].post
  update:
    x-apievangelist-phrasing:
      intent: Create API client credentials for a user
      effect: write
      questions:
      - How do I generate a client ID and secret for a Sigma user?
      - Can I limit the scopes of new API client credentials?
      instructions:
      - text: Create API client credentials named {name} for user {ownerId}.
        slots:
          name: requestBody.name
          ownerId: requestBody.ownerId
      - text: Issue client credentials {name} to {ownerId} with scopes {scopes}.
        slots:
          name: requestBody.name
          ownerId: requestBody.ownerId
          scopes: requestBody.scopes
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v2/credentials/{clientId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Revoke API client credentials
      effect: destructive
      questions:
      - How do I revoke a leaked API client ID?
      - Can an admin delete another user's API client credentials?
      instructions:
      - text: Revoke API client credentials {clientId}.
        slots:
          clientId: path.clientId
      - text: Delete client ID {clientId} so it can no longer authenticate.
        slots:
          clientId: path.clientId
      method: generated
      generated: '2026-09-26'