Confluent | the Data Streaming Platform · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Confluent Cloud Role Bindings (iam/v2) API

5 actions 5 updates phrasing extends openapi/confluent-the-data-streaming-platform-role-bindings-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 5

$.info

$.paths['/iam/v2/role-bindings'].get

$.paths['/iam/v2/role-bindings'].post

$.paths['/iam/v2/role-bindings/{id}'].get

$.paths['/iam/v2/role-bindings/{id}'].delete

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 Role Bindings (iam/v2) API
  version: 1.0.0
extends: openapi/confluent-the-data-streaming-platform-role-bindings-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: 4
- target: $.paths['/iam/v2/role-bindings'].get
  update:
    x-apievangelist-phrasing:
      intent: List role bindings
      effect: read
      questions:
      - Who has which roles on a given resource?
      - Can I list role bindings for one principal or role name?
      instructions:
      - text: List role bindings matching CRN pattern {crn}.
        slots:
          crn: query.crn_pattern
      - text: Show {role} bindings for principal {principal} under {crn}.
        slots:
          role: query.role_name
          principal: query.principal
          crn: query.crn_pattern
      method: generated
      generated: '2026-09-26'
- target: $.paths['/iam/v2/role-bindings'].post
  update:
    x-apievangelist-phrasing:
      intent: Grant a role to a principal
      effect: write
      questions:
      - How do I give a user or service account a role on a cluster?
      - Can I bind a role to a specific resource pattern?
      instructions:
      - text: Grant role {role} to {principal} on {crn}.
        slots:
          role: requestBody.role_name
          principal: requestBody.principal
          crn: requestBody.crn_pattern
      - text: Bind {principal} to {role}.
        slots:
          principal: requestBody.principal
          role: requestBody.role_name
      method: generated
      generated: '2026-09-26'
- target: $.paths['/iam/v2/role-bindings/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Read a role binding
      effect: read
      questions:
      - What role and resource does a specific role binding cover?
      - Can I look up a role binding by ID?
      instructions:
      - text: Get role binding {id}.
        slots:
          id: path.id
      - text: Show who binding {id} applies to.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/iam/v2/role-bindings/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Revoke a role binding
      effect: destructive
      questions:
      - How do I take away a role from a user?
      - Does deleting a role binding remove access immediately?
      instructions:
      - text: Delete role binding {id}.
        slots:
          id: path.id
      - text: Revoke the access granted by binding {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'