[java-okhttpgson]: Include API's Http response codes and their corresponding description and response headers in the documentation (#2995)

* fix(okhttp-gson-java): Adding response headers on api_doc.mustache

* feat(okhttp-gson): Adding Http response headers to docs and javadocs

* feat(okhttp-gson): Included dots in custom tage

* feat(java-okhttpgson): Updating pet project

* feat(java-okhttpgson): Updating other pet project
This commit is contained in:
Sai Giridhar P
2019-05-28 22:25:59 +05:30
committed by William Cheng
parent 38b1fe2d36
commit 499c8ac5c1
29 changed files with 2127 additions and 0 deletions

View File

@@ -58,6 +58,11 @@ No authorization required
- **Content-Type**: Not defined
- **Accept**: Not defined
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
**0** | successful operation | - |
<a name="createUsersWithArrayInput"></a>
# **createUsersWithArrayInput**
> createUsersWithArrayInput(body)
@@ -100,6 +105,11 @@ No authorization required
- **Content-Type**: Not defined
- **Accept**: Not defined
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
**0** | successful operation | - |
<a name="createUsersWithListInput"></a>
# **createUsersWithListInput**
> createUsersWithListInput(body)
@@ -142,6 +152,11 @@ No authorization required
- **Content-Type**: Not defined
- **Accept**: Not defined
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
**0** | successful operation | - |
<a name="deleteUser"></a>
# **deleteUser**
> deleteUser(username)
@@ -186,6 +201,12 @@ No authorization required
- **Content-Type**: Not defined
- **Accept**: Not defined
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
**400** | Invalid username supplied | - |
**404** | User not found | - |
<a name="getUserByName"></a>
# **getUserByName**
> User getUserByName(username)
@@ -229,6 +250,13 @@ No authorization required
- **Content-Type**: Not defined
- **Accept**: application/xml, application/json
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
**200** | successful operation | - |
**400** | Invalid username supplied | - |
**404** | User not found | - |
<a name="loginUser"></a>
# **loginUser**
> String loginUser(username, password)
@@ -274,6 +302,12 @@ No authorization required
- **Content-Type**: Not defined
- **Accept**: application/xml, application/json
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
**200** | successful operation | * X-Rate-Limit - calls per hour allowed by the user <br> * X-Expires-After - date in UTC when token expires <br> |
**400** | Invalid username/password supplied | - |
<a name="logoutUser"></a>
# **logoutUser**
> logoutUser()
@@ -312,6 +346,11 @@ No authorization required
- **Content-Type**: Not defined
- **Accept**: Not defined
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
**0** | successful operation | - |
<a name="updateUser"></a>
# **updateUser**
> updateUser(username, body)
@@ -358,3 +397,9 @@ No authorization required
- **Content-Type**: Not defined
- **Accept**: Not defined
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
**400** | Invalid user supplied | - |
**404** | User not found | - |