Copilot commented on code in PR #566: URL: https://github.com/apache/ozone-site/pull/566#discussion_r4267665384
########## docs/04-user-guide/01-client-interfaces/03-s3/01-s3-api.md: ########## @@ -56,6 +56,7 @@ The Ozone S3 Gateway implements a substantial subset of the Amazon S3 REST API. | ✅ [DeleteObjects](https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteObjects.html) | Deletes multiple objects in one request. | Bulk delete operation with aggregated error reporting. | | ✅ [CopyObject](https://docs.aws.amazon.com/AmazonS3/latest/API/API_CopyObject.html) | Copies an object (intra- or inter-bucket). | Supports metadata directives (COPY/REPLACE). **Non-compliant behavior:** Self-copying for metadata updates may differ slightly from AWS S3. | | ✅ [ListObjectsV2](https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListObjectsV2.html) | Lists objects in a bucket with filtering and pagination. | Supports prefix, delimiter, and continuation tokens. | +| ✅ [ListObjectVersions](https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListObjectVersions.html) | Lists the versions of the objects in a bucket. | Bucket versioning is not supported, so each object is listed with a single version whose `VersionId` is `null`, same as in an AWS S3 bucket that never had versioning enabled. `DeleteObject`, `DeleteObjects` and the object tagging operations accept `null` as the version ID and operate on the current object. | Review Comment: The doc currently implies `VersionId` is a JSON/XML null value. In AWS S3 responses, the version id value is the literal string `\"null\"` (and the `versionId` query parameter also uses `null` as a literal). Please clarify that this is a literal value (string) to prevent readers from attempting to send an empty/missing parameter or a null value in SDKs. ########## docs/04-user-guide/01-client-interfaces/03-s3/01-s3-api.md: ########## @@ -56,6 +56,7 @@ The Ozone S3 Gateway implements a substantial subset of the Amazon S3 REST API. | ✅ [DeleteObjects](https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteObjects.html) | Deletes multiple objects in one request. | Bulk delete operation with aggregated error reporting. | | ✅ [CopyObject](https://docs.aws.amazon.com/AmazonS3/latest/API/API_CopyObject.html) | Copies an object (intra- or inter-bucket). | Supports metadata directives (COPY/REPLACE). **Non-compliant behavior:** Self-copying for metadata updates may differ slightly from AWS S3. | | ✅ [ListObjectsV2](https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListObjectsV2.html) | Lists objects in a bucket with filtering and pagination. | Supports prefix, delimiter, and continuation tokens. | +| ✅ [ListObjectVersions](https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListObjectVersions.html) | Lists the versions of the objects in a bucket. | Bucket versioning is not supported, so each object is listed with a single version whose `VersionId` is `null`, same as in an AWS S3 bucket that never had versioning enabled. `DeleteObject`, `DeleteObjects` and the object tagging operations accept `null` as the version ID and operate on the current object. | Review Comment: This table cell is doing a lot of work and is likely to become hard to scan/maintain over time. Consider shortening the table note to a one-liner (e.g., “Returns a single `VersionId`=`null` per key when versioning is disabled”) and linking to a short dedicated subsection below that enumerates the affected APIs (e.g., DeleteObject/DeleteObjects and the specific tagging operations) and the exact semantics. -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: [email protected] For queries about this service, please contact Infrastructure at: [email protected] --------------------------------------------------------------------- To unsubscribe, e-mail: [email protected] For additional commands, e-mail: [email protected]
