store's Introduction

store

store is a web service for storing data that will automatically get deleted on its set expiry date.

API

Endpoints

Endpoint Description Methods

/api/**/

Requests ending in a / are namespace endpoints. Namespaces efficiently store sets of data by key/alias.

`GET`	A get request returns a JSON list of keys/aliases in that namespace.
`POST`	A post request creates an entry and returns the JSON object and a new `Location` header.

/api/**/*

Requests ending in an key/alias are entry endpoints. Entries are key/alias indexed JSON objects containing metadata of stored information.

`GET`	A get request returns a JSON object of that entry.
`PUT`	A put request either creates an entry at the specified alias if it does not exist or updates the expiry date of the existing object and returns the JSON object.
`DELETE`	A delete request deletes the entry and its associated data.

/store/**/*

Requests represent the actual data in the store.

`GET`	A get request returns the stored data with its metadata encoded in headers.
`PUT`	A put request updates the data in the resource. Note: The size and type given must match those in the `/api/` entry.

Payload

{"filename": "example.txt", "size": 144, "type": "text/plain", "expire": 2147483647, "locked": true}

Response

{"alias": "abcd", "date": "1474826615", "filename": "example.txt", "size": "144", "type": "text/plain", "expire": 2147483647, "locked": true}

store's People

Contributors

Watchers

store's Issues

close automatically help resource locks on disconnection

The HTTPRequest.close method should be overridden to release held resource locks.

add example JSON object to readme

Add an example JSON object to readme so users can know what information to send and expect to receive.

use ResLock instead of custom locking mechanism

After ResLock becomes non-blocking and reentrant (lilyinstarlight/python-fooster-web#4), use it instead of the custom locking mechanism to avoid potential DoS attacks and make it more efficient.

Recommend Projects