# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Forge Firewall Rules API
  version: 1.0.0
extends: openapi/laravel-firewall-rules-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['/orgs/{organization}/servers/{server}/firewall-rules'].get
  update:
    x-apievangelist-phrasing:
      intent: List a server's firewall rules
      effect: read
      questions:
      - Which ports are open in my server's firewall?
      - Can I filter firewall rules by IP address or port?
      instructions:
      - text: List the firewall rules on server {server} in {organization}.
        slots:
          server: path.server
          organization: path.organization
      - text: Find firewall rules on server {server} ({organization}) for port {port}.
        slots:
          server: path.server
          organization: path.organization
          port: query.filter[port]
      method: generated
      generated: '2026-10-01'
- target: $.paths['/orgs/{organization}/servers/{server}/firewall-rules'].post
  update:
    x-apievangelist-phrasing:
      intent: Open or block a port on a server
      effect: write
      questions:
      - How do I open a port on my server's firewall?
      - Can I allow a port only from a specific IP address?
      instructions:
      - text: Add a {type} firewall rule {name} on server {server} in {organization} for port {port}.
        slots:
          type: requestBody.type
          name: requestBody.name
          server: path.server
          organization: path.organization
          port: requestBody.port
      - text: Create rule {name} ({type}) on server {server}, {organization}, for port {port} from IP {ip_address}.
        slots:
          name: requestBody.name
          type: requestBody.type
          server: path.server
          organization: path.organization
          port: requestBody.port
          ip_address: requestBody.ip_address
      method: generated
      generated: '2026-10-01'
- target: $.paths['/orgs/{organization}/servers/{server}/firewall-rules/{rule}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one firewall rule on a server
      effect: read
      questions:
      - Which port and IP does a specific firewall rule cover?
      - Can I check whether a firewall rule has been applied yet?
      instructions:
      - text: Show firewall rule {rule} on server {server} in {organization}.
        slots:
          rule: path.rule
          server: path.server
          organization: path.organization
      - text: Get the details of rule {rule} on server {server}, org {organization}.
        slots:
          rule: path.rule
          server: path.server
          organization: path.organization
      method: generated
      generated: '2026-10-01'
- target: $.paths['/orgs/{organization}/servers/{server}/firewall-rules/{rule}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove a firewall rule from a server
      effect: destructive
      questions:
      - How do I close a port I opened earlier?
      - Can I delete a single firewall rule from a server?
      instructions:
      - text: Delete firewall rule {rule} from server {server} in {organization}.
        slots:
          rule: path.rule
          server: path.server
          organization: path.organization
      - text: Remove rule {rule} on server {server}, org {organization}.
        slots:
          rule: path.rule
          server: path.server
          organization: path.organization
      method: generated
      generated: '2026-10-01'