Confluent | the Data Streaming Platform · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Confluent Cloud Custom Code Loggings (ccl/v1) API

6 actions 6 updates phrasing extends openapi/confluent-the-data-streaming-platform-custom-code-loggings-ccl-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 6

$.info
$.paths['/ccl/v1/custom-code-loggings'].get
$.paths['/ccl/v1/custom-code-loggings'].post
$.paths['/ccl/v1/custom-code-loggings/{id}'].get
$.paths['/ccl/v1/custom-code-loggings/{id}'].delete
$.paths['/ccl/v1/custom-code-loggings/{id}'].patch

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 Custom Code Loggings (ccl/v1) API
  version: 1.0.0
extends: openapi/confluent-the-data-streaming-platform-custom-code-loggings-ccl-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: 5
- target: $.paths['/ccl/v1/custom-code-loggings'].get
  update:
    x-apievangelist-phrasing:
      intent: List custom code logging configs
      effect: read
      questions:
      - Which custom code logging destinations exist in my environment?
      - Can I see where logs from my custom code are being sent?
      instructions:
      - text: List custom code loggings in environment {environment}.
        slots:
          environment: query.environment
      - text: Show every custom code logging config for {environment}.
        slots:
          environment: query.environment
      method: generated
      generated: '2026-09-26'
- target: $.paths['/ccl/v1/custom-code-loggings'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a custom code logging config
      effect: write
      questions:
      - How do I send logs from my custom code to a Kafka topic?
      - Can I choose the cloud and region for a custom code logging destination?
      instructions:
      - text: Create custom code logging in {environment} for {cloud} region {region}.
        slots:
          environment: requestBody.environment
          cloud: requestBody.cloud
          region: requestBody.region
      - text: Set up custom code logging with destination settings {destination_settings}.
        slots:
          destination_settings: requestBody.destination_settings
      method: generated
      generated: '2026-09-26'
- target: $.paths['/ccl/v1/custom-code-loggings/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a custom code logging config
      effect: read
      questions:
      - What destination is a given custom code logging config using?
      - Can I read one custom code logging setup by id?
      instructions:
      - text: Show custom code logging {id} in environment {environment}.
        slots:
          environment: query.environment
          id: path.id
      - text: Get the destination settings of custom code logging {id} in {environment}.
        slots:
          environment: query.environment
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/ccl/v1/custom-code-loggings/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a custom code logging config
      effect: destructive
      questions:
      - How do I stop collecting custom code logs?
      - Can I remove a custom code logging config?
      instructions:
      - text: Delete custom code logging {id} in environment {environment}.
        slots:
          environment: query.environment
          id: path.id
      - text: Remove the custom code logging config {id} from {environment}.
        slots:
          environment: query.environment
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/ccl/v1/custom-code-loggings/{id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update a custom code logging config
      effect: write
      questions:
      - Can I change where an existing custom code logging config sends logs?
      - Is it possible to edit the destination settings of custom code logging?
      instructions:
      - text: Update custom code logging {id} in {environment} with destination {destination_settings}.
        slots:
          environment: query.environment
          id: path.id
          destination_settings: requestBody.destination_settings
      - text: Change the destination settings of custom code logging {id} in environment {environment}.
        slots:
          environment: query.environment
          id: path.id
      method: generated
      generated: '2026-09-26'