Repository: airavata-docs Updated Branches: refs/heads/master cfb04eec7 -> acf199467
Adding descriptions to API methods and linking with generated API documentation Project: http://git-wip-us.apache.org/repos/asf/airavata-docs/repo Commit: http://git-wip-us.apache.org/repos/asf/airavata-docs/commit/acf19946 Tree: http://git-wip-us.apache.org/repos/asf/airavata-docs/tree/acf19946 Diff: http://git-wip-us.apache.org/repos/asf/airavata-docs/diff/acf19946 Branch: refs/heads/master Commit: acf199467064e3f31853ca07afc84555d9b31eba Parents: cfb04ee Author: Eroma Abeysinghe <eroma.abeysin...@gmail.com> Authored: Wed Apr 27 12:51:46 2016 -0400 Committer: Eroma Abeysinghe <eroma.abeysin...@gmail.com> Committed: Wed Apr 27 12:51:46 2016 -0400 ---------------------------------------------------------------------- AiravataApi.md | 71 +++++++++++++++++++++++++++-------------------------- 1 file changed, 36 insertions(+), 35 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/airavata-docs/blob/acf19946/AiravataApi.md ---------------------------------------------------------------------- diff --git a/AiravataApi.md b/AiravataApi.md index c75992d..aebaece 100644 --- a/AiravataApi.md +++ b/AiravataApi.md @@ -6,25 +6,25 @@ For Airavata API documentation please visit <a href="http://airavata.apache.org/ | Gateway Function/Feature | Airavata API | Description | |:--------------------------------------|:----------------------------------|:------------------------------| <b style="color:blue;">Project</b> -| Create a Project | createProject | | -| Update Project | updateProject | | -| Get a Project | getProject | | -| Search Project by Name | searchProjectsByProjectName | | -| Search Project by Desc | searchProjectsByProjectDesc | | -| Get all user Projects | getUserProjects | | +| Create a Project | <a href="http://airavata.apache.org/api-docs/0.16/airavata_api.html#Fn_Airavata_createProject"; target="_blank">createProject</a> | Linked with Create Project in PGA. | +| Update Project | <a href="http://airavata.apache.org/api-docs/0.16/airavata_api.html#Fn_Airavata_updateProject"; target="_blank">updateProject</a> | To update Project name and description. | +| Get a Project | <a href="http://airavata.apache.org/api-docs/0.16/airavata_api.html#Fn_Airavata_getProject"; target="_blank">getProject</a> | Retrieve Project by providing the ID. | +| Search Project by Name | <a href="http://airavata.apache.org/api-docs/0.16/airavata_api.html#Fn_Airavata_searchProjectsByProjectName"; target="_blank">searchProjectsByProjectName</a> | Search for Project by giving part or full project name. | +| Search Project by Desc | <a href="http://airavata.apache.org/api-docs/0.16/airavata_api.html#Fn_Airavata_searchProjectsByProjectDesc"; target="_blank">searchProjectsByProjectDesc</a> | Search for Project by giving part or full project description. | +| Get all user Projects | <a href="http://airavata.apache.org/api-docs/0.16/airavata_api.html#Fn_Airavata_getUserProjects"; target="_blank">getUserProjects</a> | Retrieve all Projects of a user. | <b style="color:blue;">Experiment</b> -| Create an Experiment | createExperiment | | -| Update an Experiment | updateExperiment | | -| Get an Experiment | getExperiment | | -| Get Detailed Experiment | getDetailedExperimentTree | | -| Clone an Experiment | cloneExperiment | | -| Cancel an Experiment | terminateExperiment | | -| Search Experiment by Name | searchExperimentsByName | | -| Search Experiment by Desc | searchExperimentsByDesc | | -| Search Experiments by Application Name | searchExperimentsByApplication | | -| Search Experiment by Creation Time | searchExperimentsByCreationTime | | -| Get all user Experiments | getUserProjects | | -| Get Experiments for a Project | getExperimentsInProject | | +| Create an Experiment | <a href="http://airavata.apache.org/api-docs/0.16/airavata_api.html#Fn_Airavata_createExperiment"; target="_blank">createExperiment</a> | Create an Experiment. | +| Update an Experiment | <a href="http://airavata.apache.org/api-docs/0.16/airavata_api.html#Fn_Airavata_updateExperiment"; target="_blank">updateExperiment</a> | Update ab Experiment. Experiments with CREATED exp-status can be updated. | +| Get an Experiment | <a href="http://airavata.apache.org/api-docs/0.16/airavata_api.html#Fn_Airavata_getExperiment"; target="_blank">getExperiment</a> | Retrieve Experiment by providing the experiment ID. | +| Get Detailed Experiment | <a href="http://airavata.apache.org/api-docs/0.16/airavata_api.html#Fn_Airavata_getDetailedExperimentTree"; target="_blank">getDetailedExperimentTree</a> | | +| Clone an Experiment | <a href="http://airavata.apache.org/api-docs/0.16/airavata_api.html#Fn_Airavata_cloneExperiment"; target="_blank">cloneExperiment</a> | | +| Cancel an Experiment | <a href="http://airavata.apache.org/api-docs/0.16/airavata_api.html#Fn_Airavata_terminateExperiment"; target="_blank">terminateExperiment</a> | | +| Search Experiment by Name | <a href="http://airavata.apache.org/api-docs/0.16/airavata_api.html#Fn_Airavata_searchExperimentsByName"; target="_blank">searchExperimentsByName</a> | | +| Search Experiment by Desc | <a href="http://airavata.apache.org/api-docs/0.16/airavata_api.html#Fn_Airavata_searchExperimentsByDesc"; target="_blank">searchExperimentsByDesc</a> | | +| Search Experiments by Application Name | <a href="http://airavata.apache.org/api-docs/0.16/airavata_api.html#Fn_Airavata_searchExperimentsByApplication"; target="_blank">searchExperimentsByApplication</a> | | +| Search Experiment by Creation Time | <a href="http://airavata.apache.org/api-docs/0.16/airavata_api.html#Fn_Airavata_searchExperimentsByCreationTime"; target="_blank">searchExperimentsByCreationTime</a> | | +| Get all user Experiments | <a href="http://airavata.apache.org/api-docs/0.16/airavata_api.html#Fn_Airavata_getUserExperiments"; target="_blank">getUserExperiments</a> | | +| Get Experiments for a Project | <a href="http://airavata.apache.org/api-docs/0.16/airavata_api.html#Fn_Airavata_getExperimentsInProject"; target="_blank">getExperimentsInProject</a> | | @@ -35,28 +35,29 @@ For Airavata API documentation please visit <a href="http://airavata.apache.org/ | Admin Function/Feature | Airavata API | Description | |:----------------------------------------------|:--------------------------------------|:------------------------------------------------------------------------------------------------ | <b style="color:blue;">Add Gateway</b> -| Add a gateway | addGateway | +| Add a gateway | <a href="http://airavata.apache.org/api-docs/0.16/airavata_api.html#Fn_Airavata_addGateway"; target="_blank">addGateway</a> | <b style="color:blue;">Credential Store</b> -| Generate a Token/SSH Key | generateAndRegisterSSHKeys | | -| Get all Credential Store Tokens | getAllGatewaySSHPubKeys | | -| Remove a Token/SSH Key | deleteSSHPubKey | | +| Generate a Token/SSH Key | <a href="http://airavata.apache.org/api-docs/0.16/airavata_api.html#Fn_Airavata_generateAndRegisterSSHKeys"; target="_blank">generateAndRegisterSSHKeys</a> | | +| Get all Credential Store Tokens | <a href="http://airavata.apache.org/api-docs/0.16/airavata_api.html#Fn_Airavata_getAllGatewaySSHPubKeys"; target="_blank">getAllGatewaySSHPubKeys</a> | | +| Remove a Token/SSH Key | <a href="http://airavata.apache.org/api-docs/0.16/airavata_api.html#Fn_Airavata_deleteSSHPubKey"; target="_blank">deleteSSHPubKey</a> | | | Get all Notices | noticesView | | <b style="color:blue;">Compute Resource (CR)</b> -| Get all CRs | getAllApplicationDeployments | | -| Get a CR | getStorageResource | -| Register CR | registerComputeResource | -| Update CR | updateComputeResource || -| Enable and Disable CR | getComputeResource updateComputeResource | +| Get all CRs | <a href="http://airavata.apache.org/api-docs/0.16/airavata_api.html#Fn_Airavata_getAllApplicationDeployments"; target="_blank">getAllApplicationDeployments</a> | | +| Get a CR | <a href="http://airavata.apache.org/api-docs/0.16/airavata_api.html#Fn_Airavata_getComputeResource"; target="_blank">getComputeResource</a> | +| Register CR | <a href="http://airavata.apache.org/api-docs/0.16/airavata_api.html#Fn_Airavata_registerComputeResource"; target="_blank">registerComputeResource</a> | +| Update CR | <a href="http://airavata.apache.org/api-docs/0.16/airavata_api.html#Fn_Airavata_updateComputeResource"; target="_blank">updateComputeResource</a> || +| Enable and Disable CR | <a href="http://airavata.apache.org/api-docs/0.16/airavata_api.html#Fn_Airavata_getComputeResource"; target="_blank">getComputeResource</a> <a href="http://airavata.apache.org/api-docs/0.16/airavata_api.html#Fn_Airavata_updateComputeResource"; target="_blank">updateComputeResource</a> | +| Delete a Queue | <a href="http://airavata.apache.org/api-docs/0.16/airavata_api.html#Fn_Airavata_deleteBatchQueue"; target="_blank">deleteBatchQueue</a> | <b style="color:blue;">Storage Resource (SR)</b> -| Get all SRs | getAllApplicationDeployments | | -| Get a SR | getComputeResource | -| Register a SR | registerStorageResource | -| Update a SR | updateStorageResource || -| Enable and Disable SR | getStorageResource updateStorageResource | -| Delete SR | deleteStorageResource | -| Delete Data Movement Interface of SR | deleteDataMovementInterface | +| Get all SR Names | <a href="http://airavata.apache.org/api-docs/0.16/airavata_api.html#Fn_Airavata_getAllStorageResourceNames"; target="_blank">getAllStorageResourceNames</a> | | +| Get a SR | <a href="http://airavata.apache.org/api-docs/0.16/airavata_api.html#Fn_Airavata_getStorageResource"; target="_blank">getStorageResource</a> | +| Register a SR | <a href="http://airavata.apache.org/api-docs/0.16/airavata_api.html#Fn_Airavata_registerStorageResource"; target="_blank">registerStorageResource</a> | +| Update a SR | <a href="http://airavata.apache.org/api-docs/0.16/airavata_api.html#Fn_Airavata_updateStorageResource"; target="_blank">updateStorageResource</a> || +| Enable and Disable SR | <a href="http://airavata.apache.org/api-docs/0.16/airavata_api.html#Fn_Airavata_getStorageResource"; target="_blank">getStorageResource</a> <a href="http://airavata.apache.org/api-docs/0.16/airavata_api.html#Fn_Airavata_updateStorageResource"; target="_blank">updateStorageResource</a> | +| Delete SR | <a href="http://airavata.apache.org/api-docs/0.16/airavata_api.html#Fn_Airavata_deleteStorageResource"; target="_blank">deleteStorageResource</a> | +| Delete Data Movement Interface of SR | <a href="http://airavata.apache.org/api-docs/0.16/airavata_api.html#Fn_Airavata_deleteDataMovementInterface"; target="_blank">deleteDataMovementInterface</a> | <b style="color:blue;">Experiment Statistics</b> -| Get Experiment Statistics | getExperimentStatistics | Displays experiments grouped by the experiment status and derived for the given date time range. | +| Get Experiment Statistics | <a href="http://airavata.apache.org/api-docs/0.16/airavata_api.html#Fn_Airavata_getExperimentStatistics"; target="_blank">getExperimentStatistics</a> | Displays experiments grouped by the experiment status and derived for the given date time range. |
