Laravel · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Laravel Cloud Applications API

8 actions 8 updates phrasing extends openapi/laravel-applications-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['/applications'].get
$.paths['/applications'].post
$.paths['/applications/{application}'].get
$.paths['/applications/{application}'].delete
$.paths['/applications/{application}'].patch
$.paths['/applications/{application}/avatar'].post
$.paths['/applications/{application}/avatar'].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 Applications API
  version: 1.0.0
extends: openapi/laravel-applications-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['/applications'].get
  update:
    x-apievangelist-phrasing:
      intent: List my Cloud applications
      effect: read
      questions:
      - What applications does my Laravel Cloud organization have?
      - Can I filter my applications by region or slug?
      instructions:
      - text: List all applications in my organization.
      - text: Show applications deployed in region {region}.
        slots:
          region: query.filter[region]
      - text: Find the application named {name}.
        slots:
          name: query.filter[name]
      method: generated
      generated: '2026-10-01'
- target: $.paths['/applications'].post
  update:
    x-apievangelist-phrasing:
      intent: Create an application from a repository
      effect: write
      questions:
      - How do I create a new application from my Git repository?
      - Can I choose the region an application runs in when I create it?
      instructions:
      - text: Create an application named {name} from repository {repository} in region {region}.
        slots:
          name: requestBody.name
          repository: requestBody.repository
          region: requestBody.region
      - text: Set up app {name} in {region} using {repository} from {source_control_provider_type}.
        slots:
          name: requestBody.name
          region: requestBody.region
          repository: requestBody.repository
          source_control_provider_type: requestBody.source_control_provider_type
      method: generated
      generated: '2026-10-01'
- target: $.paths['/applications/{application}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an application
      effect: read
      questions:
      - What are the details of one of my applications?
      - Can I include an application's environments when I fetch it?
      instructions:
      - text: Show application {application}.
        slots:
          application: path.application
      - text: Get application {application} including {include}.
        slots:
          application: path.application
          include: query.include
      method: generated
      generated: '2026-10-01'
- target: $.paths['/applications/{application}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an application and its environments
      effect: destructive
      questions:
      - What happens to the environments when I delete an application?
      - How do I permanently remove an application?
      instructions:
      - text: Delete application {application} and all of its environments.
        slots:
          application: path.application
      - text: Permanently remove app {application}.
        slots:
          application: path.application
      method: generated
      generated: '2026-10-01'
- target: $.paths['/applications/{application}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update an application's settings
      effect: write
      questions:
      - Can I rename an application or change its slug?
      - Is it possible to change which environment is an app's default?
      instructions:
      - text: Rename application {application} to {name}.
        slots:
          application: path.application
          name: requestBody.name
      - text: Set the default environment of application {application} to {default_environment_id}.
        slots:
          application: path.application
          default_environment_id: requestBody.default_environment_id
      - text: Post notifications for application {application} to chat channel {slack_channel}.
        slots:
          application: path.application
          slack_channel: requestBody.slack_channel
      method: generated
      generated: '2026-10-01'
- target: $.paths['/applications/{application}/avatar'].post
  update:
    x-apievangelist-phrasing:
      intent: Upload an application's avatar
      effect: write
      questions:
      - How do I add a logo or avatar to an application?
      - Can I replace an application's existing avatar image?
      instructions:
      - text: Upload {avatar} as the avatar for application {application}.
        slots:
          avatar: requestBody.avatar
          application: path.application
      - text: Replace application {application}'s avatar image with {avatar}.
        slots:
          application: path.application
          avatar: requestBody.avatar
      method: generated
      generated: '2026-10-01'
- target: $.paths['/applications/{application}/avatar'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove an application's avatar
      effect: destructive
      questions:
      - Can I remove the avatar from an application?
      - What do I call to clear an app's logo image?
      instructions:
      - text: Remove the avatar from application {application}.
        slots:
          application: path.application
      - text: Clear app {application}'s logo image.
        slots:
          application: path.application
      method: generated
      generated: '2026-10-01'