Common Room · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Common Room API (v2) Custom Fields API

3 actions 3 updates phrasing extends openapi/common-room-custom-fields-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['/custom-fields/{id}'].get
$.paths['/custom-fields'].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) Custom Fields API
  version: 1.0.0
extends: openapi/common-room-custom-fields-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['/custom-fields/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a custom field definition by ID
      effect: read
      questions:
      - Can I look up what a specific cf_ custom field is and how it's defined?
      - What type and name does a particular custom field have?
      instructions:
      - text: Get custom field {id}.
        slots:
          id: path.id
      - text: Show the definition of custom field {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/custom-fields'].get
  update:
    x-apievangelist-phrasing:
      intent: List custom field definitions
      effect: read
      questions:
      - What custom fields have we defined across the community?
      - Can I list only the custom fields that apply to organizations?
      instructions:
      - text: List all custom field definitions.
      - text: List the custom fields for entity type {entityType}.
        slots:
          entityType: query.entityType
      method: generated
      generated: '2026-10-01'