Skip to content

Commit

Permalink
Add doc (#68)
Browse files Browse the repository at this point in the history
* adding the documentation

* spotlessApply for documentation
  • Loading branch information
alijawadfahs authored Nov 30, 2023
1 parent 7eacbeb commit 9e6e329
Show file tree
Hide file tree
Showing 10 changed files with 27 additions and 27 deletions.
2 changes: 1 addition & 1 deletion documentation/1-connection-endpoints.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,4 +29,4 @@

**Body:**

**Reply: None**
**Reply: None**
4 changes: 2 additions & 2 deletions documentation/2-cloud-endpoints.md
Original file line number Diff line number Diff line change
Expand Up @@ -152,6 +152,6 @@
```json
[
"<CLOUD_ID>",
"<CLOUD_ID>"
"<CLOUD_ID>"
]
```
```
4 changes: 2 additions & 2 deletions documentation/3-byon-endpoints.md
Original file line number Diff line number Diff line change
Expand Up @@ -92,7 +92,7 @@

```Json
{
"<BYON_ID>":"<DEPLOYMENT_NAME>/<COMPONENT_NAME>"
"<BYON_ID>":"<DEPLOYMENT_NAME>/<COMPONENT_NAME>"
}
```

Expand All @@ -110,4 +110,4 @@

**Headers:** sessionid

**Body:** None
**Body:** None
4 changes: 2 additions & 2 deletions documentation/4-edge-endpoints.md
Original file line number Diff line number Diff line change
Expand Up @@ -93,7 +93,7 @@

```Json
{
"<Edge_ID>":"<DEPLOYMENT_NAME>/<COMPONENT_NAME>"
"<Edge_ID>":"<DEPLOYMENT_NAME>/<COMPONENT_NAME>"
}
```

Expand All @@ -111,4 +111,4 @@

**Headers:** sessionid

**Body:** None
**Body:** None
2 changes: 1 addition & 1 deletion documentation/5-job-endpoints.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
**Returns**: True if the removing of all the jobs was successful, false otherwise.
2 changes: 1 addition & 1 deletion documentation/6-monitoring-endpoints.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
**Returns**: A JSON list of all the defined EMS deployments.
30 changes: 15 additions & 15 deletions documentation/7-node-endpoints.md
Original file line number Diff line number Diff line change
Expand Up @@ -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",
Expand Down Expand Up @@ -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": "<NODE_CANDIDATE_ID>",
"cloudId": "<CLOUD_ID>"
},
{
"nodeName": "component-LB-1-0",
"taskName": "Component_LB",
"nodeCandidateId": "<NODE_CANDIDATE_ID>",
"cloudId": "<CLOUD_ID>"
}
{
"nodeName": "component-App-1-0",
"taskName": "Component_App",
"nodeCandidateId": "<NODE_CANDIDATE_ID>",
"cloudId": "<CLOUD_ID>"
},
{
"nodeName": "component-LB-1-0",
"taskName": "Component_LB",
"nodeCandidateId": "<NODE_CANDIDATE_ID>",
"cloudId": "<CLOUD_ID>"
}
]
```

Expand Down Expand Up @@ -128,8 +128,8 @@ For more details about these filters you can check the SAL code [NodeCandidateUt
```json
[
"<NODE_ID>",
"<NODE_ID>",
"<NODE_ID>",
]
```

**Returns**: True if the node was successfully removed, false otherwise.
**Returns**: True if the node was successfully removed, false otherwise.
2 changes: 1 addition & 1 deletion documentation/8-scaling-endpoints.md
Original file line number Diff line number Diff line change
Expand Up @@ -52,4 +52,4 @@ A JSON list of nodes to be removed

**Returns**: True if the scaling was successful, false otherwise.

* * *
* * *
2 changes: 1 addition & 1 deletion documentation/9-vault-endpoints.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,4 +34,4 @@ A JSON body of the key/secret pairs:

**Headers:** sessionid

**Returns**: True if the secrets were successfully removed, false otherwise.
**Returns**: True if the secrets were successfully removed, false otherwise.
2 changes: 1 addition & 1 deletion documentation/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -159,4 +159,4 @@ SAL provides multiple endpoints that you can use to interact with the ProActive
</tr>
</tbody>
</table>
</figure>
</figure>

0 comments on commit 9e6e329

Please sign in to comment.