Amazon S3 · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Amazon S3 (object-level) Annotation API

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

$.info

$.paths['/{Bucket}/{Key}'].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 Amazon S3 (object-level) Annotation API
  version: 1.0.0
extends: openapi/amazon-s3-annotation-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: 1
- target: $.paths['/{Bucket}/{Key}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an annotation from an object
      effect: destructive
      questions:
      - How do I remove a named annotation from an S3 object?
      - Can I delete an annotation only if the object's ETag still matches?
      - Is deleting an object annotation permanent?
      instructions:
      - text: Delete annotation {annotation} from {key} in bucket {bucket}.
        slots:
          annotation: query.annotationName
          key: path.Key
          bucket: path.Bucket
      - text: Remove annotation {annotation} from {key} only if its ETag is {etag}.
        slots:
          annotation: query.annotationName
          key: path.Key
          etag: header.x-amz-object-if-match
      method: generated
      generated: '2026-10-01'