# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Admin API V1 Integration Connections API
  version: 1.0.0
extends: openapi/optimizely-integration-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: 9
- target: $.paths['/api/v1/admin/IntegrationConnections'].get
  update:
    x-apievangelist-phrasing:
      intent: List integration connections
      effect: read
      questions:
      - Which integration connections are set up for my commerce integration jobs?
      - Can I filter integration connections by type or data source?
      - How many integration connections exist in total?
      instructions:
      - text: List all integration connections.
      - text: List integration connections matching {filter}.
        slots:
          filter: query.$filter
      - text: Count the integration connections, including {count} in the response.
        slots:
          count: query.$count
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/IntegrationConnections'].post
  update:
    x-apievangelist-phrasing:
      intent: Create an integration connection
      effect: write
      questions:
      - How do I register a new connection that integration jobs can pull data through?
      - What details does a new integration connection need, like URL, logon and connection string?
      instructions:
      - text: Create an integration connection named {name} of type {typeName} pointing at {url}.
        slots:
          name: requestBody.name
          typeName: requestBody.typeName
          url: requestBody.url
      - text: Add a new integration connection {name} using connection string {connectionString}.
        slots:
          name: requestBody.name
          connectionString: requestBody.connectionString
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/IntegrationConnections({id})'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one integration connection
      effect: read
      questions:
      - What settings does a particular integration connection use?
      - Can I look up one integration connection by its ID?
      instructions:
      - text: Get integration connection {id}.
        slots:
          id: path.id
      - text: Show integration connection {id} with only fields {select}.
        slots:
          id: path.id
          select: query.$select
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/IntegrationConnections({id})'].put
  update:
    x-apievangelist-phrasing:
      intent: Replace an integration connection
      effect: write
      questions:
      - Is there a way to overwrite every setting of an integration connection at once?
      - What call fully replaces an existing integration connection definition?
      instructions:
      - text: Replace integration connection {id} with name {name}, type {typeName} and URL {url}.
        slots:
          id: path.id
          name: requestBody.name
          typeName: requestBody.typeName
          url: requestBody.url
      - text: Overwrite the full definition of integration connection {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/IntegrationConnections({id})'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an integration connection
      effect: destructive
      questions:
      - How do I remove an integration connection that is no longer used?
      - Can I delete one integration connection by ID with an If-Match check?
      instructions:
      - text: Delete integration connection {id}.
        slots:
          id: path.id
      - text: Remove integration connection {id} only if its ETag is {ifMatch}.
        slots:
          id: path.id
          ifMatch: header.If-Match
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/IntegrationConnections({id})'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update settings of an integration connection
      effect: write
      questions:
      - Can I change just the password on an existing integration connection?
      - How do I turn on debugging for an integration connection that's already configured?
      instructions:
      - text: Update the password on integration connection {id} to {password}.
        slots:
          id: path.id
          password: requestBody.password
      - text: Set debugging on integration connection {id} to {debuggingEnabled}.
        slots:
          id: path.id
          debuggingEnabled: requestBody.debuggingEnabled
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/IntegrationConnections/Default.Default()'].get
  update:
    x-apievangelist-phrasing:
      intent: Call the Default function on integration connections
      effect: read
      questions:
      - What does the Default function on the integration connections entity set return?
      - Is there a Default operation for integration connections?
      instructions:
      - text: Call the Default function on integration connections.
      - text: Run the integration connections Default operation and show the result.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/integrationconnections/delete'].delete
  update:
    x-apievangelist-phrasing:
      intent: Bulk delete integration connections by ID
      effect: destructive
      questions:
      - Can I delete several integration connections in a single request?
      - How do I clean up a batch of unused integration connections by ID?
      instructions:
      - text: Delete the integration connections with IDs {ids}.
        slots:
          ids: query.ids
      - text: Bulk remove integration connections {ids} together.
        slots:
          ids: query.ids
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/integrationconnections({key})/customproperties({custompropertyKey})'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a custom property of an integration connection
      effect: read
      questions:
      - How can I read a custom property stored on an integration connection?
      - Do integration connections carry custom properties I can fetch by key?
      instructions:
      - text: Get custom property {custompropertyKey} of integration connection {key}.
        slots:
          custompropertyKey: path.custompropertyKey
          key: path.key
      - text: Show the value of custom property {custompropertyKey} on integration connection {key}.
        slots:
          custompropertyKey: path.custompropertyKey
          key: path.key
      method: generated
      generated: '2026-09-26'