Confluent | the Data Streaming Platform · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Confluent Cloud IP Filters (iam/v2) API

6 actions 6 updates phrasing extends openapi/confluent-the-data-streaming-platform-ip-filters-iam-v2-api-openapi.yml
Generated by API Evangelist Written by API Evangelist tooling for Confluent | the Data Streaming Platform's API. It is a proposal applied on top of the contract, not a document Confluent | the Data Streaming Platform publishes.
View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 6

$.info
$.paths['/iam/v2/ip-filters'].get
$.paths['/iam/v2/ip-filters'].post
$.paths['/iam/v2/ip-filters/{id}'].get
$.paths['/iam/v2/ip-filters/{id}'].delete
$.paths['/iam/v2/ip-filters/{id}'].patch

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 Confluent Cloud IP Filters (iam/v2) API
  version: 1.0.0
extends: openapi/confluent-the-data-streaming-platform-ip-filters-iam-v2-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['/iam/v2/ip-filters'].get
  update:
    x-apievangelist-phrasing:
      intent: List IP filters
      effect: read
      questions:
      - Which IP filters restrict access to my Confluent Cloud organization?
      - Can I include filters inherited from parent scopes when listing?
      instructions:
      - text: List all IP filters.
      - text: List IP filters for scope {scope} including parent scopes.
        slots:
          scope: query.resource_scope
      method: generated
      generated: '2026-09-26'
- target: $.paths['/iam/v2/ip-filters'].post
  update:
    x-apievangelist-phrasing:
      intent: Create an IP filter
      effect: write
      questions:
      - How do I allow access only from certain IP ranges?
      - Can I apply an IP filter to specific operation groups only?
      instructions:
      - text: Create IP filter {name} allowing IP groups {ip_groups}.
        slots:
          name: requestBody.filter_name
          ip_groups: requestBody.ip_groups
      - text: Add IP filter {name} for operation groups {operation_groups} on scope {scope}.
        slots:
          name: requestBody.filter_name
          operation_groups: requestBody.operation_groups
          scope: requestBody.resource_scope
      method: generated
      generated: '2026-09-26'
- target: $.paths['/iam/v2/ip-filters/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Read an IP filter
      effect: read
      questions:
      - Which IP groups does a given IP filter allow?
      - Can I look up an IP filter by its ID?
      instructions:
      - text: Get IP filter {id}.
        slots:
          id: path.id
      - text: Show the IP groups on filter {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/iam/v2/ip-filters/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an IP filter
      effect: destructive
      questions:
      - Can I remove an IP filter to reopen access?
      - Is deleting an IP filter immediate?
      instructions:
      - text: Delete IP filter {id}.
        slots:
          id: path.id
      - text: Remove the network restriction {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/iam/v2/ip-filters/{id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update an IP filter
      effect: write
      questions:
      - Can I add another IP group to an existing filter?
      - How do I rename an IP filter?
      instructions:
      - text: Update IP filter {id} to allow IP groups {ip_groups}.
        slots:
          id: path.id
          ip_groups: requestBody.ip_groups
      - text: Rename filter {id} to {name}.
        slots:
          id: path.id
          name: requestBody.filter_name
      method: generated
      generated: '2026-09-26'