X · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for X API v2 Connections API

5 actions 5 updates phrasing extends openapi/x-connections-api-openapi.yml

Generated by API Evangelist Written by API Evangelist tooling for X's API. It is a proposal applied on top of the contract, not a document X publishes.

View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 5

$.info

$.paths['/2/connections'].get

$.paths['/2/connections'].delete

$.paths['/2/connections/all'].delete

$.paths['/2/connections/{endpoint_id}'].delete

OpenAPI Overlay

# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for X API v2 Connections API
  version: 1.0.0
extends: openapi/x-connections-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: 4
- target: $.paths['/2/connections'].get
  update:
    x-apievangelist-phrasing:
      intent: View streaming connection history
      effect: read
      questions:
      - Why did my streaming connection disconnect?
      - Can I list only my active streaming connections for a given endpoint?
      instructions:
      - text: Show my app's streaming connection history.
      - text: List {status} streaming connections for endpoints {endpoints}.
        slots:
          status: query.status
          endpoints: query.endpoints
      method: generated
      generated: '2026-09-26'
- target: $.paths['/2/connections'].delete
  update:
    x-apievangelist-phrasing:
      intent: Terminate specific streaming connections
      effect: destructive
      questions:
      - How do I close particular streaming connections by their UUIDs?
      - Can I terminate several stream connections in one request?
      instructions:
      - text: Terminate streaming connections {uuids}.
        slots:
          uuids: requestBody.uuids
      - text: Disconnect the stream connections with UUIDs {uuids}.
        slots:
          uuids: requestBody.uuids
      method: generated
      generated: '2026-09-26'
- target: $.paths['/2/connections/all'].delete
  update:
    x-apievangelist-phrasing:
      intent: Terminate all streaming connections
      effect: destructive
      questions:
      - Is there a way to kill every active streaming connection my app has?
      - What resets all of my app's open streams at once?
      instructions:
      - text: Terminate all of my app's active streaming connections.
      - text: Disconnect every open stream for my app.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/2/connections/{endpoint_id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Terminate streams on one endpoint
      effect: destructive
      questions:
      - Can I close all connections to just one streaming endpoint?
      - What call drops every connection for a specific endpoint ID?
      instructions:
      - text: Terminate all connections on streaming endpoint {endpoint_id}.
        slots:
          endpoint_id: path.endpoint_id
      - text: Disconnect every stream attached to endpoint {endpoint_id}.
        slots:
          endpoint_id: path.endpoint_id
      method: generated
      generated: '2026-09-26'