Neoclassical Piano Montage

npm

Need private packages and team management tools?Check out npm Orgs. »

sfss.api.endpoint

0.0.2 • Public • Published

Simple FS Storage API Endpoint

NPM version NPM downloads NPM license flattr

coverage David David

Builds uppon sfss.lib the Simple FS Storage library.

Usage

Options

  • dataRoot (mandatory): {String} absolut path to the root directory of the store.
  • disableFileDeletion: {Boolean} makes sure that no file can be deleted.
  • disableDirectoryDeletion: {Boolean} makes sure that no directory can be deleted.

API

PUT api_root/sfss/tree[/path]

Creates a new directory (success Status Code 201):

{
    "data": {
        "ref": "/sfss/tree/trial",
        "action": "created"
    },
    "status": "success"
}

GET api_root/sfss/tree[/path]

Returns the directory content - files and subdirectories names as Array (success Status Code 200):

{
    "ref": "/sfss/tree/test",
    "type": "directoryContent",
    "data": [
        "first.json",
        "second.json",
        "sub"
    ],
    "status": "success"
}

DELETE api_root/sfss/tree[/path]

Deep deletion of the directory, like rm -rf (success Status Code 204): no body


PUT api_root/sfss/data[/path]/filename.json

Creates or updates a file (success Status Code 201):

{
    "ref": "/sfss/data/test/first.json",
    "data": {
        "fileId": 1
    },
    "status": "success"
}

GET api_root/sfss/data[/path]

Reads all files in the directory (bulk read) (success Status Code 200):

{
    "ref": "/sfss/data/test",
    "type": "multipleFileContent",
    "data": [
        {
            "fileId": 1
        },
        {
            "fileId": 2
        }
    ],
    "status": "success"
}

GET api_root/sfss/data[/path]/filename.json

Reads a file (success Status Code 200):

{
    "ref": "/sfss/data/test/first.json",
    "type": "fileContent",
    "data": {
        "fileId": 1
    },
    "status": "success"
}

DELETE api_root/sfss/data[/path]/filename.json

Removes a file (success Status Code 204): no body

install

npm i sfss.api.endpoint

Downloadsweekly downloads

1

version

0.0.2

license

MIT

homepage

github.com

repository

Gitgithub

last publish

collaborators

  • avatar
Report a vulnerability