From 9e6e32976d68ed58e89cec2804b21e525bfe52b1 Mon Sep 17 00:00:00 2001 From: alijawadfahs Date: Thu, 30 Nov 2023 10:04:49 +0100 Subject: [PATCH] Add doc (#68) * adding the documentation * spotlessApply for documentation --- documentation/1-connection-endpoints.md | 2 +- documentation/2-cloud-endpoints.md | 4 ++-- documentation/3-byon-endpoints.md | 4 ++-- documentation/4-edge-endpoints.md | 4 ++-- documentation/5-job-endpoints.md | 2 +- documentation/6-monitoring-endpoints.md | 2 +- documentation/7-node-endpoints.md | 30 ++++++++++++------------- documentation/8-scaling-endpoints.md | 2 +- documentation/9-vault-endpoints.md | 2 +- documentation/README.md | 2 +- 10 files changed, 27 insertions(+), 27 deletions(-) diff --git a/documentation/1-connection-endpoints.md b/documentation/1-connection-endpoints.md index 1debc1d..9d6f85c 100644 --- a/documentation/1-connection-endpoints.md +++ b/documentation/1-connection-endpoints.md @@ -29,4 +29,4 @@ **Body:** -**Reply: None** \ No newline at end of file +**Reply: None** diff --git a/documentation/2-cloud-endpoints.md b/documentation/2-cloud-endpoints.md index 6cba801..37c9045 100644 --- a/documentation/2-cloud-endpoints.md +++ b/documentation/2-cloud-endpoints.md @@ -152,6 +152,6 @@ ```json [ "", - "" + "" ] -``` \ No newline at end of file +``` diff --git a/documentation/3-byon-endpoints.md b/documentation/3-byon-endpoints.md index 6093c32..1a6edfd 100644 --- a/documentation/3-byon-endpoints.md +++ b/documentation/3-byon-endpoints.md @@ -92,7 +92,7 @@ ```Json { - "":"/" + "":"/" } ``` @@ -110,4 +110,4 @@ **Headers:** sessionid -**Body:** None \ No newline at end of file +**Body:** None diff --git a/documentation/4-edge-endpoints.md b/documentation/4-edge-endpoints.md index 42a83f5..46fe485 100644 --- a/documentation/4-edge-endpoints.md +++ b/documentation/4-edge-endpoints.md @@ -93,7 +93,7 @@ ```Json { - "":"/" + "":"/" } ``` @@ -111,4 +111,4 @@ **Headers:** sessionid -**Body:** None \ No newline at end of file +**Body:** None diff --git a/documentation/5-job-endpoints.md b/documentation/5-job-endpoints.md index 6f69593..270b5f7 100644 --- a/documentation/5-job-endpoints.md +++ b/documentation/5-job-endpoints.md @@ -337,4 +337,4 @@ Also a job can define a Docker container: **Headers:** sessionid -**Returns**: True if the removing of all the jobs was successful, false otherwise. \ No newline at end of file +**Returns**: True if the removing of all the jobs was successful, false otherwise. diff --git a/documentation/6-monitoring-endpoints.md b/documentation/6-monitoring-endpoints.md index 1a15e41..412ae15 100644 --- a/documentation/6-monitoring-endpoints.md +++ b/documentation/6-monitoring-endpoints.md @@ -38,4 +38,4 @@ In this case the node name refers to the component name defined in the job descr **Headers:** sessionid -**Returns**: A JSON list of all the defined EMS deployments. \ No newline at end of file +**Returns**: A JSON list of all the defined EMS deployments. diff --git a/documentation/7-node-endpoints.md b/documentation/7-node-endpoints.md index 7148dfa..57666dc 100644 --- a/documentation/7-node-endpoints.md +++ b/documentation/7-node-endpoints.md @@ -34,7 +34,7 @@ For more details about these filters you can check the SAL code [NodeCandidateUt "requirementClass": "hardware", "requirementAttribute": "cores", "requirementOperator": "EQ", - "value": "2" + "value": "2" }, { "type": "AttributeRequirement", @@ -80,18 +80,18 @@ For more details about these filters you can check the SAL code [NodeCandidateUt ```json [ - { - "nodeName": "component-App-1-0", - "taskName": "Component_App", - "nodeCandidateId": "", - "cloudId": "" - }, - { - "nodeName": "component-LB-1-0", - "taskName": "Component_LB", - "nodeCandidateId": "", - "cloudId": "" - } + { + "nodeName": "component-App-1-0", + "taskName": "Component_App", + "nodeCandidateId": "", + "cloudId": "" + }, + { + "nodeName": "component-LB-1-0", + "taskName": "Component_LB", + "nodeCandidateId": "", + "cloudId": "" + } ] ``` @@ -128,8 +128,8 @@ For more details about these filters you can check the SAL code [NodeCandidateUt ```json [ "", - "", + "", ] ``` -**Returns**: True if the node was successfully removed, false otherwise. \ No newline at end of file +**Returns**: True if the node was successfully removed, false otherwise. diff --git a/documentation/8-scaling-endpoints.md b/documentation/8-scaling-endpoints.md index 7639871..3090a7c 100644 --- a/documentation/8-scaling-endpoints.md +++ b/documentation/8-scaling-endpoints.md @@ -52,4 +52,4 @@ A JSON list of nodes to be removed **Returns**: True if the scaling was successful, false otherwise. -* * * \ No newline at end of file +* * * diff --git a/documentation/9-vault-endpoints.md b/documentation/9-vault-endpoints.md index 14520f6..442c723 100644 --- a/documentation/9-vault-endpoints.md +++ b/documentation/9-vault-endpoints.md @@ -34,4 +34,4 @@ A JSON body of the key/secret pairs: **Headers:** sessionid -**Returns**: True if the secrets were successfully removed, false otherwise. \ No newline at end of file +**Returns**: True if the secrets were successfully removed, false otherwise. diff --git a/documentation/README.md b/documentation/README.md index b495db2..6278dde 100644 --- a/documentation/README.md +++ b/documentation/README.md @@ -159,4 +159,4 @@ SAL provides multiple endpoints that you can use to interact with the ProActive - \ No newline at end of file +