Welcome to mirror list, hosted at ThFree Co, Russian Federation.

github.com/nextcloud/external.git - Unnamed repository; edit this file 'description' to name the repository.
summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorJoas Schilling <coding@schilljs.com>2017-03-22 19:08:13 +0300
committerJoas Schilling <coding@schilljs.com>2017-03-26 21:05:33 +0300
commite62b3a86236331c87fb0e9005e953035d7fa1a76 (patch)
tree91670c581d3ffaf8bcfc0d091359b54f60883642 /README.md
parentd3231ad03921e9675d40254827c48c616284d338 (diff)
Adjust README.md
Signed-off-by: Joas Schilling <coding@schilljs.com>
Diffstat (limited to 'README.md')
-rw-r--r--README.md14
1 files changed, 13 insertions, 1 deletions
diff --git a/README.md b/README.md
index 745a9ea..29ee601 100644
--- a/README.md
+++ b/README.md
@@ -31,12 +31,24 @@ curl -H "OCS-APIRequest: true" \
<name>Homepage</name>
<url>https://localhost/index.php</url>
<lang>en</lang>
- <icon>external.svg</icon>
+ <type>link</type>
+ <icon>https://localhost/external.svg</icon>
</element>
</data>
</ocs>
```
+#### Explanation
+
+| Field | Type | Description |
+| ----- | ------ | ---------------------------------------- |
+| id | int | Numeric identifier of the site |
+| name | string | Name of the site, ready to use |
+| url | string | URL that should be framed/linked to |
+| lang | string | Language code for which this link is valid (empty string means all languages) |
+| type | string | Can be one of `link`, `settings` or `quota`; see [this issue](https://github.com/nextcloud/external/issues/7) for details |
+| icon | string | Full URL of the icon that should be shown next to the name of the link |
+
### Capability
The app registers a capability, so clients can check that before making the actual OCS request: