|
1 | 1 | # Davis API |
2 | 2 |
|
3 | | -## Open Endpoints |
| 3 | +## API Version 1 |
| 4 | + |
| 5 | +### Open Endpoints |
4 | 6 |
|
5 | 7 | Open endpoints require no Authentication. |
6 | 8 |
|
7 | | -* [Health](health.md) : `GET /api/health` |
| 9 | +* [Health](v1/health.md) : `GET /api/v1/health` |
8 | 10 |
|
9 | | -## Endpoints that require Authentication |
| 11 | +### Endpoints that require Authentication |
10 | 12 |
|
11 | | -Closed endpoints require a valid `X-API-Key` to be included in the header of the request. Token needs to be configured in .env file (as a environment variable `API_KEY`) and can be generated using `php bin/console api:generate` command. |
| 13 | +Closed endpoints require a valid `X-Davis-API-Token` to be included in the header of the request. Token needs to be configured in .env file (as a environment variable `API_KEY`) and can be generated using `php bin/console api:generate` command. |
12 | 14 |
|
13 | | -### User related |
| 15 | +#### User related |
14 | 16 |
|
15 | 17 | Each endpoint displays information related to the User: |
16 | 18 |
|
17 | | -* [Get Users](users/all.md) : `GET /api/users` |
18 | | -* [Get User Details](users/details.md) : `GET /api/users/:username` |
| 19 | +* [Get Users](v1/users/all.md) : `GET /api/v1/users` |
| 20 | +* [Get User Details](v1/users/details.md) : `GET /api/v1/users/:username` |
19 | 21 |
|
20 | | -### Calendars related |
| 22 | +#### Calendars related |
21 | 23 |
|
22 | 24 | Endpoints for viewing and modifying user calendars. |
23 | 25 |
|
24 | | -* [Show All User Calendars](calendars/all.md) : `GET /api/calendars/:username` |
25 | | -* [Show User Calendar Details](calendars/details.md) : `GET /api/calendars/:username/:calendar_id` |
26 | | -* [Show User Calendar Shares](calendars/shares.md) : `GET /api/calendars/:username/shares/:calendar_id` |
27 | | -* [Share User Calendar](calendars/share_add.md) : `POST /api/calendars/:username/share/:calendar_id/add` |
28 | | -* [Remove Share User Calendar](calendars/share_remove.md) : `POST /api/calendars/:username/share/:calendar_id/remove` |
| 26 | +* [Show All User Calendars](v1/calendars/all.md) : `GET /api/v1/calendars/:username` |
| 27 | +* [Show User Calendar Details](v1/calendars/details.md) : `GET /api/v1/calendars/:username/:calendar_id` |
| 28 | +* [Create User Calendar](v1/calendars/create.md) : `POST /api/v1/calendars/:username/create` |
| 29 | +* [Edit User Calendar](v1/calendars/edit.md) : `POST /api/v1/calendars/:username/:calendar_id/edit` |
| 30 | +* [Show User Calendar Shares](v1/calendars/shares.md) : `GET /api/v1/calendars/:username/shares/:calendar_id` |
| 31 | +* [Share User Calendar](v1/calendars/share_add.md) : `POST /api/v1/calendars/:username/share/:calendar_id/add` |
| 32 | +* [Remove Share User Calendar](v1/calendars/share_remove.md) : `POST /api/v1/calendars/:username/share/:calendar_id/remove` |
0 commit comments