kishan
57f935ca03
Added since version to API response docs
2012-03-27 11:12:59 +05:30
Alena Prokharchyk
50b2c26d3e
Fixed XML api writer
...
Reviewed-by: Alena
2012-02-27 12:38:30 -08:00
Alena Prokharchyk
d4a8db75d7
bug 13763: fixed api doc for logout command
...
status 13763: resolved fixed
Reviewed-by: Jessica Tomechak
2012-02-22 15:17:22 -08:00
Alena Prokharchyk
8f91856822
bug 11859: Added Usage param to @Implementation in API docs. Usage would explain what parameters combinations are valid for specific cases
...
status 11859: resolved fixed
2011-11-28 14:40:13 -08:00
Alena Prokharchyk
c66842b640
bug 11812: added domainId parameter to "login" api doc
...
status 11812: resolved fixed
2011-11-22 15:34:07 -08:00
Alena Prokharchyk
3c3cf26f64
Fixed API doc problem
2011-11-09 13:27:35 -08:00
kishan
8ee876a9a2
bug 10405: Added annontation since for API Commands and request parameters. Whenever a new APi or parameter is added since=version should be added
...
status 10405: resolved fixed
2011-10-27 14:18:34 +05:30
Edison Su
9391938908
fix conflict
2011-08-24 18:47:09 -07:00
alena
4005c7bcce
bug 10193: modified description field for login api call in API docs
...
status 10193: resolved fixed
2011-06-20 16:25:08 -07:00
alena
40d4bbeb11
bug 10088: Fixed apiXmlDoc generator to generate correct set of domain admin commands - got broken by checkin fff4112c0b2407e754318ea31f2f1bb7e92b8f12 "Introducing a new user role in cloudstack called RESOURCE_DOMAIN_ADMIN"
...
status 10088: resolved fixed
2011-06-16 12:14:55 -07:00
alena
694944e996
bug 9436: include page/pageSize/keyword to api xml doc for each list* command
...
status 9436: resolved fixed
Conflicts:
server/src/com/cloud/api/doc/ApiXmlDocWriter.java
2011-04-13 16:23:14 -07:00
alena
4460d1cf2c
Fixed api xml doc writer
2011-04-11 09:33:36 -07:00
alena
2aeacd5a4c
bug 3179: added "count" parameter to the response to all List* api commands
2011-04-01 19:29:08 -07:00
alena
8de3bacd2b
bug 9026: added ability to turn off apiCommand/commandParameter for docGeneration
...
status 9026: resolved fixed
1) Don't expose following commands in doc:
* registerSSHKeyPair
* createSSHKeyPair
* deleteSSHKeyPair
* listSSHKeyPairs
2) Don't show "sshKeyPairName" parameter for deployVm command
2011-03-23 12:56:58 -07:00
alena
e902e83d13
Fixed bug in xmlDocWriter: use "domain" parameter instead of "domainId" for "login" command
2011-03-04 10:31:58 -08:00
alena
be76a51dbe
Api xml doc generator: define if command is sync or async in the xml doc
2011-02-28 16:28:54 -08:00
alena
74e878ea7f
Fixed xml doc writer
2011-02-09 19:35:03 -08:00
alena
1c7049ef26
Forgot to write login/logout commands to domainAdmin/regularUser api xml doc
2011-02-08 16:28:58 -08:00
alena
0bdefe03ae
Added login/logout command generation to xml api doc generator
2011-02-08 15:25:55 -08:00
alena
e256285b05
Generate alerts_types.xml document along with other xml docs.
2011-01-25 10:37:00 -08:00
alena
0d2be33b2d
Changed response format in xml api doc generator
2011-01-14 17:55:32 -08:00
alena
5af31fc97c
Modified API xml doc writer - sort request and response parameters in alphabetical order.
2011-01-14 11:18:54 -08:00
alena
4418e8f245
Don't zip Api xml doc directory in java code, rpm script will do it
2011-01-12 12:18:53 -08:00
alena
6ebbff60f4
Fixed Api xml doc generator
2011-01-11 15:26:04 -08:00
alena
0c38485c19
Added missing descriptions to a bunch of api commands
2011-01-10 20:30:29 -08:00
alena
5dde719988
Api xmlDocWriter: write each xml command to single file for 1)rootAdmin 2)domainAdmin 3)regularUser
2011-01-10 19:12:16 -08:00
alena
bc74fefe68
Api xmlDocWriter: create 2 output .xml files; one contains commands in the order defined in commands.properties.in file, another - commands in alphabetical order.
2011-01-10 14:36:07 -08:00
alena
7bf7f3d284
Api xml doc: generate xml per command in addition to xml containing all api commands
2011-01-10 12:17:57 -08:00
alena
140d704e2f
Generate separate xml Api docs for regularUser/domainAdmin/rootAdmin
2011-01-07 18:40:47 -08:00
alena
050eed742f
1) Removed account/domainId info from deleteSnapshot and deleteSnapshotPolicy commands as we get account info from the snapshot/policy object.
...
2) Introduced responseObject field in @Implementation for all apis. This field contains information about the response object class, so we can used it for generating API documentation.
2010-11-12 17:36:17 -08:00
alena
b1194e68f7
Fixed the build
2010-11-10 10:14:08 -08:00
alena
afd79a9b1b
Code cleanup
2010-10-26 13:59:11 -07:00
alena
fb50fe624c
* Added descriptions for Api command's request and response parameters.
...
* Changed response type for DeleteDomain and DeletePreallocatedLun commands to SuccessResponse
* Implemented small tool (ApiXmlDocReader) for comparing api commands of different product versions.
2010-10-11 09:21:42 -07:00
alena
e7b478f43d
Added descriptions for Api commands and corresponding requrest parameters
2010-10-07 14:46:29 -07:00
alena
136060e5cf
1) Finished XmlApiDoc writer. The program gets api classes from commands.properties.in file, and build Command objects with "name"/"description"/"request"/"response" fields. Request and response are represented by the list of arguments, each argument contains "name"/"description"/"isrequired" fields. The commands are being serialized to commands.xml using imported xstream library, and can be desiarialized later - it will help to compare commands from differemt product versions.
...
2) Added description() methods to Implementation and Param annotations.
2010-10-04 09:50:14 -07:00
