Commit Graph

9 Commits

Author SHA1 Message Date
Prasanna Santhanam a789d43ded marvin_refactor: Derive the entity from the responseObject
The API discovery service is enhanced to include the entity that an API
will act upon. Also included are the changes for API doc generation.

For APIs that don't provide a direct relationship to their entities we
use the related parameter to derive the entity.

Signed-off-by: Prasanna Santhanam <tsp@apache.org>
2013-10-31 13:54:18 +05:30
David Nalley e87558256c Patch from Chip Childers
https://reviews.apache.org/r/5704/
License header updates for the server folder
2012-07-02 09:51:21 -04:00
frank 2f634c0913 Switch to Apache license 2012-04-03 04:50:05 -07: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
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
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
Alex Huang 3a9d6884ce Removed useless code 2011-01-20 09:54:05 -08: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 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