Confluent · OpenAPI Overlay 1.0.0

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

6 actions 6 updates phrasing extends openapi/confluent-networks-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/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-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 or connection type?
      - Which of my networks are still provisioning?
      instructions:
      - text: List networks in environment {environment}.
        slots:
          environment: query.environment
      - text: List 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 private network for my Kafka clusters?
      - What does a network spec need, like CIDR and connection types?
      instructions:
      - text: Create a network with spec {spec}.
        slots:
          spec: requestBody.spec
      - text: 'Provision a new private network using this spec: {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 status and CIDR of a specific network?
      - Is my network ready yet?
      instructions:
      - text: Get network {id} in environment {environment}.
        slots:
          id: path.id
          environment: query.environment
      - text: Show the provisioning phase of network {id} in environment {environment}.
        slots:
          id: path.id
          environment: query.environment
      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 remove a network from a specific environment?
      instructions:
      - text: Delete network {id} in environment {environment}.
        slots:
          id: path.id
          environment: query.environment
      - text: Tear down network {id} from environment {environment}.
        slots:
          id: path.id
          environment: query.environment
      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 a network or change its DNS settings after creation?
      - Which network fields can be updated?
      instructions:
      - text: Update network {id} with spec {spec}.
        slots:
          id: path.id
          spec: requestBody.spec
      - text: Change the settings of existing network {id} to {spec}.
        slots:
          id: path.id
          spec: requestBody.spec
      method: generated
      generated: '2026-09-26'