Confluent | the Data Streaming Platform · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Confluent Cloud Integrations (pim/v2) API

7 actions 7 updates phrasing extends openapi/confluent-the-data-streaming-platform-integrations-pim-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 7

$.info
$.paths['/pim/v2/integrations'].get
$.paths['/pim/v2/integrations'].post
$.paths['/pim/v2/integrations/{id}'].get
$.paths['/pim/v2/integrations/{id}'].delete
$.paths['/pim/v2/integrations/{id}'].patch
$.paths['/pim/v2/integrations:validate'].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 Integrations (pim/v2) API
  version: 1.0.0
extends: openapi/confluent-the-data-streaming-platform-integrations-pim-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: 6
- target: $.paths['/pim/v2/integrations'].get
  update:
    x-apievangelist-phrasing:
      intent: List cloud provider integrations
      effect: read
      questions:
      - Which cloud provider integrations exist in my environment?
      - Can I filter provider integrations by cloud provider or status?
      instructions:
      - text: List provider integrations in environment {environment}.
        slots:
          environment: query.environment
      - text: Show {provider} integrations in {environment} with status {status}.
        slots:
          provider: query.provider
          environment: query.environment
          status: query.status
      method: generated
      generated: '2026-09-26'
- target: $.paths['/pim/v2/integrations'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a cloud provider integration
      effect: write
      questions:
      - How do I set up a provider integration so Confluent can access my cloud account?
      - What config do I need to supply when creating a provider integration?
      instructions:
      - text: Create a provider integration named {name} for {provider} in {environment}.
        slots:
          name: requestBody.display_name
          provider: requestBody.provider
          environment: requestBody.environment
      - text: Add a {provider} integration with config {config}.
        slots:
          provider: requestBody.provider
          config: requestBody.config
      method: generated
      generated: '2026-09-26'
- target: $.paths['/pim/v2/integrations/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Read a provider integration
      effect: read
      questions:
      - What is the current status of one provider integration?
      - Can I read back the config of a specific integration by ID?
      instructions:
      - text: Get provider integration {id} in environment {environment}.
        slots:
          id: path.id
          environment: query.environment
      - text: Show me integration {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/pim/v2/integrations/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a provider integration
      effect: destructive
      questions:
      - Can I remove a cloud provider integration I no longer use?
      - Is deleting a provider integration permanent?
      instructions:
      - text: Delete provider integration {id} in environment {environment}.
        slots:
          id: path.id
          environment: query.environment
      - text: Remove integration {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/pim/v2/integrations/{id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update a provider integration
      effect: write
      questions:
      - Can I rename or reconfigure an existing provider integration?
      - How do I change the usages listed on a provider integration?
      instructions:
      - text: Rename provider integration {id} to {name}.
        slots:
          id: path.id
          name: requestBody.display_name
      - text: Update the config of integration {id} to {config}.
        slots:
          id: path.id
          config: requestBody.config
      method: generated
      generated: '2026-09-26'
- target: $.paths['/pim/v2/integrations:validate'].post
  update:
    x-apievangelist-phrasing:
      intent: Validate a provider integration setup
      effect: read
      questions:
      - Can I test that a provider integration's cloud access is set up correctly before relying on it?
      - Is there a dry check for an integration's IAM configuration?
      instructions:
      - text: Validate provider integration {id} in environment {environment}.
        slots:
          id: requestBody.id
          environment: requestBody.environment
      - text: Check that integration config {config} works.
        slots:
          config: requestBody.config
      method: generated
      generated: '2026-09-26'