Skip to content

merge acs-api-commands project into tools #11098

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
wants to merge 51 commits into
base: main
Choose a base branch
from
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
51 commits
Select commit Hold shift + click to select a range
b9a1248
Initial commit
pdion891 Dec 6, 2014
a98a6bc
initial commit
pdion891 Dec 6, 2014
692236c
minor changes
pdion891 Dec 6, 2014
5b3f054
more versions
pdion891 Dec 6, 2014
7c49a39
add diff files
pdion891 Dec 6, 2014
ea03df9
update README
pdion891 Dec 6, 2014
dd27059
fix merge
pdion891 Dec 6, 2014
4501d0b
4.4.2 to 4.5.0
pdion891 Feb 7, 2015
8625a61
update 4.6.0
pdion891 Oct 11, 2015
be6d1b9
updated 4.6.0 from rc2
pdion891 Nov 13, 2015
08d0ff4
add 4.7.0
pdion891 Dec 14, 2015
3c0b94f
4.8.0
pdion891 Feb 14, 2016
ee9d2f3
added 4.9 and fixed readme
swill Aug 3, 2016
3782769
Merge pull request #1 from swill/master
pdion891 Aug 3, 2016
39e2e0d
updated typo in readme
swill Jul 7, 2017
368d165
updated the readme to be more complete
swill Jul 7, 2017
0e05f7d
updated readme with more detailed instructions
swill Jul 7, 2017
26df21e
fixed a typo in the commands
swill Jul 7, 2017
20a1f60
updated readme to fix another typo
swill Jul 7, 2017
b1a92eb
updated the readme
swill Jul 7, 2017
f9496ef
added the 4.10 release
swill Jul 7, 2017
aca9cad
Merge pull request #2 from swill/master
pdion891 Jul 7, 2017
18f7fb9
add everything after 4.10
andrijapanicsb Apr 21, 2020
4d259c1
reorganised older files, renamed new ones to new naming scheme
andrijapanicsb Apr 21, 2020
867a288
readme
andrijapanicsb Apr 21, 2020
4153621
readme
andrijapanicsb Apr 21, 2020
38c102b
readme
andrijapanicsb Apr 21, 2020
420f5cb
delete 4.13 for test run via automation
andrijapanicsb Apr 21, 2020
b4dfdaa
Add files via upload
andrijapanicsb Apr 29, 2020
4a3d203
adding 4.13 commands
andrijapanicsb Apr 29, 2020
c25cb2a
Delete 4.13_commands.xml
andrijapanicsb Apr 29, 2020
4659dc1
Merge branch 'master' of github.com:shapeblue/acs-api-commands
andrijapanicsb Apr 29, 2020
e21cd1e
Adding 4.14 files
andrijapanicsb May 25, 2020
679dc1b
Update README.md
andrijapanicsb May 25, 2020
9407a1a
Update README.md
andrijapanicsb May 25, 2020
3222d40
Update README.md
andrijapanicsb May 25, 2020
df1f8bd
Merge pull request #3 from shapeblue/master
pdion891 May 25, 2020
30541d5
4.15 changes
rohityadavcloud Jan 11, 2021
ebebb26
Merge pull request #4 from shapeblue/master
pdion891 Jan 11, 2021
6d0697e
4.16.0 changes
nvazquez Nov 8, 2021
ed6d32f
Merge pull request #6 from shapeblue/master
pdion891 Nov 8, 2021
ae25635
4.17.0 Release
nvazquez Jun 6, 2022
2ace912
Merge pull request #7 from shapeblue/4170cmds
pdion891 Jun 6, 2022
c81f008
4.18 api docs
DaanHoogland Feb 14, 2023
df548fc
final version of 4.18 API
DaanHoogland Mar 16, 2023
68298df
Merge pull request #8 from shapeblue/4.18
pdion891 Mar 16, 2023
1165fa8
Add 4.19 and 4.20 api commands
Dec 10, 2024
c5ada5c
Merge pull request #9 from scclouds/add-419-and-420-commands
pdion891 Dec 18, 2024
73ea0f2
Add 'tools/apidoc-versions-diff/' from commit 'c5ada5ca4e821d61973825…
pdion891 Jun 27, 2025
d94cbc3
remove unnecessary license file, update README for updated path.
pdion891 Jun 27, 2025
16d6529
fix lint
pdion891 Jun 27, 2025
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
92,330 changes: 92,330 additions & 0 deletions tools/apidoc-versions-diff/4.11_commands.xml

Large diffs are not rendered by default.

93,090 changes: 93,090 additions & 0 deletions tools/apidoc-versions-diff/4.12_commands.xml

Large diffs are not rendered by default.

93,572 changes: 93,572 additions & 0 deletions tools/apidoc-versions-diff/4.13_commands.xml

Large diffs are not rendered by default.

100,485 changes: 100,485 additions & 0 deletions tools/apidoc-versions-diff/4.14_commands.xml

Large diffs are not rendered by default.

103,247 changes: 103,247 additions & 0 deletions tools/apidoc-versions-diff/4.15_commands.xml

Large diffs are not rendered by default.

104,122 changes: 104,122 additions & 0 deletions tools/apidoc-versions-diff/4.16_commands.xml

Large diffs are not rendered by default.

106,301 changes: 106,301 additions & 0 deletions tools/apidoc-versions-diff/4.17_commands.xml

Large diffs are not rendered by default.

115,526 changes: 115,526 additions & 0 deletions tools/apidoc-versions-diff/4.18_commands.xml

Large diffs are not rendered by default.

130,842 changes: 130,842 additions & 0 deletions tools/apidoc-versions-diff/4.19_commands.xml

Large diffs are not rendered by default.

140,119 changes: 140,119 additions & 0 deletions tools/apidoc-versions-diff/4.20_commands.xml

Large diffs are not rendered by default.

55 changes: 55 additions & 0 deletions tools/apidoc-versions-diff/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,55 @@
acs-api-commands
================

Collection of API commands.xml of [Apache CloudStack](http://cloudstack.apache.org/) versions. used to generate
[Apache CloudStack Release Notes](http://docs.cloudstack.apache.org/en/latest/releasenotes/index.html).

[How To Generate CloudStack API Documentation](https://cwiki.apache.org/confluence/display/CLOUDSTACK/How+To+Generate+CloudStack+API+Documentation)

Install NonOSS Dependencies
---------------------------

```bash
$ cd /tmp
$ git clone https://github.com/rhtyd/cloudstack-nonoss.git nonoss
$ cd nonoss && bash -x install-non-oss.sh
```

Build API doc
-------------

```bash
$ cd /path/to/cloudstack
$ git fetch <upstream>
$ git checkout main
$ git checkout <release_commit>
$ mvn -Pdeveloper -Dnoredist clean install -DskipTests=true
$ mvn -Pdeveloper -Dnoredist clean install -pl :cloud-apidoc
```

Generate Diff
-------------

```bash
$ cd /path/to/cloudstack
$ export COMMANDS=/path/to/tools/apidoc-versions-diff
$ export OLD_RELEASE=4.13
$ export NEW_RELEASE=4.14
$ cp tools/apidoc/target/commands.xml $COMMANDS/${NEW_RELEASE}_commands.xml
$ mkdir $COMMANDS/diff-${OLD_RELEASE//.}-${NEW_RELEASE//.}
$ java -cp $HOME/.m2/repository/com/thoughtworks/xstream/xstream/1.4.11.1/xstream-1.4.11.1.jar:$HOME/.m2/repository/com/google/code/gson/gson/1.7.2/gson-1.7.2.jar:server/target/classes com.cloud.api.doc.ApiXmlDocReader -old $COMMANDS/${OLD_RELEASE}_commands.xml -new $COMMANDS/${NEW_RELEASE}_commands.xml -d $COMMANDS/diff-${OLD_RELEASE//.}-${NEW_RELEASE//.}
```

Note
----

- For easier automation (i.e. select the "OLD_RELEASE" by simply choosing a previous branch like "4.12" or 4.13")
- and
- taking into consideration that the minor release never has a new/removed API/command (and very rarely changed/updated an existing API call)
- and
- taking into the consideration that we have never so far documented API changes between minor versions (i.e. 4.11.0 and 4.11.1),
- ...
- the naming scheme, used as of 4.11, is now in X.Y form (i.e. 4.11 or 4.12) instead of minor version (4.11.0 or 4.12.0),
while the older generated documentation was moved to folder "before-4.11".

In order to generate .rst version based on the diffs generated here, as well as for the generating a list of PRs/changes/fixed issues in the new release, please see https://github.com/swill/generate_acs_rn
Loading
Loading