Confluent | the Data Streaming Platform · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Confluent Cloud Private Link Attachments (networking/v1) API

6 actions 6 updates phrasing extends openapi/confluent-the-data-streaming-platform-private-link-attachments-networking-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['/networking/v1/private-link-attachments'].get
$.paths['/networking/v1/private-link-attachments'].post
$.paths['/networking/v1/private-link-attachments/{id}'].get
$.paths['/networking/v1/private-link-attachments/{id}'].delete
$.paths['/networking/v1/private-link-attachments/{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 Private Link Attachments (networking/v1) API
  version: 1.0.0
extends: openapi/confluent-the-data-streaming-platform-private-link-attachments-networking-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['/networking/v1/private-link-attachments'].get
  update:
    x-apievangelist-phrasing:
      intent: List private link attachments
      effect: read
      questions:
      - Which private link attachments exist in my environment?
      - Can I filter private link attachments by cloud, region or status phase?
      instructions:
      - text: List private link attachments in environment {environment}.
        slots:
          environment: query.environment
      - text: Show private link attachments in environment {environment} with phase {phase}.
        slots:
          environment: query.environment
          phase: query.status.phase
      method: generated
      generated: '2026-09-26'
- target: $.paths['/networking/v1/private-link-attachments'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a private link attachment
      effect: write
      questions:
      - How do I create a private link attachment for serverless cluster access?
      - What spec does a new private link attachment need?
      instructions:
      - text: Create a private link attachment with spec {spec}.
        slots:
          spec: requestBody.spec
      - text: Set up a new private link attachment described by {spec}.
        slots:
          spec: requestBody.spec
      method: generated
      generated: '2026-09-26'
- target: $.paths['/networking/v1/private-link-attachments/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a private link attachment
      effect: read
      questions:
      - What is the status of a specific private link attachment?
      - Can I read the service details of one private link attachment?
      instructions:
      - text: Show private link attachment {id} in environment {environment}.
        slots:
          id: path.id
          environment: query.environment
      - text: Check the phase of private link attachment {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/networking/v1/private-link-attachments/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a private link attachment
      effect: destructive
      questions:
      - How do I remove a private link attachment?
      - Can I delete a private link attachment from an environment?
      instructions:
      - text: Delete private link attachment {id} in environment {environment}.
        slots:
          id: path.id
          environment: query.environment
      - text: Remove private link attachment {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/networking/v1/private-link-attachments/{id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update a private link attachment
      effect: write
      questions:
      - Can I rename an existing private link attachment?
      - What can be changed on a private link attachment after creation?
      instructions:
      - text: Update private link attachment {id} with spec {spec}.
        slots:
          id: path.id
          spec: requestBody.spec
      - text: Change the display name of private link attachment {id} via {spec}.
        slots:
          id: path.id
          spec: requestBody.spec
      method: generated
      generated: '2026-09-26'