Confluent · 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-flink-artifacts-artifact-v1-api-openapi.yml
Generated by API Evangelist Written by API Evangelist tooling for Confluent's API. It is a proposal applied on top of the contract, not a document Confluent 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

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 Flink Artifacts (artifact/v1) API
  version: 1.0.0
extends: openapi/confluent-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 in a region
      effect: read
      questions:
      - Which Flink UDF artifacts have been uploaded to my environment?
      - Can I list Flink artifacts for one 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 all uploaded Flink JARs for environment {environment}, {cloud} {region}.
        slots:
          environment: query.environment
          cloud: query.cloud
          region: query.region
      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 Flink user-defined function JAR as an artifact?
      - What runtime languages are supported for Flink artifacts?
      instructions:
      - text: Create Flink artifact {display_name} in environment {environment} on {cloud} region {region} from upload {upload_source}.
        slots:
          display_name: requestBody.display_name
          environment: requestBody.environment
          cloud: query.cloud
          region: query.region
          upload_source: requestBody.upload_source
      - text: Register a new Flink UDF artifact named {display_name} with class {class} in {cloud} {region}.
        slots:
          display_name: requestBody.display_name
          class: requestBody.class
          cloud: query.cloud
          region: query.region
      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 name does a Flink artifact have?
      - Can I look up a single Flink artifact by ID?
      instructions:
      - text: Get Flink artifact {id} in environment {environment}, {cloud} region {region}.
        slots:
          id: path.id
          environment: query.environment
          cloud: query.cloud
          region: query.region
      - text: Show the details of Flink artifact {id} ({cloud} {region}, env {environment}).
        slots:
          id: path.id
          cloud: query.cloud
          region: query.region
          environment: query.environment
      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 remove a Flink artifact I no longer need?
      - Can I delete an uploaded UDF artifact?
      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 the UDF artifact {id} from env {environment} on {cloud} {region}.
        slots:
          id: path.id
          environment: query.environment
          cloud: query.cloud
          region: query.region
      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 env {environment}, {cloud} {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} ({cloud} {region}, env {environment}) to {description}.
        slots:
          id: path.id
          cloud: query.cloud
          region: query.region
          environment: query.environment
          description: requestBody.description
      method: generated
      generated: '2026-09-26'