Sigma Computing · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Sigma Computing SAML API

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

$.info
$.paths['/v2/saml/service-providers'].get
$.paths['/v2/saml/service-providers/{samlServiceProviderId}/certificates'].get
$.paths['/v2/saml/service-providers/{samlServiceProviderId}/certificates'].post
$.paths['/v2/saml/service-providers/{samlServiceProviderId}/certificates/{samlServiceProviderCertificateId}'].get
$.paths['/v2/saml/service-providers/{samlServiceProviderId}/certificates/{samlServiceProviderCertificateId}'].delete
$.paths['/v2/saml/service-providers/{samlServiceProviderId}/certificates/{samlServiceProviderCertificateId}/activate'].post
$.paths['/v2/saml/service-providers/{samlServiceProviderId}/certificates/{samlServiceProviderCertificateId}/deactivate'].post

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 SAML API
  version: 1.0.0
extends: openapi/sigma-computing-saml-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: 7
- target: $.paths['/v2/saml/service-providers'].get
  update:
    x-apievangelist-phrasing:
      intent: List SAML service providers
      effect: read
      questions:
      - Which SAML service providers are configured in my organization?
      - Where do I find the SAML service provider ID for SSO setup?
      instructions:
      - text: List all SAML service providers.
      - text: List SAML service providers, {pageSize} per page.
        slots:
          pageSize: query.pageSize
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v2/saml/service-providers/{samlServiceProviderId}/certificates'].get
  update:
    x-apievangelist-phrasing:
      intent: List certificates for a SAML service provider
      effect: read
      questions:
      - What certificates does a SAML service provider have?
      - Can I see which SAML certificates are active or expiring?
      instructions:
      - text: List certificates for SAML service provider {samlServiceProviderId}.
        slots:
          samlServiceProviderId: path.samlServiceProviderId
      - text: Show all certs on SAML provider {samlServiceProviderId}.
        slots:
          samlServiceProviderId: path.samlServiceProviderId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v2/saml/service-providers/{samlServiceProviderId}/certificates'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a SAML service provider certificate
      effect: write
      questions:
      - How do I generate a new certificate for SAML signing or encryption?
      - Can I choose how many days a new SAML certificate is valid?
      instructions:
      - text: Create a {purpose} certificate for SAML provider {samlServiceProviderId} valid for {validForDays} days.
        slots:
          purpose: requestBody.purpose
          samlServiceProviderId: path.samlServiceProviderId
          validForDays: requestBody.validForDays
      - text: Generate a new cert on {samlServiceProviderId} for {purpose} lasting {validForDays} days.
        slots:
          samlServiceProviderId: path.samlServiceProviderId
          purpose: requestBody.purpose
          validForDays: requestBody.validForDays
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v2/saml/service-providers/{samlServiceProviderId}/certificates/{samlServiceProviderCertificateId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a SAML certificate for my IdP
      effect: read
      questions:
      - How do I get the certificate to upload to my identity provider?
      - Can I retrieve one SAML service provider certificate by ID?
      instructions:
      - text: Get certificate {samlServiceProviderCertificateId} for SAML provider {samlServiceProviderId}.
        slots:
          samlServiceProviderCertificateId: path.samlServiceProviderCertificateId
          samlServiceProviderId: path.samlServiceProviderId
      - text: Fetch SAML cert {samlServiceProviderCertificateId} from {samlServiceProviderId} for my IdP.
        slots:
          samlServiceProviderCertificateId: path.samlServiceProviderCertificateId
          samlServiceProviderId: path.samlServiceProviderId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v2/saml/service-providers/{samlServiceProviderId}/certificates/{samlServiceProviderCertificateId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove a SAML certificate
      effect: destructive
      questions:
      - How do I delete an old SAML service provider certificate?
      - Can I remove a certificate I no longer use for SSO?
      instructions:
      - text: Remove certificate {samlServiceProviderCertificateId} from SAML provider {samlServiceProviderId}.
        slots:
          samlServiceProviderCertificateId: path.samlServiceProviderCertificateId
          samlServiceProviderId: path.samlServiceProviderId
      - text: Delete SAML cert {samlServiceProviderCertificateId} on {samlServiceProviderId}.
        slots:
          samlServiceProviderCertificateId: path.samlServiceProviderCertificateId
          samlServiceProviderId: path.samlServiceProviderId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v2/saml/service-providers/{samlServiceProviderId}/certificates/{samlServiceProviderCertificateId}/activate'].post
  update:
    x-apievangelist-phrasing:
      intent: Activate a SAML certificate
      effect: write
      questions:
      - How do I switch SSO over to a newly created SAML certificate?
      - Can I activate a certificate during a certificate rotation?
      instructions:
      - text: Activate certificate {samlServiceProviderCertificateId} on SAML provider {samlServiceProviderId}.
        slots:
          samlServiceProviderCertificateId: path.samlServiceProviderCertificateId
          samlServiceProviderId: path.samlServiceProviderId
      - text: Turn on SAML cert {samlServiceProviderCertificateId} for {samlServiceProviderId}.
        slots:
          samlServiceProviderCertificateId: path.samlServiceProviderCertificateId
          samlServiceProviderId: path.samlServiceProviderId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v2/saml/service-providers/{samlServiceProviderId}/certificates/{samlServiceProviderCertificateId}/deactivate'].post
  update:
    x-apievangelist-phrasing:
      intent: Deactivate a SAML certificate
      effect: destructive
      questions:
      - How do I stop using a SAML certificate without deleting it?
      - Can I deactivate an old certificate after rotating to a new one?
      instructions:
      - text: Deactivate certificate {samlServiceProviderCertificateId} on SAML provider {samlServiceProviderId}.
        slots:
          samlServiceProviderCertificateId: path.samlServiceProviderCertificateId
          samlServiceProviderId: path.samlServiceProviderId
      - text: Turn off SAML cert {samlServiceProviderCertificateId} for {samlServiceProviderId}.
        slots:
          samlServiceProviderCertificateId: path.samlServiceProviderCertificateId
          samlServiceProviderId: path.samlServiceProviderId
      method: generated
      generated: '2026-09-26'