From dac1cea793912f0813358473b2785bf0abe1781a Mon Sep 17 00:00:00 2001 From: Hunter Long Date: Wed, 12 Sep 2018 14:22:47 -0700 Subject: [PATCH] Updated API (markdown) --- API.md | 7 ++++++- 1 file changed, 6 insertions(+), 1 deletion(-) diff --git a/API.md b/API.md index 31295d8..67096d2 100644 --- a/API.md +++ b/API.md @@ -47,7 +47,7 @@ POST Data: ### Deleting Service - Endpoint: `/api/services/{id}` - Method: `DELETE` -- Response: [Service](https://github.com/hunterlong/statup/wiki/API#service-response) +- Response: [Object Response](https://github.com/hunterlong/statup/wiki/API#object-response) Response: ```json @@ -65,14 +65,17 @@ The users API endpoint will show you users that are registered inside your Statu ### View All Users - Endpoint: `/api/users` - Method: `GET` +- Response: Array of [Users](https://github.com/hunterlong/statup/wiki/API#user-response) ### Viewing User - Endpoint: `/api/users/{id}` - Method: `GET` +- Response: [User](https://github.com/hunterlong/statup/wiki/API#user-response) ### Creating New User - Endpoint: `/api/users` - Method: `POST` +- Response: [User](https://github.com/hunterlong/statup/wiki/API#user-response) POST Data: ```json @@ -87,6 +90,7 @@ POST Data: ### Updating User - Endpoint: `/api/users/{id}` - Method: `POST` +- Response: [User](https://github.com/hunterlong/statup/wiki/API#user-response) POST Data: ```json @@ -101,6 +105,7 @@ POST Data: ### Deleting User - Endpoint: `/api/services/{id}` - Method: `DELETE` +- Response: [Object Response](https://github.com/hunterlong/statup/wiki/API#object-response) Response: ```json