Common Room · OpenAPI Overlay 1.0.0

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

3 actions 3 updates phrasing extends openapi/common-room-locations-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['/locations/{id}'].get
$.paths['/locations'].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 Common Room API (v2) Locations API
  version: 1.0.0
extends: openapi/common-room-locations-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['/locations/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a location by ID
      effect: read
      questions:
      - Can I fetch the details of one location from its ID?
      - What does a specific location ID refer to?
      instructions:
      - text: Get location {id}.
        slots:
          id: path.id
      - text: Look up which place location {id} is.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/locations'].get
  update:
    x-apievangelist-phrasing:
      intent: List locations ranked by member count
      effect: read
      questions:
      - Where are most of our community members located?
      - Can I list locations by country or by city?
      - How do I get the total count of matching locations?
      instructions:
      - text: List {locationType} locations ranked by member count.
        slots:
          locationType: query.locationType
      - text: Show the top {limit} {locationType} locations from cursor {cursor}.
        slots:
          limit: query.limit
          locationType: query.locationType
          cursor: query.cursor
      method: generated
      generated: '2026-10-01'