summaryrefslogtreecommitdiffstats
path: root/Action.md
diff options
context:
space:
mode:
authorAndrey Mekin <anmekin@gmail.com>2016-10-17 09:39:11 +0300
committerGitHub <noreply@github.com>2016-10-17 09:39:11 +0300
commitc791f3c9c9198b3f687907fb16e16fa93f90d63b (patch)
tree275f214be19cdb61e5f4a7f79c57f13f29379842 /Action.md
parentc7bb619c5df98f8722781dd401c8010e886421e8 (diff)
parentfbb435e64636c685c3b4b5dff2277b7cd3b826fa (diff)
downloadomaha-server-origin/gh-pages.zip
omaha-server-origin/gh-pages.tar.gz
omaha-server-origin/gh-pages.tar.bz2
Merge pull request #225 from anmekin/gh-pagesorigin/gh-pages
Add PUT and PATCH requests in documentation
Diffstat (limited to 'Action.md')
-rw-r--r--Action.md75
1 files changed, 66 insertions, 9 deletions
diff --git a/Action.md b/Action.md
index 078c544..009518a 100644
--- a/Action.md
+++ b/Action.md
@@ -1,6 +1,6 @@
# Group Action
-## Actions Collection [/api/action{?id,version,event,run,arguments,successurl,terminateallbrowsers,successsaction,other}]
+## Actions Collection [/api/action{?id,version,event,run,arguments,successurl,terminateallbrowsers,successsaction,other}/]
### List all Actions [GET]
@@ -93,14 +93,71 @@
+ Response 200 (application/json)
{
- "id": 11,
- "version": 7,
- "event": 1,
- "run": "",
- "arguments": "--do-not-launch-chrome",
- "successurl": "",
- "terminateallbrowsers": false,
- "successsaction": "default",
+ "id": 11,
+ "version": 7,
+ "event": 1,
+ "run": "",
+ "arguments": "--do-not-launch-chrome",
+ "successurl": "",
+ "terminateallbrowsers": false,
+ "successsaction": "default",
+ "other": null
+ }
+
+### Patch an Action [PATCH]
+
++ Request (application/json)
+
+ + Headers
+
+ Authorization: Basic QWxhZGRpbjpvcGVuIHNlc2FtZQ==
+
+ + Body
+
+ {
+ "event": 0
+ }
+
++ Response 200 (application/json)
+
+ {
+ "id": 11,
+ "version": 7,
+ "event": 0,
+ "run": "",
+ "arguments": "--do-not-launch-chrome",
+ "successurl": "",
+ "terminateallbrowsers": false,
+ "successsaction": "default",
+ "other": null
+ }
+
+### Update an Action [PUT]
+
++ Request (application/json)
+
+ + Headers
+
+ Authorization: Basic QWxhZGRpbjpvcGVuIHNlc2FtZQ==
+
+ + Body
+
+ {
+ "version": 7,
+ "event": 0
+ }
+
++ Response 200 (application/json)
+
+ {
+ "id": 11,
+ "version": 7,
+ "event": 0,
+ "run": "",
+ "arguments": "--do-not-launch-chrome",
+ "successurl": "",
+ "terminateallbrowsers": false,
+ "successsaction": "default",
"other": null
}