# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Clerk Platform Config API
  version: 1.0.0
extends: openapi/clerk-com-config-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: 4
- target: $.paths['/platform/applications/{applicationID}/instances/{envOrInsID}/config'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an instance's configuration
      effect: read
      questions:
      - How do I read the current settings of my production instance?
      - Can I fetch only specific configuration keys for an instance?
      instructions:
      - text: Get the config of application {applicationID} in environment {envOrInsID}.
        slots:
          applicationID: path.applicationID
          envOrInsID: path.envOrInsID
      - text: Show config keys {keys} for instance {envOrInsID} of app {applicationID}.
        slots:
          keys: query.keys
          envOrInsID: path.envOrInsID
          applicationID: path.applicationID
      method: generated
      generated: '2026-09-26'
- target: $.paths['/platform/applications/{applicationID}/instances/{envOrInsID}/config'].put
  update:
    x-apievangelist-phrasing:
      intent: Replace an instance's full configuration
      effect: destructive
      questions:
      - How do I overwrite an instance's entire configuration in one request?
      - What happens if I leave keys out when replacing the full config?
      instructions:
      - text: Replace the whole config of application {applicationID} instance {envOrInsID}.
        slots:
          applicationID: path.applicationID
          envOrInsID: path.envOrInsID
      - text: Dry-run a full config replacement on instance {envOrInsID} of app {applicationID} with dry_run {dry_run}.
        slots:
          envOrInsID: path.envOrInsID
          applicationID: path.applicationID
          dry_run: query.dry_run
      method: generated
      generated: '2026-09-26'
- target: $.paths['/platform/applications/{applicationID}/instances/{envOrInsID}/config'].patch
  update:
    x-apievangelist-phrasing:
      intent: Partially update an instance's configuration
      effect: write
      questions:
      - How do I change just a few settings on an instance without resending everything?
      - Can I preview a config change before applying it?
      instructions:
      - text: Patch the config of application {applicationID} instance {envOrInsID}.
        slots:
          applicationID: path.applicationID
          envOrInsID: path.envOrInsID
      - text: Preview a partial config update on {envOrInsID} of app {applicationID} with dry_run {dry_run}.
        slots:
          envOrInsID: path.envOrInsID
          applicationID: path.applicationID
          dry_run: query.dry_run
      method: generated
      generated: '2026-09-26'
- target: $.paths['/platform/applications/{applicationID}/instances/{envOrInsID}/config/schema'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the instance config JSON Schema
      effect: read
      questions:
      - Where can I get the JSON Schema that describes instance configuration?
      - Which fields and types does the instance config accept?
      instructions:
      - text: Get the config schema for application {applicationID} instance {envOrInsID}.
        slots:
          applicationID: path.applicationID
          envOrInsID: path.envOrInsID
      - text: Show the JSON Schema for config keys {keys} on {envOrInsID} of app {applicationID}.
        slots:
          keys: query.keys
          envOrInsID: path.envOrInsID
          applicationID: path.applicationID
      method: generated
      generated: '2026-09-26'