Elastic Stack · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Kibana Elastic Agent binary download sources API

6 actions 6 updates phrasing extends openapi/elk-stack-elastic-agent-binary-download-sources-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 6

$.info
$.paths['/api/fleet/agent_download_sources'].get
$.paths['/api/fleet/agent_download_sources'].post
$.paths['/api/fleet/agent_download_sources/{sourceId}'].get
$.paths['/api/fleet/agent_download_sources/{sourceId}'].put
$.paths['/api/fleet/agent_download_sources/{sourceId}'].delete

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 Elastic Agent binary download sources API
  version: 1.0.0
extends: openapi/elk-stack-elastic-agent-binary-download-sources-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['/api/fleet/agent_download_sources'].get
  update:
    x-apievangelist-phrasing:
      intent: List Elastic Agent binary download sources
      effect: read
      questions:
      - Where does Fleet download Elastic Agent binaries from?
      - Which agent download sources are configured, and which one is the default?
      instructions:
      - text: List all agent binary download sources.
      - text: Show every Fleet download source for agent upgrades.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/fleet/agent_download_sources'].post
  update:
    x-apievangelist-phrasing:
      intent: Add an agent binary download source
      effect: write
      questions:
      - Can I point Fleet at our own mirror for agent binaries in an air-gapped network?
      - Can a new download source go through a proxy or use SSL settings?
      instructions:
      - text: Create a download source named {name} at host {host}.
        slots:
          name: requestBody.name
          host: requestBody.host
      - text: Add agent binary source {name} using {host} through proxy {proxy_id} and make it the default.
        slots:
          name: requestBody.name
          host: requestBody.host
          proxy_id: requestBody.proxy_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/fleet/agent_download_sources/{sourceId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one agent binary download source
      effect: read
      questions:
      - What host and proxy does a particular download source use?
      - Can I look up a single agent download source by its ID?
      instructions:
      - text: Get agent download source {sourceId}.
        slots:
          sourceId: path.sourceId
      - text: Show the host and SSL settings of download source {sourceId}.
        slots:
          sourceId: path.sourceId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/fleet/agent_download_sources/{sourceId}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update an agent binary download source
      effect: write
      questions:
      - Can I change the host URL of an existing download source?
      - Is it possible to make an existing download source the default one?
      instructions:
      - text: Update download source {sourceId} to name {name} and host {host}.
        slots:
          sourceId: path.sourceId
          name: requestBody.name
          host: requestBody.host
      - text: Switch existing source {sourceId} ({name}) to host {host} behind proxy {proxy_id}.
        slots:
          sourceId: path.sourceId
          name: requestBody.name
          host: requestBody.host
          proxy_id: requestBody.proxy_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/fleet/agent_download_sources/{sourceId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an agent binary download source
      effect: destructive
      questions:
      - How do I remove a download source we no longer use?
      - Can I delete an agent binary mirror from Fleet?
      instructions:
      - text: Delete agent download source {sourceId}.
        slots:
          sourceId: path.sourceId
      - text: Remove the binary mirror {sourceId} from Fleet.
        slots:
          sourceId: path.sourceId
      method: generated
      generated: '2026-09-26'