summaryrefslogtreecommitdiffstats
path: root/docs
diff options
context:
space:
mode:
authorBernhard Posselt <BernhardPosselt@users.noreply.github.com>2016-09-04 12:37:59 +0200
committerGitHub <noreply@github.com>2016-09-04 12:37:59 +0200
commitf64aa4e44cd0d5a2d079e08da59035d522392754 (patch)
tree281cd982d2a0b42f927943a88a0c7cee422f3184 /docs
parent15f7034a6bc15a6fd399af7fedf8b2c938d6bf70 (diff)
parent187ed7902765e02f6efe2d624e80b4d03dd49890 (diff)
Merge pull request #31 from nextcloud/ratings
add folder id to api
Diffstat (limited to 'docs')
-rw-r--r--docs/externalapi/External-Api.md4
1 files changed, 4 insertions, 0 deletions
diff --git a/docs/externalapi/External-Api.md b/docs/externalapi/External-Api.md
index aee41cf0c..cedfdaff6 100644
--- a/docs/externalapi/External-Api.md
+++ b/docs/externalapi/External-Api.md
@@ -485,6 +485,7 @@ with the following request body:
"url": "https://feed.url.com",
"name": "Feed name",
"ordering": 0,
+ "folderId": 3,
"isPinned": true,
"fullTextEnabled": false,
"basicAuthUser": "user",
@@ -492,6 +493,7 @@ with the following request body:
}
```
* **url**: Abitrary long text, the url needs to have the full schema e.g. https://the-url.com. In case the user omits the schema, prepending **https** is recommended
+* **folderId**: 64bit Integer, the feed's folder or **0** in case no folder is specified
* **name (optional)**: Abitrary long text, the feeds name or if not given taken from the RSS/Atom feed
* **basicAuthUser (optional)**: Abitrary long text, if given basic auth headers are sent for the feed
* **basicAuthPassword (optional)**: Abitrary long text, if given basic auth headers are sent for the feed
@@ -542,6 +544,7 @@ with the following request body:
"url": "https://feed.url.com",
"name": "Feed name",
"ordering": 0,
+ "folderId": 3,
"isPinned": true,
"fullTextEnabled": false,
"basicAuthUser": "user",
@@ -558,6 +561,7 @@ All parameters are optional
* **ordering (optional)**: See [feeds](#Feeds)
* **isPinned (optional)**: See [feeds](#Feeds)
* **fullTextEnabled (optional)**: See [feeds](#Feeds)
+* **folderId (optional)**: 64bit Integer, the feed's folder or **0** in case no folder is specified
The following response is being returned: