Confluent | the Data Streaming Platform · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Confluent Cloud Private Link Accesses (networking/v1) API

6 actions 6 updates phrasing extends openapi/confluent-the-data-streaming-platform-private-link-accesses-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/private-link-accesses'].get
$.paths['/networking/v1/private-link-accesses'].post
$.paths['/networking/v1/private-link-accesses/{id}'].get
$.paths['/networking/v1/private-link-accesses/{id}'].delete
$.paths['/networking/v1/private-link-accesses/{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 Private Link Accesses (networking/v1) API
  version: 1.0.0
extends: openapi/confluent-the-data-streaming-platform-private-link-accesses-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/private-link-accesses'].get
  update:
    x-apievangelist-phrasing:
      intent: List private link accesses
      effect: read
      questions:
      - Which cloud accounts have private link access to my networks?
      - Can I filter private link accesses by network or status?
      instructions:
      - text: List private link accesses in environment {environment}.
        slots:
          environment: query.environment
      - text: List private link accesses in {environment} for network {network}.
        slots:
          environment: query.environment
          network: query.spec.network
      method: generated
      generated: '2026-09-26'
- target: $.paths['/networking/v1/private-link-accesses'].post
  update:
    x-apievangelist-phrasing:
      intent: Grant private link access
      effect: write
      questions:
      - How do I allow my cloud account to connect over PrivateLink?
      - Can I grant a VPC account private link access to a Confluent network?
      instructions:
      - text: Create a private link access with spec {spec}.
        slots:
          spec: requestBody.spec
      - text: Grant private link access to my cloud account using {spec}.
        slots:
          spec: requestBody.spec
      method: generated
      generated: '2026-09-26'
- target: $.paths['/networking/v1/private-link-accesses/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a private link access
      effect: read
      questions:
      - Is a private link access I granted ready to use?
      - Can I read one private link access by id?
      instructions:
      - text: Show private link access {id} in environment {environment}.
        slots:
          environment: query.environment
          id: path.id
      - text: Check the status of private link access {id} in {environment}.
        slots:
          environment: query.environment
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/networking/v1/private-link-accesses/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Revoke a private link access
      effect: destructive
      questions:
      - How do I revoke a cloud account's private link access?
      - Can I delete a private link access?
      instructions:
      - text: Delete private link access {id} in environment {environment}.
        slots:
          environment: query.environment
          id: path.id
      - text: Revoke private link access {id} in {environment}.
        slots:
          environment: query.environment
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/networking/v1/private-link-accesses/{id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update a private link access
      effect: write
      questions:
      - Can I rename a private link access after creating it?
      - Is changing a private link access's display name supported?
      instructions:
      - text: Update private link access {id} with spec {spec}.
        slots:
          id: path.id
          spec: requestBody.spec
      - text: Rename private link access {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'