Common Room · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Common Room API (v2) Topics API

3 actions 3 updates phrasing extends openapi/common-room-topics-api-openapi.yml

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

View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 3

$.info

$.paths['/topics/{id}'].get

$.paths['/topics'].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 Common Room API (v2) Topics API
  version: 1.0.0
extends: openapi/common-room-topics-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-10-01'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 2
- target: $.paths['/topics/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a topic by ID
      effect: read
      questions:
      - Can I look up one topic from its tp_ ID?
      - What is the name of a specific topic ID?
      instructions:
      - text: Get topic {id}.
        slots:
          id: path.id
      - text: Show the details of topic {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/topics'].get
  update:
    x-apievangelist-phrasing:
      intent: List topics alphabetically
      effect: read
      questions:
      - What topics are being tracked in our community?
      - Can I find topics whose names start with certain letters?
      instructions:
      - text: List all topics.
      - text: Find topics whose name starts with {query}.
        slots:
          query: query.query
      method: generated
      generated: '2026-10-01'