Ribbon Health · OpenAPI Overlay 1.0.0

API Evangelist enhancements for ribbon-health Cost Estimates Price Transparency API

4 actions 4 updates update extends openapi/ribbon-health-price-transparency-api-openapi.yml
Generated by API Evangelist Written by API Evangelist tooling for Ribbon Health's API. It is a proposal applied on top of the contract, not a document Ribbon Health publishes.
View Overlay File View on GitHub Overlay Specification

What the actions change

deprecatedx-apievangelist-deprecationx-apievangelist-sourcex-apievangelist-providerx-apievangelist-conventionsx-apievangelist-errorsx-apievangelist-data-modelx-apievangelist-lifecycle

Targets 4

$.info
$
$.paths['/pricing/version'].get
$.paths['/pricing/version/{carrier_name}'].get

OpenAPI Overlay

Raw ↑ 
overlay: 1.0.0
info:
  title: API Evangelist enhancements for ribbon-health Cost Estimates Price Transparency API
  version: 1.0.0
extends: openapi/ribbon-health-price-transparency-api-openapi.yml
x-apievangelist:
  generated: '2026-08-14'
  method: generated
  source: openapi/ribbon-health-price-transparency-api-openapi.yml + https://ribbon.readme.io/llms.txt
    + live probes of https://api.ribbonhealth.com
actions:
- target: $.info
  update:
    x-apievangelist-source: https://ribbon.readme.io/llms.txt
    x-apievangelist-provider: ribbon-health
    x-apievangelist-conventions: conventions/ribbon-health-conventions.yml
    x-apievangelist-errors: errors/ribbon-health-problem-types.yml
    x-apievangelist-data-model: data-model/ribbon-health-data-model.yml
    x-apievangelist-lifecycle: lifecycle/ribbon-health-lifecycle.yml
    x-apievangelist-rebrand: Ribbon Health is now part of H1; the docs brand this "the H1 API" while the
      host remains api.ribbonhealth.com.
- target: $
  update:
    x-apievangelist-error-envelope:
      content_type: application/json
      shape: '{"error": {"status": <int>, "code": "<snake_case_code>", "message": "<string>"}}'
      rfc9457: false
      method: probed
      source: live 401/404 responses from https://api.ribbonhealth.com, 2026-08-14
    x-apievangelist-request-id-header:
      name: ribbon-request-id
      method: probed
      note: Returned on every response including errors. Undocumented by the provider.
    x-apievangelist-rate-limit-signal:
      response_headers: none
      status_on_exhaustion: 429
      error_code: rate_limit_exceeded
      method: probed
      note: Limits are documented per endpoint but no X-RateLimit-*/RateLimit-*/Retry-After header is
        returned.
    x-apievangelist-idempotency:
      supported: false
      note: No idempotency key anywhere in the spec or the docs. POST creates are not safely retryable.
- target: $.paths['/pricing/version'].get
  update:
    deprecated: true
    x-apievangelist-deprecation:
      announced_in: https://ribbon.readme.io/reference/getpricingcarriernames
      replacement: getPricingCarriers
      sunset_date: null
      note: Announced as deprecated in the provider API reference but NOT marked deprecated in the published
        OpenAPI.
- target: $.paths['/pricing/version/{carrier_name}'].get
  update:
    deprecated: true
    x-apievangelist-deprecation:
      announced_in: https://ribbon.readme.io/reference/getpricingversioncarrier
      replacement: getPricingCarrier
      sunset_date: null
      note: Announced as deprecated in the provider API reference but NOT marked deprecated in the published
        OpenAPI.