#Swagger documentation for Emoji Petz ## HTTP://localhost:8080/rest/work Generating documentation from Spring MVC annotations **Version** v1 [**Terms of Service**]() # APIs ## /players ### GET <a id="list"></a> #### Request ##### Parameters #### Response | Status Code | Reason | Response Model | |-------------|-------------|----------------| | 200 | successful operation | <a href="#/definitions/IterablePlayer">IterablePlayer</a>| ### POST <a id="post"></a> #### Request **Content-Type: ** application/json ##### Parameters <table border="1"> <tr> <th>Name</th> <th>Located in</th> <th>Required</th> <th>Description</th> <th>Default</th> <th>Schema</th> </tr> <tr> <th>body</th> <td>body</td> <td>no</td> <td></td> <td> - </td> <td> <a href="#/definitions/Player">Player</a> </td> </tr> </table> #### Response | Status Code | Reason | Response Model | |-------------|-------------|----------------| | 200 | successful operation | <a href="#/definitions/Player">Player</a>| ## /players/id/{player_id} ### GET <a id="get"></a> #### Request ##### Parameters <table border="1"> <tr> <th>Name</th> <th>Located in</th> <th>Required</th> <th>Description</th> <th>Default</th> <th>Schema</th> </tr> <tr> <th>player_id</th> <td>path</td> <td>yes</td> <td></td> <td> - </td> <td>integer (int64)</td> </tr> </table> #### Response | Status Code | Reason | Response Model | |-------------|-------------|----------------| | 200 | successful operation | <a href="#/definitions/Player">Player</a>| ## /players/{playerId} ### DELETE <a id="delete"></a> #### Request ##### Parameters <table border="1"> <tr> <th>Name</th> <th>Located in</th> <th>Required</th> <th>Description</th> <th>Default</th> <th>Schema</th> </tr> <tr> <th>playerId</th> <td>path</td> <td>yes</td> <td></td> <td> - </td> <td>integer (int64)</td> </tr> </table> #### Response | Status Code | Reason | Response Model | |-------------|-------------|----------------| | 204 | | - | ## /players/{playerId}/unfollow/{playerId2} ### DELETE <a id="delete"></a> #### Request ##### Parameters <table border="1"> <tr> <th>Name</th> <th>Located in</th> <th>Required</th> <th>Description</th> <th>Default</th> <th>Schema</th> </tr> <tr> <th>playerId</th> <td>path</td> <td>yes</td> <td></td> <td> - </td> <td>integer (int64)</td> </tr> <tr> <th>playerId2</th> <td>path</td> <td>yes</td> <td></td> <td> - </td> <td>integer (int64)</td> </tr> </table> #### Response | Status Code | Reason | Response Model | |-------------|-------------|----------------| | 204 | | - | ## /players/{player_oauthId} ### GET <a id="get"></a> #### Request ##### Parameters <table border="1"> <tr> <th>Name</th> <th>Located in</th> <th>Required</th> <th>Description</th> <th>Default</th> <th>Schema</th> </tr> <tr> <th>player_oauthId</th> <td>path</td> <td>yes</td> <td></td> <td> - </td> <td>string </td> </tr> </table> #### Response | Status Code | Reason | Response Model | |-------------|-------------|----------------| | 200 | successful operation | <a href="#/definitions/Player">Player</a>| ### PUT <a id="putJson"></a> #### Request **Content-Type: ** application/json ##### Parameters <table border="1"> <tr> <th>Name</th> <th>Located in</th> <th>Required</th> <th>Description</th> <th>Default</th> <th>Schema</th> </tr> <tr> <th>player_oauthId</th> <td>path</td> <td>yes</td> <td></td> <td> - </td> <td>string </td> </tr> <tr> <th>body</th> <td>body</td> <td>no</td> <td></td> <td> - </td> <td> <a href="#/definitions/Player">Player</a> </td> </tr> </table> #### Response **Content-Type: ** text/plain | Status Code | Reason | Response Model | |-------------|-------------|----------------| | 200 | successful operation | <a href="#/definitions/Player">Player</a>| ## /players/{player_oauthId}/follow/{other_player_oauthId} ### POST <a id="postFollow"></a> #### Request ##### Parameters <table border="1"> <tr> <th>Name</th> <th>Located in</th> <th>Required</th> <th>Description</th> <th>Default</th> <th>Schema</th> </tr> <tr> <th>player_oauthId</th> <td>path</td> <td>yes</td> <td></td> <td> - </td> <td>string </td> </tr> <tr> <th>other_player_oauthId</th> <td>path</td> <td>yes</td> <td></td> <td> - </td> <td>string </td> </tr> </table> #### Response | Status Code | Reason | Response Model | |-------------|-------------|----------------| | 200 | successful operation | <a href="#/definitions/Player">Player</a>| # Definitions ## <a name="/definitions/Player">Player</a> <table border="1"> <tr> <th>name</th> <th>type</th> <th>required</th> <th>description</th> <th>example</th> </tr> <tr> <td>id</td> <td> integer (int64) </td> <td>optional</td> <td>-</td> <td></td> </tr> <tr> <td>oauthId</td> <td> string </td> <td>optional</td> <td>-</td> <td></td> </tr> <tr> <td>display_name</td> <td> string </td> <td>optional</td> <td>-</td> <td></td> </tr> <tr> <td>status</td> <td> string </td> <td>optional</td> <td>-</td> <td></td> </tr> <tr> <td>wall</td> <td> string </td> <td>optional</td> <td>-</td> <td></td> </tr> <tr> <td>pet_name</td> <td> string </td> <td>optional</td> <td>-</td> <td></td> </tr> <tr> <td>pet_emoji</td> <td> string </td> <td>optional</td> <td>-</td> <td></td> </tr> <tr> <td>level</td> <td> integer (int32) </td> <td>optional</td> <td>-</td> <td></td> </tr> <tr> <td>xp</td> <td> integer (int32) </td> <td>optional</td> <td>-</td> <td></td> </tr> <tr> <td>maxXp</td> <td> integer (int32) </td> <td>optional</td> <td>-</td> <td></td> </tr> <tr> <td>timeStamp</td> <td> integer (int64) </td> <td>optional</td> <td>-</td> <td></td> </tr> <tr> <td>couragePoints</td> <td> integer (int64) </td> <td>optional</td> <td>-</td> <td></td> </tr> <tr> <td>couragePointsMax</td> <td> integer (int32) </td> <td>optional</td> <td>-</td> <td></td> </tr> <tr> <td>manaPoints</td> <td> integer (int64) </td> <td>optional</td> <td>-</td> <td></td> </tr> <tr> <td>manaPointsMax</td> <td> integer (int32) </td> <td>optional</td> <td>-</td> <td></td> </tr> <tr> <td>healthPoints</td> <td> integer (int64) </td> <td>optional</td> <td>-</td> <td></td> </tr> <tr> <td>healthPointsMax</td> <td> integer (int32) </td> <td>optional</td> <td>-</td> <td></td> </tr> <tr> <td>powerPoints</td> <td> integer (int64) </td> <td>optional</td> <td>-</td> <td></td> </tr> <tr> <td>powerPointsMax</td> <td> integer (int32) </td> <td>optional</td> <td>-</td> <td></td> </tr> </table>