Skip to content

Fix create snapshot header description separator #267

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
MantasMiksys merged 1 commit into from
Sep 15, 2025
Merged

Fix create snapshot header description separator #267

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions docs/buckets/snapshots-and-forks.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -219,7 +219,7 @@ header: `X-Tigris-Snapshot: true`.

Snapshot description can optionally be specified as part of that header (with
semicolon separator), e.g.,
`X-Tigris-Snapshot: true; test snapshot description`.
`X-Tigris-Snapshot: true; desc=test snapshot description`.

<Tabs groupId="languages">
<TabItem value="go" label="Go">
Expand All @@ -228,7 +228,7 @@ Example using the Go SDK `github.com/aws/aws-sdk-go-v2/service/s3`:
```go
func createBucketSnapshot(ctx context.Context, client *s3.Client, bucketName string) error {
_, err := client.CreateBucket(ctx, &s3.CreateBucketInput{Bucket: aws.String(bucketName)}, func(options *s3.Options) {
options.APIOptions = append(options.APIOptions, http.AddHeaderValue("X-Tigris-Snapshot", "true; test snapshot description"))
options.APIOptions = append(options.APIOptions, http.AddHeaderValue("X-Tigris-Snapshot", "true; desc=test snapshot description"))
})
return err
}
Expand All @@ -246,7 +246,7 @@ async function createBucketSnapshot(client, bucketName) {
command.middlewareStack.add(
(next) => async (args) => {
args.request.headers["X-Tigris-Snapshot"] =
"true; test snapshot description";
"true; desc=test snapshot description";
return next(args);
},
{ step: "build" },
Expand All @@ -265,7 +265,7 @@ def create_bucket_snapshot(s3_client, bucket_name):
s3_client.meta.events.register(
"before-sign.s3.CreateBucket",
lambda request, **kwargs: request.headers.add_header(
"X-Tigris-Snapshot", "true; test snapshot description"
"X-Tigris-Snapshot", "true; desc=test snapshot description"
)
)
s3_client.create_bucket(Bucket=bucket_name)
Expand Down