maket/MaketRandevu
1
1
Fork 0
Code Issues 15 Pull requests Projects Releases 4 Packages Wiki Activity

Mention the password field in the resource examples of the providers, secretaries and admin records.

Browse source
This commit is contained in:
Alex Tselegidis 2020-10-19 19:24:15 +03:00
parent 0324a3e464
commit faa22ad972
1 changed files with 9 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

9
docs/rest-api.md
View file

@ -245,6 +245,7 @@ You can also try the GET requests with your browser by navigating to the respect
"notes": "Test admin notes.", "notes": "Test admin notes.",
"settings":{ "settings":{
"username": "chrisdoe", "username": "chrisdoe",
"password": "p@ssw0rd",
"notifications": true, "notifications": true,
"calendarView": "default" "calendarView": "default"
} }
@ -256,6 +257,8 @@ You can also try the GET requests with your browser by navigating to the respect
- `PUT /api/v1/admins/:id` Provide the updated admin JSON in the request body to update an existing record. The ID in the URI is required. - `PUT /api/v1/admins/:id` Provide the updated admin JSON in the request body to update an existing record. The ID in the URI is required.
- `DELETE /api/v1/admins/:id` Remove an existing admin record. - `DELETE /api/v1/admins/:id` Remove an existing admin record.
**Note: The `password` field is optional and should only be provided when creating (POST) or updating (PUT) a record.**
### Providers ### Providers
**Resource JSON** **Resource JSON**
@ -280,6 +283,7 @@ You can also try the GET requests with your browser by navigating to the respect
], ],
"settings":{ "settings":{
"username": "chloedoe", "username": "chloedoe",
"password": "p@ssw0rd",
"notifications":true, "notifications":true,
"googleSync":true, "googleSync":true,
"googleCalendar": "calendar-id", "googleCalendar": "calendar-id",
@ -341,6 +345,8 @@ You can also try the GET requests with your browser by navigating to the respect
- `PUT /api/v1/providers/:id` Provide the updated provider JSON in the request body to update an existing record. The ID in the URI is required. - `PUT /api/v1/providers/:id` Provide the updated provider JSON in the request body to update an existing record. The ID in the URI is required.
- `DELETE /api/v1/providers/:id` Remove an existing provider record. - `DELETE /api/v1/providers/:id` Remove an existing provider record.
**Note: The `password` field is optional and should only be provided when creating (POST) or updating (PUT) a record.**
### Secretaries ### Secretaries
**Resource JSON** **Resource JSON**
@ -363,6 +369,7 @@ You can also try the GET requests with your browser by navigating to the respect
], ],
"settings":{ "settings":{
"username":"chrisdoe", "username":"chrisdoe",
"password":"p@ssw0rd",
"notifications": true, "notifications": true,
"calendarView": "default" "calendarView": "default"
} }
@ -374,6 +381,8 @@ You can also try the GET requests with your browser by navigating to the respect
- `PUT /api/v1/secretaries/:id` Provide the updated secretary JSON in the request body to update an existing record. The ID in the URI is required. - `PUT /api/v1/secretaries/:id` Provide the updated secretary JSON in the request body to update an existing record. The ID in the URI is required.
- `DELETE /api/v1/secretaries/:id` Remove an existing secretary record. - `DELETE /api/v1/secretaries/:id` Remove an existing secretary record.
**Note: The `password` field is optional and should only be provided when creating (POST) or updating (PUT) a record.**
### Settings ### Settings
**Resource JSON** **Resource JSON**