Common Room · OpenAPI Overlay 1.0.0

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

3 actions 3 updates phrasing extends openapi/common-room-organizations-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['/organizations/{id}'].get
$.paths['/organizations'].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) Organizations API
  version: 1.0.0
extends: openapi/common-room-organizations-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['/organizations/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an organization by ID
      effect: read
      questions:
      - Can I pull up one organization's record from its o_ ID?
      - How do I include employee count or revenue when fetching an organization?
      instructions:
      - text: Get organization {id}.
        slots:
          id: path.id
      - text: Fetch organization {id} with columns {cols}.
        slots:
          id: path.id
          cols: query.cols
      method: generated
      generated: '2026-10-01'
- target: $.paths['/organizations'].get
  update:
    x-apievangelist-phrasing:
      intent: List or filter organizations
      effect: read
      questions:
      - What organizations are in our community, sorted by member count?
      - Can I find an organization by its exact name or primary domain?
      instructions:
      - text: Find the organization with domain {primaryDomain}.
        slots:
          primaryDomain: query.primaryDomain
      - text: Find the organization named {name}.
        slots:
          name: query.name
      - text: List organizations sorted by {sort}.
        slots:
          sort: query.sort
      method: generated
      generated: '2026-10-01'