Skip to content

Commit 835d3ab

Browse files
committed
cosmetics and some unifying
1 parent e742322 commit 835d3ab

File tree

1 file changed

+23
-23
lines changed

1 file changed

+23
-23
lines changed

README.md

Lines changed: 23 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -77,31 +77,31 @@ Parameterizable tags can only be added to a document with a value assigned. By `
7777
7878
# API
7979

80-
| Address | Method | Description | Request / Payload | Response| Status |
81-
| - | - | - | - | - | - |
82-
| /count | GET | Count (matching) documents | * | Number | Implemented |
83-
| /doc | POST | Add / Store Document | PDF | - | Implemented |
84-
| /doc | GET | Get List of all (matching) documents | * ** *** | Array of objects with document identifiers and titles (where available) | Implemented |
85-
| /doc/{id} | GET | Get this document | - | PDF | Implemented |
86-
| /doc/{id} | DELETE | Deletes all metadata associated with the document. Document will not be deleted and is stays accessible over /doc/{id}. | - | - | Implemented |
87-
| /doc/{id}/comment | POST | Add comment to document | - | - | - |
88-
| /doc/{id}/comment | GET | Get comments | - | - | - |
89-
| /doc/{id}/tag | POST | Add a tag to document | See above | - | Implemented |
90-
| /doc/{id}/tag | GET | Get tags of document | - | See above | Implemented |
91-
| /doc/{id}/tag/{tagName} | DELETE | Remove tag from document | - | - | - |
92-
| /doc/{id}/title | PUT | Set document title | `{"title": "the_Title"}` | - | Implemented |
93-
| /doc/{id}/title | GET | Get document title | - | `{"title": "the_Title"}` | Implemented |
94-
| /doc/{id}/title | DELETE | Reset document title | - | - | Implemented |
95-
| /doc/{id}/meta | GET | Get title and tags | - | - | - |
96-
| /tag | POST | Create new tag | See above | - | Implemented |
97-
| /tag | GET | Get (list of) all tags | - | - | Implemented |
98-
| /tag/{tagName} | GET | Get Documents with this tag | - | - | try `/doc?tag={tagName}` |
99-
| /tag/{tagName} | DELETE | Delete this tag | - | - | Implemented |
80+
| Address | Method | Description | Request / Payload | Response| Status |
81+
| - | - | - | - | - | - |
82+
| `/count` | GET | Count (matching) documents | <sup>[1](#f1)</sup> <sup>[3](#f3)</sup> | Number | Implemented |
83+
| `/doc` | POST | Add / Store Document | PDF | - | Implemented |
84+
| `/doc` | GET | Get List of all (matching) documents | <sup>[1](#f1)</sup> <sup>[2](#f2)</sup> <sup>[3](#f3)</sup> | Array of objects with document identifiers and titles (where available) | Implemented |
85+
| `/doc/{id}` | GET | Get this document | - | PDF | Implemented |
86+
| `/doc/{id}` | DELETE | Deletes all metadata associated with the document. Document will not be deleted and is stays accessible over /doc/{id}. | - | - | Implemented |
87+
| `/doc/{id}/comment` | POST | Add comment to document | - | - | - |
88+
| `/doc/{id}/comment` | GET | Get comments | - | - | - |
89+
| `/doc/{id}/tag` | POST | Add a tag to document | Tag object / See above | - | Implemented |
90+
| `/doc/{id}/tag` | GET | Get tags of document | - | Array of tag objects | Implemented |
91+
| `/doc/{id}/tag/{tagLabel}` | DELETE | Remove tag from document | - | - | - |
92+
| `/doc/{id}/title` | PUT | Set document title | `{"title": "the_Title"}` | - | Implemented |
93+
| `/doc/{id}/title` | GET | Get document title | - | `{"title": "the_Title"}` | Implemented |
94+
| `/doc/{id}/title` | DELETE | Reset document title | - | - | Implemented |
95+
| `/doc/{id}/meta` | GET | Get title and tags | - | - | - |
96+
| `/tag` | POST | Create new tag | See above | - | Implemented |
97+
| `/tag` | GET | Get (list of) all tags | - | - | Implemented |
98+
| `/tag/{tagLabel}` | GET | Get Documents with this tag | <sup>[1](#f1)</sup> <sup>[2](#f2)</sup> | Array of objects with document identifiers and titles (where available) | Implemented, same as `/doc?tag={tagLabel}` |
99+
| `/tag/{tagLabel}` | DELETE | Delete this tag | - | - | Implemented |
100100

101101
#### URL-Paramters supported:
102102

103-
\* ?text \
104-
** ?limit and ?offset \
105-
*** ?tag
103+
<sup id="f1">[1](#f1)</sup> : ?text \
104+
<sup id="f2">[2](#f2)</sup> : ?limit and ?offset \
105+
<sup id="f3">[3](#f3)</sup> : ?tag
106106

107107
> Deleting / editing comments might be supportet in the future

0 commit comments

Comments
 (0)