Skip to content

Conversation

@MantasMiksys
Copy link
Contributor

desc= prefix is required when creating a snapshot with a description.

@vercel
Copy link

vercel bot commented Sep 15, 2025

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Preview Comments Updated (UTC)
docs-redirect Ready Ready Preview Comment Sep 15, 2025 1:11pm
tigris-os-docs Ready Ready Preview Comment Sep 15, 2025 1:11pm

Copy link
Contributor

@greptile-apps greptile-apps bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Greptile Summary

This PR fixes a documentation error in the bucket snapshots guide by adding the required desc= prefix to the X-Tigris-Snapshot header format. The change corrects the syntax for creating snapshots with descriptions across all three code examples (Go, JavaScript, and Python).

The modification updates the header format from "X-Tigris-Snapshot": "true; test snapshot description" to "X-Tigris-Snapshot": "true; desc=test snapshot description" in all language examples. This ensures that when users follow the documentation to create bucket snapshots with descriptions, the Tigris API will properly parse and recognize the description parameter.

This change fits into the broader documentation ecosystem by maintaining consistency with the actual Tigris API specification. The snapshots and forks documentation is part of the bucket management section, and this correction ensures users can successfully implement snapshot functionality with descriptions as intended by the API design.

Confidence score: 5/5

  • This PR is safe to merge with minimal risk as it only corrects documentation syntax
  • Score reflects a simple documentation fix that aligns with API requirements without any code logic changes
  • No files require special attention as this is a straightforward text correction

1 file reviewed, no comments

Edit Code Review Bot Settings | Greptile

@MantasMiksys MantasMiksys merged commit cace5c3 into main Sep 15, 2025
10 checks passed
@MantasMiksys MantasMiksys deleted the mm/snap-header-fix branch September 15, 2025 13:18
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants