Oracle Cloud Infrastructure · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Oracle Cloud Object Storage Buckets API

6 actions 6 updates phrasing extends openapi/oracle-cloud-buckets-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 6

$.info

$.paths['/n/{namespaceName}/b'].get

$.paths['/n/{namespaceName}/b'].post

$.paths['/n/{namespaceName}/b/{bucketName}'].get

$.paths['/n/{namespaceName}/b/{bucketName}'].put

$.paths['/n/{namespaceName}/b/{bucketName}'].delete

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 Oracle Cloud Object Storage Buckets API
  version: 1.0.0
extends: openapi/oracle-cloud-buckets-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['/n/{namespaceName}/b'].get
  update:
    x-apievangelist-phrasing:
      intent: List the buckets in a compartment
      effect: read
      questions:
      - Which storage buckets are in a given Oracle Cloud compartment?
      - Can I page through buckets when a compartment has a lot of them?
      instructions:
      - text: List the buckets in compartment {compartmentId} of namespace {namespaceName}.
        slots:
          compartmentId: query.compartmentId
          namespaceName: path.namespaceName
      - text: Show {limit} buckets from compartment {compartmentId} in {namespaceName}.
        slots:
          limit: query.limit
          compartmentId: query.compartmentId
          namespaceName: path.namespaceName
      method: generated
      generated: '2026-09-26'
- target: $.paths['/n/{namespaceName}/b'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a new storage bucket
      effect: write
      questions:
      - How do I make a new bucket to store files?
      - Can I enable versioning or object events when creating a bucket?
      instructions:
      - text: Create bucket {name} in compartment {compartmentId}, namespace {namespaceName}.
        slots:
          name: requestBody.name
          compartmentId: requestBody.compartmentId
          namespaceName: path.namespaceName
      - text: Create bucket {name} in {compartmentId} under {namespaceName} with public access {publicAccessType}.
        slots:
          name: requestBody.name
          compartmentId: requestBody.compartmentId
          namespaceName: path.namespaceName
          publicAccessType: requestBody.publicAccessType
      method: generated
      generated: '2026-09-26'
- target: $.paths['/n/{namespaceName}/b/{bucketName}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a bucket's details
      effect: read
      questions:
      - What are the current settings of a specific bucket?
      - Is versioning turned on for one of my buckets?
      instructions:
      - text: Show bucket {bucketName} in namespace {namespaceName}.
        slots:
          bucketName: path.bucketName
          namespaceName: path.namespaceName
      - text: Get the storage tier and access settings of {bucketName} in {namespaceName}.
        slots:
          bucketName: path.bucketName
          namespaceName: path.namespaceName
      method: generated
      generated: '2026-09-26'
- target: $.paths['/n/{namespaceName}/b/{bucketName}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a bucket's settings
      effect: write
      questions:
      - Can I rename a bucket or move it to another compartment after creating it?
      - How do I turn on object events for a bucket that already exists?
      instructions:
      - text: Rename existing bucket {bucketName} in {namespaceName} to {name}.
        slots:
          bucketName: path.bucketName
          namespaceName: path.namespaceName
          name: requestBody.name
      - text: Set versioning to {versioning} on the existing bucket {bucketName}, namespace {namespaceName}.
        slots:
          versioning: requestBody.versioning
          bucketName: path.bucketName
          namespaceName: path.namespaceName
      method: generated
      generated: '2026-09-26'
- target: $.paths['/n/{namespaceName}/b/{bucketName}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an empty bucket
      effect: destructive
      questions:
      - Can I delete a bucket that still contains objects?
      - How do I get rid of a bucket I no longer use?
      instructions:
      - text: Delete empty bucket {bucketName} from namespace {namespaceName}.
        slots:
          bucketName: path.bucketName
          namespaceName: path.namespaceName
      - text: Remove the bucket {bucketName} in {namespaceName}.
        slots:
          bucketName: path.bucketName
          namespaceName: path.namespaceName
      method: generated
      generated: '2026-09-26'