aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorYannic <yannic@engflow.com>2023-04-11 15:25:03 +0200
committerGitHub <noreply@github.com>2023-04-11 06:25:03 -0700
commit2871680f9f28be4208686bab798fad6c1024d1f1 (patch)
tree1b5050d9f2c8300d85397cba09df032cd28081ba
parent79bd54eb9b5f19586f61bbd8f47a7fe2c9d9e7fe (diff)
downloadbazelbuild-remote-apis-2871680f9f28be4208686bab798fad6c1024d1f1.tar.gz
Clarify that the syntax of `instance_name` is decided by the server (#245)
I.e., servers may impose limitations on the `instance_name` they accept (e.g., that it does not contain slashes, newlines, or emojis).
-rw-r--r--build/bazel/remote/execution/v2/remote_execution.proto9
1 files changed, 5 insertions, 4 deletions
diff --git a/build/bazel/remote/execution/v2/remote_execution.proto b/build/bazel/remote/execution/v2/remote_execution.proto
index d39afcd..662274b 100644
--- a/build/bazel/remote/execution/v2/remote_execution.proto
+++ b/build/bazel/remote/execution/v2/remote_execution.proto
@@ -212,10 +212,11 @@ service ActionCache {
// `{instance_name}/uploads/{uuid}/blobs/{digest_function/}{hash}/{size}{/optional_metadata}`
//
// Where:
-// * `instance_name` is an identifier, possibly containing multiple path
-// segments, used to distinguish between the various instances on the server,
-// in a manner defined by the server. If it is the empty path, the leading
-// slash is omitted, so that the `resource_name` becomes
+// * `instance_name` is an identifier used to distinguish between the various
+// instances on the server. Syntax and semantics of this field are defined
+// by the server; Clients must not make any assumptions about it (e.g.,
+// whether it spans multiple path segments or not). If it is the empty path,
+// the leading slash is omitted, so that the `resource_name` becomes
// `uploads/{uuid}/blobs/{digest_function/}{hash}/{size}{/optional_metadata}`.
// To simplify parsing, a path segment cannot equal any of the following
// keywords: `blobs`, `uploads`, `actions`, `actionResults`, `operations`,