# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Elastic Cloud Enterprise Extensions API
  version: 1.0.0
extends: openapi/elk-stack-extensions-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['/deployments/extensions'].get
  update:
    x-apievangelist-phrasing:
      intent: List available deployment extensions
      effect: read
      questions:
      - Which plugins and bundles have been registered as extensions for my deployments?
      - What extensions are available to add to an Elastic Cloud deployment?
      instructions:
      - text: List all the deployment extensions available to me.
      - text: Show every registered plugin and bundle extension.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/deployments/extensions'].post
  update:
    x-apievangelist-phrasing:
      intent: Register a new deployment extension
      effect: write
      questions:
      - How do I register a custom plugin or bundle for my Elasticsearch deployments?
      - Can I point a new extension at a download URL instead of uploading a file?
      instructions:
      - text: Create a {extension_type} extension named {name} for Elasticsearch version {version}.
        slots:
          extension_type: requestBody.extension_type
          name: requestBody.name
          version: requestBody.version
      - text: Register extension {name} ({extension_type}, version {version}) downloaded from {download_url}.
        slots:
          name: requestBody.name
          extension_type: requestBody.extension_type
          version: requestBody.version
          download_url: requestBody.download_url
      method: generated
      generated: '2026-09-26'
- target: $.paths['/deployments/extensions/{extension_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a deployment extension
      effect: read
      questions:
      - How do I see the details of one extension I registered?
      - Can I find out which deployments are using a particular extension?
      instructions:
      - text: Get extension {extension_id}.
        slots:
          extension_id: path.extension_id
      - text: Show extension {extension_id} and, with include_deployments set to {include_deployments}, the deployments using it.
        slots:
          extension_id: path.extension_id
          include_deployments: query.include_deployments
      method: generated
      generated: '2026-09-26'
- target: $.paths['/deployments/extensions/{extension_id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Upload the archive for an extension
      effect: write
      questions:
      - How do I upload the zip file for an extension I already created?
      - What file format does an extension archive upload expect?
      instructions:
      - text: Upload the zip {file} as the archive for extension {extension_id}.
        slots:
          file: requestBody.file
          extension_id: path.extension_id
      - text: Attach archive {file} to extension {extension_id}.
        slots:
          file: requestBody.file
          extension_id: path.extension_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/deployments/extensions/{extension_id}'].post
  update:
    x-apievangelist-phrasing:
      intent: Update an extension's details
      effect: write
      questions:
      - Can I change the name, description or download URL of an existing extension?
      - How do I bump the Elasticsearch version an extension targets?
      instructions:
      - text: Update extension {extension_id} to name {name}, type {extension_type}, version {version}.
        slots:
          extension_id: path.extension_id
          name: requestBody.name
          extension_type: requestBody.extension_type
          version: requestBody.version
      - text: Change the download URL of extension {extension_id} to {download_url}, keeping name {name}, type {extension_type} and version {version}.
        slots:
          extension_id: path.extension_id
          download_url: requestBody.download_url
          name: requestBody.name
          extension_type: requestBody.extension_type
          version: requestBody.version
      method: generated
      generated: '2026-09-26'
- target: $.paths['/deployments/extensions/{extension_id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a deployment extension
      effect: destructive
      questions:
      - How do I remove an extension I no longer need?
      - Can I delete a custom plugin extension from Elastic Cloud?
      instructions:
      - text: Delete extension {extension_id}.
        slots:
          extension_id: path.extension_id
      - text: Remove the custom extension {extension_id} permanently.
        slots:
          extension_id: path.extension_id
      method: generated
      generated: '2026-09-26'