meeting-planner/documentation
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Correct typo: "availibility" => "availability

Browse Source
This commit is contained in:
rui hildt 2020-06-02 16:54:13 +02:00
parent 2d48134ecb
commit 8cfdd495b3
2 changed files with 26 additions and 22 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
README.md
View File

@ -1,10 +1,12 @@
## About Meeting Planner ## About Meeting Planner
Meeting Planner helps you find the best time to schedule a meeting across several timezones. Meeting Planner helps you find the best time to schedule a meeting across several timezones.
It's based on the availibity of all participants for specific days. It's based on the availibity of all participants for specific days.
## How does it work? ## How does it work?
#### For the meeting manager #### For the meeting manager
1. Enter a title and description(optional) 1. Enter a title and description(optional)
2. Select the possible days on the calendar 2. Select the possible days on the calendar
3. Select a deadline for responses 3. Select a deadline for responses
@ -13,15 +15,17 @@ It's based on the availibity of all participants for specific days.
6. Choose and set the meeting date 6. Choose and set the meeting date
Optional: Optional:
- Choose the minimum of people for the meeting to take place (quorum) - Choose the minimum of people for the meeting to take place (quorum)
- Choose who needs to be there for the meeting to happen - Choose who needs to be there for the meeting to happen
#### For the participants #### For the participants
1. Select your availibility on the calendar: you can choose between (Yes / No / Ideal)
1. Select your availability on the calendar: you can choose between (Yes / No / Ideal)
2. Wait for the meeting manager to confirm the meeting date 2. Wait for the meeting manager to confirm the meeting date
## Code and architecture ## Code and architecture
- [Backend](https://git.armada.digital/meeting-planner/backend) - [Backend](https://git.armada.digital/meeting-planner/backend)
- Frontend (coming soon) - Frontend (coming soon)
- [API endpoints](./api-documentation.md) - [API endpoints](./api-documentation.md)

26
api-documentation.md
View File

@ -379,9 +379,9 @@ A json object for the specified meeting with an array of `possible_date`.
] ]
``` ```
#### Get a list of all availibility for a meeting #### Get a list of all availability for a meeting
**`GET /api/meetings/:id/availibility`** **`GET /api/meetings/:id/availability`**
##### Request ##### Request
@ -395,7 +395,7 @@ A json object with a `meeting_id`.
##### Response `200` ##### Response `200`
A json object for the specified meeting with `meeting_id` and an array of `availibility`. A json object for the specified meeting with `meeting_id` and an array of `availability`.
``` ```
[ [
@ -610,7 +610,7 @@ A json object for the deleted possible date with `message`.
} }
``` ```
### **Availibility** | `availibility` ### **Availability** | `availability`
| field | data type | metadata | | field | data type | metadata |
| :--------------- | :-------- | :-------------------------------------------- | | :--------------- | :-------- | :-------------------------------------------- |
@ -625,13 +625,13 @@ A json object for the deleted possible date with `message`.
| created_at | datetime | generated by database | | created_at | datetime | generated by database |
| updated_at | datetime | generated by database | | updated_at | datetime | generated by database |
#### Add an availibility #### Add an availability
**`POST /api/availibility`** **`POST /api/availability`**
##### Request ##### Request
A json object with the availibility to add with **`participant_id`**, **`possible_date_id`** and an array of intervals with **`preference`**, **`start_time`**, **`end_time`** and **`timezone`**. A json object with the availability to add with **`participant_id`**, **`possible_date_id`** and an array of intervals with **`preference`**, **`start_time`**, **`end_time`** and **`timezone`**.
``` ```
{ {
@ -648,7 +648,7 @@ A json object with the availibility to add with **`participant_id`**, **`possibl
##### Response `201` ##### Response `201`
A json object with the availibility added with **`id`**, **`account_id`**, **`meeting_id`**, **`possible_date_id`** and an array of intervals with **`id`**, **`preference`**, **`start_time`**, **`end_time`** and **`timezone`**. A json object with the availability added with **`id`**, **`account_id`**, **`meeting_id`**, **`possible_date_id`** and an array of intervals with **`id`**, **`preference`**, **`start_time`**, **`end_time`** and **`timezone`**.
``` ```
{ {
@ -663,13 +663,13 @@ A json object with the availibility added with **`id`**, **`account_id`**, **`me
} }
``` ```
#### Delete an availibility #### Delete an availability
**`DELETE /api/availibility/:id`** **`DELETE /api/availability/:id`**
##### Request ##### Request
A json object for the availibility to delete with **`token`**. A json object for the availability to delete with **`token`**.
``` ```
{ {
@ -679,10 +679,10 @@ A json object for the availibility to delete with **`token`**.
##### Response `200` ##### Response `200`
A json object for the deleted availibility with `message`. A json object for the deleted availability with `message`.
``` ```
{ {
"message": "Availibility with id 30 was successfully deleted." "message": "Availability with id 30 was successfully deleted."
} }
``` ```