# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Forge SSH Keys API
  version: 1.0.0
extends: openapi/laravel-ssh-keys-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: 6
- target: $.paths['/orgs/{organization}/servers/{server}/ssh-keys'].get
  update:
    x-apievangelist-phrasing:
      intent: List SSH keys authorized on a server
      effect: read
      questions:
      - Which SSH keys can log in to my server?
      - Can I list a server's SSH keys for one specific user?
      instructions:
      - text: List SSH keys on server {server} in {organization}.
        slots:
          server: path.server
          organization: path.organization
      - text: Show SSH keys on server {server} for user {user}.
        slots:
          server: path.server
          user: query.filter[user]
      method: generated
      generated: '2026-10-01'
- target: $.paths['/orgs/{organization}/servers/{server}/ssh-keys'].post
  update:
    x-apievangelist-phrasing:
      intent: Add an SSH key to a server
      effect: write
      questions:
      - How do I give a teammate SSH access to a server?
      - Can I add an SSH key for a user other than forge?
      instructions:
      - text: Add SSH key {name} with public key {key} to server {server} in {organization}.
        slots:
          name: requestBody.name
          key: requestBody.key
          server: path.server
          organization: path.organization
      - text: Authorize public key {key} named {name} for user {user} on server {server}.
        slots:
          key: requestBody.key
          name: requestBody.name
          user: requestBody.user
          server: path.server
      method: generated
      generated: '2026-10-01'
- target: $.paths['/orgs/{organization}/servers/{server}/ssh-keys/{key}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an SSH key on a server
      effect: read
      questions:
      - What are the details of one SSH key installed on a server?
      - Which user is a particular SSH key assigned to?
      instructions:
      - text: Show SSH key {key} on server {server} in {organization}.
        slots:
          key: path.key
          server: path.server
          organization: path.organization
      - text: Get authorized key {key} from server {server}.
        slots:
          key: path.key
          server: path.server
      method: generated
      generated: '2026-10-01'
- target: $.paths['/orgs/{organization}/servers/{server}/ssh-keys/{key}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove an SSH key from a server
      effect: destructive
      questions:
      - How do I revoke someone's SSH access to a server?
      - Can I delete an authorized SSH key from a server?
      instructions:
      - text: Remove SSH key {key} from server {server} in {organization}.
        slots:
          key: path.key
          server: path.server
          organization: path.organization
      - text: Revoke authorized key {key} on server {server}.
        slots:
          key: path.key
          server: path.server
      method: generated
      generated: '2026-10-01'
- target: $.paths['/orgs/{organization}/servers/{server}/key'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a server's own public SSH key
      effect: read
      questions:
      - What is my server's public key so I can add it to my git host as a deploy key?
      - Where do I find the public SSH key a server uses?
      instructions:
      - text: Show the public key of server {server} in {organization}.
        slots:
          server: path.server
          organization: path.organization
      - text: Get server {server}'s own public SSH key.
        slots:
          server: path.server
      method: generated
      generated: '2026-10-01'
- target: $.paths['/orgs/{organization}/servers/{server}/key'].put
  update:
    x-apievangelist-phrasing:
      intent: Regenerate a server's SSH key pair
      effect: destructive
      questions:
      - How do I rotate a server's own SSH key pair?
      - Can I generate a fresh public key for a server before unarchiving it?
      instructions:
      - text: Regenerate the SSH key pair of server {server} in {organization}.
        slots:
          server: path.server
          organization: path.organization
      - text: Rotate server {server}'s key pair and give me the new public key.
        slots:
          server: path.server
      method: generated
      generated: '2026-10-01'