CloudHealth · OpenAPI Overlay 1.0.0

API Evangelist enhancements for CloudHealth REST Search API

4 actions 4 updates update extends ../openapi/cloudhealth-search-api-openapi.yml

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

View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-provenancex-rate-limitapiKeyQueryexternalDocs429403

Targets 4

$.info

$.components.securitySchemes

$.paths['/api/search'].get.responses

OpenAPI Overlay

overlay: 1.0.0
info:
  title: API Evangelist enhancements for CloudHealth REST Search API
  version: 1.0.0
extends: ../openapi/cloudhealth-search-api-openapi.yml
x-generated: '2026-09-16'
x-method: generated
actions:
- target: $.info
  update:
    x-apievangelist-provenance: authored by API Evangelist from https://apidocs.cloudhealthtech.com/ (see openapi/_ae-authored/README.md)
    x-rate-limit:
      limit: 30
      window: 1 minute
      scope: per-client
      source: https://knowledge.broadcom.com/external/article/420604/cloudhealth-rest-and-graphql-api-rate-li.html
- target: $.components.securitySchemes
  update:
    apiKeyQuery:
      type: apiKey
      in: query
      name: api_key
      description: 'Documented alternative to the Authorization: Bearer header.'
- target: $
  update:
    externalDocs:
      description: CloudHealth REST API Guide
      url: https://apidocs.cloudhealthtech.com/
- target: $.paths['/api/search'].get.responses
  update:
    '429':
      description: "Too many requests \u2014 exceeding the rate limit (retry with exponential backoff)."
    '403':
      description: "Forbidden \u2014 bad API key."