Laravel · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Forge Redirect Rules API

5 actions 5 updates phrasing extends openapi/laravel-redirect-rules-api-openapi.yml
Generated by API Evangelist Written by API Evangelist tooling for Laravel's API. It is a proposal applied on top of the contract, not a document Laravel publishes.
View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 5

$.info
$.paths['/orgs/{organization}/servers/{server}/sites/{site}/redirect-rules'].get
$.paths['/orgs/{organization}/servers/{server}/sites/{site}/redirect-rules'].post
$.paths['/orgs/{organization}/servers/{server}/sites/{site}/redirect-rules/{redirectRule}'].get
$.paths['/orgs/{organization}/servers/{server}/sites/{site}/redirect-rules/{redirectRule}'].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 Forge Redirect Rules API
  version: 1.0.0
extends: openapi/laravel-redirect-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}/sites/{site}/redirect-rules'].get
  update:
    x-apievangelist-phrasing:
      intent: List a site's redirect rules
      effect: read
      questions:
      - Which redirects are configured on my site?
      - Can I filter a site's redirects by type or status?
      instructions:
      - text: List redirect rules for site {site} on server {server} in {organization}.
        slots:
          site: path.site
          server: path.server
          organization: path.organization
      - text: Show redirects on site {site} of server {server} that come from {from}.
        slots:
          site: path.site
          server: path.server
          from: query.filter[from]
      method: generated
      generated: '2026-10-01'
- target: $.paths['/orgs/{organization}/servers/{server}/sites/{site}/redirect-rules'].post
  update:
    x-apievangelist-phrasing:
      intent: Add a redirect rule to a site
      effect: write
      questions:
      - How do I redirect an old URL path to a new one on my site?
      - Can I choose a permanent or temporary redirect?
      instructions:
      - text: Redirect {from} to {to} as a {type} redirect on site {site} of server {server} in {organization}.
        slots:
          from: requestBody.from
          to: requestBody.to
          type: requestBody.type
          site: path.site
          server: path.server
          organization: path.organization
      - text: Add a {type} redirect rule from {from} to {to} on site {site}.
        slots:
          type: requestBody.type
          from: requestBody.from
          to: requestBody.to
          site: path.site
      method: generated
      generated: '2026-10-01'
- target: $.paths['/orgs/{organization}/servers/{server}/sites/{site}/redirect-rules/{redirectRule}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a site redirect rule
      effect: read
      questions:
      - What are the details of one redirect rule on my site?
      - Has a specific redirect finished being applied?
      instructions:
      - text: Show redirect rule {redirectRule} on site {site} of server {server} in {organization}.
        slots:
          redirectRule: path.redirectRule
          site: path.site
          server: path.server
          organization: path.organization
      - text: Get redirect {redirectRule} for site {site}.
        slots:
          redirectRule: path.redirectRule
          site: path.site
      method: generated
      generated: '2026-10-01'
- target: $.paths['/orgs/{organization}/servers/{server}/sites/{site}/redirect-rules/{redirectRule}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove a site redirect rule
      effect: destructive
      questions:
      - How do I delete a redirect from my site?
      - Can I stop a URL from redirecting anymore?
      instructions:
      - text: Delete redirect rule {redirectRule} from site {site} on server {server} in {organization}.
        slots:
          redirectRule: path.redirectRule
          site: path.site
          server: path.server
          organization: path.organization
      - text: Remove redirect {redirectRule} from site {site}.
        slots:
          redirectRule: path.redirectRule
          site: path.site
      method: generated
      generated: '2026-10-01'