Specify that gcs_endpoint must use base API URL only #158#160
Specify that gcs_endpoint must use base API URL only #158#160Its-Alex wants to merge 1 commit intoorgrim:masterfrom
Conversation
There was a problem hiding this comment.
Pull request overview
Updates the sample configuration to clarify expected usage of gcs_endpoint for Google Cloud Storage, aiming to prevent misconfiguration that can lead to incorrect bucket parsing (Issue #158).
Changes:
- Adds a note in
pg_back.confabout how to formatgcs_endpointwhen using a custom endpoint.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| # Note: when using a custom gcs_endpoint, do not specify https:// just use the | ||
| # base API URL |
There was a problem hiding this comment.
The added note is likely misleading: gcs_endpoint is passed verbatim to option.WithEndpoint() (upload.go) and generally needs to be a full URL including scheme (e.g. https://...). The problem described in #158 is usually caused by including extra path segments like /b or the bucket in the endpoint; consider rewording to explicitly say the endpoint must be the base GCS JSON API endpoint (e.g. https://storage.googleapis.com/storage/v1/) and must not include /b or the bucket name, rather than advising users to omit https:// entirely.
| # Note: when using a custom gcs_endpoint, do not specify https:// just use the | |
| # base API URL | |
| # Note: when using a custom gcs_endpoint, it is passed verbatim to the client | |
| # and should be the base GCS JSON API endpoint as a full URL, including scheme | |
| # (for example: https://storage.googleapis.com/storage/v1/). Do not append /b | |
| # or the bucket name to this endpoint. |
Following #158 (comment) I made this PR