TextQL · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for TextQL SCIM Service API

7 actions 7 updates phrasing extends openapi/textql-scimservice-api-openapi.yml
Generated by API Evangelist Written by API Evangelist tooling for TextQL's API. It is a proposal applied on top of the contract, not a document TextQL publishes.
View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 7

$.info
$.paths['/textql.rpc.public.scim.ScimService/CreateScimOAuthClient'].post
$.paths['/textql.rpc.public.scim.ScimService/CreateScimToken'].post
$.paths['/textql.rpc.public.scim.ScimService/ListScimOAuthClients'].post
$.paths['/textql.rpc.public.scim.ScimService/ListScimTokens'].post
$.paths['/textql.rpc.public.scim.ScimService/RevokeScimOAuthClient'].post
$.paths['/textql.rpc.public.scim.ScimService/RevokeScimToken'].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 TextQL SCIM Service API
  version: 1.0.0
extends: openapi/textql-scimservice-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-10-01'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 6
- target: $.paths['/textql.rpc.public.scim.ScimService/CreateScimOAuthClient'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a SCIM OAuth client
      effect: write
      questions:
      - How do I set up an OAuth client for SCIM user provisioning?
      - Can a SCIM OAuth client be made to expire?
      instructions:
      - text: Create a SCIM OAuth client described as {description}.
        slots:
          description: requestBody.description
      - text: Create a SCIM OAuth client that expires in {expires_in_days} days.
        slots:
          expires_in_days: requestBody.expiresInDays
      method: generated
      generated: '2026-10-01'
- target: $.paths['/textql.rpc.public.scim.ScimService/CreateScimToken'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a SCIM bearer token
      effect: write
      questions:
      - What token does my identity provider need to provision users over SCIM?
      - How long can a SCIM token stay valid?
      instructions:
      - text: Generate a SCIM token labeled {description}.
        slots:
          description: requestBody.description
      - text: Issue a SCIM token valid for {expires_in_days} days.
        slots:
          expires_in_days: requestBody.expiresInDays
      method: generated
      generated: '2026-10-01'
- target: $.paths['/textql.rpc.public.scim.ScimService/ListScimOAuthClients'].post
  update:
    x-apievangelist-phrasing:
      intent: List SCIM OAuth clients
      effect: read
      questions:
      - Which SCIM OAuth clients exist for my org?
      - Are there old SCIM OAuth clients I should clean up?
      instructions:
      - text: List our SCIM OAuth clients.
      - text: Show all SCIM OAuth clients with a {timeout_ms} ms timeout.
        slots:
          timeout_ms: header.Connect-Timeout-Ms
      method: generated
      generated: '2026-10-01'
- target: $.paths['/textql.rpc.public.scim.ScimService/ListScimTokens'].post
  update:
    x-apievangelist-phrasing:
      intent: List SCIM tokens
      effect: read
      questions:
      - What SCIM tokens are currently issued?
      - When do our SCIM provisioning tokens expire?
      instructions:
      - text: List our SCIM tokens.
      - text: Show every SCIM bearer token, timing out after {timeout_ms} ms.
        slots:
          timeout_ms: header.Connect-Timeout-Ms
      method: generated
      generated: '2026-10-01'
- target: $.paths['/textql.rpc.public.scim.ScimService/RevokeScimOAuthClient'].post
  update:
    x-apievangelist-phrasing:
      intent: Revoke a SCIM OAuth client
      effect: destructive
      questions:
      - How do I revoke a SCIM OAuth client I no longer use?
      - Does revoking a SCIM OAuth client stop provisioning immediately?
      instructions:
      - text: Revoke SCIM OAuth client {id}.
        slots:
          id: requestBody.id
      - text: Disable the SCIM OAuth client {id} for good.
        slots:
          id: requestBody.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/textql.rpc.public.scim.ScimService/RevokeScimToken'].post
  update:
    x-apievangelist-phrasing:
      intent: Revoke a SCIM token
      effect: destructive
      questions:
      - Can I revoke a leaked SCIM token?
      - What happens to provisioning after a SCIM token is revoked?
      instructions:
      - text: Revoke SCIM token {id}.
        slots:
          id: requestBody.id
      - text: Invalidate the SCIM bearer token {id}.
        slots:
          id: requestBody.id
      method: generated
      generated: '2026-10-01'