Xquik · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Xquik Communities API

7 actions 7 updates phrasing extends openapi/xquik-api-communities-api-openapi.yml
Generated by API Evangelist Written by API Evangelist tooling for Xquik's API. It is a proposal applied on top of the contract, not a document Xquik publishes.
View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 7

$.info
$.paths['/api/v1/x/communities/{id}/info'].get
$.paths['/api/v1/x/communities/{id}/members'].get
$.paths['/api/v1/x/communities/{id}/moderators'].get
$.paths['/api/v1/x/communities/{id}/tweets'].get
$.paths['/api/v1/x/communities/search'].get
$.paths['/api/v1/x/communities/tweets'].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 Xquik Communities API
  version: 1.0.0
extends: openapi/xquik-api-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: 6
- target: $.paths['/api/v1/x/communities/{id}/info'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an X Community's profile
      effect: read
      questions:
      - How many members does an X Community have?
      - Can I get a community's name and description by its ID?
      instructions:
      - text: Get the name, description and member count of community {id}.
        slots:
          id: path.id
      - text: Show me info about X Community {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/x/communities/{id}/members'].get
  update:
    x-apievangelist-phrasing:
      intent: List members of an X Community
      effect: read
      questions:
      - Who are the members of an X Community?
      - Can I filter a community's members to verified accounts only?
      - Can I list only community members with lots of followers?
      instructions:
      - text: List the members of community {id}.
        slots:
          id: path.id
      - text: List members of community {id} with at least {minFollowers} followers.
        slots:
          id: path.id
          minFollowers: query.minFollowers
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/x/communities/{id}/moderators'].get
  update:
    x-apievangelist-phrasing:
      intent: List moderators of an X Community
      effect: read
      questions:
      - Who moderates an X Community?
      - Can I filter a community's moderators by a keyword in their bio?
      instructions:
      - text: List the moderators of community {id}.
        slots:
          id: path.id
      - text: Find moderators of community {id} whose bio mentions {bioContains}.
        slots:
          id: path.id
          bioContains: query.bioContains
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/x/communities/{id}/tweets'].get
  update:
    x-apievangelist-phrasing:
      intent: Read the tweet feed of an X Community
      effect: read
      questions:
      - What has been posted recently in an X Community?
      - Can I page through a community's whole tweet feed without a keyword?
      instructions:
      - text: Show the latest tweets posted in community {id}.
        slots:
          id: path.id
      - text: Fetch {pageSize} tweets from the feed of community {id}.
        slots:
          id: path.id
          pageSize: query.pageSize
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/x/communities/search'].get
  update:
    x-apievangelist-phrasing:
      intent: Keyword-search tweets in a community
      effect: read
      questions:
      - Can I keyword-search the posts inside one X Community using the community search endpoint?
      - Does community search return community records or tweets?
      instructions:
      - text: Search community {communityId} for tweets mentioning {q}.
        slots:
          communityId: query.communityId
          q: query.q
      - text: Use the community search endpoint to find {q} in community {communityId}.
        slots:
          communityId: query.communityId
          q: query.q
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/x/communities/tweets'].get
  update:
    x-apievangelist-phrasing:
      intent: Query all community tweets matching a keyword
      effect: read
      questions:
      - Can I query every tweet in a community that matches a keyword via the community tweets endpoint?
      - Is a community ID required to query community tweets by keyword?
      instructions:
      - text: Query all tweets in community {communityId} that match {q}.
        slots:
          communityId: query.communityId
          q: query.q
      - text: Pull matching tweets for {q} from the community tweets endpoint for community {communityId}.
        slots:
          communityId: query.communityId
          q: query.q
      method: generated
      generated: '2026-09-26'