Common Room · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Common Room API (v2) Data Available API

2 actions 2 updates phrasing extends openapi/common-room-data-available-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['/data-available'].post

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) Data Available API
  version: 1.0.0
extends: openapi/common-room-data-available-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['/data-available'].post
  update:
    x-apievangelist-phrasing:
      intent: Signal that new source data is ready to import
      effect: write
      questions:
      - How do I tell Common Room that a connected source has new data to import?
      - Can I trigger an import and augmentation run for one data source on demand?
      instructions:
      - text: Notify Common Room that source {sourceId} has new data available.
        slots:
          sourceId: requestBody.sourceId
      - text: Trigger an import for provider {sourceId}.
        slots:
          sourceId: requestBody.sourceId
      method: generated
      generated: '2026-10-01'