Confluent | the Data Streaming Platform · OpenAPI Overlay 1.0.0

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

6 actions 6 updates phrasing extends openapi/confluent-the-data-streaming-platform-ip-groups-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-groups'].get

$.paths['/iam/v2/ip-groups'].post

$.paths['/iam/v2/ip-groups/{id}'].get

$.paths['/iam/v2/ip-groups/{id}'].delete

$.paths['/iam/v2/ip-groups/{id}'].patch

OpenAPI Overlay

# 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 Groups (iam/v2) API
  version: 1.0.0
extends: openapi/confluent-the-data-streaming-platform-ip-groups-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-groups'].get
  update:
    x-apievangelist-phrasing:
      intent: List IP groups
      effect: read
      questions:
      - Which IP groups have I defined for IP filtering?
      - Can I see all the CIDR block groups in my organization?
      instructions:
      - text: List my IP groups.
      - text: Show every IP group and its CIDR blocks.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/iam/v2/ip-groups'].post
  update:
    x-apievangelist-phrasing:
      intent: Create an IP group
      effect: write
      questions:
      - How do I define a set of allowed CIDR blocks for IP filtering?
      - Can I create an IP group of office network ranges?
      instructions:
      - text: Create IP group {group_name} with CIDR blocks {cidr_blocks}.
        slots:
          group_name: requestBody.group_name
          cidr_blocks: requestBody.cidr_blocks
      - text: Add a new IP group named {group_name}.
        slots:
          group_name: requestBody.group_name
      method: generated
      generated: '2026-09-26'
- target: $.paths['/iam/v2/ip-groups/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an IP group
      effect: read
      questions:
      - Which CIDR ranges are in a specific IP group?
      - Can I read one IP group by id?
      instructions:
      - text: Show IP group {id}.
        slots:
          id: path.id
      - text: List the CIDR blocks in IP group {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/iam/v2/ip-groups/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an IP group
      effect: destructive
      questions:
      - How do I remove an IP group I no longer use?
      - Can I delete an IP group of CIDR ranges?
      instructions:
      - text: Delete IP group {id}.
        slots:
          id: path.id
      - text: Remove IP group {id} from my organization.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/iam/v2/ip-groups/{id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update an IP group
      effect: write
      questions:
      - Can I add or change the CIDR blocks in an existing IP group?
      - Is it possible to rename an IP group?
      instructions:
      - text: Set the CIDR blocks of IP group {id} to {cidr_blocks}.
        slots:
          id: path.id
          cidr_blocks: requestBody.cidr_blocks
      - text: Rename IP group {id} to {group_name}.
        slots:
          id: path.id
          group_name: requestBody.group_name
      method: generated
      generated: '2026-09-26'