# 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 Instances API
  version: 1.0.0
extends: openapi/laravel-instances-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: 13
- target: $.paths['/environments/{environment}/instances'].get
  update:
    x-apievangelist-phrasing:
      intent: List an environment's instances
      effect: read
      questions:
      - What compute instances are running in one of my Laravel Cloud environments?
      - Can I filter an environment's instances by type, size or scaling type?
      instructions:
      - text: List the instances in environment {environment}.
        slots:
          environment: path.environment
      - text: Show {type} instances of size {size} in environment {environment}.
        slots:
          type: query.filter[type]
          size: query.filter[size]
          environment: path.environment
      method: generated
      generated: '2026-10-01'
- target: $.paths['/environments/{environment}/instances'].post
  update:
    x-apievangelist-phrasing:
      intent: Create an instance in an environment
      effect: write
      questions:
      - How do I add a worker or managed queue instance to an environment?
      - Can a new instance autoscale between a minimum and maximum number of replicas?
      - Which timeouts must I set when creating a managed queue instance?
      instructions:
      - text: Create a {type} instance named {name} of size {size} in environment {environment} with {scaling_type} scaling and at least {min_replicas} replicas.
        slots:
          type: requestBody.type
          name: requestBody.name
          size: requestBody.size
          environment: path.environment
          scaling_type: requestBody.scaling_type
          min_replicas: requestBody.min_replicas
      - text: 'Add instance {name} to {environment}: type {type}, size {size}, scaling {scaling_type}, {min_replicas}-{max_replicas} replicas.'
        slots:
          name: requestBody.name
          environment: path.environment
          type: requestBody.type
          size: requestBody.size
          scaling_type: requestBody.scaling_type
          min_replicas: requestBody.min_replicas
          max_replicas: requestBody.max_replicas
      method: generated
      generated: '2026-10-01'
- target: $.paths['/instances/sizes'].get
  update:
    x-apievangelist-phrasing:
      intent: List available instance sizes
      effect: read
      questions:
      - What instance sizes can I choose from, grouped by category?
      - Which compute sizes are available before I create or resize an instance?
      instructions:
      - text: List all available instance sizes.
      - text: Show me the instance size options grouped by category.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/instances/{instance}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an instance's details
      effect: read
      questions:
      - What size and replica settings does one of my instances have?
      - Can I look up a single instance by its ID?
      instructions:
      - text: Show instance {instance}.
        slots:
          instance: path.instance
      - text: Get the details and scaling settings of instance {instance}.
        slots:
          instance: path.instance
      method: generated
      generated: '2026-10-01'
- target: $.paths['/instances/{instance}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an instance
      effect: destructive
      questions:
      - How do I remove an instance I no longer need from my environment?
      - Can I delete a single compute instance?
      instructions:
      - text: Delete instance {instance}.
        slots:
          instance: path.instance
      - text: Remove compute instance {instance} permanently.
        slots:
          instance: path.instance
      method: generated
      generated: '2026-10-01'
- target: $.paths['/instances/{instance}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Resize or reconfigure an instance
      effect: write
      questions:
      - Can I change the size or replica limits of an existing instance?
      - How do I set the hibernation timeout or turn on Octane for an instance?
      instructions:
      - text: Resize instance {instance} to {size}.
        slots:
          instance: path.instance
          size: requestBody.size
      - text: Set instance {instance} to scale between {min_replicas} and {max_replicas} replicas.
        slots:
          instance: path.instance
          min_replicas: requestBody.min_replicas
          max_replicas: requestBody.max_replicas
      - text: Make instance {instance} hibernate after {hibernation_timeout} minutes.
        slots:
          instance: path.instance
          hibernation_timeout: requestBody.hibernation_timeout
      method: generated
      generated: '2026-10-01'
- target: $.paths['/instances/{instance}/pause'].post
  update:
    x-apievangelist-phrasing:
      intent: Pause a managed queue
      effect: write
      questions:
      - Can I stop workers from picking up jobs without losing what is queued?
      - Are queued messages kept when I pause a managed queue?
      instructions:
      - text: Pause managed queue {instance}.
        slots:
          instance: path.instance
      - text: Stop dispatching jobs from queue {instance} but keep its messages.
        slots:
          instance: path.instance
      method: generated
      generated: '2026-10-01'
- target: $.paths['/instances/{instance}/resume'].post
  update:
    x-apievangelist-phrasing:
      intent: Resume a paused managed queue
      effect: write
      questions:
      - How do I start a paused queue processing jobs again?
      - Can workers resume a managed queue after it was paused?
      instructions:
      - text: Resume managed queue {instance}.
        slots:
          instance: path.instance
      - text: Start dispatching jobs again on paused queue {instance}.
        slots:
          instance: path.instance
      method: generated
      generated: '2026-10-01'
- target: $.paths['/instances/{instance}/purge'].post
  update:
    x-apievangelist-phrasing:
      intent: Purge all messages from a managed queue
      effect: destructive
      questions:
      - How do I empty every pending message from a managed queue?
      - Can a purged queue's messages be recovered afterwards?
      instructions:
      - text: Purge all messages from managed queue {instance}.
        slots:
          instance: path.instance
      - text: Permanently clear the backlog in queue {instance}.
        slots:
          instance: path.instance
      method: generated
      generated: '2026-10-01'
- target: $.paths['/instances/{instance}/default'].post
  update:
    x-apievangelist-phrasing:
      intent: Make a managed queue the environment default
      effect: write
      questions:
      - Which queue do jobs go to when they don't name one, and can I change it?
      - How do I set the default managed queue for an environment?
      instructions:
      - text: Make managed queue {instance} the environment's default queue.
        slots:
          instance: path.instance
      - text: Route jobs without a named queue to {instance}.
        slots:
          instance: path.instance
      method: generated
      generated: '2026-10-01'
- target: $.paths['/instances/{instance}/failed-jobs'].get
  update:
    x-apievangelist-phrasing:
      intent: List failed jobs on a managed queue
      effect: read
      questions:
      - Which jobs have failed on my managed queue?
      - Can I see the failed jobs for a queue before retrying them?
      instructions:
      - text: List the failed jobs on managed queue {instance}.
        slots:
          instance: path.instance
      - text: Show what has failed on queue {instance}.
        slots:
          instance: path.instance
      method: generated
      generated: '2026-10-01'
- target: $.paths['/instances/{instance}/failed-jobs/{jobId}/retry'].post
  update:
    x-apievangelist-phrasing:
      intent: Retry a failed job on a managed queue
      effect: write
      questions:
      - Can I re-queue a failed job so it runs again?
      - How do I retry one specific failed job on a managed queue?
      instructions:
      - text: Retry failed job {jobId} on managed queue {instance}.
        slots:
          jobId: path.jobId
          instance: path.instance
      - text: Put failed job {jobId} back on queue {instance} for another attempt.
        slots:
          jobId: path.jobId
          instance: path.instance
      method: generated
      generated: '2026-10-01'
- target: $.paths['/instances/{instance}/failed-jobs/{jobId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a failed job from a managed queue
      effect: destructive
      questions:
      - How do I discard a failed job I don't want to retry?
      - Is removing a failed job from a managed queue permanent?
      instructions:
      - text: Delete failed job {jobId} from managed queue {instance}.
        slots:
          jobId: path.jobId
          instance: path.instance
      - text: Discard failed job {jobId} on queue {instance} without retrying it.
        slots:
          jobId: path.jobId
          instance: path.instance
      method: generated
      generated: '2026-10-01'