Netlify · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Netlify's API documentation Deploy Key API

5 actions 5 updates phrasing extends openapi/netlify-deploykey-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 5

$.info
$.paths['/deploy_keys'].get
$.paths['/deploy_keys'].post
$.paths['/deploy_keys/{key_id}'].get
$.paths['/deploy_keys/{key_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 Netlify's API documentation Deploy Key API
  version: 1.0.0
extends: openapi/netlify-deploykey-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['/deploy_keys'].get
  update:
    x-apievangelist-phrasing:
      intent: List deploy keys
      effect: read
      questions:
      - What deploy keys exist on my account?
      - Can I see all the SSH deploy keys used for repo access?
      instructions:
      - text: List all my deploy keys.
      - text: Show every SSH deploy key on my account.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/deploy_keys'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a deploy key
      effect: write
      questions:
      - How do I generate a new SSH deploy key for a private repo?
      - Can I get a fresh public key to add to my Git host?
      instructions:
      - text: Create a new deploy key.
      - text: Generate an SSH deploy key I can add to my repository.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/deploy_keys/{key_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a deploy key
      effect: read
      questions:
      - Can I retrieve the public key of an existing deploy key?
      - Where do I find one deploy key's details?
      instructions:
      - text: Get deploy key {key}.
        slots:
          key: path.key_id
      - text: Show the public key for deploy key {key}.
        slots:
          key: path.key_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/deploy_keys/{key_id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a deploy key
      effect: destructive
      questions:
      - How do I delete a deploy key I no longer use?
      - Can I revoke a compromised deploy key?
      instructions:
      - text: Delete deploy key {key}.
        slots:
          key: path.key_id
      - text: Revoke deploy key {key}.
        slots:
          key: path.key_id
      method: generated
      generated: '2026-09-26'