Confluent | the Data Streaming Platform · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Confluent Cloud Flink Artifacts (artifact/v1) API

6 actions 6 updates phrasing extends openapi/confluent-the-data-streaming-platform-flink-artifacts-artifact-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['/artifact/v1/flink-artifacts'].get

$.paths['/artifact/v1/flink-artifacts'].post

$.paths['/artifact/v1/flink-artifacts/{id}'].get

$.paths['/artifact/v1/flink-artifacts/{id}'].delete

$.paths['/artifact/v1/flink-artifacts/{id}'].patch

OpenAPI Overlay

# 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 Flink Artifacts (artifact/v1) API
  version: 1.0.0
extends: openapi/confluent-the-data-streaming-platform-flink-artifacts-artifact-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['/artifact/v1/flink-artifacts'].get
  update:
    x-apievangelist-phrasing:
      intent: List Flink artifacts
      effect: read
      questions:
      - Which Flink UDF artifacts have I uploaded to an environment?
      - Can I list Flink artifacts for a particular cloud and region?
      instructions:
      - text: List Flink artifacts in environment {environment} on {cloud} region {region}.
        slots:
          environment: query.environment
          cloud: query.cloud
          region: query.region
      - text: Show the Flink artifacts I have in {region} for environment {environment} on cloud {cloud}.
        slots:
          region: query.region
          environment: query.environment
          cloud: query.cloud
      method: generated
      generated: '2026-09-26'
- target: $.paths['/artifact/v1/flink-artifacts'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a Flink artifact
      effect: write
      questions:
      - How do I register a JAR of Flink user-defined functions as an artifact?
      - What runtime languages and content formats can a new Flink artifact use?
      instructions:
      - text: Create Flink artifact {display_name} in environment {environment}, {cloud} region {region}, from upload {upload_source}.
        slots:
          display_name: requestBody.display_name
          environment: requestBody.environment
          cloud: requestBody.cloud
          region: requestBody.region
          upload_source: requestBody.upload_source
      - text: Register a {runtime_language} Flink artifact named {display_name} from {upload_source}.
        slots:
          runtime_language: requestBody.runtime_language
          display_name: requestBody.display_name
          upload_source: requestBody.upload_source
      method: generated
      generated: '2026-09-26'
- target: $.paths['/artifact/v1/flink-artifacts/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a Flink artifact
      effect: read
      questions:
      - What versions and class does a specific Flink artifact have?
      - Can I read one Flink artifact by its ID?
      instructions:
      - text: Show Flink artifact {id} in environment {environment}, {cloud} region {region}.
        slots:
          id: path.id
          environment: query.environment
          cloud: query.cloud
          region: query.region
      - text: Read the details of Flink artifact {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/artifact/v1/flink-artifacts/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a Flink artifact
      effect: destructive
      questions:
      - How do I delete a Flink UDF artifact I no longer need?
      - Can I remove a Flink artifact from one region?
      instructions:
      - text: Delete Flink artifact {id} in environment {environment}, {cloud} region {region}.
        slots:
          id: path.id
          environment: query.environment
          cloud: query.cloud
          region: query.region
      - text: Remove Flink artifact {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/artifact/v1/flink-artifacts/{id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update a Flink artifact
      effect: write
      questions:
      - Can I change the description or documentation link of a Flink artifact?
      - Is it possible to rename an existing Flink artifact?
      instructions:
      - text: Rename Flink artifact {id} in environment {environment}, {cloud} region {region} to {display_name}.
        slots:
          id: path.id
          environment: query.environment
          cloud: query.cloud
          region: query.region
          display_name: requestBody.display_name
      - text: Update the description of Flink artifact {id} to {description}.
        slots:
          id: path.id
          description: requestBody.description
      method: generated
      generated: '2026-09-26'