opendev/gerrit
Code Issues Proposed changes

Document how to get pretty-printed JSON for REST calls

Browse Source 
Since change I2f1cb91e9 the returned JSON is always compacted which
makes it hard to read for humans. Explain in the docs how to get
pretty-printed JSON.

Change-Id: Ia659eeb9a07277883ca8a725adfa7d8640ac50b9
This commit is contained in:
Edwin Kempin
2021-02-26 12:16:20 +01:00
parent d096ff2faa
commit 427c7d8724
1 changed files with 5 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

5
Documentation/dev-rest-api.txt
View File

@@ -50,6 +50,11 @@ Example to set a Gerrit project's link:rest-api-projects.html#set-project-descri
curl -X PUT --user john:2LlAB3K9B0PF --data-binary @project-desc.txt --header "Content-Type: application/json; charset=UTF-8" http://localhost:8080/a/projects/myproject/description
----
[[pretty-json]]
=== Pretty JSON
By default any JSON in responses is compacted. To get pretty-printed JSON add `pp=1` to the request.
=== Authentication
To test APIs that require authentication, the username and password must be specified on