# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Forge Security Rules API
  version: 1.0.0
extends: openapi/laravel-security-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: 5
- target: $.paths['/orgs/{organization}/servers/{server}/sites/{site}/security-rules'].get
  update:
    x-apievangelist-phrasing:
      intent: List a site's password protection rules
      effect: read
      questions:
      - Which paths on my site are password protected?
      - Can I filter a site's security rules by path or status?
      instructions:
      - text: List the security rules for site {site} on server {server} in {organization}.
        slots:
          site: path.site
          server: path.server
          organization: path.organization
      - text: Show security rules on site {site} ({server}, {organization}) that protect path {path}.
        slots:
          site: path.site
          server: path.server
          organization: path.organization
          path: query.filter[path]
      method: generated
      generated: '2026-10-01'
- target: $.paths['/orgs/{organization}/servers/{server}/sites/{site}/security-rules'].post
  update:
    x-apievangelist-phrasing:
      intent: Password-protect a path on a site
      effect: write
      questions:
      - How do I put basic auth in front of my staging site?
      - Can I protect only one path of a site with a username and password?
      instructions:
      - text: Create security rule {name} on site {site} on {server} in {organization} with credentials {credentials}.
        slots:
          name: requestBody.name
          site: path.site
          server: path.server
          organization: path.organization
          credentials: requestBody.credentials
      - text: Password-protect {path} on site {site} ({server}, {organization}) as rule {name} using {credentials}.
        slots:
          path: requestBody.path
          site: path.site
          server: path.server
          organization: path.organization
          name: requestBody.name
          credentials: requestBody.credentials
      method: generated
      generated: '2026-10-01'
- target: $.paths['/orgs/{organization}/servers/{server}/sites/{site}/security-rules/{securityRule}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a site security rule
      effect: read
      questions:
      - What path and users does one security rule protect?
      - Can I look up a single password protection rule by ID?
      instructions:
      - text: Show security rule {securityRule} on site {site} on server {server} in {organization}.
        slots:
          securityRule: path.securityRule
          site: path.site
          server: path.server
          organization: path.organization
      - text: Get details of protection rule {securityRule} for site {site}, server {server}, org {organization}.
        slots:
          securityRule: path.securityRule
          site: path.site
          server: path.server
          organization: path.organization
      method: generated
      generated: '2026-10-01'
- target: $.paths['/orgs/{organization}/servers/{server}/sites/{site}/security-rules/{securityRule}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a site security rule
      effect: write
      questions:
      - Can I change the credentials on an existing password protection rule?
      - How do I move an existing security rule to a different path?
      instructions:
      - text: Update security rule {securityRule} on site {site} ({server}, {organization}) to name {name} with credentials {credentials}.
        slots:
          securityRule: path.securityRule
          site: path.site
          server: path.server
          organization: path.organization
          name: requestBody.name
          credentials: requestBody.credentials
      - text: Point existing rule {securityRule} ({name}) on site {site}, server {server}, org {organization} at path {path} with {credentials}.
        slots:
          securityRule: path.securityRule
          name: requestBody.name
          site: path.site
          server: path.server
          organization: path.organization
          path: requestBody.path
          credentials: requestBody.credentials
      method: generated
      generated: '2026-10-01'
- target: $.paths['/orgs/{organization}/servers/{server}/sites/{site}/security-rules/{securityRule}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove a site security rule
      effect: destructive
      questions:
      - How do I take password protection off a site?
      - Can I delete one security rule and keep the others?
      instructions:
      - text: Delete security rule {securityRule} from site {site} on server {server} in {organization}.
        slots:
          securityRule: path.securityRule
          site: path.site
          server: path.server
          organization: path.organization
      - text: Remove password protection rule {securityRule} on site {site}, server {server}, org {organization}.
        slots:
          securityRule: path.securityRule
          site: path.site
          server: path.server
          organization: path.organization
      method: generated
      generated: '2026-10-01'