Adding descriptions to thirft API methods
Project: http://git-wip-us.apache.org/repos/asf/airavata/repo Commit: http://git-wip-us.apache.org/repos/asf/airavata/commit/4c8d3967 Tree: http://git-wip-us.apache.org/repos/asf/airavata/tree/4c8d3967 Diff: http://git-wip-us.apache.org/repos/asf/airavata/diff/4c8d3967 Branch: refs/heads/master Commit: 4c8d396745b1ed13c3fe7ff17f16aff012cd9ac4 Parents: 9462bd1 Author: Eroma Abeysinghe <[email protected]> Authored: Wed Dec 16 09:42:35 2015 -0500 Committer: Eroma Abeysinghe <[email protected]> Committed: Wed Dec 16 09:42:35 2015 -0500 ---------------------------------------------------------------------- .../airavata-apis/airavata_api.thrift | 15 ++++++++++++++- 1 file changed, 14 insertions(+), 1 deletion(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/airavata/blob/4c8d3967/thrift-interface-descriptions/airavata-apis/airavata_api.thrift ---------------------------------------------------------------------- diff --git a/thrift-interface-descriptions/airavata-apis/airavata_api.thrift b/thrift-interface-descriptions/airavata-apis/airavata_api.thrift index 928af6b..179a842 100644 --- a/thrift-interface-descriptions/airavata-apis/airavata_api.thrift +++ b/thrift-interface-descriptions/airavata-apis/airavata_api.thrift @@ -304,7 +304,13 @@ service Airavata { 4: airavata_errors.AuthorizationException ae) /** - * Update a Project + * Update an Existing Project + * + * @param projectId + * The projectId of the project needed an update. + * + * @return void + * Currently this does not return any value. * */ void updateProject (1: required security_model.AuthzToken authzToken, @@ -318,6 +324,13 @@ service Airavata { /** * Get a Project by ID + * This method is to obtain a project by providing a projectId + * + * @param projectId + * projectId of the project you require + * + * @return project + * project data model will be returned * */ workspace_model.Project getProject (1: required security_model.AuthzToken authzToken, 2: required string projectId)
