Correct some endpoints and terms
This commit is contained in:
parent
44fd4ea6d0
commit
1c45a4a94b
@ -15,10 +15,10 @@ ___
|
||||
| created_at | datetime | generated by database |
|
||||
|
||||
#### Add an account
|
||||
**`POST /api/accounts/add`**
|
||||
**`POST /api/accounts`**
|
||||
|
||||
##### Request
|
||||
A json object for the user to register with **`username`**, **`email`**, **`password`**, `timezone`, `earliest_time` and `latest_time`.
|
||||
A json object for the account to register with **`username`**, **`email`**, **`password`**, `timezone`, `earliest_time` and `latest_time`.
|
||||
|
||||
```
|
||||
{
|
||||
@ -32,7 +32,7 @@ A json object for the user to register with **`username`**, **`email`**, **`pass
|
||||
```
|
||||
|
||||
##### Response
|
||||
A json object for the registered user with `id`, `username`, `email`, `timezone`, `earliest_time` and `latest_time`.
|
||||
A json object for the registered account with `id`, `username`, `email`, `timezone`, `earliest_time` and `latest_time`.
|
||||
|
||||
```
|
||||
{
|
||||
@ -52,7 +52,7 @@ A json object for the registered user with `id`, `username`, `email`, `timezone`
|
||||
**`POST /api/accounts/login`**
|
||||
|
||||
##### Request
|
||||
A json object for the user to login with either **`email`** or **`username`**, and **`password`** .
|
||||
A json object for the account to login with either **`email`** or **`username`**, and **`password`** .
|
||||
|
||||
```
|
||||
{
|
||||
@ -62,7 +62,7 @@ A json object for the user to login with either **`email`** or **`username`**, a
|
||||
```
|
||||
|
||||
##### Response
|
||||
A json object for the registered user with `id`, `username`, `email`, `timezone`, `earliest_time` and `latest_time`.
|
||||
A json object for the registered account with `id`, `username`, `email`, `timezone`, `earliest_time` and `latest_time`.
|
||||
|
||||
```
|
||||
{
|
||||
@ -82,7 +82,7 @@ A json object for the registered user with `id`, `username`, `email`, `timezone`
|
||||
**`PUT /api/accounts/:id`**
|
||||
|
||||
##### Request
|
||||
A json object for the user to register with `id` and any of `username`, `email`, `password`, `timezone`, `earliest_time`, `latest_time`.
|
||||
A json object for the account to register with `id` and any of `username`, `email`, `password`, `timezone`, `earliest_time`, `latest_time`.
|
||||
|
||||
```
|
||||
{
|
||||
@ -93,7 +93,7 @@ A json object for the user to register with `id` and any of `username`, `email`,
|
||||
```
|
||||
|
||||
##### Response
|
||||
A json object for the registered user with `id`, `username`, `email`, `timezone`, `earliest_time` and `latest_time`.
|
||||
A json object for the registered account with `id`, `username`, `email`, `timezone`, `earliest_time` and `latest_time`.
|
||||
|
||||
```
|
||||
{
|
||||
@ -113,7 +113,7 @@ A json object for the registered user with `id`, `username`, `email`, `timezone`
|
||||
**`DELETE /api/accounts/:id`**
|
||||
|
||||
##### Request
|
||||
A json object for the user to delete with `id`.
|
||||
A json object for the account to delete with `id`.
|
||||
|
||||
```
|
||||
{
|
||||
@ -122,7 +122,7 @@ A json object for the user to delete with `id`.
|
||||
```
|
||||
|
||||
##### Response
|
||||
A json object for the deleted user with `username` and `email`.
|
||||
A json object for the deleted account with `username` and `email`.
|
||||
|
||||
```
|
||||
{
|
||||
@ -187,7 +187,7 @@ A json object for the specified account with an array of `meeting`.
|
||||
| created_at | datetime | generated by database |
|
||||
|
||||
#### Add a meeting
|
||||
**`POST /api/meetings/add`**
|
||||
**`POST /api/meetings`**
|
||||
|
||||
##### Request
|
||||
A json object for the meeting to add with **`id`**, **`title`**, `description`, `start_time`, **`duration`** and `password`.
|
||||
@ -266,7 +266,7 @@ A json object for the meeting to delete with `id` and `account_id`.
|
||||
```
|
||||
|
||||
##### Response
|
||||
A json object for the deleted user with `username` and `email`.
|
||||
A json object for the deleted meeting with `id` and `title`.
|
||||
|
||||
```
|
||||
{
|
||||
@ -278,8 +278,8 @@ A json object for the deleted user with `username` and `email`.
|
||||
}
|
||||
```
|
||||
|
||||
#### Get a list of all invited for a meeting
|
||||
**`GET /api/meeting/:id/invited`**
|
||||
#### Get a list of all participants for a meeting
|
||||
**`GET /api/meetings/:id/participants`**
|
||||
|
||||
##### Request
|
||||
A json object with an `account_id`.
|
||||
@ -292,7 +292,7 @@ A json object with an `account_id`.
|
||||
```
|
||||
|
||||
##### Response
|
||||
A json object for the specified meeting with an array of `invited`.
|
||||
A json object for the specified meeting with an array of `participant`.
|
||||
|
||||
```
|
||||
{
|
||||
@ -386,7 +386,7 @@ A json object for the deleted possible date with `id` and `possible_date`.
|
||||
}
|
||||
```
|
||||
|
||||
### **Invited** | `invited`
|
||||
### **Participants** | `participant`
|
||||
| field | data type | metadata |
|
||||
| :------------ | :-------- | :-------------------------- |
|
||||
| account_id | int | primary key, auto-increment |
|
||||
@ -400,11 +400,11 @@ A json object for the deleted possible date with `id` and `possible_date`.
|
||||
| timezone | varchar | required |
|
||||
| created_at | datetime | generated by database |
|
||||
|
||||
#### Add an invited
|
||||
**`POST /api/invited`**
|
||||
#### Invite a participant
|
||||
**`POST /api/participants`**
|
||||
|
||||
##### Request
|
||||
A json object for the invited to add with **`account_id`**, **`meeting_id`**, **`earliest_time`**, **`latest_time`**, **`quorum`**, **`mandatory`**, **`host`**, **`answered`** and **`timezone`**.
|
||||
A json object for the participant to add with **`account_id`**, **`meeting_id`**, **`earliest_time`**, **`latest_time`**, **`quorum`**, **`mandatory`**, **`host`**, **`answered`** and **`timezone`**.
|
||||
|
||||
```
|
||||
{
|
||||
@ -421,7 +421,7 @@ A json object for the invited to add with **`account_id`**, **`meeting_id`**, **
|
||||
```
|
||||
|
||||
##### Response
|
||||
A json object for the invited with `id`, `account_id`, `meeting_id`, `earliest_time`, `latest_time`, `quorum`, `mandatory`, `host`, `answered` and `timezone`.
|
||||
A json object for the participant with `id`, `account_id`, `meeting_id`, `earliest_time`, `latest_time`, `quorum`, `mandatory`, `host`, `answered` and `timezone`.
|
||||
|
||||
```
|
||||
{
|
||||
@ -441,11 +441,11 @@ A json object for the invited with `id`, `account_id`, `meeting_id`, `earliest_t
|
||||
}
|
||||
```
|
||||
|
||||
#### Update an invited
|
||||
**`PUT /api/invited/:id`**
|
||||
#### Update a participant
|
||||
**`PUT /api/participants/:id`**
|
||||
|
||||
##### Request
|
||||
A json object for the user to invite with `id` and any of `id`, `earliest_time`, `latest_time`, `quorum`, `mandatory`, `host`, `answered` and `timezone`.
|
||||
A json object for the participant to invite with `id` and any of `id`, `earliest_time`, `latest_time`, `quorum`, `mandatory`, `host`, `answered` and `timezone`.
|
||||
|
||||
```
|
||||
{
|
||||
@ -459,7 +459,7 @@ A json object for the user to invite with `id` and any of `id`, `earliest_time`,
|
||||
```
|
||||
|
||||
##### Response
|
||||
A json object for the invited user with `id`, `account_id`, `meeting_id`, `earliest_time`, `latest_time`, `quorum`, `mandatory`, `host`, `answered` and `timezone`.
|
||||
A json object for the participant with `id`, `account_id`, `meeting_id`, `earliest_time`, `latest_time`, `quorum`, `mandatory`, `host`, `answered` and `timezone`.
|
||||
|
||||
```
|
||||
{
|
||||
@ -479,11 +479,11 @@ A json object for the invited user with `id`, `account_id`, `meeting_id`, `earli
|
||||
}
|
||||
```
|
||||
|
||||
#### Delete an invited
|
||||
**`DELETE /api/invited/:id`**
|
||||
#### Delete a participant
|
||||
**`DELETE /api/participants/:id`**
|
||||
|
||||
##### Request
|
||||
A json object for the invited to delete with `id`.
|
||||
A json object for the participant to delete with `id`.
|
||||
|
||||
```
|
||||
{
|
||||
@ -492,7 +492,7 @@ A json object for the invited to delete with `id`.
|
||||
```
|
||||
|
||||
##### Response
|
||||
A json object for the deleted user with `id`, `account_id` and `meeting_id`.
|
||||
A json object for the deleted participant with `id`, `account_id` and `meeting_id`.
|
||||
|
||||
```
|
||||
{
|
||||
|
||||
Loading…
Reference in New Issue
Block a user