X · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for X Trends API

4 actions 4 updates phrasing extends openapi/x-trends-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 4

$.info

$.paths['/2/trends/by/woeid/{woeid}'].get

$.paths['/2/users/personalized_trends'].get

$.paths['/trends/by/woeid/{woeid}'].get

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 Trends API
  version: 1.0.0
extends: openapi/x-trends-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: 3
- target: $.paths['/2/trends/by/woeid/{woeid}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get trends for a location (v2)
      effect: read
      questions:
      - What's trending right now in a specific city or country on the v2 endpoint?
      - Can I cap how many trends come back for a location?
      instructions:
      - text: Get v2 trends for WOEID {woeid}.
        slots:
          woeid: path.woeid
      - text: Show the top {max_trends} trends for location {woeid} using the v2 endpoint.
        slots:
          max_trends: query.max_trends
          woeid: path.woeid
      method: generated
      generated: '2026-09-26'
- target: $.paths['/2/users/personalized_trends'].get
  update:
    x-apievangelist-phrasing:
      intent: Get my personalized trends
      effect: read
      questions:
      - What topics are trending for me personally?
      - Can I see the trends tailored to the authenticated user?
      instructions:
      - text: Show my personalized trends.
      - text: List trends tailored to my account.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/trends/by/woeid/{woeid}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get location trends (unversioned endpoint)
      effect: read
      questions:
      - Is there an older unversioned path for trending topics by Where On Earth ID?
      - Which trending topics does the legacy non-/2 trends route return for a place?
      instructions:
      - text: Get trending topics for WOEID {woeid} from the unversioned trends endpoint.
        slots:
          woeid: path.woeid
      - text: Use the legacy /trends route to list trends at {woeid}.
        slots:
          woeid: path.woeid
      method: generated
      generated: '2026-09-26'