[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
2019-05-28 22:25:59 +05:30
parent 38b1fe2d36
commit 499c8ac5c1
29 changed files with 2127 additions and 0 deletions
--- a/samples/client/petstore/java/okhttp-gson/docs/AnotherFakeApi.md
+++ b/samples/client/petstore/java/okhttp-gson/docs/AnotherFakeApi.md
@@ -52,3 +52,8 @@ No authorization required
 - **Content-Type**: application/json
 - **Accept**: application/json

+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+**200** | successful operation |  -  |
+
--- a/samples/client/petstore/java/okhttp-gson/docs/FakeApi.md
+++ b/samples/client/petstore/java/okhttp-gson/docs/FakeApi.md
@@ -63,6 +63,11 @@ No authorization required
 - **Content-Type**: application/xml, application/xml; charset=utf-8, application/xml; charset=utf-16, text/xml, text/xml; charset=utf-8, text/xml; charset=utf-16
 - **Accept**: Not defined

+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+**200** | successful operation |  -  |
+
 <a name="fakeOuterBooleanSerialize"></a>
 # **fakeOuterBooleanSerialize**
 > Boolean fakeOuterBooleanSerialize(body)
@@ -108,6 +113,11 @@ No authorization required
 - **Content-Type**: Not defined
 - **Accept**: */*

+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+**200** | Output boolean |  -  |
+
 <a name="fakeOuterCompositeSerialize"></a>
 # **fakeOuterCompositeSerialize**
 > OuterComposite fakeOuterCompositeSerialize(body)
@@ -153,6 +163,11 @@ No authorization required
 - **Content-Type**: Not defined
 - **Accept**: */*

+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+**200** | Output composite |  -  |
+
 <a name="fakeOuterNumberSerialize"></a>
 # **fakeOuterNumberSerialize**
 > BigDecimal fakeOuterNumberSerialize(body)
@@ -198,6 +213,11 @@ No authorization required
 - **Content-Type**: Not defined
 - **Accept**: */*

+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+**200** | Output number |  -  |
+
 <a name="fakeOuterStringSerialize"></a>
 # **fakeOuterStringSerialize**
 > String fakeOuterStringSerialize(body)
@@ -243,6 +263,11 @@ No authorization required
 - **Content-Type**: Not defined
 - **Accept**: */*

+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+**200** | Output string |  -  |
+
 <a name="testBodyWithFileSchema"></a>
 # **testBodyWithFileSchema**
 > testBodyWithFileSchema(body)
@@ -287,6 +312,11 @@ No authorization required
 - **Content-Type**: application/json
 - **Accept**: Not defined

+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+**200** | Success |  -  |
+
 <a name="testBodyWithQueryParams"></a>
 # **testBodyWithQueryParams**
 > testBodyWithQueryParams(query, body)
@@ -331,6 +361,11 @@ No authorization required
 - **Content-Type**: application/json
 - **Accept**: Not defined

+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+**200** | Success |  -  |
+
 <a name="testClientModel"></a>
 # **testClientModel**
 > Client testClientModel(body)
@@ -376,6 +411,11 @@ No authorization required
 - **Content-Type**: application/json
 - **Accept**: application/json

+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+**200** | successful operation |  -  |
+
 <a name="testEndpointParameters"></a>
 # **testEndpointParameters**
 > testEndpointParameters(number, _double, patternWithoutDelimiter, _byte, integer, int32, int64, _float, string, binary, date, dateTime, password, paramCallback)
@@ -455,6 +495,12 @@ null (empty response body)
 - **Content-Type**: application/x-www-form-urlencoded
 - **Accept**: Not defined

+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+**400** | Invalid username supplied |  -  |
+**404** | User not found |  -  |
+
 <a name="testEnumParameters"></a>
 # **testEnumParameters**
 > testEnumParameters(enumHeaderStringArray, enumHeaderString, enumQueryStringArray, enumQueryString, enumQueryInteger, enumQueryDouble, enumFormStringArray, enumFormString)
@@ -513,6 +559,12 @@ No authorization required
 - **Content-Type**: application/x-www-form-urlencoded
 - **Accept**: Not defined

+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+**400** | Invalid request |  -  |
+**404** | Not found |  -  |
+
 <a name="testGroupParameters"></a>
 # **testGroupParameters**
 > testGroupParameters(requiredStringGroup, requiredBooleanGroup, requiredInt64Group).stringGroup(stringGroup).booleanGroup(booleanGroup).int64Group(int64Group).execute();
@@ -571,6 +623,11 @@ No authorization required
 - **Content-Type**: Not defined
 - **Accept**: Not defined

+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+**400** | Someting wrong |  -  |
+
 <a name="testInlineAdditionalProperties"></a>
 # **testInlineAdditionalProperties**
 > testInlineAdditionalProperties(param)
@@ -613,6 +670,11 @@ No authorization required
 - **Content-Type**: application/json
 - **Accept**: Not defined

+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+**200** | successful operation |  -  |
+
 <a name="testJsonFormData"></a>
 # **testJsonFormData**
 > testJsonFormData(param, param2)
@@ -657,3 +719,8 @@ No authorization required
 - **Content-Type**: application/x-www-form-urlencoded
 - **Accept**: Not defined

+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+**200** | successful operation |  -  |
+
--- a/samples/client/petstore/java/okhttp-gson/docs/FakeClassnameTags123Api.md
+++ b/samples/client/petstore/java/okhttp-gson/docs/FakeClassnameTags123Api.md
@@ -62,3 +62,8 @@ Name | Type | Description  | Notes
 - **Content-Type**: application/json
 - **Accept**: application/json

+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+**200** | successful operation |  -  |
+
--- a/samples/client/petstore/java/okhttp-gson/docs/PetApi.md
+++ b/samples/client/petstore/java/okhttp-gson/docs/PetApi.md
@@ -65,6 +65,12 @@ null (empty response body)
 - **Content-Type**: application/json, application/xml
 - **Accept**: Not defined

+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+**200** | successful operation |  -  |
+**405** | Invalid input |  -  |
+
 <a name="deletePet"></a>
 # **deletePet**
 > deletePet(petId, apiKey)
@@ -117,6 +123,12 @@ null (empty response body)
 - **Content-Type**: Not defined
 - **Accept**: Not defined

+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+**200** | successful operation |  -  |
+**400** | Invalid pet value |  -  |
+
 <a name="findPetsByStatus"></a>
 # **findPetsByStatus**
 > List&lt;Pet&gt; findPetsByStatus(status)
@@ -170,6 +182,12 @@ Name | Type | Description  | Notes
 - **Content-Type**: Not defined
 - **Accept**: application/xml, application/json

+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+**200** | successful operation |  -  |
+**400** | Invalid status value |  -  |
+
 <a name="findPetsByTags"></a>
 # **findPetsByTags**
 > List&lt;Pet&gt; findPetsByTags(tags)
@@ -223,6 +241,12 @@ Name | Type | Description  | Notes
 - **Content-Type**: Not defined
 - **Accept**: application/xml, application/json

+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+**200** | successful operation |  -  |
+**400** | Invalid tag value |  -  |
+
 <a name="getPetById"></a>
 # **getPetById**
 > Pet getPetById(petId)
@@ -278,6 +302,13 @@ Name | Type | Description  | Notes
 - **Content-Type**: Not defined
 - **Accept**: application/xml, application/json

+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+**200** | successful operation |  -  |
+**400** | Invalid ID supplied |  -  |
+**404** | Pet not found |  -  |
+
 <a name="updatePet"></a>
 # **updatePet**
 > updatePet(body)
@@ -328,6 +359,14 @@ null (empty response body)
 - **Content-Type**: application/json, application/xml
 - **Accept**: Not defined

+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+**200** | successful operation |  -  |
+**400** | Invalid ID supplied |  -  |
+**404** | Pet not found |  -  |
+**405** | Validation exception |  -  |
+
 <a name="updatePetWithForm"></a>
 # **updatePetWithForm**
 > updatePetWithForm(petId, name, status)
@@ -382,6 +421,11 @@ null (empty response body)
 - **Content-Type**: application/x-www-form-urlencoded
 - **Accept**: Not defined

+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+**405** | Invalid input |  -  |
+
 <a name="uploadFile"></a>
 # **uploadFile**
 > ModelApiResponse uploadFile(petId, additionalMetadata, file)
@@ -437,6 +481,11 @@ Name | Type | Description  | Notes
 - **Content-Type**: multipart/form-data
 - **Accept**: application/json

+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+**200** | successful operation |  -  |
+
 <a name="uploadFileWithRequiredFile"></a>
 # **uploadFileWithRequiredFile**
 > ModelApiResponse uploadFileWithRequiredFile(petId, requiredFile, additionalMetadata)
@@ -492,3 +541,8 @@ Name | Type | Description  | Notes
 - **Content-Type**: multipart/form-data
 - **Accept**: application/json

+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+**200** | successful operation |  -  |
+
--- a/samples/client/petstore/java/okhttp-gson/docs/StoreApi.md
+++ b/samples/client/petstore/java/okhttp-gson/docs/StoreApi.md
@@ -54,6 +54,12 @@ No authorization required
 - **Content-Type**: Not defined
 - **Accept**: Not defined

+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+**400** | Invalid ID supplied |  -  |
+**404** | Order not found |  -  |
+
 <a name="getInventory"></a>
 # **getInventory**
 > Map&lt;String, Integer&gt; getInventory()
@@ -105,6 +111,11 @@ This endpoint does not need any parameter.
 - **Content-Type**: Not defined
 - **Accept**: application/json

+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+**200** | successful operation |  -  |
+
 <a name="getOrderById"></a>
 # **getOrderById**
 > Order getOrderById(orderId)
@@ -150,6 +161,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 ID supplied |  -  |
+**404** | Order not found |  -  |
+
 <a name="placeOrder"></a>
 # **placeOrder**
 > Order placeOrder(body)
@@ -193,3 +211,9 @@ 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 Order |  -  |
+
--- a/samples/client/petstore/java/okhttp-gson/docs/UserApi.md
+++ b/samples/client/petstore/java/okhttp-gson/docs/UserApi.md
@@ -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 |  -  |
+