Verato · OpenAPI Overlay 1.0.0

API Evangelist enhancements for Verato Provider API

2 actions 2 updates update extends openapi/verato-provider-openapi.yml
Authorship not recorded No authorship marker is recorded for this file. It is not presented as the provider's.
View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-notex-apievangelist-providerx-apievangelist-entityx-apievangelist-authx-apievangelist-error-modelx-apievangelist-idempotency

Targets 2

$.info
$.servers

OpenAPI Overlay

Raw ↑
overlay: 1.0.0
info:
  title: API Evangelist enhancements for Verato Provider API
  version: 1.0.0
extends: openapi/verato-provider-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-provider: verato
    x-apievangelist-entity: provider
    x-apievangelist-auth: HTTP Basic over mutual TLS
    x-apievangelist-error-model: ServiceResponse envelope (HTTP 200, success flag)
    x-apievangelist-idempotency: not-supported
    x-apievangelist-note: >-
      Provider spec operations are published without operationIds; agents should
      address operations by path (e.g. POST /postIdentity, POST /demographicsSearch).
- target: $.servers
  update:
    x-apievangelist-note: >-
      Published server host is the placeholder yourveratodomain.com; production
      base is tenant-specific https://<tenant>.verato.com/provider-link-ws/svc.