Confluent | the Data Streaming Platform · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Confluent Cloud Network Link Endpoints (networking/v1) API

6 actions 6 updates phrasing extends openapi/confluent-the-data-streaming-platform-network-link-endpoints-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/network-link-endpoints'].get
$.paths['/networking/v1/network-link-endpoints'].post
$.paths['/networking/v1/network-link-endpoints/{id}'].get
$.paths['/networking/v1/network-link-endpoints/{id}'].delete
$.paths['/networking/v1/network-link-endpoints/{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 Network Link Endpoints (networking/v1) API
  version: 1.0.0
extends: openapi/confluent-the-data-streaming-platform-network-link-endpoints-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/network-link-endpoints'].get
  update:
    x-apievangelist-phrasing:
      intent: List network link endpoints
      effect: read
      questions:
      - Which network link endpoints exist in my environment?
      - Can I filter network link endpoints by network or by network link service?
      instructions:
      - text: List network link endpoints in environment {environment}.
        slots:
          environment: query.environment
      - text: List network link endpoints in {environment} for network {network}.
        slots:
          environment: query.environment
          network: query.spec.network
      - text: Show endpoints in {environment} connected to network link service {service}.
        slots:
          environment: query.environment
          service: query.spec.network_link_service
      method: generated
      generated: '2026-09-26'
- target: $.paths['/networking/v1/network-link-endpoints'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a network link endpoint
      effect: write
      questions:
      - How do I connect my network to another network's link service?
      - Can I create an endpoint for cross-network cluster linking?
      instructions:
      - text: Create a network link endpoint with spec {spec}.
        slots:
          spec: requestBody.spec
      - text: Set up a new network link endpoint using {spec}.
        slots:
          spec: requestBody.spec
      method: generated
      generated: '2026-09-26'
- target: $.paths['/networking/v1/network-link-endpoints/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a network link endpoint
      effect: read
      questions:
      - Is my network link endpoint ready or still pending?
      - Can I read one network link endpoint's details?
      instructions:
      - text: Show network link endpoint {id} in environment {environment}.
        slots:
          environment: query.environment
          id: path.id
      - text: Check the phase of network link endpoint {id} in {environment}.
        slots:
          environment: query.environment
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/networking/v1/network-link-endpoints/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a network link endpoint
      effect: destructive
      questions:
      - How do I remove a network link endpoint?
      - Can I disconnect a network from a link service by deleting its endpoint?
      instructions:
      - text: Delete network link endpoint {id} in environment {environment}.
        slots:
          environment: query.environment
          id: path.id
      - text: Remove network link endpoint {id} from {environment}.
        slots:
          environment: query.environment
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/networking/v1/network-link-endpoints/{id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update a network link endpoint
      effect: write
      questions:
      - Can I rename or redescribe an existing network link endpoint?
      - Is updating a network link endpoint's spec supported?
      instructions:
      - text: Update network link endpoint {id} with spec {spec}.
        slots:
          id: path.id
          spec: requestBody.spec
      - text: Rename network link endpoint {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'