Adobe Suite · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Cloud Manager Environment Restore From Backup API

6 actions 6 updates phrasing extends openapi/adobe-suite-environment-restore-from-backup-api-openapi.yml

Generated by API Evangelist Written by API Evangelist tooling for Adobe Suite's API. It is a proposal applied on top of the contract, not a document Adobe Suite publishes.

View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 6

$.info

$.paths['/api/program/{programId}/environment/{environmentId}/restorePoints'].get

$.paths['/api/program/{programId}/environment/{environmentId}/restoreExecution/{restoreId}'].get

$.paths['/api/program/{programId}/environment/{environmentId}/restoreExecution/{restoreId}/logs'].get

$.paths['/api/program/{programId}/environment/{environmentId}/restoreExecutions'].get

$.paths['/api/program/{programId}/environment/{environmentId}/restoreExecution'].put

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 Cloud Manager Environment Restore From Backup API
  version: 1.0.0
extends: openapi/adobe-suite-environment-restore-from-backup-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: 5
- target: $.paths['/api/program/{programId}/environment/{environmentId}/restorePoints'].get
  update:
    x-apievangelist-phrasing:
      intent: List available backup restore points
      effect: read
      questions:
      - Which backups can I restore my Cloud Service environment from?
      - How far back do the available restore points for an environment go?
      instructions:
      - text: List restore points for environment {environment} in program {program}.
        slots:
          environment: path.environmentId
          program: path.programId
      - text: Show the backups available to restore environment {environment} of program {program}.
        slots:
          environment: path.environmentId
          program: path.programId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/program/{programId}/environment/{environmentId}/restoreExecution/{restoreId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one restore execution
      effect: read
      questions:
      - How do I check the progress of a specific environment restore?
      - Did my restore from backup succeed?
      instructions:
      - text: Get restore execution {restore} for environment {environment} in program {program}.
        slots:
          restore: path.restoreId
          environment: path.environmentId
          program: path.programId
      - text: Tell me the status of restore {restore} on {environment} in program {program}.
        slots:
          restore: path.restoreId
          environment: path.environmentId
          program: path.programId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/program/{programId}/environment/{environmentId}/restoreExecution/{restoreId}/logs'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the logs of a restore execution
      effect: read
      questions:
      - Where can I read the logs from an environment restore?
      - Can I troubleshoot a failed restore by looking at its log output?
      instructions:
      - text: Get the logs for restore {restore} on environment {environment} in program {program}.
        slots:
          restore: path.restoreId
          environment: path.environmentId
          program: path.programId
      - text: Download the log output of restore run {restore} for {environment} in program {program}.
        slots:
          restore: path.restoreId
          environment: path.environmentId
          program: path.programId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/program/{programId}/environment/{environmentId}/restoreExecutions'].get
  update:
    x-apievangelist-phrasing:
      intent: List restore executions for an environment
      effect: read
      questions:
      - What restores have been run on this environment so far?
      - Can I page through the history of environment restores?
      instructions:
      - text: List all restore executions for environment {environment} in program {program}.
        slots:
          environment: path.environmentId
          program: path.programId
      - text: Show the last {limit} restore runs on environment {environment} of program {program}.
        slots:
          limit: query.limit
          environment: path.environmentId
          program: path.programId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/program/{programId}/environment/{environmentId}/restoreExecution'].put
  update:
    x-apievangelist-phrasing:
      intent: Restore an environment from backup
      effect: destructive
      questions:
      - How do I roll my Cloud Service environment back to an earlier backup?
      - Can I restore an environment to a specific point in time?
      instructions:
      - text: Restore environment {environment} in program {program} to point in time {time}.
        slots:
          environment: path.environmentId
          program: path.programId
          time: requestBody.pointInTimeInMillis
      - text: Start a backup restore of environment {environment} in program {program} as of {time}.
        slots:
          environment: path.environmentId
          program: path.programId
          time: requestBody.pointInTimeInMillis
      method: generated
      generated: '2026-09-26'