Verato · OpenAPI Overlay 1.0.0

API Evangelist enhancements for Verato Person API

2 actions 2 updates update extends openapi/verato-person-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-providerx-apievangelist-entityx-apievangelist-authx-apievangelist-error-modelx-apievangelist-paginationx-apievangelist-idempotencyx-apievangelist-note

Targets 2

$.info

$.servers

OpenAPI Overlay

overlay: 1.0.0
info:
  title: API Evangelist enhancements for Verato Person API
  version: 1.0.0
extends: openapi/verato-person-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-provider: verato
    x-apievangelist-entity: person
    x-apievangelist-auth: HTTP Basic over mutual TLS
    x-apievangelist-error-model: ServiceResponse envelope (HTTP 200, success flag)
    x-apievangelist-pagination: page-based (pageNumber/pageSize/totalElements)
    x-apievangelist-idempotency: not-supported
- target: $.servers
  update:
    x-apievangelist-note: >-
      Published server host is the placeholder yourveratodomain.com; production
      base is tenant-specific https://<tenant>.verato.com/link-ws/svc.