Confluent | the Data Streaming Platform · OpenAPI Overlay 1.0.0

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

4 actions 4 updates phrasing extends openapi/confluent-the-data-streaming-platform-signup-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/signup'].post

$.paths['/partner/v2/signup/activate'].post

$.paths['/partner/v2/signup/link'].post

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 Signup (partner/v2) API
  version: 1.0.0
extends: openapi/confluent-the-data-streaming-platform-signup-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/signup'].post
  update:
    x-apievangelist-phrasing:
      intent: Sign up a new organization for a customer
      effect: write
      questions:
      - As a partner, how do I create a Confluent Cloud organization for my customer?
      - Can I do a dry run of a customer signup first?
      instructions:
      - text: Sign up organization {organization} with entitlement {entitlement}.
        slots:
          organization: requestBody.organization
          entitlement: requestBody.entitlement
      - text: Dry-run a signup for {organization} with admin user {user}.
        slots:
          organization: requestBody.organization
          user: requestBody.user
      method: generated
      generated: '2026-09-26'
- target: $.paths['/partner/v2/signup/activate'].post
  update:
    x-apievangelist-phrasing:
      intent: Activate an incomplete customer signup
      effect: write
      questions:
      - How do I finish a signup that was created without a user?
      - Can I attach the first user to a pending organization?
      instructions:
      - text: Activate signup for organization {org} with user {user}.
        slots:
          org: requestBody.organization_id
          user: requestBody.user
      - text: Complete pending organization {org} by adding {user}.
        slots:
          org: requestBody.organization_id
          user: requestBody.user
      method: generated
      generated: '2026-09-26'
- target: $.paths['/partner/v2/signup/link'].post
  update:
    x-apievangelist-phrasing:
      intent: Link a customer's existing organization
      effect: write
      questions:
      - Can I bring a customer's existing organization under my partner account?
      - What token is needed to link an existing organization?
      instructions:
      - text: Link existing organization {organization} using token {token} with entitlement {entitlement}.
        slots:
          organization: requestBody.organization
          token: requestBody.token
          entitlement: requestBody.entitlement
      - text: Dry-run linking {organization} with token {token}.
        slots:
          organization: requestBody.organization
          token: requestBody.token
      method: generated
      generated: '2026-09-26'