Common Room · OpenAPI Overlay 1.0.0

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

3 actions 3 updates phrasing extends openapi/common-room-objects-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['/objects/{id}'].get

$.paths['/objects'].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) Objects API
  version: 1.0.0
extends: openapi/common-room-objects-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['/objects/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a custom object by ID
      effect: read
      questions:
      - Can I fetch one custom object record from its co_ ID?
      - How do I include custom field values when retrieving a single object?
      instructions:
      - text: Get custom object {id}.
        slots:
          id: path.id
      - text: Fetch custom object {id} with columns {cols}.
        slots:
          id: path.id
          cols: query.cols
      method: generated
      generated: '2026-10-01'
- target: $.paths['/objects'].get
  update:
    x-apievangelist-phrasing:
      intent: List custom objects of a given type
      effect: read
      questions:
      - What records exist for one of our custom object types?
      - Can I list only the custom objects in a particular segment?
      instructions:
      - text: List custom objects of type {objectTypeId}.
        slots:
          objectTypeId: query.objectTypeId
      - text: List {objectTypeId} objects in segment {segmentId}.
        slots:
          objectTypeId: query.objectTypeId
          segmentId: query.segmentId
      method: generated
      generated: '2026-10-01'