Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

API docs: corrected methods' paths #32

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

API docs: corrected methods' paths #32

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions docs/api/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,7 @@ A response with `Content-Type: text/html` is returned. Possible status codes:
This method does not (ever) return a response with the `401 Unauthorized` status code. All the others are possible


### `/activities`
### `/api/activities`
Either get all activities or add a new activity

#### Request
Expand All @@ -68,11 +68,11 @@ For `POST`: response will contain a `json` of the following scheme `{'type_id':
days.


### `/emotions`
### `/api/emotions`
Exactly like `/activities` (but for emotions)


### `/activities/<type_id: int>`
### `/api/activities/<type_id: int>`
Either get info about the activity type by its id or update an activity

#### Request
Expand All @@ -96,7 +96,7 @@ For `PATCH`: you will get a response with the `200 OK` status code
If there is no activity with the `id` identifier, you will get an error response with the `404 Not Found` status code


### `/emotions/<type_id: int>`
### `/api/emotions/<type_id: int>`
Exactly like `/activities/<type_id: int>` (but for emotions)


Expand Down