From 4d33735d9d6d52b97b861aa73ac440361ed6f4db Mon Sep 17 00:00:00 2001 From: Malte Poll <1780588+malt3@users.noreply.github.com> Date: Mon, 24 Feb 2025 14:03:38 +0100 Subject: [PATCH] remoteapis: improve configuration docs --- docs/providers/remoteapis.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/providers/remoteapis.md b/docs/providers/remoteapis.md index 6eac4dc..cd6ce51 100644 --- a/docs/providers/remoteapis.md +++ b/docs/providers/remoteapis.md @@ -27,11 +27,11 @@ While mTLS cannot be setup using a credential helper, any authentication scheme The configuration in `.tweag-credential-helper.json` supports the following values: - `.urls[].helper`: `"remoteapis"` (name of the helper) -- `.urls[].auth_method`: one of +- `.urls[].config.auth_method`: one of - `"header"`: Default. Send a HTTP header with the value being the default secret. - `"basic_auth"` Used by `bazel-remote`. Send the default secret containing username and password (`username:password`) as a basic auth header. -- `.urls[].header_name`: Name of the HTTP header used for authentication. Example: use `"x-buildbuddy_api_key"` for BuildBuddy. -- `.urls[].lookup_chain`: The [lookup chain][lookup_chain] used to find the `default` secret. Defaults to: +- `.urls[].config.header_name`: Name of the HTTP header used for authentication. Example: use `"x-buildbuddy_api_key"` for BuildBuddy. +- `.urls[].config.lookup_chain`: The [lookup chain][lookup_chain] used to find the `default` secret. Defaults to: ```json [ {