Cloudflare · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Cloudflare Certificates API

5 actions 5 updates phrasing extends openapi/cloudflare-certificates-api-openapi.yml

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

View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 5

$.info

$.paths['/certificates'].get

$.paths['/certificates'].post

$.paths['/certificates/{certificate_id}'].get

$.paths['/certificates/{certificate_id}'].delete

OpenAPI Overlay

# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Cloudflare Certificates API
  version: 1.0.0
extends: openapi/cloudflare-certificates-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-09-26'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 4
- target: $.paths['/certificates'].get
  update:
    x-apievangelist-phrasing:
      intent: List Origin CA certificates for a zone
      effect: read
      questions:
      - Which Origin CA certificates have been issued for my zone?
      - Can I see all origin certificates Cloudflare issued for my server?
      instructions:
      - text: List the Origin CA certificates for zone {identifier}.
        slots:
          identifier: query.identifier
      - text: Show all my existing origin certificates.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/certificates'].post
  update:
    x-apievangelist-phrasing:
      intent: Issue an Origin CA certificate
      effect: write
      questions:
      - How do I get an Origin CA certificate for my origin server?
      - Can I issue a wildcard origin certificate with an ECC signature?
      - What validity periods can I request for an origin certificate?
      instructions:
      - text: Create an Origin CA certificate for hostnames {hostnames} from CSR {csr}.
        slots:
          hostnames: requestBody.hostnames
          csr: requestBody.csr
      - text: Issue an {request_type} origin certificate for {hostnames} valid for {requested_validity} days.
        slots:
          request_type: requestBody.request_type
          hostnames: requestBody.hostnames
          requested_validity: requestBody.requested_validity
      method: generated
      generated: '2026-09-26'
- target: $.paths['/certificates/{certificate_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an Origin CA certificate
      effect: read
      questions:
      - How do I fetch one origin certificate by its serial number?
      - Can I download the details of an Origin CA certificate I issued earlier?
      instructions:
      - text: Get Origin CA certificate {certificate}.
        slots:
          certificate: path.certificate_id
      - text: Show the origin certificate with serial number {certificate}.
        slots:
          certificate: path.certificate_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/certificates/{certificate_id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Revoke an Origin CA certificate
      effect: destructive
      questions:
      - How do I revoke an origin certificate whose private key was exposed?
      - Can I invalidate an Origin CA certificate using its serial number?
      instructions:
      - text: Revoke Origin CA certificate {certificate}.
        slots:
          certificate: path.certificate_id
      - text: Invalidate the origin certificate with serial {certificate} right away.
        slots:
          certificate: path.certificate_id
      method: generated
      generated: '2026-09-26'