APIClarity · OpenAPI Overlay 1.0.0

API Evangelist enhancements for APIClarity Plugins telemetries API

5 actions 5 updates update extends apiclarity-plugins-telemetry-swagger.yml

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

View Overlay File View on GitHub Overlay Specification

What the actions change

contactlicensex-lifecyclex-served-underx-deployment-modelx-upstream-sourcex-conventions

Targets 1

$.info

OpenAPI Overlay

overlay: 1.0.0
info:
  title: API Evangelist enhancements for APIClarity Plugins telemetries API
  version: 1.0.0
extends: apiclarity-plugins-telemetry-swagger.yml
x-generated: '2026-09-04'
x-method: generated
x-source: openapi/apiclarity-plugins-telemetry-swagger.yml, https://github.com/openclarity/apiclarity
x-note: Additive metadata only. It never rewrites paths, schemas or responses, and it adds no securityScheme
  — the original document is APIClarity's and stays untouched.
actions:
- target: $.info
  description: Attach the publisher contact APIClarity omits from this document.
  update:
    contact:
      name: OpenClarity
      url: https://github.com/openclarity/apiclarity
- target: $.info
  description: Record the Apache-2.0 licence the repository declares but the document does not.
  update:
    license:
      name: Apache-2.0
      url: https://github.com/openclarity/apiclarity/blob/master/LICENSE
- target: $.info
  description: Record end-of-life. The source repository was archived read-only on 2026-05-29 and the
    last release was v0.14.5 on 2023-05-05.
  update:
    x-lifecycle:
      status: end-of-life
      archived: '2026-05-29'
      last-release: v0.14.5
      last-release-date: '2023-05-05'
      successor: null
      evidence: https://github.com/openclarity/apiclarity
- target: $.info
  description: State where this document actually lives and how it is served, which the document itself
    does not say.
  update:
    x-served-under: /api
    x-deployment-model: self-hosted; there is no vendor API host. The server is whatever Service or ingress
      the operator exposes.
    x-upstream-source: https://github.com/openclarity/apiclarity
- target: $.info
  description: Record the runtime semantics an integrator needs and the document does not carry.
  update:
    x-conventions:
      idempotency: none — no Idempotency-Key header exists anywhere in the APIClarity surface
      rate-limits: none published and none implemented
      error-envelope: '{"message": string} (schema ApiResponse); not RFC 9457 problem+json'
      artifact: conventions/apiclarity-conventions.yml