search

GoogleCloudPlatform / cloud-sql-proxy

A utility for connecting securely to your Cloud SQL instances
Apache License 2.0
1.27k stars 346 forks source link

docs: update documentation of accepted /quitquitquit HTTP methods #2255

Closed wolfpeyton closed 3 months ago

wolfpeyton commented 3 months ago

In version 2.7.0, the /quitquitquit endpoint was updated to accept GET requests (in addition to POST requests, which it already accepted). See changelog. Also see the PR that made this change, https://github.com/GoogleCloudPlatform/cloud-sql-proxy/pull/1947.

Recently, while debugging a k8s shutdown problem, I quickly skimmed the readme to check that I was using /quitquitquit correctly and became convinced that I wasn't because I was sending a GET request. I had copied the example here, but didn't remember that in the moment:

https://github.com/GoogleCloudPlatform/cloud-sql-proxy/blob/848e1ea79287ac4772d603ff6391d0fcd8483cb5/examples/k8s-health-check/proxy_with_http_health_check.yaml#L107-L115

Updating the docs to be more complete on this topic.

jackwotherspoon commented 3 months ago

Thanks @wolfpeyton for this great catch and helping make our docs better for future users! Greatly appreciated 😄