Laravel · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Forge Nginx API

6 actions 6 updates phrasing extends openapi/laravel-nginx-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 6

$.info
$.paths['/orgs/{organization}/servers/{server}/nginx/templates'].get
$.paths['/orgs/{organization}/servers/{server}/nginx/templates'].post
$.paths['/orgs/{organization}/servers/{server}/nginx/templates/{nginxTemplate}'].get
$.paths['/orgs/{organization}/servers/{server}/nginx/templates/{nginxTemplate}'].put
$.paths['/orgs/{organization}/servers/{server}/nginx/templates/{nginxTemplate}'].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 Nginx API
  version: 1.0.0
extends: openapi/laravel-nginx-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}/nginx/templates'].get
  update:
    x-apievangelist-phrasing:
      intent: List a server's Nginx templates
      effect: read
      questions:
      - Which Nginx templates are saved on my server?
      - Can I search a server's Nginx templates by name?
      instructions:
      - text: List Nginx templates on server {server} in {organization}.
        slots:
          server: path.server
          organization: path.organization
      - text: Find Nginx templates named {name} on server {server}.
        slots:
          name: query.filter[name]
          server: path.server
      method: generated
      generated: '2026-10-01'
- target: $.paths['/orgs/{organization}/servers/{server}/nginx/templates'].post
  update:
    x-apievangelist-phrasing:
      intent: Create an Nginx template on a server
      effect: write
      questions:
      - How do I save a custom Nginx config as a template for new sites?
      - Can I add my own Nginx template to a server?
      instructions:
      - text: Create Nginx template {name} on server {server} in {organization} with content {content}.
        slots:
          name: requestBody.name
          server: path.server
          organization: path.organization
          content: requestBody.content
      - text: Save {content} as a new Nginx template called {name} on {server}.
        slots:
          content: requestBody.content
          name: requestBody.name
          server: path.server
      method: generated
      generated: '2026-10-01'
- target: $.paths['/orgs/{organization}/servers/{server}/nginx/templates/{nginxTemplate}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an Nginx template
      effect: read
      questions:
      - What does one of my server's Nginx templates contain?
      - Can I read a specific Nginx template's config?
      instructions:
      - text: Show Nginx template {nginxTemplate} on server {server} in {organization}.
        slots:
          nginxTemplate: path.nginxTemplate
          server: path.server
          organization: path.organization
      - text: Get the content of Nginx template {nginxTemplate} on {server}.
        slots:
          nginxTemplate: path.nginxTemplate
          server: path.server
      method: generated
      generated: '2026-10-01'
- target: $.paths['/orgs/{organization}/servers/{server}/nginx/templates/{nginxTemplate}'].put
  update:
    x-apievangelist-phrasing:
      intent: Edit an Nginx template
      effect: write
      questions:
      - How do I change an existing Nginx template on my server?
      - Can I rename an Nginx template and replace its content?
      instructions:
      - text: Update Nginx template {nginxTemplate} on server {server} in {organization} to name {name} and content {content}.
        slots:
          nginxTemplate: path.nginxTemplate
          server: path.server
          organization: path.organization
          name: requestBody.name
          content: requestBody.content
      - text: Replace template {nginxTemplate} on {server} with {content}, named {name}.
        slots:
          nginxTemplate: path.nginxTemplate
          server: path.server
          content: requestBody.content
          name: requestBody.name
      method: generated
      generated: '2026-10-01'
- target: $.paths['/orgs/{organization}/servers/{server}/nginx/templates/{nginxTemplate}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an Nginx template
      effect: destructive
      questions:
      - How do I remove an Nginx template I no longer use?
      - Can I delete a custom Nginx template from a server?
      instructions:
      - text: Delete Nginx template {nginxTemplate} from server {server} in {organization}.
        slots:
          nginxTemplate: path.nginxTemplate
          server: path.server
          organization: path.organization
      - text: Remove template {nginxTemplate} from {server}.
        slots:
          nginxTemplate: path.nginxTemplate
          server: path.server
      method: generated
      generated: '2026-10-01'