# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Kibana Connectors API
  version: 1.0.0
extends: openapi/elk-stack-connectors-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/actions/connector_types'].get
  update:
    x-apievangelist-phrasing:
      intent: List available connector types
      effect: read
      questions:
      - What kinds of connectors can I set up in Kibana?
      - Which connector types support cases or alerting?
      instructions:
      - text: List all available connector types.
      - text: Show connector types that support feature {feature_id}.
        slots:
          feature_id: query.feature_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/actions/connector/_oauth_callback'].get
  update:
    x-apievangelist-phrasing:
      intent: Complete a connector's OAuth callback
      effect: write
      questions:
      - How does a connector exchange the OAuth authorization code for tokens?
      - What does the connector OAuth callback do when the provider returns an error?
      instructions:
      - text: Complete the connector OAuth callback with code {code} and state {state}.
        slots:
          code: query.code
          state: query.state
      - text: Handle the connector OAuth failure {error} described as {error_description}.
        slots:
          error: query.error
          error_description: query.error_description
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/actions/connector/{connectorId}/oauth/start'].get
  update:
    x-apievangelist-phrasing:
      intent: Start OAuth authorization for a connector
      effect: read
      questions:
      - How do I kick off the OAuth sign-in for a connector?
      - Where does a connector send me to authorize with the identity provider?
      instructions:
      - text: Start OAuth authorization for connector {connectorId}.
        slots:
          connectorId: path.connectorId
      - text: Redirect me to the identity provider to authorize connector {connectorId}.
        slots:
          connectorId: path.connectorId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/actions/connector/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a connector's details
      effect: read
      questions:
      - How do I look up the configuration of one connector?
      - Can I see what type a specific connector is?
      instructions:
      - text: Get connector {id}.
        slots:
          id: path.id
      - text: Show the details of connector {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/actions/connector/{id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a connector
      effect: write
      questions:
      - How do I rename or reconfigure an existing connector?
      - Can I update a connector's secrets without recreating it?
      instructions:
      - text: Rename connector {id} to {name}.
        slots:
          id: path.id
          name: requestBody.name
      - text: Update connector {id} named {name} with config {config}.
        slots:
          id: path.id
          name: requestBody.name
          config: requestBody.config
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/actions/connector/{id}'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a connector with a chosen ID
      effect: write
      questions:
      - How do I create a new connector in Kibana with my own ID?
      - What fields are required to set up a new connector, such as its type and name?
      instructions:
      - text: Create a {connector_type_id} connector {id} named {name}.
        slots:
          connector_type_id: requestBody.connector_type_id
          id: path.id
          name: requestBody.name
      - text: Set up new connector {id} of type {connector_type_id} called {name} with config {config}.
        slots:
          id: path.id
          connector_type_id: requestBody.connector_type_id
          name: requestBody.name
          config: requestBody.config
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/actions/connector/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a connector
      effect: destructive
      questions:
      - How do I delete a connector I no longer use?
      - Can a deleted connector be recovered?
      instructions:
      - text: Delete connector {id}.
        slots:
          id: path.id
      - text: Permanently remove connector {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/actions/connector/{id}/_execute'].post
  update:
    x-apievangelist-phrasing:
      intent: Run a connector
      effect: write
      questions:
      - How do I test a connector by running it?
      - Can I trigger a connector action on demand with custom parameters?
      instructions:
      - text: Run connector {id} with params {params}.
        slots:
          id: path.id
          params: requestBody.params
      - text: Execute connector {id} as a test using {params}.
        slots:
          id: path.id
          params: requestBody.params
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/actions/connectors'].get
  update:
    x-apievangelist-phrasing:
      intent: List all connectors
      effect: read
      questions:
      - What connectors are configured in my Kibana space?
      - Can I see every connector at once?
      instructions:
      - text: List all my connectors.
      - text: Show every connector set up in this space.
      method: generated
      generated: '2026-09-26'