X · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for X API v2 Communities API

3 actions 3 updates phrasing extends openapi/x-communities-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 3

$.info
$.paths['/2/communities/search'].get
$.paths['/2/communities/{id}'].get

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 X API v2 Communities API
  version: 1.0.0
extends: openapi/x-communities-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: 2
- target: $.paths['/2/communities/search'].get
  update:
    x-apievangelist-phrasing:
      intent: Search Communities by keyword
      effect: read
      questions:
      - Which X Communities exist about a given topic?
      - Can I find Communities matching a keyword and page through the results?
      instructions:
      - text: Search Communities for {query}.
        slots:
          query: query.query
      - text: Find up to {max_results} Communities about {query}.
        slots:
          max_results: query.max_results
          query: query.query
      method: generated
      generated: '2026-09-26'
- target: $.paths['/2/communities/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a Community by ID
      effect: read
      questions:
      - How can I look up a single Community's details from its ID?
      - What information is returned for one Community?
      instructions:
      - text: Get Community {id}.
        slots:
          id: path.id
      - text: Show Community {id} with fields {fields}.
        slots:
          id: path.id
          fields: query.community.fields
      method: generated
      generated: '2026-09-26'