Sigma Computing · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Sigma Computing Public REST API Credentials API

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

$.info

$.paths['/v2/api-credentials'].get

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

$.paths['/v2/api-credentials/{apiCredentialId}'].get

$.paths['/v2/api-credentials/{apiCredentialId}'].delete

$.paths['/v2/api-credentials/{apiCredentialId}'].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 API Credentials API
  version: 1.0.0
extends: openapi/sigma-computing-api-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: 5
- target: $.paths['/v2/api-credentials'].get
  update:
    x-apievangelist-phrasing:
      intent: List stored API credentials
      effect: read
      questions:
      - Which API credentials are stored for my API connectors?
      - Can I find an API credential by name?
      instructions:
      - text: List my API credentials.
      - text: Find API credentials named {name}, ordered by {orderBy}.
        slots:
          name: query.name
          orderBy: query.orderBy
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v2/api-credentials'].post
  update:
    x-apievangelist-phrasing:
      intent: Store a credential for API connectors
      effect: write
      questions:
      - How do I save a secret for use with the Call API action?
      - Can I restrict which hosts an API credential may be sent to?
      instructions:
      - text: Create API credential {name} with secret {credential} allowed for {allowlist}.
        slots:
          name: requestBody.name
          credential: requestBody.credential
          allowlist: requestBody.allowlist
      - text: Store a new connector credential {name} for hosts {allowlist} using {credential}.
        slots:
          name: requestBody.name
          allowlist: requestBody.allowlist
          credential: requestBody.credential
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v2/api-credentials/{apiCredentialId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an API credential's non-secret details
      effect: read
      questions:
      - What hosts and description does a stored API credential have?
      - Can I view an API credential without exposing the secret?
      instructions:
      - text: Get API credential {apiCredentialId}.
        slots:
          apiCredentialId: path.apiCredentialId
      - text: Show the nonsensitive details of credential {apiCredentialId}.
        slots:
          apiCredentialId: path.apiCredentialId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v2/api-credentials/{apiCredentialId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Archive an API credential
      effect: destructive
      questions:
      - How do I retire an API credential so new connectors cannot use it?
      - What happens when an API credential is deleted?
      instructions:
      - text: Delete API credential {apiCredentialId}.
        slots:
          apiCredentialId: path.apiCredentialId
      - text: Archive connector credential {apiCredentialId}.
        slots:
          apiCredentialId: path.apiCredentialId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v2/api-credentials/{apiCredentialId}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update or rotate an API credential
      effect: write
      questions:
      - How do I rotate the secret in a stored API credential?
      - Can I change the allowlist of an existing API credential?
      instructions:
      - text: Rotate API credential {apiCredentialId} to secret {credential}.
        slots:
          apiCredentialId: path.apiCredentialId
          credential: requestBody.credential
      - text: Change the allowlist of credential {apiCredentialId} to {allowlist}.
        slots:
          apiCredentialId: path.apiCredentialId
          allowlist: requestBody.allowlist
      method: generated
      generated: '2026-09-26'