Brad Buckingham wrote:
Miroslav Suchý wrote:
<http://git.fedorahosted.org/git/?p=spacewalk.git;a=commitdiff;h=c55ad4bf0952843b458b33579544338069cb442e>
May I ask that with new API addition/change we bump minor number of
web.apiversion in file web/conf/rhn_web.conf
And in Javadoc we write comment similar to:
Available since API version 10.1
Mirek,
Thanks for the suggestion. Sure, I'll commit a change today.
Brad
_______________________________________________
Spacewalk-devel mailing list
Spacewalk-devel@redhat.com
https://www.redhat.com/mailman/listinfo/spacewalk-devel
Team,
I updated the API doclet that is used to generate our API docs to
support the javadoc '@since' tag. As a result, when adding a new API or
modifying the signature/return of an API, if you add this tag, it will
reflect the version in the generated API documentation.
For example, the following is the 'code' for the listSnapshotPackages API:
/**
* list the packages for a given snapshot
* @param sessionKey key
* @param snapId snapshot id
* @return Set of packageNEvra objects
* @since 10.1
*
* @xmlrpc.doc List the packages associated with a snapshot.
* @xmlrpc.param #session_key()
* @xmlrpc.param #param("int", "snapId")
* @xmlrpc.returntype
* #array()
* $PackageNevraSerializer
* #array_end()
*/
From this, the following API doc will get generated:
Method: listSnapshotPackages
Description:
List the packages associated with a snapshot.
Parameters:
* string sessionKey
* int snapId
Returns:
* array:
o struct - package nvera
+ string "name"
+ string "epoch"
+ string "version"
+ string "release"
+ string "arch"
Available since: 10.1
cheers,
Brad
_______________________________________________
Spacewalk-devel mailing list
Spacewalk-devel@redhat.com
https://www.redhat.com/mailman/listinfo/spacewalk-devel
