uvicorn sysapi.main:app --reload# SAFER-STORAGE System Backend REST API Server
This backend is implemented using FastAPI
Quick start
Install the module on your system sing PyPI:
pip install sysapi
Then start the service using default settings (test on localhost:8000), run the following command:
uvicorn sysapi.main:app --reload
File system organization
REST Routes
GET routes
Version prefix
All routes start with a /{version}/ prefix, which is currently set to v1
Meta data
These routes are used to retrieve data about users and snapshots
/v1/users: list user accounts/v1/user/{user}: getuser's meta-data/v1/snapshots: list of all available snapshots/v1/snapshots?user={user}: list of available snapshots foruser/v1/snapshot/{@snapshot}: get@snapshotmeta-data
NB:
users,snapshots, androotare reserved user names to avoid conflicts.- snapshots are always identified using an
@-prefixed name, eg.@initial, which also solved ambiguity between snapshot and user routes.
Filesystem navigation in time and space
The general form is as follows:
/v1/{user}/{time-location}/{space-location}
With the following constructs:
{time-location}is one of:fat/{@sanpshot}: the state of a single file as captured in snapshot named{snapid}dat/{@sanpshot}: the state of a directory as captured in snapshot named{snapid}fbefore/{@snapshot}: the state of a file as captured in snapshot immediately preceding the snapshot named{@snapshot}(if any)dbefore/{@snapshot}: the state of a directory as captured in snapshot immediately preceding the snapshot named{@snapshot}(if any)past/{@snapshot}: merged view of a directory composed of all snapshot(s) preceding, and including, the snapshot named{@snapshot}.historic/{username}/{path}: list of snapshots that contain the given file for the given user- The special name
@currentis reserved and used to designate the current state of the filesystem. It is actually a real snapshot, that is created each time an API call requests this time-point.
{space-location}is of the form:- `` (empty):
user's homedir content {path}/: content of the directory designated by the URL-encodedpathstarting from theuser's homedir{path}/file: file located in directory designated bypath
- `` (empty):
NB: the root virtual user is only available to the admin user and his/her home directpry is at the root of the filesystem
Examples:
/v1/joe/at/@current/:joe's current homedir/v1/joe/at/@snap-2019-09-18-2230/Photos/Kickoff/people.jpg:joe's file namedpeople.jpgin sub-directoryPhotos/Kickoffas it was captured by snapshot named@snap-2019-09-18-2230/v1/root/before/@snap-2019-09-18-2230/users/joe/Photos/: content of directoryusers/joe/Photos/for admin user as it was captured by snapshot immediately preceding the snapshot named@snap-2019-09-18-2230
POST routes
-
/v1/users/newCreates a user with following elements:
- login
- password
-
/v1/copyto/{space-location}Copies the list of files designated in the body to the space-location designated by the URL: In the body, each file is designated by a triplet:
"path"="path/to/file""snapshot"="@snapshot"from which the file is copied"destructive"=booleanReturns: The updated content of target directory (space-location)
1 maintainer
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file sysapi-0.0.7.tar.gz.
File metadata
- Download URL: sysapi-0.0.7.tar.gz
- Upload date:
- Size: 9.2 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via:
twine/2.0.0 pkginfo/1.5.0.1 requests/2.21.0 setuptools/41.4.0 requests-toolbelt/0.9.1 tqdm/4.36.1 CPython/3.7.3
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
aa6a985090f569307919b697c89e7bcc6ebd026739ffaa253f36e2d8c2c692b5
|
|
| MD5 |
9d34c416191920eb16a6c12d1c71ce1f
|
|
| BLAKE2b-256 |
f5298a6cb83b527b34e9d4397df269b24946b13212e77fa862d84876a1177efa
|
File details
Details for the file sysapi-0.0.7-py3-none-any.whl.
File metadata
- Download URL: sysapi-0.0.7-py3-none-any.whl
- Upload date:
- Size: 8.6 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via:
twine/2.0.0 pkginfo/1.5.0.1 requests/2.21.0 setuptools/41.4.0 requests-toolbelt/0.9.1 tqdm/4.36.1 CPython/3.7.3
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
a64ae3fe7eb4319ed9d27afe549cdee3207d5d47760d27603dd74acc83d75f66
|
|
| MD5 |
36eca86d1d57aa2fd045e4ca5ae157da
|
|
| BLAKE2b-256 |
c8c03d5f93ac55ca042f243770c86a7828b45012b6e7c66e2f5618519881e851
|
