loafle/openapi-generator
3
0
Fork 0
forked from loafle/openapi-generator-original
Code Pull Requests Activity

[r] Updating api docs to include HTTP response codes and their corresponding headers (#3699)

Browse Source 
* fix(r): Adding response headers on docs

* fix(r): Adding response headers on docs
This commit is contained in:
Sai Giridhar P
2019-08-21 07:51:56 +05:30
committed by William Cheng
parent 50253f2b15
commit 10a310ef69
4 changed files with 103 additions and 21 deletions
Download Patch File Download Diff File Expand all files Collapse all files

9
modules/openapi-generator/src/main/resources/r/api_doc.mustache vendored
View File

@@ -95,7 +95,14 @@ Name | Type | Description | Notes
- **Content-Type**: {{#consumes}}{{{mediaType}}}{{#hasMore}}, {{/hasMore}}{{/consumes}}{{^consumes}}Not defined{{/consumes}}
- **Accept**: {{#produces}}{{{mediaType}}}{{#hasMore}}, {{/hasMore}}{{/produces}}{{^produces}}Not defined{{/produces}}
{{#responses.0}}
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
{{#responses}}
| **{{code}}** | {{message}} | {{#headers}} * {{baseName}} - {{description}} <br> {{/headers}}{{^headers.0}} - {{/headers.0}} |
{{/responses}}
{{/responses.0}}
{{/operation}}
{{/operations}}

46
samples/client/petstore/R/docs/PetApi.md
View File

@@ -51,7 +51,10 @@ void (empty response body)
- **Content-Type**: application/json, application/xml
- **Accept**: Not defined
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
| **405** | Invalid input | - |
# **DeletePet**
> DeletePet(pet.id, api.key=var.api.key)
@@ -92,7 +95,10 @@ void (empty response body)
- **Content-Type**: Not defined
- **Accept**: Not defined
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
| **400** | Invalid pet value | - |
# **FindPetsByStatus**
> array[Pet] FindPetsByStatus(status)
@@ -134,7 +140,11 @@ 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 | - |
# **FindPetsByTags**
> array[Pet] FindPetsByTags(tags)
@@ -176,7 +186,11 @@ 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 | - |
# **GetPetById**
> Pet GetPetById(pet.id)
@@ -218,7 +232,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 ID supplied | - |
| **404** | Pet not found | - |
# **UpdatePet**
> UpdatePet(body)
@@ -257,7 +276,12 @@ void (empty response body)
- **Content-Type**: application/json, application/xml
- **Accept**: Not defined
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
| **400** | Invalid ID supplied | - |
| **404** | Pet not found | - |
| **405** | Validation exception | - |
# **UpdatePetWithForm**
> UpdatePetWithForm(pet.id, name=var.name, status=var.status)
@@ -300,7 +324,10 @@ void (empty response body)
- **Content-Type**: application/x-www-form-urlencoded
- **Accept**: Not defined
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
| **405** | Invalid input | - |
# **UploadFile**
> ModelApiResponse UploadFile(pet.id, additional.metadata=var.additional.metadata, file=var.file)
@@ -344,5 +371,8 @@ Name | Type | Description | Notes
- **Content-Type**: multipart/form-data
- **Accept**: application/json
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
| **200** | successful operation | - |

24
samples/client/petstore/R/docs/StoreApi.md
View File

@@ -47,7 +47,11 @@ 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 | - |
# **GetInventory**
> map(integer) GetInventory()
@@ -85,7 +89,10 @@ 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 | - |
# **GetOrderById**
> Order GetOrderById(order.id)
@@ -125,7 +132,12 @@ 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 | - |
# **PlaceOrder**
> Order PlaceOrder(body)
@@ -163,5 +175,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 | - |

45
samples/client/petstore/R/docs/UserApi.md
View File

@@ -51,7 +51,10 @@ No authorization required
- **Content-Type**: Not defined
- **Accept**: Not defined
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
| **0** | successful operation | - |
# **CreateUsersWithArrayInput**
> CreateUsersWithArrayInput(body)
@@ -88,7 +91,10 @@ No authorization required
- **Content-Type**: Not defined
- **Accept**: Not defined
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
| **0** | successful operation | - |
# **CreateUsersWithListInput**
> CreateUsersWithListInput(body)
@@ -125,7 +131,10 @@ No authorization required
- **Content-Type**: Not defined
- **Accept**: Not defined
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
| **0** | successful operation | - |
# **DeleteUser**
> DeleteUser(username)
@@ -164,7 +173,11 @@ 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 | - |
# **GetUserByName**
> User GetUserByName(username)
@@ -202,7 +215,12 @@ 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 | - |
# **LoginUser**
> character LoginUser(username, password)
@@ -242,7 +260,11 @@ 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 toekn expires <br> |
| **400** | Invalid username/password supplied | - |
# **LogoutUser**
> LogoutUser()
@@ -275,7 +297,10 @@ No authorization required
- **Content-Type**: Not defined
- **Accept**: Not defined
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
| **0** | successful operation | - |
# **UpdateUser**
> UpdateUser(username, body)
@@ -316,5 +341,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 | - |