opendev/gerrit
Code Issues Proposed changes

Document that every ID in a REST URL must be URL encoded

Browse Source 
Document this once for the whole REST API instead of writing this for
every REST endpoint again and again.

Change-Id: Ic919d202316a1bef5042732a415bd5b43d75f40f
Signed-off-by: Edwin Kempin <edwin.kempin@sap.com>
This commit is contained in:
Edwin Kempin
2013-02-06 10:12:52 +01:00
parent 724e432f4f
commit 7fe2f7fdbc
3 changed files with 10 additions and 10 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
Documentation/rest-api.txt
View File

@@ -61,6 +61,12 @@ Responses will be gzip compressed by the server if the HTTP
`Accept-Encoding` request header is set to `gzip`. This may
save on network transfer time for larger responses.
[[encoding]]
Encoding
~~~~~~~~
All IDs that appear in the URL of a REST call (e.g. project name, group name)
must be URL encoded.
Endpoints
---------
link:rest-api-accounts.html[/accounts/]::