mirror of
https://git.cant.at/Madeorsk/PollVerlaine
synced 2024-11-22 11:24:31 +01:00
Some more documentaion
This commit is contained in:
parent
e0b4db74c9
commit
d0f1ffc456
68
API.md
Normal file
68
API.md
Normal file
@ -0,0 +1,68 @@
|
|||||||
|
# VerlainePoll's API
|
||||||
|
|
||||||
|
## Methods
|
||||||
|
|
||||||
|
### Create a poll
|
||||||
|
```
|
||||||
|
POST /polls
|
||||||
|
```
|
||||||
|
|
||||||
|
| Field | Description | Optional |
|
||||||
|
| -------------- | ------------------------------------ | ---------- |
|
||||||
|
| `title` | The question. | no |
|
||||||
|
| `options` | All the options. Array of strings. | no |
|
||||||
|
| `settings` | A Settings object. | yes |
|
||||||
|
|
||||||
|
Return a Poll.
|
||||||
|
|
||||||
|
### Retrieve a poll
|
||||||
|
|
||||||
|
```
|
||||||
|
GET /polls/:id
|
||||||
|
```
|
||||||
|
|
||||||
|
Return a Poll.
|
||||||
|
|
||||||
|
### Vote
|
||||||
|
|
||||||
|
```
|
||||||
|
POST /polls/:id/vote
|
||||||
|
```
|
||||||
|
| Field | Description | Optional |
|
||||||
|
| -------------- | -------------------------------------------- | ---------- |
|
||||||
|
| `options` | Options you want to vote for. Array of ids. | no |
|
||||||
|
|
||||||
|
Return a Poll.
|
||||||
|
|
||||||
|
### Delete a poll
|
||||||
|
|
||||||
|
```
|
||||||
|
DELETE /polls/:id
|
||||||
|
```
|
||||||
|
|
||||||
|
Return a Poll.
|
||||||
|
|
||||||
|
## Entities
|
||||||
|
|
||||||
|
### Poll
|
||||||
|
|
||||||
|
| Attribute | Description | Nullable |
|
||||||
|
| --------------- | ------------------------------------ | ---------- |
|
||||||
|
| `id` | | no |
|
||||||
|
| `title` | The question. | no |
|
||||||
|
| `options` | All the options. Array of Options. | no |
|
||||||
|
| `settings` | A Settings object. | no |
|
||||||
|
| `creation_date` | Creation date. | no |
|
||||||
|
|
||||||
|
### Options
|
||||||
|
|
||||||
|
| Attribute | Description | Nullable |
|
||||||
|
| --------------- | ------------------------------------ | ---------- |
|
||||||
|
| `id` | | no |
|
||||||
|
| `label` | The option. | no |
|
||||||
|
|
||||||
|
### Settings
|
||||||
|
|
||||||
|
| Attribute | Description | Nullable |
|
||||||
|
| --------------- | ------------------------------------ | ---------- |
|
||||||
|
| `unique_ip` | One vote per IP address. Boolean. | yes |
|
@ -9,7 +9,7 @@ Clone the repository :
|
|||||||
mkdir db && touch db/polls.db && composer install
|
mkdir db && touch db/polls.db && composer install
|
||||||
```
|
```
|
||||||
|
|
||||||
Uncomment the dba extention in `php.ini` :
|
Uncomment the `dba` extention in `php.ini` :
|
||||||
```
|
```
|
||||||
extension=dba
|
extension=dba
|
||||||
```
|
```
|
||||||
@ -25,3 +25,5 @@ location /
|
|||||||
```
|
```
|
||||||
|
|
||||||
## API
|
## API
|
||||||
|
|
||||||
|
See [API.md](API.md).
|
Loading…
Reference in New Issue
Block a user