Common Room · OpenAPI Overlay 1.0.0

API Evangelist enhancements for Common Room Core Activities Me API

3 actions 3 updates update extends openapi/common-room-me-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-providerx-apievangelist-artifactsx-agent-surfacex-rate-limit-headersx-error-envelopex-apievangelist-tags

Targets 1

$.info

OpenAPI Overlay

Raw ↑ 
overlay: 1.0.0
info:
  title: API Evangelist enhancements for Common Room Core Activities Me API
  version: 1.0.0
extends: openapi/common-room-me-api-openapi.yml
x-generated: '2026-08-13'
x-method: generated
x-source: apis.yml + repo artifacts (conventions/, errors/, rate-limits/, authentication/,
  mcp/)
actions:
- target: $.info
  update:
    x-apievangelist-provider: common-room
    x-apievangelist-artifacts:
      conventions: conventions/common-room-conventions.yml
      errors: errors/common-room-problem-types.yml
      rate-limits: rate-limits/common-room-rate-limits.yml
      authentication: authentication/common-room-authentication.yml
      data-model: data-model/common-room-data-model.yml
      mcp: mcp/common-room-mcp.yml
    x-agent-surface:
      mcp: https://mcp.commonroom.io/mcp
      cli: '@commonroomio/cli'
- target: $.info
  update:
    x-rate-limit-headers:
    - X-RateLimit-Limit
    - X-RateLimit-Remaining
    - X-RateLimit-Reset
    - Retry-After
    x-error-envelope: '{"success": false, "error": {"code": "<machine_code>", "message":
      "<human message>"}}'
- target: $.info
  update:
    x-apievangelist-tags:
    - Me