CustomerOS · OpenAPI Overlay 1.0.0

API Evangelist enhancements for CustomerOS CustomerBASE

5 actions 5 updates update extends openapi/customeros-customerbase-openapi.yml
Published by CustomerOS Authored by the provider (searched).
View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-provenancex-apievangelist-surfacex-apievangelist-host-checkx-apievangelist-operationid-gapx-apievangelist-notex-apievangelist-defect

Targets 5

$.info
$.servers[0]
$.paths
$.components.securitySchemes.ApiKeyAuth
$.paths['/customerbase/v1/contacts/import'].post

OpenAPI Overlay

Raw ↑
overlay: 1.0.0
info:
  title: API Evangelist enhancements for CustomerOS CustomerBASE
  version: 1.0.0
extends: openapi/customeros-customerbase-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-provenance:
      harvested: '2026-08-13'
      method: searched
      source: https://github.com/customeros/customeros/blob/otter/packages/server/customer-os-api/docs/openapi_customerbase.yaml
      note: Saved verbatim. This overlay carries API Evangelist observations; the underlying document
        is unmodified.
    x-apievangelist-surface: CustomerBASE
- target: $.servers[0]
  update:
    x-apievangelist-host-check:
      host: api.customeros.ai
      resolves: false
      checked: '2026-08-13'
      note: dig against 1.1.1.1 and 8.8.8.8 returns NOERROR with an empty answer section (MX records only).
        No A or AAAA record exists, so this server URL is not reachable as published.
- target: $.paths
  update:
    x-apievangelist-operationid-gap:
      operations: 6
      with_operation_id: 0
      note: No operation in this document declares an operationId. Tooling and agent skills must address
        these operations by METHOD + path.
- target: $.components.securitySchemes.ApiKeyAuth
  update:
    x-apievangelist-note: Per-tenant API key. Access to each endpoint group is granted on request by the
      CustomerOS team; there is no self-serve key issuance documented.
- target: $.paths['/customerbase/v1/contacts/import'].post
  update:
    x-apievangelist-defect:
      kind: undefined-security-scheme
      declared: ApiKeyAutl
      expected: ApiKeyAuth
      note: 'Typo in the provider-published document: this operation references a security scheme that
        is not defined in components.securitySchemes.'