diff options
| author | rr- | 2016-04-19 11:50:47 +0200 |
|---|---|---|
| committer | rr- | 2016-04-19 11:55:31 +0200 |
| commit | 83784c5e76e46d56dc36a69bb96fb23508c8c14a (patch) | |
| tree | bdabdae1c9097f90fc0b5a5f94008ea9351a301a /API.md | |
| parent | 7263849fac61798d18ff7aa2132db7f3632e86a0 (diff) | |
server/api: improve input sanitization, fix docs
Diffstat (limited to 'API.md')
| -rw-r--r-- | API.md | 11 |
1 files changed, 6 insertions, 5 deletions
@@ -14,7 +14,7 @@ 2. [API reference](#api-reference) - Tag categories - - [Listing tag categories](#listing-tags-category) + - [Listing tag categories](#listing-tags-categories) - [Creating tag category](#creating-tag-category) - [Updating tag category](#updating-tag-category) - [Getting tag category](#getting-tag-category) @@ -245,7 +245,8 @@ Not implemented yet. are optional. If specified implied tags or suggested tags do not exist yet, they will be automatically created. Tags created automatically have no implications, no suggestions, one name and their category is set to the - first item of `tag_categories` from server's configuration. + first tag category found. If there are no tag categories established yet, + an error will be thrown. ## Updating tag @@ -275,10 +276,10 @@ Not implemented yet. - **Errors** + - the tag does not exist - any name is used by an existing tag (names are case insensitive) - - any name, implication or suggestion has invalid name + - any name, implication or suggestion name is invalid - category is invalid - - no name was specified - implications or suggestions contain any item from names (e.g. there's a shallow cyclic dependency) - privileges are too low @@ -338,7 +339,7 @@ Not implemented yet. - **Description** - Deletes existing tag. + Deletes existing tag. The tag to be deleted must have no usages. ## Listing users |