Checkly · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Checkly Public Client certificates API

5 actions 5 updates phrasing extends openapi/checkly-clientcertificates-api-openapi.yml
Generated by API Evangelist Written by API Evangelist tooling for Checkly's API. It is a proposal applied on top of the contract, not a document Checkly publishes.
View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 5

$.info
$.paths['/v1/client-certificates'].get
$.paths['/v1/client-certificates'].post
$.paths['/v1/client-certificates/{id}'].get
$.paths['/v1/client-certificates/{id}'].delete

OpenAPI Overlay

Raw ↑ 
# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Checkly Public Client certificates API
  version: 1.0.0
extends: openapi/checkly-clientcertificates-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-10-01'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 4
- target: $.paths['/v1/client-certificates'].get
  update:
    x-apievangelist-phrasing:
      intent: List client certificates
      effect: read
      questions:
      - Which client certificates have I uploaded for mTLS checks?
      - What hosts do my stored client certificates cover?
      instructions:
      - text: List all my client certificates.
      - text: Show every mTLS client certificate in my account.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/client-certificates'].post
  update:
    x-apievangelist-phrasing:
      intent: Upload a client certificate
      effect: write
      questions:
      - How do I let my API checks call an endpoint that requires mutual TLS?
      - Can one client certificate cover a wildcard host?
      - Is the private key passphrase stored encrypted?
      instructions:
      - text: Add client certificate {cert} for host {host}.
        slots:
          cert: requestBody.cert
          host: requestBody.host
      - text: Upload certificate {cert} with private key {key} for {host}.
        slots:
          cert: requestBody.cert
          key: requestBody.key
          host: requestBody.host
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/client-certificates/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a client certificate
      effect: read
      questions:
      - What host is a specific client certificate registered for?
      - Can I view one client certificate by its id?
      instructions:
      - text: Show client certificate {id}.
        slots:
          id: path.id
      - text: Get the details of client certificate {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/client-certificates/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a client certificate
      effect: destructive
      questions:
      - How do I remove an expired client certificate?
      - Is deleting a client certificate permanent?
      instructions:
      - text: Delete client certificate {id}.
        slots:
          id: path.id
      - text: Permanently remove client certificate {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'