Elastic Stack · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Kibana Fleet cloud connectors API

7 actions 7 updates phrasing extends openapi/elk-stack-fleet-cloud-connectors-api-openapi.yml
Generated by API Evangelist Written by API Evangelist tooling for Elastic Stack's API. It is a proposal applied on top of the contract, not a document Elastic Stack publishes.
View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 7

$.info
$.paths['/api/fleet/cloud_connectors'].get
$.paths['/api/fleet/cloud_connectors'].post
$.paths['/api/fleet/cloud_connectors/{cloudConnectorId}'].get
$.paths['/api/fleet/cloud_connectors/{cloudConnectorId}'].put
$.paths['/api/fleet/cloud_connectors/{cloudConnectorId}'].delete
$.paths['/api/fleet/cloud_connectors/{cloudConnectorId}/usage'].get

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 Kibana Fleet cloud connectors API
  version: 1.0.0
extends: openapi/elk-stack-fleet-cloud-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: 6
- target: $.paths['/api/fleet/cloud_connectors'].get
  update:
    x-apievangelist-phrasing:
      intent: List Fleet cloud connectors
      effect: read
      questions:
      - Which cloud connectors are set up in Fleet?
      - Can I filter my Fleet cloud connectors with a KQL query?
      instructions:
      - text: List all Fleet cloud connectors.
      - text: Find cloud connectors matching {kuery}.
        slots:
          kuery: query.kuery
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/fleet/cloud_connectors'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a Fleet cloud connector
      effect: write
      questions:
      - How do I connect Fleet to my AWS or Azure account with a cloud connector?
      - What do I need to supply to create a new cloud connector in Fleet?
      instructions:
      - text: Create a cloud connector named {name} for {cloudProvider} with credentials {vars}.
        slots:
          name: requestBody.name
          cloudProvider: requestBody.cloudProvider
          vars: requestBody.vars
      - text: Set up a new {cloudProvider} cloud connector called {name} for a {accountType} account using {vars}.
        slots:
          cloudProvider: requestBody.cloudProvider
          name: requestBody.name
          accountType: requestBody.accountType
          vars: requestBody.vars
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/fleet/cloud_connectors/{cloudConnectorId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a Fleet cloud connector
      effect: read
      questions:
      - How do I look up the configuration of one cloud connector?
      - Can I see which cloud provider a specific connector points at?
      instructions:
      - text: Show cloud connector {cloudConnectorId}.
        slots:
          cloudConnectorId: path.cloudConnectorId
      - text: Get the details of Fleet cloud connector {cloudConnectorId}.
        slots:
          cloudConnectorId: path.cloudConnectorId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/fleet/cloud_connectors/{cloudConnectorId}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a Fleet cloud connector
      effect: write
      questions:
      - How do I rename an existing cloud connector?
      - Can I rotate the credentials stored on a cloud connector?
      instructions:
      - text: Rename cloud connector {cloudConnectorId} to {name}.
        slots:
          cloudConnectorId: path.cloudConnectorId
          name: requestBody.name
      - text: Update the variables on cloud connector {cloudConnectorId} to {vars}.
        slots:
          cloudConnectorId: path.cloudConnectorId
          vars: requestBody.vars
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/fleet/cloud_connectors/{cloudConnectorId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a Fleet cloud connector
      effect: destructive
      questions:
      - How do I remove a cloud connector I no longer use?
      - Can I force-delete a cloud connector that package policies still rely on?
      instructions:
      - text: Delete cloud connector {cloudConnectorId}.
        slots:
          cloudConnectorId: path.cloudConnectorId
      - text: Force-delete cloud connector {cloudConnectorId} even though policies still use it (force={force}).
        slots:
          cloudConnectorId: path.cloudConnectorId
          force: query.force
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/fleet/cloud_connectors/{cloudConnectorId}/usage'].get
  update:
    x-apievangelist-phrasing:
      intent: See which policies use a cloud connector
      effect: read
      questions:
      - Which package policies depend on a given cloud connector?
      - Is a cloud connector still in use before I delete it?
      instructions:
      - text: List the package policies using cloud connector {cloudConnectorId}.
        slots:
          cloudConnectorId: path.cloudConnectorId
      - text: Show page {page} of integrations that rely on connector {cloudConnectorId}.
        slots:
          page: query.page
          cloudConnectorId: path.cloudConnectorId
      method: generated
      generated: '2026-09-26'