Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/doncato/freemind-api
Freemind API server written in rust. Serving xml documents to structure todos, appointments and events
https://github.com/doncato/freemind-api
calendar rust todo xml
Last synced: about 19 hours ago
JSON representation
Freemind API server written in rust. Serving xml documents to structure todos, appointments and events
- Host: GitHub
- URL: https://github.com/doncato/freemind-api
- Owner: doncato
- License: gpl-3.0
- Created: 2023-02-15T13:19:51.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2024-03-04T19:31:29.000Z (11 months ago)
- Last Synced: 2024-12-03T18:14:09.029Z (about 2 months ago)
- Topics: calendar, rust, todo, xml
- Language: Rust
- Homepage:
- Size: 166 KB
- Stars: 1
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Freemind - API
This is the Api server of the Freemind project.
**Note: The main documentation is to be found on the wiki page of this repo**
## TODOs
- Add more endpoints
- Make Session authentication better
## LIMITATIONS
### Elements
Each Element (each entry and directory node) must have an unique ID which is
(as of now) saved and handled as an unsigned 16 bit integer. Meaning you can
have 'only' about 65535 entries. The ID `0` **SHOULD NOT** be used Although
the more you approach this number the longer generation of new entries might
take. As of now I don't think that anyone needs more than 1000 entries
registred at once.
## SETUP
### 1. Installation
Put the released binary or your custom compiled binary
in a (created folder) where you want it. Launch the
programm once to generate the config file in the local
directory. Customize the configuration according to your
needs (e.g. fill in the SQL DB login data)
### 2. Set up your SQL database
Assuming you already MariaDB (or something comparable)
installed, create a new Database (the name is not important
but use the name in your config file):
```sql
CREATE DATABASE freemind;
```
```sql
USE freemind;
```
Afterwards generate
the important tables with the following two SQL commands:
```sql
CREATE TABLE logins (username varchar(255) NOT NULL UNIQUE, password varchar(255) NOT NULL, token varchar(255) NOT NULL UNIQUE, id int, PRIMARY KEY (id));
```
(This one is really important when you want to have an integrated frontend for
tracking and comparing valid sessions you may not need this command but the
server might fail if you don't have this table in place. Additionally it
may be used more in upcomming releases (currently it is only used by the webapp))
```sql
CREATE TABLE sessions (session varchar(255), expires varchar(255) NOT NULL, id int NOT NULL, PRIMARY KEY(session));
```
Furthermore a User is needed that has access to the newly created databases.
This can be donce like so (choose something different as username and password please):
```sql
CREATE USER 'freeadmin'@'localhost' IDENTIFIED BY 'admind';
```
```sql
GRANT ALL PRIVILEGES ON freemind.* TO 'freeadmin'@'localhost';
```
### 3. Run
Start the binary. You can now insert new users into your database (or do so via the web frontend when also installed).
Please note: passwords and tokens are expected to be saved as a
bcrypt hash in the database
## Endpoints
### Existing
- `/checksum/{algorithm}` To get the calculated checksum of the current document calculated using the provided algorithm (sha1, md5 currently supported)
- `/session/auth` To start a new session and obtain a session id for further authentication
- `/session/extend` To further extend an existing session
- `/xml/priority/highest` To get only the nodes which have the highest priority among the document
- `/xml/priority/{priority}` To get only nodes which priority is higher (lower numerical value) or equal to the provided priority.
- `/xml/filter/{name}/{value}` To only get nodes which have subnodes called NAME whose value equals VALUE (not case sensitive)
- `/xml/get_by_id/{id}` To fetch a partial XML document specifed by it's id
- `/xml/fetch` To fetch the whole XML document.
- `/xml/update` To update the whole XML document.
- `/xml/validate` To validate a XML document but not actually perform any changes.
- `/xml/due/over` To get only nodes wich were due in the past.
- `/xml/due/today` To get only nodes wich are due or on today.
- `/xml/due/tomorrow` To get only nodes which are due or on tomorrow.
- `/xml/due/in/{start}/{end}` To get only nodes which due date is in between start and end
### Planned
- `/act/delete_past` To delete nodes which are expired
- `/act/delete_past/TIMESTAMP` To delete nodes which are expired after TIMESTAMP
- `/xml/get_next_due` To get the next due node
- `/json/fetch` To fetch the whole XML document but returned as JSON.
- `/json/sort_by/due` To get the nodes as json sorted by due
- `/json/sort_by/priority` To get the nodes as json sorted by priority