Amazon S3 · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Amazon S3 REST Buckets API

5 actions 5 updates phrasing extends openapi/amazon-s3-buckets-api-openapi.yml
Generated by API Evangelist Written by API Evangelist tooling for Amazon S3's API. It is a proposal applied on top of the contract, not a document Amazon S3 publishes.
View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 5

$.info
$.paths['/'].get
$.paths['/{Bucket}'].put
$.paths['/{Bucket}'].delete
$.paths['/{Bucket}'].head

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 Amazon S3 REST Buckets API
  version: 1.0.0
extends: openapi/amazon-s3-buckets-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-10-01'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 4
- target: $.paths['/'].get
  update:
    x-apievangelist-phrasing:
      intent: List my buckets
      effect: read
      questions:
      - What S3 buckets do I own?
      - Which permission do I need to list all of my buckets?
      instructions:
      - text: List all my S3 buckets.
      - text: Show every bucket owned by this account.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/{Bucket}'].put
  update:
    x-apievangelist-phrasing:
      intent: Create a bucket
      effect: write
      questions:
      - How do I create a new S3 bucket?
      - Can I create a bucket in a region other than us-east-1?
      - Can I turn on Object Lock when creating a bucket?
      instructions:
      - text: Create bucket {bucket}.
        slots:
          bucket: path.Bucket
      - text: Create bucket {bucket} in region {region}.
        slots:
          bucket: path.Bucket
          region: requestBody.LocationConstraint
      - text: Create {bucket} with Object Lock enabled set to {object_lock}.
        slots:
          bucket: path.Bucket
          object_lock: header.x-amz-bucket-object-lock-enabled
      method: generated
      generated: '2026-10-01'
- target: $.paths['/{Bucket}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a bucket
      effect: destructive
      questions:
      - How do I delete an S3 bucket?
      - Does a bucket need to be empty before I can delete it?
      instructions:
      - text: Delete bucket {bucket}.
        slots:
          bucket: path.Bucket
      - text: Remove the empty bucket {bucket} from my account.
        slots:
          bucket: path.Bucket
      method: generated
      generated: '2026-10-01'
- target: $.paths['/{Bucket}'].head
  update:
    x-apievangelist-phrasing:
      intent: Check a bucket exists and is accessible
      effect: read
      questions:
      - How do I check whether a bucket exists and I have access to it?
      - What does a 403 versus a 404 mean when probing a bucket?
      instructions:
      - text: Check whether bucket {bucket} exists and I can access it.
        slots:
          bucket: path.Bucket
      - text: Verify access to {bucket}.
        slots:
          bucket: path.Bucket
      method: generated
      generated: '2026-10-01'