Amazon S3 · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Amazon S3 Core (-level) Object API

3 actions 3 updates phrasing extends openapi/amazon-s3-object-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 3

$.info
$.paths['/{Bucket}/{Key}'].post
$.paths['/{Bucket}/{Key}'].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 Core (-level) Object API
  version: 1.0.0
extends: openapi/amazon-s3-object-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: 2
- target: $.paths['/{Bucket}/{Key}'].post
  update:
    x-apievangelist-phrasing:
      intent: Complete a multipart upload into an object
      effect: write
      questions:
      - How do I finalize a multipart upload once every part is uploaded?
      - Can I verify the assembled object with a full-object checksum or expected size?
      instructions:
      - text: Complete multipart upload {upload_id} for object {key} in {bucket}.
        slots:
          upload_id: query.uploadId
          key: path.Key
          bucket: path.Bucket
      - text: Finish upload {upload_id} for {key} only if the total size is {size} bytes.
        slots:
          upload_id: query.uploadId
          key: path.Key
          size: header.x-amz-mp-object-size
      method: generated
      generated: '2026-10-01'
- target: $.paths['/{Bucket}/{Key}'].head
  update:
    x-apievangelist-phrasing:
      intent: Read an object's metadata without the body
      effect: read
      questions:
      - How do I get a file's size, ETag and content type without downloading it?
      - Can I check metadata only if the object changed since a certain time?
      instructions:
      - text: Fetch metadata for {key} in {bucket} without the body.
        slots:
          key: path.Key
          bucket: path.Bucket
      - text: Check {key} in {bucket} only if modified since {since}.
        slots:
          key: path.Key
          bucket: path.Bucket
          since: header.If-Modified-Since
      method: generated
      generated: '2026-10-01'