Laravel · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Laravel Cloud Bucket Keys API

6 actions 6 updates phrasing extends openapi/laravel-bucket-keys-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/{filesystem}/keys'].get
$.paths['/buckets/{filesystem}/keys'].post
$.paths['/bucket-keys/{filesystemKey}'].get
$.paths['/bucket-keys/{filesystemKey}'].delete
$.paths['/bucket-keys/{filesystemKey}'].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 Bucket Keys API
  version: 1.0.0
extends: openapi/laravel-bucket-keys-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/{filesystem}/keys'].get
  update:
    x-apievangelist-phrasing:
      intent: List access keys for a storage bucket
      effect: read
      questions:
      - Which access keys exist for an object storage bucket?
      - Who has credentials to one of my buckets?
      instructions:
      - text: List keys for bucket {filesystem}.
        slots:
          filesystem: path.filesystem
      - text: Show access keys on bucket {filesystem} including {include}.
        slots:
          filesystem: path.filesystem
          include: query.include
      method: generated
      generated: '2026-10-01'
- target: $.paths['/buckets/{filesystem}/keys'].post
  update:
    x-apievangelist-phrasing:
      intent: Create an access key for a storage bucket
      effect: write
      questions:
      - How do I create credentials for an object storage bucket?
      - Can I create a read-only key for a bucket?
      instructions:
      - text: Create key {name} with {permission} permission on bucket {filesystem}.
        slots:
          name: requestBody.name
          permission: requestBody.permission
          filesystem: path.filesystem
      - text: Issue a new bucket key called {name} for {filesystem} with permission {permission}.
        slots:
          name: requestBody.name
          filesystem: path.filesystem
          permission: requestBody.permission
      method: generated
      generated: '2026-10-01'
- target: $.paths['/bucket-keys/{filesystemKey}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a bucket access key
      effect: read
      questions:
      - What permission does a particular bucket key have?
      - Can I look up one object storage key by its id?
      instructions:
      - text: Show bucket key {filesystemKey}.
        slots:
          filesystemKey: path.filesystemKey
      - text: Get storage key {filesystemKey} including {include}.
        slots:
          filesystemKey: path.filesystemKey
          include: query.include
      method: generated
      generated: '2026-10-01'
- target: $.paths['/bucket-keys/{filesystemKey}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a bucket access key
      effect: destructive
      questions:
      - How do I revoke an object storage key?
      - Can I delete a bucket key that leaked?
      instructions:
      - text: Delete bucket key {filesystemKey}.
        slots:
          filesystemKey: path.filesystemKey
      - text: Revoke storage key {filesystemKey}.
        slots:
          filesystemKey: path.filesystemKey
      method: generated
      generated: '2026-10-01'
- target: $.paths['/bucket-keys/{filesystemKey}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Rename a bucket access key
      effect: write
      questions:
      - Can I rename an existing object storage key?
      - How do I change the label on a bucket key?
      instructions:
      - text: Rename bucket key {filesystemKey} to {name}.
        slots:
          filesystemKey: path.filesystemKey
          name: requestBody.name
      - text: Change the name of storage key {filesystemKey} to {name}.
        slots:
          filesystemKey: path.filesystemKey
          name: requestBody.name
      method: generated
      generated: '2026-10-01'