Confluent | the Data Streaming Platform · OpenAPI Overlay 1.0.0

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

6 actions 6 updates phrasing extends openapi/confluent-the-data-streaming-platform-access-points-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/access-points'].get
$.paths['/networking/v1/access-points'].post
$.paths['/networking/v1/access-points/{id}'].get
$.paths['/networking/v1/access-points/{id}'].delete
$.paths['/networking/v1/access-points/{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 Access Points (networking/v1) API
  version: 1.0.0
extends: openapi/confluent-the-data-streaming-platform-access-points-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/access-points'].get
  update:
    x-apievangelist-phrasing:
      intent: List access points in an environment
      effect: read
      questions:
      - Which network access points exist in my environment?
      - Can I filter access points by gateway or display name?
      instructions:
      - text: List access points in environment {environment}.
        slots:
          environment: query.environment
      - text: List access points on gateway {gateway} in environment {environment}.
        slots:
          gateway: query.spec.gateway
          environment: query.environment
      method: generated
      generated: '2026-09-26'
- target: $.paths['/networking/v1/access-points'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a network access point
      effect: write
      questions:
      - How do I create an access point on a gateway in Confluent Cloud?
      - Can I set up a new access point for private connectivity?
      instructions:
      - text: Create an access point with spec {spec}.
        slots:
          spec: requestBody.spec
      - text: Set up a new network access point on my gateway.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/networking/v1/access-points/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an access point
      effect: read
      questions:
      - What is the status of one of my access points?
      - Can I read an access point's configuration by ID?
      instructions:
      - text: Get access point {id} in environment {environment}.
        slots:
          id: path.id
          environment: query.environment
      - text: Show the status of access point {id} in {environment}.
        slots:
          id: path.id
          environment: query.environment
      method: generated
      generated: '2026-09-26'
- target: $.paths['/networking/v1/access-points/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an access point
      effect: destructive
      questions:
      - How do I remove an access point I no longer need?
      - Can I delete a network access point from an environment?
      instructions:
      - text: Delete access point {id} in environment {environment}.
        slots:
          id: path.id
          environment: query.environment
      - text: Remove network access point {id} from {environment}.
        slots:
          id: path.id
          environment: query.environment
      method: generated
      generated: '2026-09-26'
- target: $.paths['/networking/v1/access-points/{id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update an access point
      effect: write
      questions:
      - How do I rename or change the configuration of an access point?
      - Can I modify an existing access point's spec?
      instructions:
      - text: Update access point {id} with spec {spec}.
        slots:
          id: path.id
          spec: requestBody.spec
      - text: Rename access point {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'