Confluent | the Data Streaming Platform · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Confluent Cloud Connect Artifacts (cam/v1) API

5 actions 5 updates phrasing extends openapi/confluent-the-data-streaming-platform-connect-artifacts-cam-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['/cam/v1/connect-artifacts'].get
$.paths['/cam/v1/connect-artifacts'].post
$.paths['/cam/v1/connect-artifacts/{id}'].get
$.paths['/cam/v1/connect-artifacts/{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 Connect Artifacts (cam/v1) API
  version: 1.0.0
extends: openapi/confluent-the-data-streaming-platform-connect-artifacts-cam-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['/cam/v1/connect-artifacts'].get
  update:
    x-apievangelist-phrasing:
      intent: List Connect artifacts
      effect: read
      questions:
      - Which custom Connect artifacts have I uploaded to an environment?
      - Can I list Connect artifacts for one cloud provider?
      instructions:
      - text: List Connect artifacts in environment {environment} on cloud {cloud}.
        slots:
          cloud: query.spec.cloud
          environment: query.environment
      - text: Show all uploaded Connect artifacts for {cloud} in {environment}.
        slots:
          cloud: query.spec.cloud
          environment: query.environment
      method: generated
      generated: '2026-09-26'
- target: $.paths['/cam/v1/connect-artifacts'].post
  update:
    x-apievangelist-phrasing:
      intent: Register a Connect artifact
      effect: write
      questions:
      - How do I register a connector archive I uploaded as a Connect artifact?
      - Can I create a Connect artifact after uploading it to a presigned URL?
      instructions:
      - text: Create a Connect artifact in {environment} on {cloud} with spec {spec}.
        slots:
          cloud: query.spec.cloud
          environment: query.environment
          spec: requestBody.spec
      - text: Register the uploaded archive as a new Connect artifact for {cloud} in {environment}.
        slots:
          cloud: query.spec.cloud
          environment: query.environment
      method: generated
      generated: '2026-09-26'
- target: $.paths['/cam/v1/connect-artifacts/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a Connect artifact
      effect: read
      questions:
      - What is the status of a Connect artifact I uploaded?
      - Can I read a single Connect artifact by id?
      instructions:
      - text: Show Connect artifact {id} in {environment} on {cloud}.
        slots:
          cloud: query.spec.cloud
          environment: query.environment
          id: path.id
      - text: Check the status of Connect artifact {id} for {cloud} in environment {environment}.
        slots:
          cloud: query.spec.cloud
          environment: query.environment
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/cam/v1/connect-artifacts/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a Connect artifact
      effect: destructive
      questions:
      - How do I delete a Connect artifact I no longer need?
      - Why does deleting a Connect artifact fail while workloads use it?
      instructions:
      - text: Delete Connect artifact {id} in {environment} on {cloud}.
        slots:
          cloud: query.spec.cloud
          environment: query.environment
          id: path.id
      - text: Remove Connect artifact {id} for {cloud} from environment {environment}.
        slots:
          cloud: query.spec.cloud
          environment: query.environment
          id: path.id
      method: generated
      generated: '2026-09-26'