Commit bcd3396c authored by Roman Litvinenko's avatar Roman Litvinenko
Browse files

Readme draft

parent dc80fdd6
# jameditor-api
Based on [webJAM](https://gitlab.ambhost.net/stimpy/website_jamreader) by Philipp Giebel
Based on webJAM by Philipp Giebel
## Intro
The original idea was to create a standalone API to read/ write
Fidonet echo area messages. Separated from front end, it would allow anyone
to create a GUI in a form of Web or Native app to participate in Fidonet areas on the go.
https://gitlab.ambhost.net/stimpy/website_jamreader
## API endpoints
```
GET: /echoareas
```
List available areas from areas.ini or fidoconf.
Readme is yet to come.
\ No newline at end of file
```
GET: /echoarea/{area_name}
```
List messages from selected area by name, acquired from the request above
```
GET: /echoarea/{area_name}/{message_number}
```
Get a message and headers ny the message number acquired from the request above
```
DELETE: /echoarea/{area_name}/{message_number}
```
(*) Delete a message by message number
```
PATCH: /echoarea/{area_name}/{message_number}
```
Expected POST data:
* toName: String
* toAka: String (?)
* fromName: String (?)
* fromAka: String (?)
* defaultAka: String (?)
* (?) replyId: Integer (?)
* subject: String
* message: String
(*) Edit a message by message number
```
POST: /echoarea/{area_name}
```
Expected POST data:
* toName: String
* toAka: String (?)
* fromName: String (?)
* fromAka: String (?)
* defaultAka: String (?)
* replyId: Integer (?)
* subject: String
* message: String
(*) Create a message in selected echo area
(*) - Not yet implemented. Syntax might be slightly changed.
\ No newline at end of file
......@@ -62,15 +62,15 @@
}
private function deleteMessage() {
$this->syntaxErrorMessage('Not implemented yet (DELETE)');
$this->syntaxErrorMessage('Not yet implemented (DELETE)');
}
private function editMessage() {
$this->syntaxErrorMessage('Not implemented yet (PATCH)');
$this->syntaxErrorMessage('Not yet implemented (PATCH)');
}
private function newMessage() {
$this->syntaxErrorMessage('Not implemented yet (POST)');
$this->syntaxErrorMessage('Not yet implemented (POST)');
}
public function run() {
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment