# 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 internals API
  version: 1.0.0
extends: openapi/elk-stack-fleet-internals-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: 7
- target: $.paths['/api/fleet/check-permissions'].get
  update:
    x-apievangelist-phrasing:
      intent: Check the current user's Fleet permissions
      effect: read
      questions:
      - Do I have the privileges needed to use Fleet?
      - Can I also verify I'm allowed to set up a Fleet Server?
      instructions:
      - text: Check whether I have permission to use Fleet.
      - text: Verify my Fleet permissions with Fleet Server setup check set to {fleetServerSetup}.
        slots:
          fleetServerSetup: query.fleetServerSetup
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/fleet/health_check'].post
  update:
    x-apievangelist-phrasing:
      intent: Check a Fleet Server's health
      effect: read
      questions:
      - Is my Fleet Server instance healthy and reachable?
      - How do I get the status of a Fleet Server by its host ID?
      instructions:
      - text: Check the health of Fleet Server host {id}.
        slots:
          id: requestBody.id
      - text: Report status and name for the Fleet Server with host ID {id}.
        slots:
          id: requestBody.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/fleet/settings'].get
  update:
    x-apievangelist-phrasing:
      intent: Get global Fleet settings
      effect: read
      questions:
      - What are the current global Fleet settings?
      - Are prerelease integrations turned on in Fleet?
      instructions:
      - text: Show the global Fleet settings.
      - text: Get Fleet's cluster-wide configuration.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/fleet/settings'].put
  update:
    x-apievangelist-phrasing:
      intent: Update global Fleet settings
      effect: write
      questions:
      - How do I allow prerelease integrations in Fleet?
      - Can Fleet automatically delete agents after they unenroll?
      instructions:
      - text: Set Fleet prerelease integrations enabled to {prerelease_integrations_enabled}.
        slots:
          prerelease_integrations_enabled: requestBody.prerelease_integrations_enabled
      - text: Turn delete_unenrolled_agents to {delete_unenrolled_agents} in global Fleet settings.
        slots:
          delete_unenrolled_agents: requestBody.delete_unenrolled_agents
      - text: Update the Kibana URLs Fleet uses to {kibana_urls}.
        slots:
          kibana_urls: requestBody.kibana_urls
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/fleet/setup'].post
  update:
    x-apievangelist-phrasing:
      intent: Initialize Fleet
      effect: write
      questions:
      - How do I set up Fleet and create the Elasticsearch resources it needs?
      - Is it safe to run Fleet setup more than once?
      instructions:
      - text: Initialize Fleet, sending kbn-xsrf header {kbn_xsrf}.
        slots:
          kbn_xsrf: header.kbn-xsrf
      - text: Run Fleet setup to create its required resources.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/fleet/space_settings'].get
  update:
    x-apievangelist-phrasing:
      intent: Get Fleet settings for the current space
      effect: read
      questions:
      - What Fleet settings apply to this particular Kibana space?
      - Which namespace prefixes are allowed in the current space?
      instructions:
      - text: Show Fleet settings for the current space.
      - text: Get the allowed namespace prefixes for this space's Fleet config.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/fleet/space_settings'].put
  update:
    x-apievangelist-phrasing:
      intent: Set Fleet settings for the current space
      effect: write
      questions:
      - How do I restrict which namespace prefixes a Kibana space can use in Fleet?
      - Can each space have its own Fleet namespace rules?
      instructions:
      - text: Restrict this space's Fleet namespaces to prefixes {allowed_namespace_prefixes}.
        slots:
          allowed_namespace_prefixes: requestBody.allowed_namespace_prefixes
      - text: Save space-level Fleet settings with allowed prefixes {allowed_namespace_prefixes}.
        slots:
          allowed_namespace_prefixes: requestBody.allowed_namespace_prefixes
      method: generated
      generated: '2026-09-26'