Confluent · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Confluent Cloud Transit Gateway Attachments (networking/v1)…

6 actions 6 updates phrasing extends openapi/confluent-transit-gateway-attachments-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/transit-gateway-attachments'].get
$.paths['/networking/v1/transit-gateway-attachments'].post
$.paths['/networking/v1/transit-gateway-attachments/{id}'].get
$.paths['/networking/v1/transit-gateway-attachments/{id}'].delete
$.paths['/networking/v1/transit-gateway-attachments/{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 Transit Gateway Attachments (networking/v1)…
  version: 1.0.0
extends: openapi/confluent-transit-gateway-attachments-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/transit-gateway-attachments'].get
  update:
    x-apievangelist-phrasing:
      intent: List AWS Transit Gateway attachments
      effect: read
      questions:
      - Which Transit Gateway attachments connect my AWS networks to Confluent?
      - Can I filter attachments by network or provisioning phase?
      instructions:
      - text: List transit gateway attachments in environment {environment}.
        slots:
          environment: query.environment
      - text: List attachments on network {network} in {environment} with phase {phase}.
        slots:
          network: query.spec.network
          environment: query.environment
          phase: query.status.phase
      method: generated
      generated: '2026-09-26'
- target: $.paths['/networking/v1/transit-gateway-attachments'].post
  update:
    x-apievangelist-phrasing:
      intent: Attach a network to a Transit Gateway
      effect: write
      questions:
      - How do I connect a Confluent network to my AWS Transit Gateway?
      - What is needed to create a Transit Gateway attachment?
      instructions:
      - text: Create a transit gateway attachment with spec {spec}.
        slots:
          spec: requestBody.spec
      - text: Attach the Confluent network to my Transit Gateway using {spec}.
        slots:
          spec: requestBody.spec
      method: generated
      generated: '2026-09-26'
- target: $.paths['/networking/v1/transit-gateway-attachments/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one Transit Gateway attachment
      effect: read
      questions:
      - Is my Transit Gateway attachment ready yet?
      - How do I read one attachment's details by ID?
      instructions:
      - text: Get transit gateway attachment {id} in environment {environment}.
        slots:
          id: path.id
          environment: query.environment
      - text: Show the status of TGW attachment {id} in {environment}.
        slots:
          id: path.id
          environment: query.environment
      method: generated
      generated: '2026-09-26'
- target: $.paths['/networking/v1/transit-gateway-attachments/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a Transit Gateway attachment
      effect: destructive
      questions:
      - How do I detach a Confluent network from my Transit Gateway?
      - Can I remove a Transit Gateway attachment that is stuck?
      instructions:
      - text: Delete transit gateway attachment {id} in environment {environment}.
        slots:
          id: path.id
          environment: query.environment
      - text: Detach TGW attachment {id} in {environment}.
        slots:
          id: path.id
          environment: query.environment
      method: generated
      generated: '2026-09-26'
- target: $.paths['/networking/v1/transit-gateway-attachments/{id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update a Transit Gateway attachment
      effect: write
      questions:
      - Can I rename an existing Transit Gateway attachment?
      - What can be changed on a TGW attachment after it is created?
      instructions:
      - text: Update transit gateway attachment {id} with spec {spec}.
        slots:
          id: path.id
          spec: requestBody.spec
      - text: Rename TGW attachment {id} per {spec}.
        slots:
          id: path.id
          spec: requestBody.spec
      method: generated
      generated: '2026-09-26'