Confluent | the Data Streaming Platform · OpenAPI Overlay 1.0.0

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

4 actions 4 updates phrasing extends openapi/confluent-the-data-streaming-platform-entitlements-partner-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 4

$.info

$.paths['/partner/v2/entitlements'].get

$.paths['/partner/v2/entitlements'].post

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

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 Entitlements (partner/v2) API
  version: 1.0.0
extends: openapi/confluent-the-data-streaming-platform-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 marketplace entitlements have I created as a partner?
      - Can I filter partner entitlements by customer organization?
      instructions:
      - text: List my 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 provision an entitlement for a customer as a partner?
      - Can I attach a plan and product ID to a new entitlement?
      instructions:
      - text: Create entitlement {name} with external ID {external_id} on plan {plan_id}.
        slots:
          name: requestBody.name
          external_id: requestBody.external_id
          plan_id: requestBody.plan_id
      - text: Create an entitlement for product {product_id} with usage reporting ID {usage_reporting_id}.
        slots:
          product_id: requestBody.product_id
          usage_reporting_id: requestBody.usage_reporting_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/partner/v2/entitlements/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a partner entitlement
      effect: read
      questions:
      - What plan and product is one entitlement on?
      - Can I look up a partner entitlement by ID?
      instructions:
      - text: Get entitlement {id}.
        slots:
          id: path.id
      - text: Get entitlement {id} for organization {organization_id}.
        slots:
          id: path.id
          organization_id: query.organization.id
      method: generated
      generated: '2026-09-26'