Skip to content

docs(storage): add comprehensive JSDoc documentation to GetSignedUrlConfig interface properties#8782

Draft
thiyaguk09 wants to merge 2 commits into
googleapis:mainfrom
thiyaguk09:docs/issue-7352-getsignedurlconfig
Draft

docs(storage): add comprehensive JSDoc documentation to GetSignedUrlConfig interface properties#8782
thiyaguk09 wants to merge 2 commits into
googleapis:mainfrom
thiyaguk09:docs/issue-7352-getsignedurlconfig

Conversation

@thiyaguk09

Copy link
Copy Markdown
Contributor

Thank you for opening a Pull Request! Before submitting your PR, there are a few things you can do to make sure it goes smoothly:

  • Make sure to open an issue as a bug/issue before writing your code! That way we can discuss the change, evaluate designs, and agree on the general idea
  • Ensure the tests and linter pass
  • Code coverage does not decrease (if any source code was changed)
  • Appropriate docs were updated (if necessary)

Fixes #7352

@product-auto-label product-auto-label Bot added the api: storage Issues related to the Cloud Storage API. label Jun 30, 2026

@gemini-code-assist gemini-code-assist Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Code Review

This pull request adds detailed JSDoc documentation to the properties of the GetSignedUrlConfig interface in handwritten/storage/src/file.ts. The review feedback recommends clarifying the documentation in two areas: first, by explicitly noting that promptSaveAs takes precedence over and overrides responseDisposition if both are provided; and second, by correcting the description of queryParams to specify that only query parameters starting with x-goog- are included in the signature for V4 signed URLs.

Comment thread handwritten/storage/src/file.ts
Comment thread handwritten/storage/src/file.ts
Comment thread handwritten/storage/src/file.ts
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

api: storage Issues related to the Cloud Storage API.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Missing GetSignedUrlConfig type documentation

1 participant