alex/anki-connect
1
Fork 0
Code Releases 7 Activity

added documentation

Browse Source
This commit is contained in:
Austin Siew 2022-08-17 12:50:22 -06:00
parent 83cc55769b
commit db2e7f2e95
1 changed files with 12 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

20
README.md
View File

@ -2101,7 +2101,7 @@ corresponding to when the API was available for use.
* **modelFieldRename** * **modelFieldRename**
TODO Rename the field name of a given model.
*Sample Request*: *Sample Request*:
```json ```json
@ -2126,7 +2126,9 @@ corresponding to when the API was available for use.
* **modelFieldReposition** * **modelFieldReposition**
TODO Reposition the field within the field list of a given model.
The value of `index` starts at 0. For example, an index of `0` puts the field in the first position, and an index of `2` puts the field in the third position.
*Sample Request*: *Sample Request*:
```json ```json
@ -2135,8 +2137,8 @@ corresponding to when the API was available for use.
"version": 6, "version": 6,
"params": { "params": {
"modelName": "Basic", "modelName": "Basic",
"fieldName": "Front", "fieldName": "Back",
"index": 1 "index": 0
} }
} }
``` ```
@ -2151,8 +2153,9 @@ corresponding to when the API was available for use.
* **modelFieldAdd** * **modelFieldAdd**
TODO Creates a new field within a given model.
(optional index, defaults to adding the field to the very end of the list)
Optionally, the `index` value can be provided, which works exactly the same as the index in `modelFieldReposition`. By default, the field is added to the end of the field list.
*Sample Request*: *Sample Request*:
```json ```json
@ -2161,7 +2164,8 @@ corresponding to when the API was available for use.
"version": 6, "version": 6,
"params": { "params": {
"modelName": "Basic", "modelName": "Basic",
"fieldName": "NewField" "fieldName": "NewField",
"index": 0
} }
} }
``` ```
@ -2176,7 +2180,7 @@ corresponding to when the API was available for use.
* **modelFieldRemove** * **modelFieldRemove**
TODO Deletes a field within a given model.
*Sample Request*: *Sample Request*:
```json ```json