API Evangelist conversational phrasing for Elastic Cloud Enterprise Deployments Traffic Filter API

# 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 Deployments Traffic Filter API
  version: 1.0.0
extends: openapi/elk-stack-deploymentstrafficfilter-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: 12
- target: $.paths['/deployments/traffic-filter/associations/{association_type}/{associated_entity_id}/rulesets'].get
  update:
    x-apievangelist-phrasing:
      intent: List rulesets applied to a deployment
      effect: read
      questions:
      - Which traffic filter rulesets are attached to my Elastic Cloud deployment?
      - How can I check what network restrictions currently protect a given deployment?
      instructions:
      - text: Show the traffic filter rulesets associated with {association_type} {associated_entity_id}.
        slots:
          association_type: path.association_type
          associated_entity_id: path.associated_entity_id
      - text: List every ruleset protecting deployment {associated_entity_id} (association type {association_type}).
        slots:
          associated_entity_id: path.associated_entity_id
          association_type: path.association_type
      method: generated
      generated: '2026-09-26'
- target: $.paths['/deployments/traffic-filter/link-ids'].get
  update:
    x-apievangelist-phrasing:
      intent: List claimed private link IDs
      effect: read
      questions:
      - Which private link IDs has my organization claimed for traffic filtering?
      - Can I see claimed link IDs for just one region?
      instructions:
      - text: List the traffic filter link IDs we have claimed.
      - text: Show claimed link IDs in region {region} for organization {organization_id}.
        slots:
          region: query.region
          organization_id: query.organization_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/deployments/traffic-filter/link-ids/_claim'].post
  update:
    x-apievangelist-phrasing:
      intent: Claim a private link ID
      effect: write
      questions:
      - How do I claim ownership of a private link endpoint ID for my organization?
      - Can I claim an Azure Private Link endpoint by its name and GUID?
      instructions:
      - text: Claim link ID {link_id} in region {region}.
        slots:
          link_id: requestBody.link_id
          region: requestBody.region
      - text: Claim the Azure endpoint {azure_endpoint_name} with GUID {azure_endpoint_guid} in {region}.
        slots:
          azure_endpoint_name: requestBody.azure_endpoint_name
          azure_endpoint_guid: requestBody.azure_endpoint_guid
          region: requestBody.region
      method: generated
      generated: '2026-09-26'
- target: $.paths['/deployments/traffic-filter/link-ids/_unclaim'].post
  update:
    x-apievangelist-phrasing:
      intent: Release a claimed private link ID
      effect: destructive
      questions:
      - How do I give up ownership of a link ID I claimed earlier?
      - Can I unclaim an Azure private endpoint so another organization can use it?
      instructions:
      - text: Unclaim link ID {link_id} in region {region}.
        slots:
          link_id: requestBody.link_id
          region: requestBody.region
      - text: Release our claim on Azure endpoint {azure_endpoint_name} ({azure_endpoint_guid}) in {region}.
        slots:
          azure_endpoint_name: requestBody.azure_endpoint_name
          azure_endpoint_guid: requestBody.azure_endpoint_guid
          region: requestBody.region
      method: generated
      generated: '2026-09-26'
- target: $.paths['/deployments/traffic-filter/rulesets'].get
  update:
    x-apievangelist-phrasing:
      intent: List traffic filter rulesets
      effect: read
      questions:
      - What IP and private link traffic filter rulesets do I have in Elastic Cloud?
      - Can I list rulesets for one region along with the deployments they apply to?
      instructions:
      - text: List all my traffic filter rulesets.
      - text: Show traffic filter rulesets in {region}, including their associations ({include_associations}).
        slots:
          region: query.region
          include_associations: query.include_associations
      method: generated
      generated: '2026-09-26'
- target: $.paths['/deployments/traffic-filter/rulesets'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a traffic filter ruleset
      effect: write
      questions:
      - How do I restrict access to my deployments to a set of allowed IP addresses?
      - Can a new ruleset be applied automatically to every new deployment in a region?
      instructions:
      - text: Create a {type} traffic filter ruleset named {name} in {region} with rules {rules}.
        slots:
          type: requestBody.type
          name: requestBody.name
          region: requestBody.region
          rules: requestBody.rules
      - text: 'Create ruleset {name} in {region} allowing {rules}, applied to new deployments by default: {include_by_default}, type {type}.'
        slots:
          name: requestBody.name
          region: requestBody.region
          rules: requestBody.rules
          include_by_default: requestBody.include_by_default
          type: requestBody.type
      method: generated
      generated: '2026-09-26'
- target: $.paths['/deployments/traffic-filter/rulesets/{ruleset_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a traffic filter ruleset
      effect: read
      questions:
      - How do I see the rules inside one traffic filter ruleset?
      - Can I fetch a single ruleset together with the resources it is attached to?
      instructions:
      - text: Show traffic filter ruleset {ruleset_id}.
        slots:
          ruleset_id: path.ruleset_id
      - text: Get ruleset {ruleset_id} and include its associations.
        slots:
          ruleset_id: path.ruleset_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/deployments/traffic-filter/rulesets/{ruleset_id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a traffic filter ruleset
      effect: write
      questions:
      - How do I add a new allowed IP range to an existing ruleset?
      - Can I rename a traffic filter ruleset or change its description?
      instructions:
      - text: Update ruleset {ruleset_id} so its rules are {rules}.
        slots:
          ruleset_id: path.ruleset_id
          rules: requestBody.rules
      - text: Rename ruleset {ruleset_id} to {name} and describe it as {description}.
        slots:
          ruleset_id: path.ruleset_id
          name: requestBody.name
          description: requestBody.description
      method: generated
      generated: '2026-09-26'
- target: $.paths['/deployments/traffic-filter/rulesets/{ruleset_id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a traffic filter ruleset
      effect: destructive
      questions:
      - How do I delete a traffic filter ruleset I no longer need?
      - Can I delete a ruleset that is still attached to deployments?
      instructions:
      - text: Delete traffic filter ruleset {ruleset_id}.
        slots:
          ruleset_id: path.ruleset_id
      - text: Delete ruleset {ruleset_id} even if deployments still use it (ignore_associations={ignore_associations}).
        slots:
          ruleset_id: path.ruleset_id
          ignore_associations: query.ignore_associations
      method: generated
      generated: '2026-09-26'
- target: $.paths['/deployments/traffic-filter/rulesets/{ruleset_id}/associations'].get
  update:
    x-apievangelist-phrasing:
      intent: List deployments using a ruleset
      effect: read
      questions:
      - Which deployments is a particular traffic filter ruleset applied to?
      - Before I change a ruleset, how do I find every deployment it affects?
      instructions:
      - text: List the deployments associated with ruleset {ruleset_id}.
        slots:
          ruleset_id: path.ruleset_id
      - text: Show which deployments ruleset {ruleset_id} is attached to.
        slots:
          ruleset_id: path.ruleset_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/deployments/traffic-filter/rulesets/{ruleset_id}/associations'].post
  update:
    x-apievangelist-phrasing:
      intent: Apply a ruleset to a deployment
      effect: write
      questions:
      - How do I attach a traffic filter ruleset to one of my deployments?
      - Can I apply an existing IP filter ruleset to a deployment without editing the ruleset?
      instructions:
      - text: Apply ruleset {ruleset_id} to {entity_type} {id}.
        slots:
          ruleset_id: path.ruleset_id
          entity_type: requestBody.entity_type
          id: requestBody.id
      - text: Attach traffic filter ruleset {ruleset_id} to deployment {id}.
        slots:
          ruleset_id: path.ruleset_id
          id: requestBody.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/deployments/traffic-filter/rulesets/{ruleset_id}/associations/{association_type}/{associated_entity_id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Detach a ruleset from a deployment
      effect: destructive
      questions:
      - How do I remove a traffic filter ruleset from just one deployment?
      - Can I stop a ruleset applying to a deployment without deleting the ruleset?
      instructions:
      - text: Detach ruleset {ruleset_id} from {association_type} {associated_entity_id}.
        slots:
          ruleset_id: path.ruleset_id
          association_type: path.association_type
          associated_entity_id: path.associated_entity_id
      - text: Remove ruleset {ruleset_id} traffic rules from deployment {associated_entity_id}, type {association_type}.
        slots:
          ruleset_id: path.ruleset_id
          associated_entity_id: path.associated_entity_id
          association_type: path.association_type
      method: generated
      generated: '2026-09-26'