diff --git a/API.md b/API.md index 67096d2..2f7e8c6 100644 --- a/API.md +++ b/API.md @@ -16,16 +16,22 @@ The services API endpoint will show you detailed information about services and - Endpoint: `/api/services` - Method: `GET` - Response: Array of [Services](https://github.com/hunterlong/statup/wiki/API#service-response) +- Response Type: `application/json` +- Request Type: `application/json` ### Viewing Service - Endpoint: `/api/services/{id}` - Method: `GET` - Response: [Service](https://github.com/hunterlong/statup/wiki/API#service-response) +- Response Type: `application/json` +- Request Type: `application/json` ### Updating Service - Endpoint: `/api/services/{id}` - Method: `POST` - Response: [Service](https://github.com/hunterlong/statup/wiki/API#service-response) +- Response Type: `application/json` +- Request Type: `application/json` POST Data: ```json @@ -48,6 +54,8 @@ POST Data: - Endpoint: `/api/services/{id}` - Method: `DELETE` - Response: [Object Response](https://github.com/hunterlong/statup/wiki/API#object-response) +- Response Type: `application/json` +- Request Type: `application/json` Response: ```json @@ -66,16 +74,22 @@ The users API endpoint will show you users that are registered inside your Statu - Endpoint: `/api/users` - Method: `GET` - Response: Array of [Users](https://github.com/hunterlong/statup/wiki/API#user-response) +- Response Type: `application/json` +- Request Type: `application/json` ### Viewing User - Endpoint: `/api/users/{id}` - Method: `GET` - Response: [User](https://github.com/hunterlong/statup/wiki/API#user-response) +- Response Type: `application/json` +- Request Type: `application/json` ### Creating New User - Endpoint: `/api/users` - Method: `POST` - Response: [User](https://github.com/hunterlong/statup/wiki/API#user-response) +- Response Type: `application/json` +- Request Type: `application/json` POST Data: ```json @@ -91,6 +105,8 @@ POST Data: - Endpoint: `/api/users/{id}` - Method: `POST` - Response: [User](https://github.com/hunterlong/statup/wiki/API#user-response) +- Response Type: `application/json` +- Request Type: `application/json` POST Data: ```json @@ -106,6 +122,8 @@ POST Data: - Endpoint: `/api/services/{id}` - Method: `DELETE` - Response: [Object Response](https://github.com/hunterlong/statup/wiki/API#object-response) +- Response Type: `application/json` +- Request Type: `application/json` Response: ```json