Common Room · OpenAPI Overlay 1.0.0

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

2 actions 2 updates phrasing extends openapi/common-room-industries-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 2

$.info

$.paths['/industries'].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) Industries API
  version: 1.0.0
extends: openapi/common-room-industries-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: 1
- target: $.paths['/industries'].get
  update:
    x-apievangelist-phrasing:
      intent: Search NAICS industry codes
      effect: read
      questions:
      - Which NAICS industry codes does Common Room recognize?
      - Can I search industry codes by name, like software or banking?
      instructions:
      - text: Search industry codes matching {query}.
        slots:
          query: query.query
      - text: List {limit} NAICS industry codes from cursor {cursor}.
        slots:
          limit: query.limit
          cursor: query.cursor
      method: generated
      generated: '2026-10-01'