Confluent · OpenAPI Overlay 1.0.0

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

4 actions 4 updates phrasing extends openapi/confluent-signup-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/signup'].post
$.paths['/partner/v2/signup/activate'].post
$.paths['/partner/v2/signup/link'].post

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 Signup (partner/v2) API
  version: 1.0.0
extends: openapi/confluent-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:
      - How do I create a Confluent Cloud organization on behalf of a customer as a partner?
      - Can I dry-run a partner signup to validate it first?
      instructions:
      - text: Sign up organization {organization} for a customer with entitlement {entitlement}.
        slots:
          organization: requestBody.organization
          entitlement: requestBody.entitlement
      - text: Create a new customer organization {organization} with user {user} and entitlement {entitlement}.
        slots:
          organization: requestBody.organization
          user: requestBody.user
          entitlement: requestBody.entitlement
      method: generated
      generated: '2026-09-26'
- target: $.paths['/partner/v2/signup/activate'].post
  update:
    x-apievangelist-phrasing:
      intent: Activate an incomplete signup
      effect: write
      questions:
      - How do I finish a customer signup that was left incomplete?
      - What is needed to activate a pending organization signup?
      instructions:
      - text: Activate the incomplete signup for organization {organization_id} with user {user}.
        slots:
          organization_id: requestBody.organization_id
          user: requestBody.user
      - text: Complete signup for org {organization_id} by activating user {user}.
        slots:
          organization_id: 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 to an existing organization
      effect: write
      questions:
      - Can I sign up a customer by linking them to an organization they already have?
      - Is there a dry-run for linking a customer's existing organization?
      instructions:
      - text: Link the customer's existing organization {organization} using token {token} with entitlement {entitlement}.
        slots:
          organization: requestBody.organization
          token: requestBody.token
          entitlement: requestBody.entitlement
      - text: Sign up a customer via link token {token} to existing org {organization}, entitlement {entitlement}.
        slots:
          token: requestBody.token
          organization: requestBody.organization
          entitlement: requestBody.entitlement
      method: generated
      generated: '2026-09-26'