Elastic Stack · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Kibana Fleet package policies API

10 actions 10 updates phrasing extends openapi/elk-stack-fleet-package-policies-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 10

$.info
$.paths['/api/fleet/package_policies'].get
$.paths['/api/fleet/package_policies'].post
$.paths['/api/fleet/package_policies/_bulk_get'].post
$.paths['/api/fleet/package_policies/{packagePolicyId}'].get
$.paths['/api/fleet/package_policies/{packagePolicyId}'].put
$.paths['/api/fleet/package_policies/{packagePolicyId}'].delete
$.paths['/api/fleet/package_policies/delete'].post
$.paths['/api/fleet/package_policies/upgrade'].post
$.paths['/api/fleet/package_policies/upgrade/dryrun'].post

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 package policies API
  version: 1.0.0
extends: openapi/elk-stack-fleet-package-policies-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/fleet/package_policies'].get
  update:
    x-apievangelist-phrasing:
      intent: List Fleet package policies
      effect: read
      questions:
      - Which integration package policies are configured in Fleet?
      - Can I list only the package policies that have an upgrade available?
      instructions:
      - text: List my Fleet package policies.
      - text: Show package policies matching KQL {kuery}, with agent counts {withAgentCount}.
        slots:
          kuery: query.kuery
          withAgentCount: query.withAgentCount
      - text: List package policies where upgradeable is {showUpgradeable}.
        slots:
          showUpgradeable: query.showUpgradeable
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/fleet/package_policies'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a package policy on an agent policy
      effect: write
      questions:
      - How do I add an integration to an agent policy in Fleet?
      - Can I create a package policy using the simplified format?
      instructions:
      - text: Create a new package policy and attach it to an agent policy.
      - text: Create a package policy using the {format} request format.
        slots:
          format: query.format
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/fleet/package_policies/_bulk_get'].post
  update:
    x-apievangelist-phrasing:
      intent: Fetch several package policies by ID
      effect: read
      questions:
      - Can I fetch several package policies in one request?
      - Will a bulk lookup fail if one of the package policy IDs is missing?
      instructions:
      - text: Get package policies {ids}.
        slots:
          ids: requestBody.ids
      - text: 'Look up package policies {ids}, ignoring missing ones: {ignoreMissing}.'
        slots:
          ids: requestBody.ids
          ignoreMissing: requestBody.ignoreMissing
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/fleet/package_policies/{packagePolicyId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a package policy
      effect: read
      questions:
      - What inputs and variables does a specific package policy have?
      - Can I retrieve one integration policy by its ID?
      instructions:
      - text: Get package policy {packagePolicyId}.
        slots:
          packagePolicyId: path.packagePolicyId
      - text: Show package policy {packagePolicyId} in the {format} format.
        slots:
          packagePolicyId: path.packagePolicyId
          format: query.format
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/fleet/package_policies/{packagePolicyId}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a package policy
      effect: write
      questions:
      - How do I change the settings of an integration already on an agent policy?
      - Can I edit one package policy's inputs in place?
      instructions:
      - text: Update package policy {packagePolicyId}.
        slots:
          packagePolicyId: path.packagePolicyId
      - text: Save new settings to package policy {packagePolicyId} using the {format} format.
        slots:
          packagePolicyId: path.packagePolicyId
          format: query.format
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/fleet/package_policies/{packagePolicyId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a package policy
      effect: destructive
      questions:
      - How do I remove one integration from an agent policy?
      - Can I force-delete a managed package policy?
      instructions:
      - text: Delete package policy {packagePolicyId}.
        slots:
          packagePolicyId: path.packagePolicyId
      - text: Force delete package policy {packagePolicyId} with force {force}.
        slots:
          packagePolicyId: path.packagePolicyId
          force: query.force
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/fleet/package_policies/delete'].post
  update:
    x-apievangelist-phrasing:
      intent: Delete several package policies
      effect: destructive
      questions:
      - Can I remove many integrations from agent policies in one call?
      - What bulk deletes package policies by a list of IDs?
      instructions:
      - text: Bulk delete package policies {packagePolicyIds}.
        slots:
          packagePolicyIds: requestBody.packagePolicyIds
      - text: 'Remove all of these package policies, force {force}: {packagePolicyIds}.'
        slots:
          force: requestBody.force
          packagePolicyIds: requestBody.packagePolicyIds
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/fleet/package_policies/upgrade'].post
  update:
    x-apievangelist-phrasing:
      intent: Upgrade package policies to a newer version
      effect: write
      questions:
      - How do I move integrations onto the latest package version?
      - Can I upgrade several package policies at once?
      instructions:
      - text: Upgrade package policies {packagePolicyIds} to the newer package version.
        slots:
          packagePolicyIds: requestBody.packagePolicyIds
      - text: Apply the available integration upgrade to {packagePolicyIds}.
        slots:
          packagePolicyIds: requestBody.packagePolicyIds
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/fleet/package_policies/upgrade/dryrun'].post
  update:
    x-apievangelist-phrasing:
      intent: Preview a package policy upgrade
      effect: read
      questions:
      - What would change if I upgraded an integration's package version?
      - Can I preview a package policy upgrade to a specific version first?
      instructions:
      - text: Dry run the upgrade of package policies {packagePolicyIds}.
        slots:
          packagePolicyIds: requestBody.packagePolicyIds
      - text: Preview upgrading {packagePolicyIds} to package version {packageVersion}.
        slots:
          packagePolicyIds: requestBody.packagePolicyIds
          packageVersion: requestBody.packageVersion
      method: generated
      generated: '2026-09-26'