Skip to content

Commit df152a1

Browse files
committed
added DataPackageTable put method documentation
1 parent 89cf253 commit df152a1

File tree

1 file changed

+20
-6
lines changed

1 file changed

+20
-6
lines changed

REST_API_InternalDoc.md

Lines changed: 20 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -46,7 +46,7 @@ Subscription: `connectUpdate`
4646
the authentication was accepted.
4747

4848
### parameters
49-
a json body in the following format
49+
a JSON body in the following format
5050
```json
5151
{"Authorization": [YOUR WEBSOCKET KEY]}
5252
```
@@ -58,7 +58,7 @@ Subscription: `connectUpdate`
5858
Subscription: `userUpdate`
5959

6060
### returns
61-
a json message containing connected clients
61+
a JSON message containing connected clients
6262
```
6363
{
6464
"Users":[
@@ -279,7 +279,7 @@ None
279279
```
280280

281281
### parameters
282-
accepts json data containing information regarding the desired status of each service in the following format
282+
accepts JSON data containing information regarding the desired status of each service in the following format
283283
```json
284284
{
285285
"services": {
@@ -369,7 +369,7 @@ used to remove a system user and their associated files from the server<br />
369369
* DELETE
370370

371371
### GET
372-
returns json data containing information regarding all DataPackages currently on server
372+
returns JSON data containing information regarding all DataPackages currently on server
373373
```json
374374
{
375375
"DataPackages":[
@@ -385,7 +385,7 @@ used to remove a system user and their associated files from the server<br />
385385
* creatorUid(optional): the uid of the user associated with the DataPackage defaults to ```server``` if none is provided
386386

387387
### DELETE
388-
accepts the following json data
388+
accepts the following JSON data
389389
```json
390390
{
391391
"DataPackages":[
@@ -395,7 +395,21 @@ used to remove a system user and their associated files from the server<br />
395395
}
396396
```
397397
the hash values are the hashes of DataPackages to be deleted
398-
398+
399+
### PUT
400+
accepts the following JSON data
401+
```json
402+
{
403+
"DataPackages": [
404+
{"PrimaryKey": "1", "Name": "new_name", "Keywords": "new keywords", "Privacy": "0"}
405+
]
406+
}
407+
```
408+
* PrimaryKey: primary key of DataPackage to be modified
409+
* Name: optional new name of DataPackage if not set name will not be changed
410+
* Keywords: optional new keywords of DataPackage if not set keywords will not be changed
411+
* Privacy: optional new privacy of DataPackage if not set privacy will not be changed must be 1(Private) or 0(Public)
412+
399413
## MissionTable
400414
### description
401415
Endpoint used to access data regarding mission packages

0 commit comments

Comments
 (0)