Oracle Cloud Infrastructure · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Oracle Cloud Compute Instances API

7 actions 7 updates phrasing extends openapi/oracle-cloud-instances-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.
View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 7

$.info
$.paths['/instances'].get
$.paths['/instances'].post
$.paths['/instances/{instanceId}'].get
$.paths['/instances/{instanceId}'].put
$.paths['/instances/{instanceId}'].delete
$.paths['/instances/{instanceId}/actions/{action}'].post

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 Oracle Cloud Compute Instances API
  version: 1.0.0
extends: openapi/oracle-cloud-instances-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: 6
- target: $.paths['/instances'].get
  update:
    x-apievangelist-phrasing:
      intent: List compute instances in a compartment
      effect: read
      questions:
      - What virtual machines are running in my Oracle Cloud compartment?
      - Can I filter my instances by availability domain or lifecycle state?
      instructions:
      - text: List the compute instances in compartment {compartmentId}.
        slots:
          compartmentId: query.compartmentId
      - text: Show instances in compartment {compartmentId} that are {lifecycleState}.
        slots:
          compartmentId: query.compartmentId
          lifecycleState: query.lifecycleState
      method: generated
      generated: '2026-09-26'
- target: $.paths['/instances'].post
  update:
    x-apievangelist-phrasing:
      intent: Launch a new compute instance
      effect: write
      questions:
      - How do I create a new virtual machine?
      - Which shape, image and subnet can I pick when launching an instance?
      instructions:
      - text: Launch a {shape} instance in availability domain {availabilityDomain} of compartment {compartmentId}.
        slots:
          shape: requestBody.shape
          availabilityDomain: requestBody.availabilityDomain
          compartmentId: requestBody.compartmentId
      - text: Create instance {displayName} with shape {shape} from image {imageId} in subnet {subnetId}, AD {availabilityDomain}, compartment {compartmentId}.
        slots:
          displayName: requestBody.displayName
          shape: requestBody.shape
          imageId: requestBody.imageId
          subnetId: requestBody.subnetId
          availabilityDomain: requestBody.availabilityDomain
          compartmentId: requestBody.compartmentId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/instances/{instanceId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get details of a compute instance
      effect: read
      questions:
      - What shape and state is a specific instance in?
      - Is my virtual machine running or stopped right now?
      instructions:
      - text: Show instance {instanceId}.
        slots:
          instanceId: path.instanceId
      - text: Check the lifecycle state of instance {instanceId}.
        slots:
          instanceId: path.instanceId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/instances/{instanceId}'].put
  update:
    x-apievangelist-phrasing:
      intent: Rename or resize a compute instance
      effect: write
      questions:
      - Can I change an existing instance's shape to give it more CPU or memory?
      - How do I rename an instance or update its tags?
      instructions:
      - text: Change instance {instanceId} to shape {shape}.
        slots:
          instanceId: path.instanceId
          shape: requestBody.shape
      - text: Rename instance {instanceId} to {displayName}.
        slots:
          instanceId: path.instanceId
          displayName: requestBody.displayName
      method: generated
      generated: '2026-09-26'
- target: $.paths['/instances/{instanceId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Terminate a compute instance
      effect: destructive
      questions:
      - How do I permanently delete a virtual machine?
      - Can I keep the boot volume when terminating an instance?
      instructions:
      - text: Terminate instance {instanceId}.
        slots:
          instanceId: path.instanceId
      - text: Terminate instance {instanceId} and set preserve boot volume to {preserveBootVolume}.
        slots:
          instanceId: path.instanceId
          preserveBootVolume: query.preserveBootVolume
      method: generated
      generated: '2026-09-26'
- target: $.paths['/instances/{instanceId}/actions/{action}'].post
  update:
    x-apievangelist-phrasing:
      intent: Start, stop or reset a compute instance
      effect: write
      questions:
      - How do I stop or restart a single virtual machine?
      - Which power actions can I run on an instance, like soft reset?
      instructions:
      - text: Run the {action} action on instance {instanceId}.
        slots:
          action: path.action
          instanceId: path.instanceId
      - text: Power {action} instance {instanceId} now.
        slots:
          action: path.action
          instanceId: path.instanceId
      method: generated
      generated: '2026-09-26'