Netlify · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Netlify's API documentation Sni Certificate API

4 actions 4 updates phrasing extends openapi/netlify-snicertificate-api-openapi.yml

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

View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 4

$.info

$.paths['/sites/{site_id}/ssl'].get

$.paths['/sites/{site_id}/ssl'].post

$.paths['/sites/{site_id}/ssl/certificates'].get

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 Netlify's API documentation Sni Certificate API
  version: 1.0.0
extends: openapi/netlify-snicertificate-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: 3
- target: $.paths['/sites/{site_id}/ssl'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a site's TLS certificate
      effect: read
      questions:
      - What TLS certificate is my site using?
      - When does my site's HTTPS certificate expire?
      instructions:
      - text: Show the TLS certificate for site {site}.
        slots:
          site: path.site_id
      - text: Check the SSL certificate on site {site}.
        slots:
          site: path.site_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/sites/{site_id}/ssl'].post
  update:
    x-apievangelist-phrasing:
      intent: Provision or upload a TLS certificate
      effect: write
      questions:
      - How do I get a free Let's Encrypt certificate for my site?
      - Can I upload my own custom SSL certificate?
      - What do I need to provide to replace an existing certificate?
      instructions:
      - text: Provision a Let's Encrypt certificate for site {site}.
        slots:
          site: path.site_id
      - text: Install custom certificate {certificate} with key {key} and CA chain {ca} on site {site}.
        slots:
          certificate: query.certificate
          key: query.key
          ca: query.ca_certificates
          site: path.site_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/sites/{site_id}/ssl/certificates'].get
  update:
    x-apievangelist-phrasing:
      intent: List certificates for a site domain
      effect: read
      questions:
      - Which certificates cover a particular domain on my site?
      - Can I see all certificates issued for a domain?
      instructions:
      - text: List certificates on site {site} for domain {domain}.
        slots:
          site: path.site_id
          domain: query.domain
      - text: Show every certificate for {domain} on site {site}.
        slots:
          domain: query.domain
          site: path.site_id
      method: generated
      generated: '2026-09-26'