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
Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we
store it to create your key and to recognise you if you sign in with another
provider. See our Privacy Policy and
Terms.