Confluent · OpenAPI Overlay 1.0.0

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

6 actions 6 updates phrasing extends openapi/confluent-gateways-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/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

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 Gateways (networking/v1) API
  version: 1.0.0
extends: openapi/confluent-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 network gateways exist in my Confluent environment?
      - Can I filter gateways by type, region or provisioning phase?
      instructions:
      - text: List gateways in environment {environment}.
        slots:
          environment: query.environment
      - text: List {gateway_type} gateways in {environment} in region {region}.
        slots:
          gateway_type: query.gateway_type
          environment: query.environment
          region: query.spec.config.region
      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 a gateway for private networking to Confluent Cloud?
      - Can I choose the cloud region when I create a gateway?
      instructions:
      - text: Create a gateway with spec {spec}.
        slots:
          spec: requestBody.spec
      - text: Create a new private networking gateway configured as {spec}.
        slots:
          spec: requestBody.spec
      method: generated
      generated: '2026-09-26'
- target: $.paths['/networking/v1/gateways/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one network gateway
      effect: read
      questions:
      - Is a specific gateway ready, and what endpoints does it expose?
      - How do I read a gateway's configuration by ID?
      instructions:
      - text: Get gateway {id} in environment {environment}.
        slots:
          id: path.id
          environment: query.environment
      - text: Show the status of gateway {id} in {environment}.
        slots:
          id: path.id
          environment: query.environment
      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:
      - How do I delete a gateway I no longer need?
      - Can I remove a gateway from an environment?
      instructions:
      - text: Delete gateway {id} in environment {environment}.
        slots:
          id: path.id
          environment: query.environment
      - text: Remove network gateway {id} from {environment}.
        slots:
          id: path.id
          environment: query.environment
      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?
      - What 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'