Laravel · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Laravel Cloud Object Storage Buckets API

6 actions 6 updates phrasing extends openapi/laravel-object-storage-buckets-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['/buckets'].get
$.paths['/buckets'].post
$.paths['/buckets/{filesystem}'].get
$.paths['/buckets/{filesystem}'].delete
$.paths['/buckets/{filesystem}'].patch

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 Laravel Cloud Object Storage Buckets API
  version: 1.0.0
extends: openapi/laravel-object-storage-buckets-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['/buckets'].get
  update:
    x-apievangelist-phrasing:
      intent: List object storage buckets
      effect: read
      questions:
      - Which object storage buckets does my organization have?
      - Can I list only my public buckets?
      instructions:
      - text: List my object storage buckets.
      - text: Show buckets with visibility {visibility}.
        slots:
          visibility: query.filter[visibility]
      method: generated
      generated: '2026-10-01'
- target: $.paths['/buckets'].post
  update:
    x-apievangelist-phrasing:
      intent: Create an object storage bucket
      effect: write
      questions:
      - How do I create a storage bucket for user uploads?
      - Does a new bucket come with an access key, and can I choose its permissions?
      - Can I set the data jurisdiction and CORS origins when creating a bucket?
      instructions:
      - text: Create a {visibility} bucket named {name} in jurisdiction {jurisdiction} with key {key_name} ({key_permission}).
        slots:
          visibility: requestBody.visibility
          name: requestBody.name
          jurisdiction: requestBody.jurisdiction
          key_name: requestBody.key_name
          key_permission: requestBody.key_permission
      - text: Make bucket {name}, {visibility}, jurisdiction {jurisdiction}, allowing origins {allowed_origins}, first key {key_name} with {key_permission} access.
        slots:
          name: requestBody.name
          visibility: requestBody.visibility
          jurisdiction: requestBody.jurisdiction
          allowed_origins: requestBody.allowed_origins
          key_name: requestBody.key_name
          key_permission: requestBody.key_permission
      method: generated
      generated: '2026-10-01'
- target: $.paths['/buckets/{filesystem}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an object storage bucket
      effect: read
      questions:
      - What visibility and status does a specific bucket have?
      - Can I look up one storage bucket by ID?
      instructions:
      - text: Show bucket {filesystem}.
        slots:
          filesystem: path.filesystem
      - text: Get the details of object storage bucket {filesystem}.
        slots:
          filesystem: path.filesystem
      method: generated
      generated: '2026-10-01'
- target: $.paths['/buckets/{filesystem}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an object storage bucket
      effect: destructive
      questions:
      - How do I delete a storage bucket I no longer need?
      - Can an object storage bucket be removed through the API?
      instructions:
      - text: Delete bucket {filesystem}.
        slots:
          filesystem: path.filesystem
      - text: Remove the object storage bucket {filesystem} permanently.
        slots:
          filesystem: path.filesystem
      method: generated
      generated: '2026-10-01'
- target: $.paths['/buckets/{filesystem}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Change a bucket's visibility or CORS
      effect: write
      questions:
      - Can I make an existing private bucket public?
      - How do I update the allowed CORS origins on a bucket?
      instructions:
      - text: Set bucket {filesystem} visibility to {visibility}.
        slots:
          filesystem: path.filesystem
          visibility: requestBody.visibility
      - text: Allow origins {allowed_origins} on bucket {filesystem}.
        slots:
          filesystem: path.filesystem
          allowed_origins: requestBody.allowed_origins
      - text: Rename bucket {filesystem} to {name}.
        slots:
          filesystem: path.filesystem
          name: requestBody.name
      method: generated
      generated: '2026-10-01'