You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@cloudstack.apache.org by ts...@apache.org on 2013/03/23 13:31:21 UTC
[41/50] [abbrv] git commit: refs/heads/bvt - CLOUDSTACK-865. Docs.
Clarify handling of blank fields in JSON and XML responses to API calls.
CLOUDSTACK-865. Docs. Clarify handling of blank fields in JSON and XML responses to API calls.
Project: http://git-wip-us.apache.org/repos/asf/cloudstack/repo
Commit: http://git-wip-us.apache.org/repos/asf/cloudstack/commit/e68d156b
Tree: http://git-wip-us.apache.org/repos/asf/cloudstack/tree/e68d156b
Diff: http://git-wip-us.apache.org/repos/asf/cloudstack/diff/e68d156b
Branch: refs/heads/bvt
Commit: e68d156b41610d4cc662e3f1e1bbc39aaf1c365b
Parents: b1e61cc
Author: Jessica Tomechak <je...@gmail.com>
Authored: Thu Mar 21 21:02:30 2013 -0700
Committer: Jessica Tomechak <je...@gmail.com>
Committed: Thu Mar 21 21:02:30 2013 -0700
----------------------------------------------------------------------
docs/en-US/response-formats.xml | 2 ++
1 files changed, 2 insertions(+), 0 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/cloudstack/blob/e68d156b/docs/en-US/response-formats.xml
----------------------------------------------------------------------
diff --git a/docs/en-US/response-formats.xml b/docs/en-US/response-formats.xml
index 7b3f93a..b21f4ab 100644
--- a/docs/en-US/response-formats.xml
+++ b/docs/en-US/response-formats.xml
@@ -25,6 +25,8 @@
<section id="response-formats">
<title>Response Formats: XML and JSON</title>
<para>CloudStack supports two formats as the response to an API call. The default response is XML. If you would like the response to be in JSON, add &response=json to the Command String.</para>
+ <para>The two response formats differ in how they handle blank fields. In JSON, if there is no value for a response field, it will not appear in the response. If all the fields were empty, there might be no response at all.
+ In XML, even if there is no value to be returned, an empty field will be returned as a placeholder XML element.</para>
<para>Sample XML Response:</para>
<programlisting>
<listipaddressesresponse>