Confluent | the Data Streaming Platform · OpenAPI Overlay 1.0.0

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

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

$.info
$.paths['/pim/v1/integrations'].get
$.paths['/pim/v1/integrations'].post
$.paths['/pim/v1/integrations/{id}'].get
$.paths['/pim/v1/integrations/{id}'].delete

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/v1) API
  version: 1.0.0
extends: openapi/confluent-the-data-streaming-platform-integrations-pim-v1-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: 4
- target: $.paths['/pim/v1/integrations'].get
  update:
    x-apievangelist-phrasing:
      intent: List provider integrations
      effect: read
      questions:
      - Which cloud provider integrations exist in my environment?
      - Can I list only the integrations for one cloud provider?
      instructions:
      - text: List provider integrations in environment {environment}.
        slots:
          environment: query.environment
      - text: List {provider} integrations in {environment}.
        slots:
          environment: query.environment
          provider: query.provider
      method: generated
      generated: '2026-09-26'
- target: $.paths['/pim/v1/integrations'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a provider integration
      effect: write
      questions:
      - How do I set up a cloud provider integration so connectors can access my account?
      - Can I create an integration for a specific cloud provider?
      instructions:
      - text: Create provider integration {display_name} for {provider} in environment {environment}.
        slots:
          display_name: requestBody.display_name
          provider: requestBody.provider
          environment: requestBody.environment
      - text: Set up a {provider} integration with config {config}.
        slots:
          provider: requestBody.provider
          config: requestBody.config
      method: generated
      generated: '2026-09-26'
- target: $.paths['/pim/v1/integrations/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a provider integration
      effect: read
      questions:
      - What config and usages does one provider integration have?
      - Can I read a provider integration by id?
      instructions:
      - text: Show provider integration {id} in environment {environment}.
        slots:
          environment: query.environment
          id: path.id
      - text: Get the config of provider integration {id} in {environment}.
        slots:
          environment: query.environment
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/pim/v1/integrations/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a provider integration
      effect: destructive
      questions:
      - How do I remove a cloud provider integration?
      - Can I delete a provider integration that's no longer used?
      instructions:
      - text: Delete provider integration {id} in environment {environment}.
        slots:
          environment: query.environment
          id: path.id
      - text: Remove provider integration {id} from {environment}.
        slots:
          environment: query.environment
          id: path.id
      method: generated
      generated: '2026-09-26'