Laravel · OpenAPI Overlay 1.0.0
API Evangelist conversational phrasing for Laravel Cloud Caches API
8 actions
8 updates
phrasing
extends
openapi/laravel-caches-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.
What the actions change
x-apievangelist-phrasing
Targets 8
$.info
$.paths['/caches/types'].get
$.paths['/caches'].get
$.paths['/caches'].post
$.paths['/caches/{cache}'].get
$.paths['/caches/{cache}'].delete
$.paths['/caches/{cache}'].patch
$.paths['/caches/{cache}/metrics'].get
OpenAPI Overlay
# 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 Caches API
version: 1.0.0
extends: openapi/laravel-caches-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['/caches/types'].get
update:
x-apievangelist-phrasing:
intent: List available cache types and options
effect: read
questions:
- What kinds of cache can I create on Laravel Cloud?
- Which sizes, regions and eviction options does each cache type support?
instructions:
- text: List the available cache types with their configuration options.
- text: Show me which cache types and settings I can choose from.
method: generated
generated: '2026-10-01'
- target: $.paths['/caches'].get
update:
x-apievangelist-phrasing:
intent: List my organization's caches
effect: read
questions:
- Which caches does my organization have running?
- Can I filter my caches by type, region or status?
instructions:
- text: List all my caches.
- text: Show caches in region {region}.
slots:
region: query.filter[region]
- text: Find caches of type {type} with status {status}.
slots:
type: query.filter[type]
status: query.filter[status]
method: generated
generated: '2026-10-01'
- target: $.paths['/caches'].post
update:
x-apievangelist-phrasing:
intent: Create a cache
effect: write
questions:
- How do I spin up a new Redis-compatible cache in a region?
- Can a new cache hibernate when it's idle?
instructions:
- text: Create a {type} cache named {name} in {region} with size {size}, auto-upgrade {auto_upgrade_enabled}, public {is_public}.
slots:
type: requestBody.type
name: requestBody.name
region: requestBody.region
size: requestBody.size
auto_upgrade_enabled: requestBody.auto_upgrade_enabled
is_public: requestBody.is_public
- text: Spin up cache {name} ({type}, {size}) in {region}, private {is_public}, auto-upgrade {auto_upgrade_enabled}, eviction {eviction_policy}.
slots:
name: requestBody.name
type: requestBody.type
size: requestBody.size
region: requestBody.region
is_public: requestBody.is_public
auto_upgrade_enabled: requestBody.auto_upgrade_enabled
eviction_policy: requestBody.eviction_policy
method: generated
generated: '2026-10-01'
- target: $.paths['/caches/{cache}'].get
update:
x-apievangelist-phrasing:
intent: Get a cache's details
effect: read
questions:
- What size and region is a specific cache in?
- Can I look up a single cache by ID?
instructions:
- text: Show cache {cache}.
slots:
cache: path.cache
- text: Get the details and status of cache {cache}.
slots:
cache: path.cache
method: generated
generated: '2026-10-01'
- target: $.paths['/caches/{cache}'].delete
update:
x-apievangelist-phrasing:
intent: Delete a cache
effect: destructive
questions:
- How do I tear down a cache I no longer need?
- Can I delete a cache permanently?
instructions:
- text: Delete cache {cache}.
slots:
cache: path.cache
- text: Tear down the cache {cache} for good.
slots:
cache: path.cache
method: generated
generated: '2026-10-01'
- target: $.paths['/caches/{cache}'].patch
update:
x-apievangelist-phrasing:
intent: Resize or reconfigure a cache
effect: write
questions:
- Can I resize an existing cache without recreating it?
- How do I change a cache's eviction policy or hibernation timeout?
instructions:
- text: Resize cache {cache} to {size}.
slots:
cache: path.cache
size: requestBody.size
- text: Set cache {cache} eviction policy to {eviction_policy}.
slots:
cache: path.cache
eviction_policy: requestBody.eviction_policy
- text: Let cache {cache} hibernate after {hibernation_timeout} idle.
slots:
cache: path.cache
hibernation_timeout: requestBody.hibernation_timeout
method: generated
generated: '2026-10-01'
- target: $.paths['/caches/{cache}/metrics'].get
update:
x-apievangelist-phrasing:
intent: Get usage metrics for a cache
effect: read
questions:
- How much memory and traffic is my cache using?
- Can I pull cache metrics for a specific time period?
instructions:
- text: Show metrics for cache {cache}.
slots:
cache: path.cache
- text: Get cache {cache} metrics over the last {period}.
slots:
cache: path.cache
period: query.period
method: generated
generated: '2026-10-01'