Merge pull request #1658 from swill/api_diff_gen

Added an additional JSON diff output to the ApiXmlDocReaderThe original TXT 
diff format is very hard to work with if you are trying to programmatically use 
the output to generate documentation.  Previously, @pdion891 spent a lot of 
time trying to manually reformat this output in order for it to be represented 
in the Release Notes.

This pull request adds JSON as an output format as well as the existing TXT to 
simplify the ability for parsers and generators to use the output.

This new JSON format was used to generate the 4.9.0 release notes (that code 
will be contributed separately).

Old manually formatted output:
http://docs.cloudstack.apache.org/projects/cloudstack-release-notes/en/4.7.0/api-changes.html

New auto-formatted output using this new JSON output:
http://docs.cloudstack.apache.org/projects/cloudstack-release-notes/en/4.9.0/api-changes.html

I have included the output of the `diff.txt` as well as the `diff.json` to this 
PR so you can see the resulting output of both file formats (diff between 4.8 
and 4.9).

[diff.txt.zip](https://github.com/apache/cloudstack/files/432983/diff.txt.zip)
[diff.json.zip](https://github.com/apache/cloudstack/files/432982/diff.json.zip)

* pr/1658:
  Added JSON diff output to the ApiXmlDocReader in additon TXT for parsability

Signed-off-by: Will Stevens <[email protected]>


Project: http://git-wip-us.apache.org/repos/asf/cloudstack/repo
Commit: http://git-wip-us.apache.org/repos/asf/cloudstack/commit/6b9cd283
Tree: http://git-wip-us.apache.org/repos/asf/cloudstack/tree/6b9cd283
Diff: http://git-wip-us.apache.org/repos/asf/cloudstack/diff/6b9cd283

Branch: refs/heads/4.9-bountycastle-daan
Commit: 6b9cd2832bb16343ff39afaf7093954ec5a38a56
Parents: 2acb0b7 0e5e602
Author: Will Stevens <[email protected]>
Authored: Mon Sep 12 14:42:15 2016 -0400
Committer: Will Stevens <[email protected]>
Committed: Mon Sep 12 14:42:16 2016 -0400

----------------------------------------------------------------------
 .../src/com/cloud/api/doc/ApiXmlDocReader.java  | 74 ++++++++++++++++++--
 1 file changed, 68 insertions(+), 6 deletions(-)
----------------------------------------------------------------------


Reply via email to