Updating README.md

This commit is contained in:
Alex Yatskov 2017-07-01 17:29:48 -07:00
parent d38fea7498
commit be900206cf

View File

@ -77,12 +77,12 @@ ankiInvoke('version').then(response => {
Or using [`curl`](https://curl.haxx.se): Or using [`curl`](https://curl.haxx.se):
``` ```
curl localhost:8765 -X POST -d '{"action": "version", "params": {}}' curl localhost:8765 -X POST -d '{"action": "version"}'
``` ```
### Supported Actions ### ### Supported Actions ###
Below is a list of currently supported actions: Below is a list of currently supported actions. Requests with invalid actions or parameters will a return `null` result.
* **version** * **version**
@ -95,14 +95,13 @@ Below is a list of currently supported actions:
*Sample request*: *Sample request*:
``` ```
{ {
"action": "version", "action": "version"
"params": {}
} }
``` ```
*Sample response*: *Sample response*:
``` ```
3 4
``` ```
* **deckNames** * **deckNames**
@ -111,8 +110,7 @@ Below is a list of currently supported actions:
*Sample request*: *Sample request*:
``` ```
{ {
"action": "deckNames", "action": "deckNames"
"params": {}
} }
``` ```
@ -130,8 +128,7 @@ Below is a list of currently supported actions:
*Sample request*: *Sample request*:
``` ```
{ {
"action": "modelNames", "action": "modelNames"
"params": {}
} }
``` ```
@ -310,8 +307,7 @@ Below is a list of currently supported actions:
*Sample request*: *Sample request*:
``` ```
{ {
"action": "guiAddCards", "action": "guiAddCards"
"params": {}
} }
``` ```
@ -327,8 +323,7 @@ Below is a list of currently supported actions:
*Sample request*: *Sample request*:
``` ```
{ {
"action": "guiCurrentCard", "action": "guiCurrentCard"
"params": {}
} }
``` ```
@ -351,8 +346,7 @@ Below is a list of currently supported actions:
*Sample request*: *Sample request*:
``` ```
{ {
"action": "guiShowQuestion", "action": "guiShowQuestion"
"params": {}
} }
``` ```
@ -368,8 +362,7 @@ Below is a list of currently supported actions:
*Sample request*: *Sample request*:
``` ```
{ {
"action": "guiShowAnswer", "action": "guiShowAnswer"
"params": {}
} }
``` ```
@ -407,8 +400,7 @@ Below is a list of currently supported actions:
*Sample request*: *Sample request*:
``` ```
{ {
"action": "upgrade", "action": "upgrade"
"params": {}
} }
``` ```