Confluent · OpenAPI Overlay 1.0.0

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

6 actions 6 updates phrasing extends openapi/confluent-peerings-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/peerings'].get
$.paths['/networking/v1/peerings'].post
$.paths['/networking/v1/peerings/{id}'].get
$.paths['/networking/v1/peerings/{id}'].delete
$.paths['/networking/v1/peerings/{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 Peerings (networking/v1) API
  version: 1.0.0
extends: openapi/confluent-peerings-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/peerings'].get
  update:
    x-apievangelist-phrasing:
      intent: List VPC/VNet peerings
      effect: read
      questions:
      - Which VPC or VNet peerings are connected to my Confluent networks?
      - Can I list only peerings on one network or in a given phase?
      instructions:
      - text: List peerings in environment {environment}.
        slots:
          environment: query.environment
      - text: List peerings on network {network} in {environment} in phase {phase}.
        slots:
          network: query.spec.network
          environment: query.environment
          phase: query.status.phase
      method: generated
      generated: '2026-09-26'
- target: $.paths['/networking/v1/peerings'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a VPC/VNet peering
      effect: write
      questions:
      - How do I peer my cloud VPC with a Confluent Cloud network?
      - What do I need to provide to set up a new peering connection?
      instructions:
      - text: Create a peering with spec {spec}.
        slots:
          spec: requestBody.spec
      - text: Peer my VPC to the Confluent network described in {spec}.
        slots:
          spec: requestBody.spec
      method: generated
      generated: '2026-09-26'
- target: $.paths['/networking/v1/peerings/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one peering
      effect: read
      questions:
      - Is a specific peering connection ready or still pending?
      - How do I read a peering's details by ID?
      instructions:
      - text: Get peering {id} in environment {environment}.
        slots:
          id: path.id
          environment: query.environment
      - text: Show the status of peering {id} in {environment}.
        slots:
          id: path.id
          environment: query.environment
      method: generated
      generated: '2026-09-26'
- target: $.paths['/networking/v1/peerings/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a peering
      effect: destructive
      questions:
      - How do I disconnect a VPC peering from Confluent Cloud?
      - Can I remove a peering that failed to provision?
      instructions:
      - text: Delete peering {id} in environment {environment}.
        slots:
          id: path.id
          environment: query.environment
      - text: Tear down peering connection {id} in {environment}.
        slots:
          id: path.id
          environment: query.environment
      method: generated
      generated: '2026-09-26'
- target: $.paths['/networking/v1/peerings/{id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update a peering
      effect: write
      questions:
      - Can I rename an existing peering connection?
      - What is editable on a peering after it is created?
      instructions:
      - text: Update peering {id} with spec {spec}.
        slots:
          id: path.id
          spec: requestBody.spec
      - text: Rename peering {id} per {spec}.
        slots:
          id: path.id
          spec: requestBody.spec
      method: generated
      generated: '2026-09-26'