# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Sandbox Admin operations API
  version: 1.0.0
extends: openapi/adobe-suite-admin-operations-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-09-26'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 7
- target: $.paths['/sandbox-management/sandboxTypes'].get
  update:
    x-apievangelist-phrasing:
      intent: List supported sandbox types
      effect: read
      questions:
      - What types of sandboxes can our organization create?
      - Does our Experience Platform org support both development and production sandboxes?
      instructions:
      - text: List the sandbox types supported for org {org}.
        slots:
          org: header.x-gw-ims-org-id
      - text: Show which sandbox types are available to us.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/sandbox-management/sandboxes'].get
  update:
    x-apievangelist-phrasing:
      intent: List the organization's sandboxes
      effect: read
      questions:
      - How do I see every sandbox that belongs to our organization?
      - Can I filter or sort the sandbox list by a property?
      instructions:
      - text: List all sandboxes in org {org}.
        slots:
          org: header.x-gw-ims-org-id
      - text: List sandboxes matching {property} ordered by {orderBy}.
        slots:
          property: query.property
          orderBy: query.orderBy
      method: generated
      generated: '2026-09-26'
- target: $.paths['/sandbox-management/sandboxes'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a sandbox
      effect: write
      questions:
      - How do I create a new development sandbox?
      - Can I create a production sandbox through the API?
      instructions:
      - text: Create a {type} sandbox named {name} titled {title}.
        slots:
          type: requestBody.type
          name: requestBody.name
          title: requestBody.title
      - text: Make a new development sandbox called {name} with display title {title}.
        slots:
          name: requestBody.name
          title: requestBody.title
      method: generated
      generated: '2026-09-26'
- target: $.paths['/sandbox-management/sandboxes/{sandboxName}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a sandbox by name
      effect: read
      questions:
      - What state is a particular sandbox in right now?
      - Can I check a sandbox's status by its name?
      instructions:
      - text: Get sandbox {sandboxName}.
        slots:
          sandboxName: path.sandboxName
      - text: Show the status of sandbox {sandboxName}.
        slots:
          sandboxName: path.sandboxName
      method: generated
      generated: '2026-09-26'
- target: $.paths['/sandbox-management/sandboxes/{sandboxName}'].put
  update:
    x-apievangelist-phrasing:
      intent: Reset a sandbox
      effect: destructive
      questions:
      - How do I reset a sandbox back to a clean state?
      - Does resetting a sandbox wipe the data in it?
      instructions:
      - text: Reset sandbox {sandboxName}.
        slots:
          sandboxName: path.sandboxName
      - text: Run action {action} on sandbox {sandboxName} to reset it.
        slots:
          action: requestBody.action
          sandboxName: path.sandboxName
      method: generated
      generated: '2026-09-26'
- target: $.paths['/sandbox-management/sandboxes/{sandboxName}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a sandbox
      effect: destructive
      questions:
      - Is it possible to delete a sandbox we no longer need?
      - Can I remove a development sandbox by name?
      instructions:
      - text: Delete sandbox {sandboxName}.
        slots:
          sandboxName: path.sandboxName
      - text: Permanently remove the sandbox called {sandboxName}.
        slots:
          sandboxName: path.sandboxName
      method: generated
      generated: '2026-09-26'
- target: $.paths['/sandbox-management/sandboxes/{sandboxName}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Rename a sandbox's display title
      effect: write
      questions:
      - What's the way to change a sandbox's display title?
      - Can I update a sandbox without resetting it?
      instructions:
      - text: Change the title of sandbox {sandboxName} to {title}.
        slots:
          sandboxName: path.sandboxName
          title: requestBody.title
      - text: Update sandbox {sandboxName} so its display name reads {title}.
        slots:
          sandboxName: path.sandboxName
          title: requestBody.title
      method: generated
      generated: '2026-09-26'