proposals icon indicating copy to clipboard operation
proposals copied to clipboard

designs/2022-06-07-bazel-credential-helpers.md says request has "url", but bazel uses "uri"

Open ukai opened this issue 2 years ago • 2 comments

https://github.com/bazelbuild/proposals/blob/main/designs/2022-06-07-bazel-credential-helpers.md

get: Retrieves credentials. The payload provided as standard input to the credential helper will be a json object with a single key url containing the url (including the protocol) to get credentials for ({"url": "..."}).

but https://github.com/bazelbuild/bazel/blob/c00e8e623b717ecb734feeeb8f268af718b95683/src/main/java/com/google/devtools/build/lib/authandtls/credentialhelper/GetCredentialsRequest.java#L66

  writer.name("uri").value(value.getUri().toString());

ukai avatar Jul 26 '23 11:07 ukai

Thanks, I've sent https://github.com/bazelbuild/proposals/pull/328 to fix the example in the proposal.

More importantly, we need better user-facing documentation on how to write a credential helper - note that proposals only describe the initial design for a feature and are not supposed to be kept up to date as the implementation evolves, but in the case of credential helpers the documentation is lacking, so your expectation that the proposal should be up to date is reasonable.

tjgq avatar Jul 26 '23 14:07 tjgq

thanks!

yeah. the doc is referenced from flag help message. https://github.com/bazelbuild/bazel/blob/7a262a6ee88e0ecc10705c460e38efe32c8543e2/src/main/java/com/google/devtools/build/lib/authandtls/AuthAndTLSOptions.java#L159

It would be nice if it points to spec doc, rather than proposals.

ukai avatar Jul 27 '23 01:07 ukai

With https://github.com/bazelbuild/proposals/pull/328 having been merged, can this issue be closed?

philwo avatar Apr 13 '25 04:04 philwo