Laravel · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Forge Storage Providers API

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

$.info
$.paths['/orgs/{organization}/storage-providers'].get
$.paths['/orgs/{organization}/storage-providers'].post
$.paths['/orgs/{organization}/storage-providers/{storageConfiguration}'].get
$.paths['/orgs/{organization}/storage-providers/{storageConfiguration}'].put
$.paths['/orgs/{organization}/storage-providers/{storageConfiguration}'].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 Storage Providers API
  version: 1.0.0
extends: openapi/laravel-storage-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: 5
- target: $.paths['/orgs/{organization}/storage-providers'].get
  update:
    x-apievangelist-phrasing:
      intent: List backup storage providers
      effect: read
      questions:
      - Which storage destinations has my organization configured?
      - Can I filter my storage providers by provider type?
      instructions:
      - text: List storage providers in organization {organization}.
        slots:
          organization: path.organization
      - text: Show storage providers of type {provider} in {organization}.
        slots:
          provider: query.filter[provider]
          organization: path.organization
      method: generated
      generated: '2026-10-01'
- target: $.paths['/orgs/{organization}/storage-providers'].post
  update:
    x-apievangelist-phrasing:
      intent: Add a storage provider
      effect: write
      questions:
      - How do I connect an S3-compatible bucket as a storage provider?
      - Can I use a custom endpoint and directory for a new storage provider?
      instructions:
      - text: Create storage provider {name} using {provider} in {organization}.
        slots:
          name: requestBody.name
          provider: requestBody.provider
          organization: path.organization
      - text: Add {provider} storage named {name} on bucket {bucket} in region {region}.
        slots:
          provider: requestBody.provider
          name: requestBody.name
          bucket: requestBody.bucket
          region: requestBody.region
      method: generated
      generated: '2026-10-01'
- target: $.paths['/orgs/{organization}/storage-providers/{storageConfiguration}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a storage provider
      effect: read
      questions:
      - What bucket and region does one of our storage providers point to?
      - Can I inspect a single storage provider's settings?
      instructions:
      - text: Show storage provider {storageConfiguration} in {organization}.
        slots:
          storageConfiguration: path.storageConfiguration
          organization: path.organization
      - text: Get the settings of storage provider {storageConfiguration}.
        slots:
          storageConfiguration: path.storageConfiguration
      method: generated
      generated: '2026-10-01'
- target: $.paths['/orgs/{organization}/storage-providers/{storageConfiguration}'].put
  update:
    x-apievangelist-phrasing:
      intent: Change a storage provider's settings
      effect: write
      questions:
      - How do I rotate the access keys on a storage provider?
      - Can I point an existing storage provider at a different bucket?
      instructions:
      - text: 'Update storage provider {storageConfiguration} in {organization}: name {name}, provider {provider}.'
        slots:
          storageConfiguration: path.storageConfiguration
          organization: path.organization
          name: requestBody.name
          provider: requestBody.provider
      - text: Switch storage provider {storageConfiguration} ({name}, {provider}) to bucket {bucket}.
        slots:
          storageConfiguration: path.storageConfiguration
          name: requestBody.name
          provider: requestBody.provider
          bucket: requestBody.bucket
      method: generated
      generated: '2026-10-01'
- target: $.paths['/orgs/{organization}/storage-providers/{storageConfiguration}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a storage provider
      effect: destructive
      questions:
      - How do I remove a storage provider we no longer use?
      - Can I delete a storage destination from my organization?
      instructions:
      - text: Delete storage provider {storageConfiguration} from {organization}.
        slots:
          storageConfiguration: path.storageConfiguration
          organization: path.organization
      - text: Remove storage destination {storageConfiguration}.
        slots:
          storageConfiguration: path.storageConfiguration
      method: generated
      generated: '2026-10-01'