Oracle Cloud Infrastructure · OpenAPI Overlay 1.0.0
API Evangelist conversational phrasing for Core Services Blockstorage API
61 actions
61 updates
phrasing
extends
openapi/oracle-cloud-blockstorage-api-openapi.yml
Generated by API Evangelist
Written by API Evangelist tooling for Oracle Cloud Infrastructure's API. It is a proposal applied on top of the contract, not a document Oracle Cloud Infrastructure publishes.
What the actions change
x-apievangelist-phrasing
Targets 61 · first 16 shown; the file carries all of them
$.info
$.paths['/blockVolumeReplicas'].get
$.paths['/blockVolumeReplicas/{blockVolumeReplicaId}'].get
$.paths['/bootVolumeBackups'].get
$.paths['/bootVolumeBackups'].post
$.paths['/bootVolumeBackups/{bootVolumeBackupId}'].get
$.paths['/bootVolumeBackups/{bootVolumeBackupId}'].put
$.paths['/bootVolumeBackups/{bootVolumeBackupId}'].delete
$.paths['/bootVolumeBackups/{bootVolumeBackupId}/actions/changeCompartment'].post
$.paths['/bootVolumeBackups/{bootVolumeBackupId}/actions/copy'].post
$.paths['/bootVolumeReplicas'].get
$.paths['/bootVolumeReplicas/{bootVolumeReplicaId}'].get
$.paths['/bootVolumes'].get
$.paths['/bootVolumes'].post
$.paths['/bootVolumes/{bootVolumeId}'].get
$.paths['/bootVolumes/{bootVolumeId}'].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 Core Services Blockstorage API
version: 1.0.0
extends: openapi/oracle-cloud-blockstorage-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: 60
- target: $.paths['/blockVolumeReplicas'].get
update:
x-apievangelist-phrasing:
intent: List block volume replicas in an availability domain
effect: read
questions:
- Which cross-region replicas of my block volumes exist in this availability domain?
- Can I filter block volume replicas by lifecycle state or display name?
instructions:
- text: List the block volume replicas in compartment {compartmentId} in availability domain {availabilityDomain}.
slots:
compartmentId: query.compartmentId
availabilityDomain: query.availabilityDomain
- text: Show only {lifecycleState} block volume replicas in {availabilityDomain} for compartment {compartmentId}.
slots:
lifecycleState: query.lifecycleState
availabilityDomain: query.availabilityDomain
compartmentId: query.compartmentId
method: generated
generated: '2026-09-26'
- target: $.paths['/blockVolumeReplicas/{blockVolumeReplicaId}'].get
update:
x-apievangelist-phrasing:
intent: Get details of one block volume replica
effect: read
questions:
- What is the status of a specific block volume replica?
- How can I see which source volume a block volume replica was copied from?
instructions:
- text: Get the details of block volume replica {blockVolumeReplicaId}.
slots:
blockVolumeReplicaId: path.blockVolumeReplicaId
- text: Check whether block volume replica {blockVolumeReplicaId} is available.
slots:
blockVolumeReplicaId: path.blockVolumeReplicaId
method: generated
generated: '2026-09-26'
- target: $.paths['/bootVolumeBackups'].get
update:
x-apievangelist-phrasing:
intent: List boot volume backups in a compartment
effect: read
questions:
- What backups exist of my instance boot volumes in a compartment?
- Can I see only the backups taken of one particular boot volume?
- Which boot volume backups were copied from another boot volume backup?
instructions:
- text: List the boot volume backups in compartment {compartmentId}.
slots:
compartmentId: query.compartmentId
- text: Show only the backups taken from boot volume {bootVolumeId}, searching compartment {compartmentId}.
slots:
bootVolumeId: query.bootVolumeId
compartmentId: query.compartmentId
method: generated
generated: '2026-09-26'
- target: $.paths['/bootVolumeBackups'].post
update:
x-apievangelist-phrasing:
intent: Back up a boot volume
effect: write
questions:
- How do I take a backup of an instance's boot volume?
- Can I choose a full instead of incremental backup for a boot volume?
- Is it possible to lock a boot volume backup against deletion with a retention period?
instructions:
- text: Create a backup of boot volume {bootVolumeId}.
slots:
bootVolumeId: requestBody.bootVolumeId
- text: Take a {type} backup of boot volume {bootVolumeId} named {displayName}.
slots:
type: requestBody.type
bootVolumeId: requestBody.bootVolumeId
displayName: requestBody.displayName
method: generated
generated: '2026-09-26'
- target: $.paths['/bootVolumeBackups/{bootVolumeBackupId}'].get
update:
x-apievangelist-phrasing:
intent: Get details of a boot volume backup
effect: read
questions:
- What size and state is a specific boot volume backup in?
- How do I look up one boot volume backup by its OCID?
instructions:
- text: Get boot volume backup {bootVolumeBackupId}.
slots:
bootVolumeBackupId: path.bootVolumeBackupId
- text: Show whether boot volume backup {bootVolumeBackupId} has finished.
slots:
bootVolumeBackupId: path.bootVolumeBackupId
method: generated
generated: '2026-09-26'
- target: $.paths['/bootVolumeBackups/{bootVolumeBackupId}'].put
update:
x-apievangelist-phrasing:
intent: Rename or retag a boot volume backup
effect: write
questions:
- How do I rename an existing boot volume backup?
- Can I change the retention period on a boot volume backup I already took?
instructions:
- text: Rename boot volume backup {bootVolumeBackupId} to {displayName}.
slots:
bootVolumeBackupId: path.bootVolumeBackupId
displayName: requestBody.displayName
- text: Turn on deletion protection for existing boot volume backup {bootVolumeBackupId}.
slots:
bootVolumeBackupId: path.bootVolumeBackupId
method: generated
generated: '2026-09-26'
- target: $.paths['/bootVolumeBackups/{bootVolumeBackupId}'].delete
update:
x-apievangelist-phrasing:
intent: Delete a boot volume backup
effect: destructive
questions:
- How do I remove an old boot volume backup I no longer need?
- Can I delete a single boot volume backup permanently?
instructions:
- text: Delete boot volume backup {bootVolumeBackupId}.
slots:
bootVolumeBackupId: path.bootVolumeBackupId
- text: Permanently remove the boot volume backup {bootVolumeBackupId}.
slots:
bootVolumeBackupId: path.bootVolumeBackupId
method: generated
generated: '2026-09-26'
- target: $.paths['/bootVolumeBackups/{bootVolumeBackupId}/actions/changeCompartment'].post
update:
x-apievangelist-phrasing:
intent: Move a boot volume backup to another compartment
effect: write
questions:
- How do I move a boot volume backup into a different compartment?
- Can a boot volume backup be reorganized into another compartment of the same tenancy?
instructions:
- text: Move boot volume backup {bootVolumeBackupId} to compartment {compartmentId}.
slots:
bootVolumeBackupId: path.bootVolumeBackupId
compartmentId: requestBody.compartmentId
- text: Relocate the boot volume backup {bootVolumeBackupId} into compartment {compartmentId}.
slots:
bootVolumeBackupId: path.bootVolumeBackupId
compartmentId: requestBody.compartmentId
method: generated
generated: '2026-09-26'
- target: $.paths['/bootVolumeBackups/{bootVolumeBackupId}/actions/copy'].post
update:
x-apievangelist-phrasing:
intent: Copy a boot volume backup to another region
effect: write
questions:
- How do I copy a boot volume backup to a different region for disaster recovery?
- Can the cross-region copy of a boot volume backup use its own encryption key?
instructions:
- text: Copy boot volume backup {bootVolumeBackupId} to region {destinationRegion}.
slots:
bootVolumeBackupId: path.bootVolumeBackupId
destinationRegion: requestBody.destinationRegion
- text: Copy boot volume backup {bootVolumeBackupId} to {destinationRegion} encrypted with key {kmsKeyId}.
slots:
bootVolumeBackupId: path.bootVolumeBackupId
destinationRegion: requestBody.destinationRegion
kmsKeyId: requestBody.kmsKeyId
method: generated
generated: '2026-09-26'
- target: $.paths['/bootVolumeReplicas'].get
update:
x-apievangelist-phrasing:
intent: List boot volume replicas in an availability domain
effect: read
questions:
- Which boot volume replicas do I have in a given availability domain?
- Can I find boot volume replicas by display name?
instructions:
- text: List the boot volume replicas in compartment {compartmentId} and availability domain {availabilityDomain}.
slots:
compartmentId: query.compartmentId
availabilityDomain: query.availabilityDomain
- text: Find boot volume replicas named {displayName} in {availabilityDomain}, compartment {compartmentId}.
slots:
displayName: query.displayName
availabilityDomain: query.availabilityDomain
compartmentId: query.compartmentId
method: generated
generated: '2026-09-26'
- target: $.paths['/bootVolumeReplicas/{bootVolumeReplicaId}'].get
update:
x-apievangelist-phrasing:
intent: Get details of one boot volume replica
effect: read
questions:
- What state is a particular boot volume replica in?
- How do I check when a boot volume replica was last synced?
instructions:
- text: Get boot volume replica {bootVolumeReplicaId}.
slots:
bootVolumeReplicaId: path.bootVolumeReplicaId
- text: Show the details of the boot volume replica {bootVolumeReplicaId}.
slots:
bootVolumeReplicaId: path.bootVolumeReplicaId
method: generated
generated: '2026-09-26'
- target: $.paths['/bootVolumes'].get
update:
x-apievangelist-phrasing:
intent: List boot volumes in an availability domain
effect: read
questions:
- What boot volumes exist in my compartment and availability domain?
- Can I list only the boot volumes that belong to a volume group?
instructions:
- text: List the boot volumes in compartment {compartmentId} in {availabilityDomain}.
slots:
compartmentId: query.compartmentId
availabilityDomain: query.availabilityDomain
- text: List boot volumes in volume group {volumeGroupId} for compartment {compartmentId} in {availabilityDomain}.
slots:
volumeGroupId: query.volumeGroupId
compartmentId: query.compartmentId
availabilityDomain: query.availabilityDomain
method: generated
generated: '2026-09-26'
- target: $.paths['/bootVolumes'].post
update:
x-apievangelist-phrasing:
intent: Create a boot volume from a backup or clone
effect: write
questions:
- How do I restore a boot volume from a boot volume backup?
- Can I clone an existing boot volume into a new, larger one?
- What performance setting (VPUs per GB) can I give a new boot volume?
instructions:
- text: Create a boot volume in compartment {compartmentId} from source {sourceDetails}.
slots:
compartmentId: requestBody.compartmentId
sourceDetails: requestBody.sourceDetails
- text: Restore a {sizeInGBs} GB boot volume into compartment {compartmentId} from {sourceDetails}.
slots:
sizeInGBs: requestBody.sizeInGBs
compartmentId: requestBody.compartmentId
sourceDetails: requestBody.sourceDetails
method: generated
generated: '2026-09-26'
- target: $.paths['/bootVolumes/{bootVolumeId}'].get
update:
x-apievangelist-phrasing:
intent: Get details of a boot volume
effect: read
questions:
- What size and performance level is a given boot volume?
- How do I look up a boot volume's current lifecycle state?
instructions:
- text: Get boot volume {bootVolumeId}.
slots:
bootVolumeId: path.bootVolumeId
- text: Show the size and state of boot volume {bootVolumeId}.
slots:
bootVolumeId: path.bootVolumeId
method: generated
generated: '2026-09-26'
- target: $.paths['/bootVolumes/{bootVolumeId}'].put
update:
x-apievangelist-phrasing:
intent: Resize, retune or rename a boot volume
effect: write
questions:
- How do I enlarge an existing boot volume?
- Can I turn on performance auto-tune for a boot volume that's already running?
instructions:
- text: Resize boot volume {bootVolumeId} to {sizeInGBs} GB.
slots:
bootVolumeId: path.bootVolumeId
sizeInGBs: requestBody.sizeInGBs
- text: Rename boot volume {bootVolumeId} to {displayName}.
slots:
bootVolumeId: path.bootVolumeId
displayName: requestBody.displayName
method: generated
generated: '2026-09-26'
- target: $.paths['/bootVolumes/{bootVolumeId}'].delete
update:
x-apievangelist-phrasing:
intent: Delete a boot volume
effect: destructive
questions:
- How do I delete a boot volume that's no longer attached to an instance?
- Why can't I delete a boot volume that still has an active instance connection?
instructions:
- text: Delete boot volume {bootVolumeId}.
slots:
bootVolumeId: path.bootVolumeId
- text: Permanently remove the detached boot volume {bootVolumeId}.
slots:
bootVolumeId: path.bootVolumeId
method: generated
generated: '2026-09-26'
- target: $.paths['/bootVolumes/{bootVolumeId}/actions/changeCompartment'].post
update:
x-apievangelist-phrasing:
intent: Move a boot volume to another compartment
effect: write
questions:
- How do I move a boot volume into another compartment?
- Can a boot volume change compartments without leaving the tenancy?
instructions:
- text: Move boot volume {bootVolumeId} to compartment {compartmentId}.
slots:
bootVolumeId: path.bootVolumeId
compartmentId: requestBody.compartmentId
- text: Put the boot volume {bootVolumeId} under compartment {compartmentId}.
slots:
bootVolumeId: path.bootVolumeId
compartmentId: requestBody.compartmentId
method: generated
generated: '2026-09-26'
- target: $.paths['/bootVolumes/{bootVolumeId}/kmsKey'].get
update:
x-apievangelist-phrasing:
intent: See which Vault key encrypts a boot volume
effect: read
questions:
- Which Vault encryption key is protecting my boot volume?
- Is a boot volume using a customer-managed key or the Oracle-managed default?
instructions:
- text: Get the Vault encryption key assigned to boot volume {bootVolumeId}.
slots:
bootVolumeId: path.bootVolumeId
- text: Tell me which master key encrypts boot volume {bootVolumeId}.
slots:
bootVolumeId: path.bootVolumeId
method: generated
generated: '2026-09-26'
- target: $.paths['/bootVolumes/{bootVolumeId}/kmsKey'].put
update:
x-apievangelist-phrasing:
intent: Assign a new Vault key to a boot volume
effect: write
questions:
- How do I rotate a boot volume onto a different Vault master encryption key?
- Can I switch a boot volume to my own customer-managed key?
instructions:
- text: Encrypt boot volume {bootVolumeId} with Vault key {kmsKeyId}.
slots:
bootVolumeId: path.bootVolumeId
kmsKeyId: requestBody.kmsKeyId
- text: Change the master encryption key on boot volume {bootVolumeId} to {kmsKeyId}.
slots:
bootVolumeId: path.bootVolumeId
kmsKeyId: requestBody.kmsKeyId
method: generated
generated: '2026-09-26'
- target: $.paths['/bootVolumes/{bootVolumeId}/kmsKey'].delete
update:
x-apievangelist-phrasing:
intent: Remove the Vault key from a boot volume
effect: destructive
questions:
- How do I unassign a customer-managed Vault key from a boot volume?
- Can I take the Vault key off a boot volume and fall back to Oracle-managed encryption?
instructions:
- text: Remove the Vault encryption key from boot volume {bootVolumeId}.
slots:
bootVolumeId: path.bootVolumeId
- text: Unassign the master key on boot volume {bootVolumeId}.
slots:
bootVolumeId: path.bootVolumeId
method: generated
generated: '2026-09-26'
- target: $.paths['/volumeBackupPolicies'].get
update:
x-apievangelist-phrasing:
intent: List volume backup policies
effect: read
questions:
- What backup policies can I apply to my block and boot volumes?
- Which user-defined backup policies exist in a compartment, next to the Oracle-defined ones?
instructions:
- text: List the volume backup policies available to me.
- text: List the backup policies defined in compartment {compartmentId}.
slots:
compartmentId: query.compartmentId
method: generated
generated: '2026-09-26'
- target: $.paths['/volumeBackupPolicies'].post
update:
x-apievangelist-phrasing:
intent: Create a scheduled volume backup policy
effect: write
questions:
- How do I set up my own schedule for automatic volume backups?
- Can a custom backup policy also copy backups to another region?
instructions:
- text: Create a backup policy named {displayName} in compartment {compartmentId}.
slots:
displayName: requestBody.displayName
compartmentId: requestBody.compartmentId
- text: Create a backup policy in compartment {compartmentId} with schedules {schedules} that copies to {destinationRegion}.
slots:
compartmentId: requestBody.compartmentId
schedules: requestBody.schedules
destinationRegion: requestBody.destinationRegion
method: generated
generated: '2026-09-26'
- target: $.paths['/volumeBackupPolicies/{policyId}'].get
update:
x-apievangelist-phrasing:
intent: Get a volume backup policy's schedules
effect: read
questions:
- What schedules does a particular backup policy run on?
- Which region does a given backup policy copy its backups to?
instructions:
- text: Get backup policy {policyId}.
slots:
policyId: path.policyId
- text: Show the backup schedules in volume backup policy {policyId}.
slots:
policyId: path.policyId
method: generated
generated: '2026-09-26'
- target: $.paths['/volumeBackupPolicies/{policyId}'].put
update:
x-apievangelist-phrasing:
intent: Change a user-defined backup policy
effect: write
questions:
- How do I change the schedule of a custom backup policy I already made?
- Can I add a cross-region copy destination to an existing backup policy?
instructions:
- text: Replace the schedules on backup policy {policyId} with {schedules}.
slots:
policyId: path.policyId
schedules: requestBody.schedules
- text: Make backup policy {policyId} copy backups to {destinationRegion}.
slots:
policyId: path.policyId
destinationRegion: requestBody.destinationRegion
method: generated
generated: '2026-09-26'
- target: $.paths['/volumeBackupPolicies/{policyId}'].delete
update:
x-apievangelist-phrasing:
intent: Delete a user-defined backup policy
effect: destructive
questions:
- How do I get rid of a custom volume backup policy?
- Can I delete a backup policy I created myself?
instructions:
- text: Delete backup policy {policyId}.
slots:
policyId: path.policyId
- text: Remove the user-defined volume backup policy {policyId}.
slots:
policyId: path.policyId
method: generated
generated: '2026-09-26'
- target: $.paths['/volumeBackupPolicyAssignments'].get
update:
x-apievangelist-phrasing:
intent: Find the backup policy assigned to a volume
effect: read
questions:
- Which backup policy is my volume currently using?
- Does this block volume have any backup policy assigned at all?
instructions:
- text: Find the backup policy assigned to volume {assetId}.
slots:
assetId: query.assetId
- text: Check whether volume {assetId} has a backup policy assignment.
slots:
assetId: query.assetId
method: generated
generated: '2026-09-26'
- target: $.paths['/volumeBackupPolicyAssignments'].post
update:
x-apievangelist-phrasing:
intent: Assign a backup policy to a volume
effect: write
questions:
- How do I put a volume on an automatic backup schedule?
- What happens if I assign a backup policy to a volume that already has a different one?
instructions:
- text: Assign backup policy {policyId} to volume {assetId}.
slots:
policyId: requestBody.policyId
assetId: requestBody.assetId
- text: Start backing up volume {assetId} on the schedule in policy {policyId}.
slots:
assetId: requestBody.assetId
policyId: requestBody.policyId
method: generated
generated: '2026-09-26'
- target: $.paths['/volumeBackupPolicyAssignments/{policyAssignmentId}'].get
update:
x-apievangelist-phrasing:
intent: Get a backup policy assignment by ID
effect: read
questions:
- How do I look up a backup policy assignment by its own OCID?
- When was a particular policy assignment created, and which volume does it cover?
instructions:
- text: Get backup policy assignment {policyAssignmentId}.
slots:
policyAssignmentId: path.policyAssignmentId
- text: Show which volume and policy assignment {policyAssignmentId} links.
slots:
policyAssignmentId: path.policyAssignmentId
method: generated
generated: '2026-09-26'
- target: $.paths['/volumeBackupPolicyAssignments/{policyAssignmentId}'].delete
update:
x-apievangelist-phrasing:
intent: Unassign a backup policy from a volume
effect: destructive
questions:
- How do I stop scheduled backups on a volume?
- Can I remove a volume's backup policy assignment?
instructions:
- text: Delete backup policy assignment {policyAssignmentId}.
slots:
policyAssignmentId: path.policyAssignmentId
- text: Take the volume off its backup schedule by removing assignment {policyAssignmentId}.
slots:
policyAssignmentId: path.policyAssignmentId
method: generated
generated: '2026-09-26'
- target: $.paths['/volumeBackups'].get
update:
x-apievangelist-phrasing:
intent: List block volume backups in a compartment
effect: read
questions:
- What block volume backups do I have in a compartment?
- Can I filter volume backups down to just one block volume?
instructions:
- text: List the block volume backups in compartment {compartmentId}.
slots:
compartmentId: query.compartmentId
- text: List backups of block volume {volumeId} in compartment {compartmentId}.
slots:
volumeId: query.volumeId
compartmentId: query.compartmentId
method: generated
generated: '2026-09-26'
- target: $.paths['/volumeBackups'].post
update:
x-apievangelist-phrasing:
intent: Back up a block volume
effect: write
questions:
- How do I make an on-demand backup of a block volume?
- Are block volume backups incremental unless I ask for a full one?
instructions:
- text: Create a backup of block volume {volumeId}.
slots:
volumeId: requestBody.volumeId
- text: Take a {type} backup of block volume {volumeId} called {displayName}.
slots:
type: requestBody.type
volumeId: requestBody.volumeId
displayName: requestBody.displayName
method: generated
generated: '2026-09-26'
- target: $.paths['/volumeBackups/{volumeBackupId}'].get
update:
x-apievangelist-phrasing:
intent: Get details of a block volume backup
effect: read
questions:
- How big is a specific block volume backup and is it complete?
- Where can I see the details of a single volume backup?
instructions:
- text: Get volume backup {volumeBackupId}.
slots:
volumeBackupId: path.volumeBackupId
- text: Check the state of block volume backup {volumeBackupId}.
slots:
volumeBackupId: path.volumeBackupId
method: generated
generated: '2026-09-26'
- target: $.paths['/volumeBackups/{volumeBackupId}'].put
update:
x-apievangelist-phrasing:
intent: Rename or retag a block volume backup
effect: write
questions:
- How do I rename a block volume backup?
- Can I change the retention settings of a block volume backup after it's taken?
instructions:
- text: Rename volume backup {volumeBackupId} to {displayName}.
slots:
volumeBackupId: path.volumeBackupId
displayName: requestBody.displayName
- text: Set the retention period on block volume backup {volumeBackupId} to {retentionPeriod}.
slots:
volumeBackupId: path.volumeBackupId
retentionPeriod: requestBody.retentionPeriod
method: generated
generated: '2026-09-26'
- target: $.paths['/volumeBackups/{volumeBackupId}'].delete
update:
x-apievangelist-phrasing:
intent: Delete a block volume backup
effect: destructive
questions:
- How do I delete a block volume backup to save storage cost?
- Can I remove one volume backup without touching the volume itself?
instructions:
- text: Delete volume backup {volumeBackupId}.
slots:
volumeBackupId: path.volumeBackupId
- text: Permanently remove block volume backup {volumeBackupId}.
slots:
volumeBackupId: path.volumeBackupId
method: generated
generated: '2026-09-26'
- target: $.paths['/volumeBackups/{volumeBackupId}/actions/changeCompartment'].post
update:
x-apievangelist-phrasing:
intent: Move a block volume backup to another compartment
effect: write
questions:
- How do I move a block volume backup into a different compartment?
- Can I reorganize volume backups across compartments in my tenancy?
instructions:
- text: Move volume backup {volumeBackupId} to compartment {compartmentId}.
slots:
volumeBackupId: path.volumeBackupId
compartmentId: requestBody.compartmentId
- text: Relocate the block volume backup {volumeBackupId} into compartment {compartmentId}.
slots:
volumeBackupId: path.volumeBackupId
compartmentId: requestBody.compartmentId
method: generated
generated: '2026-09-26'
- target: $.paths['/volumeBackups/{volumeBackupId}/actions/copy'].post
update:
x-apievangelist-phrasing:
intent: Copy a block volume backup to another region
effect: write
questions:
- How do I copy a block volume backup to another region?
- Can a cross-region volume backup copy get a new display name?
instructions:
- text: Copy volume backup {volumeBackupId} to region {destinationRegion}.
slots:
volumeBackupId: path.volumeBackupId
destinationRegion: requestBody.destinationRegion
- text: Copy block volume backup {volumeBackupId} to {destinationRegion} as {displayName}.
slots:
volumeBackupId: path.volumeBackupId
destinationRegion: requestBody.destinationRegion
displayName: requestBody.displayName
method: generated
generated: '2026-09-26'
- target: $.paths['/volumeGroupBackups'].get
update:
x-apievangelist-phrasing:
intent: List volume group backups in a compartment
effect: read
questions:
- What backups of my volume groups exist in a compartment?
- Can I list only the backups for a single volume group?
instructions:
- text: List the volume group backups in compartment {compartmentId}.
slots:
compartmentId: query.compartmentId
- text: List backups of volume group {volumeGroupId} in compartment {compartmentId}.
slots:
volumeGroupId: query.volumeGroupId
compartmentId: query.compartmentId
method: generated
generated: '2026-09-26'
- target: $.paths['/volumeGroupBackups'].post
update:
x-apievangelist-phrasing:
intent: Back up a volume group
effect: write
questions:
- How do I take a consistent backup of all volumes in a volume group at once?
- Can I make a full rather than incremental volume group backup?
instructions:
- text: Create a backup of volume group {volumeGroupId}.
slots:
volumeGroupId: requestBody.volumeGroupId
- text: Take a {type} backup of volume group {volumeGroupId} named {displayName}.
slots:
type: requestBody.type
volumeGroupId: requestBody.volumeGroupId
displayName: requestBody.displayName
method: generated
generated: '2026-09-26'
- target: $.paths['/volumeGroupBackups/{volumeGroupBackupId}'].get
update:
x-apievangelist-phrasing:
intent: Get details of a volume group backup
effect: read
questions:
- Which volume backups make up a specific volume group backup?
- Is a given volume group backup finished yet?
instructions:
- text: Get volume group backup {volumeGroupBackupId}.
slots:
volumeGroupBackupId: path.volumeGroupBackupId
- text: Show the state of volume group backup {volumeGroupBackupId}.
slots:
volumeGroupBackupId: path.volumeGroupBackupId
method: generated
generated: '2026-09-26'
- target: $.paths['/volumeGroupBackups/{volumeGroupBackupId}'].put
update:
x-apievangelist-phrasing:
intent: Rename or retag a volume group backup
effect: write
questions:
- How do I rename a volume group backup?
- Can I extend retention on an existing volume group backup?
instructions:
- text: Rename volume group backup {volumeGroupBackupId} to {displayName}.
slots:
volumeGroupBackupId: path.volumeGroupBackupId
displayName: requestBody.displayName
- text: Set retention on volume group backup {volumeGroupBackupId} to {retentionPeriod}.
slots:
volumeGroupBackupId: path.volumeGroupBackupId
retentionPeriod: requestBody.retentionPeriod
method: generated
generated: '2026-09-26'
- target: $.paths['/volumeGroupBackups/{volumeGroupBackupId}'].delete
update:
x-apievangelist-phrasing:
intent: Delete a volume group backup and its backups
effect: destructive
questions:
- How do I delete a volume group backup?
- Does deleting a volume group backup also remove every volume backup inside it?
instructions:
- text: Delete volume group backup {volumeGroupBackupId}.
slots:
volumeGroupBackupId: path.volumeGroupBackupId
- text: Remove volume group backup {volumeGroupBackupId} and all the backups it contains.
slots:
volumeGroupBackupId: path.volumeGroupBackupId
method: generated
generated: '2026-09-26'
- target: $.paths['/volumeGroupBackups/{volumeGroupBackupId}/actions/changeCompartment'].post
update:
x-apievangelist-phrasing:
intent: Move a volume group backup to another compartment
effect: write
questions:
- How do I move a volume group backup to another compartment?
- Can volume group backups be shifted between compartments in one tenancy?
instructions:
- text: Move volume group backup {volumeGroupBackupId} to compartment {compartmentId}.
slots:
volumeGroupBackupId: path.volumeGroupBackupId
compartmentId: requestBody.compartmentId
- text: Put volume group backup {volumeGroupBackupId} in compartment {compartmentId}.
slots:
volumeGroupBackupId: path.volumeGroupBackupId
compartmentId: requestBody.compartmentId
method: generated
generated: '2026-09-26'
# --- truncated at 32 KB (44 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/oracle-cloud/refs/heads/main/overlays/oracle-cloud-blockstorage-api-phrasing-overlay.yaml