# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Drata Custom Connections API
  version: 1.0.0
extends: openapi/drata-custom-connections-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['/custom-connections'].get
  update:
    x-apievangelist-phrasing:
      intent: List custom connections
      effect: read
      questions:
      - Which custom connections have we set up?
      - Can I page through all custom connections in the account?
      instructions:
      - text: List custom connections.
      - text: Show custom connections, {size} per page.
        slots:
          size: query.size
      method: generated
      generated: '2026-09-26'
- target: $.paths['/custom-connections'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a custom connection
      effect: write
      questions:
      - How do I create a custom connection for my own data source?
      - What does a CUSTOM connection require that MDM and HRIS ones don't?
      instructions:
      - text: Create custom connection {name} with provider types {providerTypes}.
        slots:
          name: requestBody.name
          providerTypes: requestBody.providerTypes
      - text: Create connection {name} of type {providerTypes} for workspaces {workspaceIds}, display key {displayNameKey}, schema {schema}.
        slots:
          name: requestBody.name
          providerTypes: requestBody.providerTypes
          workspaceIds: requestBody.workspaceIds
          displayNameKey: requestBody.displayNameKey
          schema: requestBody.schema
      method: generated
      generated: '2026-09-26'
- target: $.paths['/custom-connections/{connectionId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a custom connection
      effect: read
      questions:
      - What are the settings of one custom connection?
      - Can I view a single custom connection by its ID?
      instructions:
      - text: Get custom connection {connectionId}.
        slots:
          connectionId: path.connectionId
      - text: Show custom connection {connectionId} with {expand} expanded.
        slots:
          connectionId: path.connectionId
          expand: query.expand[]
      method: generated
      generated: '2026-09-26'
- target: $.paths['/custom-connections/{connectionId}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a custom connection
      effect: write
      questions:
      - How do I rename a custom connection's alias?
      - Can I change the description of a custom connection?
      instructions:
      - text: Set the alias of custom connection {connectionId} to {clientAlias}.
        slots:
          connectionId: path.connectionId
          clientAlias: requestBody.clientAlias
      - text: Update the description of custom connection {connectionId} to {description}.
        slots:
          connectionId: path.connectionId
          description: requestBody.description
      method: generated
      generated: '2026-09-26'
- target: $.paths['/custom-connections/{connectionId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a custom connection
      effect: destructive
      questions:
      - Is there a way to delete a custom connection we stopped using?
      - Can I remove a custom connection entirely?
      instructions:
      - text: Delete custom connection {connectionId}.
        slots:
          connectionId: path.connectionId
      - text: Remove the custom connection {connectionId} from the account.
        slots:
          connectionId: path.connectionId
      method: generated
      generated: '2026-09-26'