Confluent | the Data Streaming Platform · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Confluent Cloud Networks (networking/v1) API

6 actions 6 updates phrasing extends openapi/confluent-the-data-streaming-platform-networks-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/networks'].get
$.paths['/networking/v1/networks'].post
$.paths['/networking/v1/networks/{id}'].get
$.paths['/networking/v1/networks/{id}'].delete
$.paths['/networking/v1/networks/{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 Networks (networking/v1) API
  version: 1.0.0
extends: openapi/confluent-the-data-streaming-platform-networks-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/networks'].get
  update:
    x-apievangelist-phrasing:
      intent: List networks in an environment
      effect: read
      questions:
      - Which Confluent Cloud networks exist in my environment?
      - Can I filter networks by cloud, region, CIDR or connection type?
      instructions:
      - text: List networks in environment {environment}.
        slots:
          environment: query.environment
      - text: Show networks in environment {environment} on cloud {cloud} in region {region}.
        slots:
          environment: query.environment
          cloud: query.spec.cloud
          region: query.spec.region
      method: generated
      generated: '2026-09-26'
- target: $.paths['/networking/v1/networks'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a network
      effect: write
      questions:
      - How do I create a dedicated network for private connectivity to my clusters?
      - What spec fields does a new network need, like cloud, region and CIDR?
      instructions:
      - text: Create a network with spec {spec}.
        slots:
          spec: requestBody.spec
      - text: Provision a new Confluent network described by {spec}.
        slots:
          spec: requestBody.spec
      method: generated
      generated: '2026-09-26'
- target: $.paths['/networking/v1/networks/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a network
      effect: read
      questions:
      - What is the provisioning phase of a specific network?
      - Can I see the CIDR and zones of one network?
      instructions:
      - text: Show network {id} in environment {environment}.
        slots:
          id: path.id
          environment: query.environment
      - text: Check the status of network {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/networking/v1/networks/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a network
      effect: destructive
      questions:
      - How do I delete a network I no longer use?
      - Can I tear down a network in an environment?
      instructions:
      - text: Delete network {id} in environment {environment}.
        slots:
          id: path.id
          environment: query.environment
      - text: Remove network {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/networking/v1/networks/{id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update a network
      effect: write
      questions:
      - Can I rename an existing network?
      - Which network settings can be changed after it is created?
      instructions:
      - text: Update network {id} with spec {spec}.
        slots:
          id: path.id
          spec: requestBody.spec
      - text: Change the display name of existing network {id} via spec {spec}.
        slots:
          id: path.id
          spec: requestBody.spec
      method: generated
      generated: '2026-09-26'