Confluent · OpenAPI Overlay 1.0.0

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

6 actions 6 updates phrasing extends openapi/confluent-network-link-services-networking-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['/networking/v1/network-link-services'].get
$.paths['/networking/v1/network-link-services'].post
$.paths['/networking/v1/network-link-services/{id}'].get
$.paths['/networking/v1/network-link-services/{id}'].delete
$.paths['/networking/v1/network-link-services/{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 Services (networking/v1) API
  version: 1.0.0
extends: openapi/confluent-network-link-services-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-services'].get
  update:
    x-apievangelist-phrasing:
      intent: List network link services
      effect: read
      questions:
      - Which network link services exist in an environment?
      - Can I filter network link services by the network they run on or their phase?
      instructions:
      - text: List network link services in environment {environment}.
        slots:
          environment: query.environment
      - text: List network link services on network {network} in {environment}.
        slots:
          network: query.spec.network
          environment: query.environment
      - text: Show network link services in {environment} whose phase is {phase}.
        slots:
          phase: query.status.phase
          environment: query.environment
      method: generated
      generated: '2026-09-26'
- target: $.paths['/networking/v1/network-link-services'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a network link service
      effect: write
      questions:
      - How do I expose my network so other Confluent networks can link to it for cluster linking?
      - What spec is required to create a network link service?
      instructions:
      - text: Create a network link service with spec {spec}.
        slots:
          spec: requestBody.spec
      - text: Set up a new network link service using {spec}.
        slots:
          spec: requestBody.spec
      method: generated
      generated: '2026-09-26'
- target: $.paths['/networking/v1/network-link-services/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a network link service
      effect: read
      questions:
      - Is my network link service ready yet?
      - Can I read one network link service and its accept policy?
      instructions:
      - text: Get network link service {id} in environment {environment}.
        slots:
          id: path.id
          environment: query.environment
      - text: Show the status of network link service {id} in {environment}.
        slots:
          id: path.id
          environment: query.environment
      method: generated
      generated: '2026-09-26'
- target: $.paths['/networking/v1/network-link-services/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a network link service
      effect: destructive
      questions:
      - What removes a network link service from my network?
      - Can I delete a network link service that's no longer used?
      instructions:
      - text: Delete network link service {id} in environment {environment}.
        slots:
          id: path.id
          environment: query.environment
      - text: Remove network link service {id} from {environment}.
        slots:
          id: path.id
          environment: query.environment
      method: generated
      generated: '2026-09-26'
- target: $.paths['/networking/v1/network-link-services/{id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update a network link service
      effect: write
      questions:
      - Can I change which environments or networks may connect to my network link service?
      - Which call edits an existing network link service?
      instructions:
      - text: Update network link service {id} with spec {spec}.
        slots:
          id: path.id
          spec: requestBody.spec
      - text: Change the accept policy of network link service {id} to {spec}.
        slots:
          id: path.id
          spec: requestBody.spec
      method: generated
      generated: '2026-09-26'