all repos — litestore @ 70e18a3dfa92dbab74871c8b3fa3d930f9b86b23

A minimalist nosql document store.

doc/_md/api.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
 115
 116
 117
 118
 119
 120
 121
 122
 123
 124
 125
 126
 127
 
## REST API Reference

### info - LiteStore Information

This resource can be queried to obtain basic information and statistics on the {{LS}} server.

#### OPTIONS info

{{options -> Returns the allowed HTTP verbs for this resource.}}

##### Example

> %terminal%
> curl -i -X OPTIONS http://0.0.0.0:9500info  
> HTTP/1.1 200 OK   
> Content-Length: 0  
> Allow: GET,OPTIONS

#### GET info

Returns the following server statistics:

* Version
* Size of the database on disk (in MB)
* Total documents
* Total Tags
* Number of documents per tag

##### Example Response

```
{
    "version": "LiteStore v1.0",
    "size": "9.71 MB",
    "total_documents": 103,
    "total_tags": 10,
    "tags": [{
        "$dir:lib": 10
    }, {
        "$dir:nimcache": 93
    }, {
        "$format:binary": 46
    }, {
        "$format:text": 57
    }, {
        "$subtype:json": 1
    }, {
        "$subtype:octet-stream": 46
    }, {
        "$subtype:plain": 11
    }, {
        "$subtype:x-c": 45
    }, {
        "$type:application": 47
    }, {
        "$type:text": 56
    }]
}
```

### docs - LiteStore Documents

A document is the main resource type managed by {{LS}}. Any {{LS}} document can be represented as a JSON object exposing the following properties:

id
: The unique identifier of the document.
data
: The document contents (base64-encoded if binary).
created
: The document creation date expressed as combined date and time in UTC ([ISO 8601](http://en.wikipedia.org/wiki/ISO_8601) compliant).
modified
: The document modification date (if applicable) expressed as combined date and time in UTC ([ISO 8601](http://en.wikipedia.org/wiki/ISO_8601) compliant).
tags
: A list of tags associated to the document.

#### Example Document

```
{
    "id": "test_document",
    "data": "This is a test document",
    "created": "2015-02-07T10:36:09Z",
    "modified": "",
    "tags": ["$type:text", "$subtype:plain", "$format:text", "another_tag"]
}
```

#### OPTIONS docs

{{options}}

##### Example

> %terminal%
> curl -i -X OPTIONS http://0.0.0.0:9500/v1/docs  
> HTTP/1.1 200 OK   
> Content-Length: 0  
> Allow: HEAD,GET,POST,OPTIONS


#### OPTIONS docs/:id

{{options}}

##### Example

> %terminal%
> curl -i -X OPTIONS http://0.0.0.0:9500/v1/docs/test  
> HTTP/1.1 200 OK   
> Content-Length: 0  
> Allow: HEAD,GET,PUT,PATCH,DELETE,OPTIONS

#### POST docs

#### HEAD docs

#### HEAD docs/:id

#### GET docs

#### GET docs/:id

#### PUT docs/:id

#### PATCH docs/:id

#### DELETE docs/:id