Laravel · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Forge Providers API

9 actions 9 updates phrasing extends openapi/laravel-providers-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 9

$.info
$.paths['/providers'].get
$.paths['/providers/{provider}'].get
$.paths['/providers/{provider}/sizes'].get
$.paths['/providers/{provider}/sizes/{providerSize}'].get
$.paths['/providers/{provider}/regions'].get
$.paths['/providers/{provider}/regions/{providerRegion}'].get
$.paths['/providers/{provider}/regions/{providerRegion}/sizes'].get
$.paths['/providers/{provider}/regions/{providerRegion}/sizes/{providerSize}'].get

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 Providers API
  version: 1.0.0
extends: openapi/laravel-providers-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: 8
- target: $.paths['/providers'].get
  update:
    x-apievangelist-phrasing:
      intent: List supported server providers
      effect: read
      questions:
      - Which cloud providers can Forge create servers on?
      - What hosting providers are supported for new servers?
      instructions:
      - text: List the supported server providers.
      - text: Show the next page of server providers after cursor {cursor}.
        slots:
          cursor: query.page[cursor]
      method: generated
      generated: '2026-10-01'
- target: $.paths['/providers/{provider}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a server provider
      effect: read
      questions:
      - What details are available for one server provider?
      - Is a particular cloud provider supported?
      instructions:
      - text: Show server provider {provider}.
        slots:
          provider: path.provider
      - text: Get details for hosting provider {provider}.
        slots:
          provider: path.provider
      method: generated
      generated: '2026-10-01'
- target: $.paths['/providers/{provider}/sizes'].get
  update:
    x-apievangelist-phrasing:
      intent: List a provider's server sizes
      effect: read
      questions:
      - What server sizes can I choose from at a provider?
      - Which instance plans does a provider offer across all regions?
      instructions:
      - text: List server sizes offered by provider {provider}.
        slots:
          provider: path.provider
      - text: Show every plan size available at {provider}.
        slots:
          provider: path.provider
      method: generated
      generated: '2026-10-01'
- target: $.paths['/providers/{provider}/sizes/{providerSize}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a provider server size
      effect: read
      questions:
      - How much CPU and memory does a provider size have?
      - What are the specs of one server plan at a provider?
      instructions:
      - text: Show size {providerSize} at provider {provider}.
        slots:
          providerSize: path.providerSize
          provider: path.provider
      - text: Get the specs of plan {providerSize} from {provider}.
        slots:
          providerSize: path.providerSize
          provider: path.provider
      method: generated
      generated: '2026-10-01'
- target: $.paths['/providers/{provider}/regions'].get
  update:
    x-apievangelist-phrasing:
      intent: List a provider's regions
      effect: read
      questions:
      - Which regions can I deploy a server into at a provider?
      - What data center locations does a provider offer?
      instructions:
      - text: List regions for provider {provider}.
        slots:
          provider: path.provider
      - text: Show the data center regions available at {provider}.
        slots:
          provider: path.provider
      method: generated
      generated: '2026-10-01'
- target: $.paths['/providers/{provider}/regions/{providerRegion}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a provider region
      effect: read
      questions:
      - What details are there about a specific provider region?
      - Is a given region available at my provider?
      instructions:
      - text: Show region {providerRegion} of provider {provider}.
        slots:
          providerRegion: path.providerRegion
          provider: path.provider
      - text: Get details for data center {providerRegion} at {provider}.
        slots:
          providerRegion: path.providerRegion
          provider: path.provider
      method: generated
      generated: '2026-10-01'
- target: $.paths['/providers/{provider}/regions/{providerRegion}/sizes'].get
  update:
    x-apievangelist-phrasing:
      intent: List server sizes available in a region
      effect: read
      questions:
      - Which server sizes are offered in one particular region?
      - Can I get a server plan in a specific region at my provider?
      instructions:
      - text: List sizes available in region {providerRegion} of provider {provider}.
        slots:
          providerRegion: path.providerRegion
          provider: path.provider
      - text: Show plans I can launch in {providerRegion} at {provider}.
        slots:
          providerRegion: path.providerRegion
          provider: path.provider
      method: generated
      generated: '2026-10-01'
- target: $.paths['/providers/{provider}/regions/{providerRegion}/sizes/{providerSize}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a server size within a region
      effect: read
      questions:
      - Is a specific server size offered in a given region?
      - What does one region-specific size look like at a provider?
      instructions:
      - text: Show size {providerSize} in region {providerRegion} at {provider}.
        slots:
          providerSize: path.providerSize
          providerRegion: path.providerRegion
          provider: path.provider
      - text: Check plan {providerSize} availability in {providerRegion} of {provider}.
        slots:
          providerSize: path.providerSize
          providerRegion: path.providerRegion
          provider: path.provider
      method: generated
      generated: '2026-10-01'