Sigma Computing · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Sigma Computing Source Swap Policies API

6 actions 6 updates phrasing extends openapi/sigma-computing-sourceswappolicies-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/sourceSwapPolicies'].get

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

$.paths['/v2/sourceSwapPolicies/{policyId}'].get

$.paths['/v2/sourceSwapPolicies/{policyId}'].delete

$.paths['/v2/sourceSwapPolicies/{policyId}'].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 Source Swap Policies API
  version: 1.0.0
extends: openapi/sigma-computing-sourceswappolicies-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/sourceSwapPolicies'].get
  update:
    x-apievangelist-phrasing:
      intent: List source swap policies
      effect: read
      questions:
      - What source swap policies are defined in my organization?
      - Are connection source swap policies included in the list?
      instructions:
      - text: List all source swap policies.
      - text: List source swap policies, {limit} per page.
        slots:
          limit: query.limit
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v2/sourceSwapPolicies'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a source swap policy
      effect: write
      questions:
      - How do I define a policy that swaps connections based on a user attribute?
      - Can I create a connection source swap policy if the beta isn't enabled?
      instructions:
      - text: Create a new source swap policy.
      - text: Set up a connection source swap policy driven by a user attribute.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v2/sourceSwapPolicies/{policyId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a source swap policy
      effect: read
      questions:
      - How do I view one source swap policy's settings?
      - Which connection does a source swap policy swap from?
      instructions:
      - text: Get source swap policy {policyId}.
        slots:
          policyId: path.policyId
      - text: Show the swaps configured in policy {policyId}.
        slots:
          policyId: path.policyId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v2/sourceSwapPolicies/{policyId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a source swap policy
      effect: destructive
      questions:
      - How do I remove a source swap policy I no longer need?
      - Can I delete a connection source swap policy by ID?
      instructions:
      - text: Delete source swap policy {policyId}.
        slots:
          policyId: path.policyId
      - text: Remove the {policyId} swap policy.
        slots:
          policyId: path.policyId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v2/sourceSwapPolicies/{policyId}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update a source swap policy
      effect: write
      questions:
      - How do I change the swaps in an existing source swap policy?
      - Can I point a source swap policy at a different from-connection?
      instructions:
      - text: Update source swap policy {policyId}.
        slots:
          policyId: path.policyId
      - text: Change the connection swaps defined in policy {policyId}.
        slots:
          policyId: path.policyId
      method: generated
      generated: '2026-09-26'