Confluent | the Data Streaming Platform · OpenAPI Overlay 1.0.0

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

6 actions 6 updates phrasing extends openapi/confluent-the-data-streaming-platform-dns-records-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-records'].get
$.paths['/networking/v1/dns-records'].post
$.paths['/networking/v1/dns-records/{id}'].get
$.paths['/networking/v1/dns-records/{id}'].delete
$.paths['/networking/v1/dns-records/{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 Records (networking/v1) API
  version: 1.0.0
extends: openapi/confluent-the-data-streaming-platform-dns-records-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-records'].get
  update:
    x-apievangelist-phrasing:
      intent: List DNS records
      effect: read
      questions:
      - Which private DNS records are configured in my environment?
      - Can I filter DNS records by domain or gateway?
      instructions:
      - text: List DNS records in environment {environment}.
        slots:
          environment: query.environment
      - text: List DNS records in {environment} for domain {domain}.
        slots:
          environment: query.environment
          domain: query.spec.domain
      - text: Show DNS records in {environment} on gateway {gateway}.
        slots:
          environment: query.environment
          gateway: query.spec.gateway
      method: generated
      generated: '2026-09-26'
- target: $.paths['/networking/v1/dns-records'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a DNS record
      effect: write
      questions:
      - How do I add a DNS record that points to a private access point?
      - Can I create a private DNS record for a gateway?
      instructions:
      - text: Create a DNS record with spec {spec}.
        slots:
          spec: requestBody.spec
      - text: Add a new private DNS record using {spec}.
        slots:
          spec: requestBody.spec
      method: generated
      generated: '2026-09-26'
- target: $.paths['/networking/v1/dns-records/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a DNS record
      effect: read
      questions:
      - What domain and target does a specific DNS record have?
      - Is a DNS record I created ready yet?
      instructions:
      - text: Show DNS record {id} in environment {environment}.
        slots:
          environment: query.environment
          id: path.id
      - text: Check the status of DNS record {id} in {environment}.
        slots:
          environment: query.environment
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/networking/v1/dns-records/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a DNS record
      effect: destructive
      questions:
      - How do I remove a private DNS record?
      - Can I delete a DNS record that's no longer used?
      instructions:
      - text: Delete DNS record {id} in environment {environment}.
        slots:
          environment: query.environment
          id: path.id
      - text: Remove DNS record {id} from {environment}.
        slots:
          environment: query.environment
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/networking/v1/dns-records/{id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update a DNS record
      effect: write
      questions:
      - Can I rename or repoint an existing DNS record?
      - Is it possible to change a DNS record's display name?
      instructions:
      - text: Update DNS record {id} with spec {spec}.
        slots:
          id: path.id
          spec: requestBody.spec
      - text: Rename DNS record {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'