RTB House · OpenAPI Overlay 1.0.0

API Evangelist enhancements for Client's panel API docs Advertisers Dev API

3 actions 3 updates update extends openapi/rtbhouse-dev-api-openapi.yml

Generated by API Evangelist Written by API Evangelist tooling for RTB House's API. It is a proposal applied on top of the contract, not a document RTB House publishes.

View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-providerx-apievangelist-artifactsx-api-version-headerx-retired-version-statusx-error-envelopex-rate-limitx-idempotencyx-apievangelist-gaps

Targets 2

$.info

$.paths['/healthcheck'].get

OpenAPI Overlay

overlay: 1.0.0
info:
  title: API Evangelist enhancements for Client's panel API docs Advertisers Dev API
  version: 1.0.0
x-generated: '2026-08-13'
x-method: generated
x-source: openapi/rtbhouse-dev-api-openapi.yml
extends: openapi/rtbhouse-dev-api-openapi.yml
actions:
- target: $.info
  description: Record the API Evangelist enrichment context for this contract.
  update:
    x-apievangelist-provider: rtbhouse
    x-apievangelist-artifacts:
      authentication: authentication/rtbhouse-authentication.yml
      conventions: conventions/rtbhouse-conventions.yml
      errors: errors/rtbhouse-problem-types.yml
      rate-limits: rate-limits/rtbhouse-rate-limits.yml
      lifecycle: lifecycle/rtbhouse-lifecycle.yml
      data-model: data-model/rtbhouse-data-model.yml
- target: $.info
  description: 'Document the runtime semantics the published contract omits: versioning header, error
    envelope, and the resource-usage rate-limit signal.'
  update:
    x-api-version-header: X-Current-Api-Version
    x-retired-version-status: 410
    x-error-envelope:
      status: error
      fields:
      - status
      - message
      - httpCode
      - appCode
      - errors
      rfc9457: false
    x-rate-limit:
      status: 429
      header: X-Resource-Usage
      format: METRIC-WINDOWSECONDS=used/limit joined by ";"
      metrics:
      - WORKER_TIME
      - BQ_TB_BILLED
      retry_after: false
    x-idempotency:
      supported: false
- target: $.paths['/healthcheck'].get
  description: Flag the contract gaps on GET /healthcheck — no operationId and no documented 4xx/5xx response.
  update:
    x-apievangelist-gaps:
    - no-operationId
    - no-error-responses