Confluent | the Data Streaming Platform · OpenAPI Overlay 1.0.0

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

6 actions 6 updates phrasing extends openapi/confluent-the-data-streaming-platform-gateways-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/gateways'].get

$.paths['/networking/v1/gateways'].post

$.paths['/networking/v1/gateways/{id}'].get

$.paths['/networking/v1/gateways/{id}'].delete

$.paths['/networking/v1/gateways/{id}'].patch

OpenAPI Overlay

# 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 Gateways (networking/v1) API
  version: 1.0.0
extends: openapi/confluent-the-data-streaming-platform-gateways-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/gateways'].get
  update:
    x-apievangelist-phrasing:
      intent: List network gateways
      effect: read
      questions:
      - Which networking gateways exist in my environment?
      - Can I filter gateways by region, type or provisioning phase?
      instructions:
      - text: List gateways in environment {environment}.
        slots:
          environment: query.environment
      - text: Show {type} gateways in region {region} of {environment}.
        slots:
          type: query.gateway_type
          region: query.spec.config.region
          environment: query.environment
      method: generated
      generated: '2026-09-26'
- target: $.paths['/networking/v1/gateways'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a network gateway
      effect: write
      questions:
      - How do I create an egress or ingress gateway for private networking?
      - What config does a new gateway need?
      instructions:
      - text: Create a gateway with spec {spec}.
        slots:
          spec: requestBody.spec
      - text: Provision a new network gateway using {spec}.
        slots:
          spec: requestBody.spec
      method: generated
      generated: '2026-09-26'
- target: $.paths['/networking/v1/gateways/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Read a network gateway
      effect: read
      questions:
      - Has my gateway finished provisioning?
      - Can I look up one gateway's config by ID?
      instructions:
      - text: Get gateway {id} in environment {environment}.
        slots:
          id: path.id
          environment: query.environment
      - text: Show the phase and config of gateway {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/networking/v1/gateways/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a network gateway
      effect: destructive
      questions:
      - Can I delete a gateway I'm no longer routing through?
      - What happens to traffic when a gateway is removed?
      instructions:
      - text: Delete gateway {id} in environment {environment}.
        slots:
          id: path.id
          environment: query.environment
      - text: Tear down gateway {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/networking/v1/gateways/{id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update a network gateway
      effect: write
      questions:
      - Can I rename an existing gateway?
      - Which gateway settings can be changed after creation?
      instructions:
      - text: Update gateway {id} with spec {spec}.
        slots:
          id: path.id
          spec: requestBody.spec
      - text: Rename gateway {id} using {spec}.
        slots:
          id: path.id
          spec: requestBody.spec
      method: generated
      generated: '2026-09-26'