src/admin/md/api_tags.md
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 |
### tags (LiteStore Tags)
This resource can be queried to retrieve the total of documents associated to a tag, or a list of tags matching a string.
> %note%
> API v4 Required
>
> This resource has been introduced in version 4 of the LiteStore API.
#### OPTIONS tags
Returns the allowed HTTP verbs for this resource.
##### Example
```
$ curl -i -X OPTIONS http://127.0.0.1:9500/tags
HTTP/1.1 200 OK
server: LiteStore/1.5.0
access-control-allow-origin: http://localhost:9500
access-control-allow-headers: Content-Type
allow: GET,OPTIONS
access-control-allow-methods: GET,OPTIONS
content-length: 0
```
#### OPTIONS tags/:id
Returns the allowed HTTP verbs for this resource.
##### Example
```
$ curl -i -X OPTIONS http://127.0.0.1:9500/tags/$type:text
HTTP/1.1 200 OK
server: LiteStore/1.5.0
access-control-allow-origin: http://localhost:9500
access-control-allow-headers: Content-Type
allow: GET,OPTIONS
access-control-allow-methods: GET,OPTIONS
Content-Length: 0
```
#### GET tags
Retrieves all tags and the total of their associated documents.
##### `like` option
If this option is specified, retrieves all tags matching the specified string.
> %tip%
> Wildcards
>
> You can use asterisks (\*) as wildcards.
##### `limit` and `offset` options
Provide a way to implement pagination:
* **limit** causes the query to retrieve only the first _n_ results.
* **offset** causes the query to skip the first _n_ results.
##### Example
```
$ curl -i http://localhost:9500/tags/?like=%24type:%2A
HTTP/1.1 200 OK
server: LiteStore/1.5.0
access-control-allow-origin: http://localhost:9500
content-type: application/json
vary: Origin
access-control-allow-headers: Content-Type
Content-Length: 290
{
"like": "$type:*",
"total": 3,
"execution_time": 0.0008190000000000003,
"results": [
{
"id": "$type:application",
"documents": 43
},
{
"id": "$type:image",
"documents": 10
},
{
"id": "$type:text",
"documents": 32
}
]
}
```
#### GET tags/:id
Retrieves the specified tag and corresponding document total.
##### Example
```
$ curl -i http://localhost:9500/tags/%24type%3Atext
HTTP/1.1 200 OK
server: LiteStore/1.5.0
access-control-allow-origin: http://localhost:9500
content-type: application/json
vary: Origin
access-control-allow-headers: Content-Type
Content-Length: 34
{"id":"$type:text","documents":32}
```
|