Laravel · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Laravel Cloud Database Snapshots API

5 actions 5 updates phrasing extends openapi/laravel-database-snapshots-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 5

$.info
$.paths['/databases/clusters/{database}/snapshots'].get
$.paths['/databases/clusters/{database}/snapshots'].post
$.paths['/database-snapshots/{databaseSnapshot}'].get
$.paths['/database-snapshots/{databaseSnapshot}'].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 Laravel Cloud Database Snapshots API
  version: 1.0.0
extends: openapi/laravel-database-snapshots-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: 4
- target: $.paths['/databases/clusters/{database}/snapshots'].get
  update:
    x-apievangelist-phrasing:
      intent: List snapshots of a database cluster
      effect: read
      questions:
      - Which snapshots exist for my database cluster?
      - Can I see every point-in-time snapshot taken of a cluster?
      instructions:
      - text: List snapshots for database cluster {database}.
        slots:
          database: path.database
      - text: Show all snapshots taken of cluster {database}.
        slots:
          database: path.database
      method: generated
      generated: '2026-10-01'
- target: $.paths['/databases/clusters/{database}/snapshots'].post
  update:
    x-apievangelist-phrasing:
      intent: Take a manual database cluster snapshot
      effect: write
      questions:
      - How do I snapshot my database cluster before a big change?
      - Can I give a manual snapshot a name and description?
      instructions:
      - text: Take a snapshot of cluster {database} named {name}.
        slots:
          database: path.database
          name: requestBody.name
      - text: Snapshot cluster {database} as {name} with note {description}.
        slots:
          database: path.database
          name: requestBody.name
          description: requestBody.description
      method: generated
      generated: '2026-10-01'
- target: $.paths['/database-snapshots/{databaseSnapshot}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a database snapshot
      effect: read
      questions:
      - What is the status of a particular database snapshot?
      - Can I look up one snapshot by its ID?
      instructions:
      - text: Show database snapshot {databaseSnapshot}.
        slots:
          databaseSnapshot: path.databaseSnapshot
      - text: Get the details of snapshot {databaseSnapshot}.
        slots:
          databaseSnapshot: path.databaseSnapshot
      method: generated
      generated: '2026-10-01'
- target: $.paths['/database-snapshots/{databaseSnapshot}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a database snapshot
      effect: destructive
      questions:
      - How do I delete an old database snapshot?
      - Can I remove a snapshot I took manually?
      instructions:
      - text: Delete database snapshot {databaseSnapshot}.
        slots:
          databaseSnapshot: path.databaseSnapshot
      - text: Remove snapshot {databaseSnapshot} permanently.
        slots:
          databaseSnapshot: path.databaseSnapshot
      method: generated
      generated: '2026-10-01'