Laravel · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Laravel Cloud Database Clusters API

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

$.info
$.paths['/databases/types'].get
$.paths['/databases/clusters'].get
$.paths['/databases/clusters'].post
$.paths['/databases/clusters/{database}'].get
$.paths['/databases/clusters/{database}'].delete
$.paths['/databases/clusters/{database}'].patch
$.paths['/databases/clusters/{database}/metrics'].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 Laravel Cloud Database Clusters API
  version: 1.0.0
extends: openapi/laravel-database-clusters-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: 7
- target: $.paths['/databases/types'].get
  update:
    x-apievangelist-phrasing:
      intent: List available database types
      effect: read
      questions:
      - What kinds of managed databases can I create in Laravel Cloud?
      - Which configuration options does each database type accept?
      instructions:
      - text: List the available database types.
      - text: Show the configuration schema for every database type.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/databases/clusters'].get
  update:
    x-apievangelist-phrasing:
      intent: List my database clusters
      effect: read
      questions:
      - Which database clusters does my organization have?
      - Can I filter database clusters by type, region or status?
      instructions:
      - text: List my database clusters.
      - text: Show database clusters of type {type} in region {region}.
        slots:
          type: query.filter[type]
          region: query.filter[region]
      method: generated
      generated: '2026-10-01'
- target: $.paths['/databases/clusters'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a database cluster
      effect: write
      questions:
      - How do I create a managed database cluster?
      - Does a new database cluster come with a default database?
      instructions:
      - text: Create a {type} database cluster named {name} in {region} with config {config}.
        slots:
          type: requestBody.type
          name: requestBody.name
          region: requestBody.region
          config: requestBody.config
      - text: Provision database cluster {name} of type {type} in region {region} using {config}.
        slots:
          name: requestBody.name
          type: requestBody.type
          region: requestBody.region
          config: requestBody.config
      method: generated
      generated: '2026-10-01'
- target: $.paths['/databases/clusters/{database}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a database cluster
      effect: read
      questions:
      - What is the status and configuration of a database cluster?
      - Can I see the databases inside a specific cluster?
      instructions:
      - text: Show database cluster {database}.
        slots:
          database: path.database
      - text: Get cluster {database} including {include}.
        slots:
          database: path.database
          include: query.include
      method: generated
      generated: '2026-10-01'
- target: $.paths['/databases/clusters/{database}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a database cluster
      effect: destructive
      questions:
      - How do I delete a database cluster?
      - Can I permanently remove a managed database cluster?
      instructions:
      - text: Delete database cluster {database}.
        slots:
          database: path.database
      - text: Permanently remove cluster {database}.
        slots:
          database: path.database
      method: generated
      generated: '2026-10-01'
- target: $.paths['/databases/clusters/{database}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Change a database cluster's configuration
      effect: write
      questions:
      - Can I resize or reconfigure an existing database cluster?
      - How do I change the config of a database cluster?
      instructions:
      - text: Update database cluster {database} with config {config}.
        slots:
          database: path.database
          config: requestBody.config
      - text: Reconfigure cluster {database} to {config}.
        slots:
          database: path.database
          config: requestBody.config
      method: generated
      generated: '2026-10-01'
- target: $.paths['/databases/clusters/{database}/metrics'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a database cluster's metrics
      effect: read
      questions:
      - How busy is my database cluster?
      - Can I see database cluster metrics over a time period?
      instructions:
      - text: Show metrics for database cluster {database}.
        slots:
          database: path.database
      - text: Get metrics for cluster {database} over period {period}.
        slots:
          database: path.database
          period: query.period
      method: generated
      generated: '2026-10-01'