diff options
| author | Chris Poucet <poucet@google.com> | 2023-08-22 07:11:13 +0000 |
|---|---|---|
| committer | Gerrit Code Review <noreply-gerritcodereview@google.com> | 2023-08-22 07:11:13 +0000 |
| commit | bbb6ed83d92aed38a12985644d5bb685b2a4a4d3 (patch) | |
| tree | 71b70e66fd842d3ae25b9a182399274d0a1c4477 | |
| parent | b0f6a1ce9f51aa2ee8dfc412bce2899715229408 (diff) | |
| parent | 5cfec3458cb9a34af3844718d40ff951bd05144b (diff) | |
Merge "Updated custom-keyed-values documentation"
| -rw-r--r-- | Documentation/rest-api-changes.txt | 5 |
1 files changed, 5 insertions, 0 deletions
diff --git a/Documentation/rest-api-changes.txt b/Documentation/rest-api-changes.txt index 844f4c6182..8aa5c7f669 100644 --- a/Documentation/rest-api-changes.txt +++ b/Documentation/rest-api-changes.txt @@ -2916,6 +2916,11 @@ Adds and/or removes custom keyed values from a change. The custom keyed values to add or remove must be provided in the request body inside a link:#custom-keyed-values-input[CustomKeyedValuesInput] entity. +Note that custom keyed values are expected to be small in both key and value. +A typical use-case would be storing the ID to some external system, in which +case the key would be something unique to that system and the value would be +the ID. + .Request ---- POST /changes/myProject~master~I8473b95934b5732ac55d26311a706c9c2bde9940/custom_keyed_values HTTP/1.0 |