Confluent · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Confluent Cloud Entitlements (partner/v2) API

4 actions 4 updates phrasing extends openapi/confluent-entitlements-partner-v2-api-openapi.yml
Generated by API Evangelist Written by API Evangelist tooling for Confluent's API. It is a proposal applied on top of the contract, not a document Confluent publishes.
View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 4

$.info
$.paths['/partner/v2/entitlements'].get
$.paths['/partner/v2/entitlements'].post
$.paths['/partner/v2/entitlements/{id}'].get

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 Entitlements (partner/v2) API
  version: 1.0.0
extends: openapi/confluent-entitlements-partner-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: 3
- target: $.paths['/partner/v2/entitlements'].get
  update:
    x-apievangelist-phrasing:
      intent: List partner entitlements
      effect: read
      questions:
      - Which entitlements have I created as a Confluent partner?
      - Can I list entitlements for a single customer organization?
      instructions:
      - text: List all partner entitlements.
      - text: List entitlements for organization {organization_id}.
        slots:
          organization_id: query.organization.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/partner/v2/entitlements'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a partner entitlement
      effect: write
      questions:
      - How do I entitle a customer to a Confluent plan through the partner program?
      - What plan and product IDs do I need to create an entitlement?
      instructions:
      - text: Create entitlement {name} for plan {plan_id} and product {product_id}.
        slots:
          name: requestBody.name
          plan_id: requestBody.plan_id
          product_id: requestBody.product_id
      - text: Create an entitlement with external ID {external_id} for organization {organization}.
        slots:
          external_id: requestBody.external_id
          organization: requestBody.organization
      method: generated
      generated: '2026-09-26'
- target: $.paths['/partner/v2/entitlements/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one partner entitlement
      effect: read
      questions:
      - What plan and organization does a specific entitlement belong to?
      - How do I look up an entitlement by ID?
      instructions:
      - text: Get entitlement {id}.
        slots:
          id: path.id
      - text: Show entitlement {id} for organization {organization_id}.
        slots:
          id: path.id
          organization_id: query.organization.id
      method: generated
      generated: '2026-09-26'