Confluent | the Data Streaming Platform · OpenAPI Overlay 1.0.0

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

6 actions 6 updates phrasing extends openapi/confluent-the-data-streaming-platform-dns-forwarders-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/dns-forwarders'].get
$.paths['/networking/v1/dns-forwarders'].post
$.paths['/networking/v1/dns-forwarders/{id}'].get
$.paths['/networking/v1/dns-forwarders/{id}'].delete
$.paths['/networking/v1/dns-forwarders/{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 DNS Forwarders (networking/v1) API
  version: 1.0.0
extends: openapi/confluent-the-data-streaming-platform-dns-forwarders-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/dns-forwarders'].get
  update:
    x-apievangelist-phrasing:
      intent: List DNS forwarders in an environment
      effect: read
      questions:
      - Which DNS forwarders are configured in my Confluent Cloud environment?
      - Can I page through all DNS forwarders in an environment?
      instructions:
      - text: List DNS forwarders in environment {environment}.
        slots:
          environment: query.environment
      - text: Show every DNS forwarder set up in {environment}.
        slots:
          environment: query.environment
      method: generated
      generated: '2026-09-26'
- target: $.paths['/networking/v1/dns-forwarders'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a DNS forwarder
      effect: write
      questions:
      - How do I forward DNS queries for my private domains from a Confluent network?
      - What do I specify when creating a DNS forwarder, like domains and DNS server IPs?
      instructions:
      - text: Create a DNS forwarder with spec {spec}.
        slots:
          spec: requestBody.spec
      - text: Set up a new forwarder for my corporate domains using {spec}.
        slots:
          spec: requestBody.spec
      method: generated
      generated: '2026-09-26'
- target: $.paths['/networking/v1/dns-forwarders/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Read a DNS forwarder
      effect: read
      questions:
      - Is my DNS forwarder provisioned and ready?
      - Can I read a DNS forwarder's domains and servers by ID?
      instructions:
      - text: Get DNS forwarder {id} in environment {environment}.
        slots:
          id: path.id
          environment: query.environment
      - text: Show the status of forwarder {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/networking/v1/dns-forwarders/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a DNS forwarder
      effect: destructive
      questions:
      - Can I remove a DNS forwarder I no longer need?
      - Will deleting a DNS forwarder break name resolution for private endpoints?
      instructions:
      - text: Delete DNS forwarder {id} in environment {environment}.
        slots:
          id: path.id
          environment: query.environment
      - text: Tear down forwarder {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/networking/v1/dns-forwarders/{id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update a DNS forwarder
      effect: write
      questions:
      - Can I change the forwarded domains on an existing DNS forwarder?
      - How do I rename a DNS forwarder?
      instructions:
      - text: Update DNS forwarder {id} with spec {spec}.
        slots:
          id: path.id
          spec: requestBody.spec
      - text: Change the domains forwarded by {id} to those in {spec}.
        slots:
          id: path.id
          spec: requestBody.spec
      method: generated
      generated: '2026-09-26'