From a4b1c269d868fd188112b0d9181f4dd0d26f13a1 Mon Sep 17 00:00:00 2001 From: Ramanth Addala Date: Wed, 24 Jul 2019 20:45:21 +0530 Subject: [PATCH] fix(r): updated example in doc(.md) file (#3429) * fix(r): updated doc(.md) files * fix(r): changed enum representation --- .../src/main/resources/r/api_doc.mustache | 29 ++++++++++++++++--- samples/client/petstore/R/docs/PetApi.md | 4 +-- samples/client/petstore/R/docs/UserApi.md | 4 +-- 3 files changed, 29 insertions(+), 8 deletions(-) diff --git a/modules/openapi-generator/src/main/resources/r/api_doc.mustache b/modules/openapi-generator/src/main/resources/r/api_doc.mustache index 9473cf7c13b..8a3af45edd4 100644 --- a/modules/openapi-generator/src/main/resources/r/api_doc.mustache +++ b/modules/openapi-generator/src/main/resources/r/api_doc.mustache @@ -46,20 +46,41 @@ api.instance$apiClient$accessToken <- 'TODO_YOUR_ACCESS_TOKEN'; {{/isOAuth}} {{/authMethods}} {{/hasAuthMethods}} +{{#returnExceptionOnFailure}} +{{#useRlangExceptionHandling}} +result <- tryCatch( + api.instance${{{operationId}}}({{#requiredParams}}var.{{{paramName}}}{{^-last}}, {{/-last}}{{/requiredParams}}{{#optionalParams}}{{#-first}}{{#requiredParams.0}}, {{/requiredParams.0}}{{/-first}}{{{paramName}}}=var.{{{paramName}}}{{^-last}}, {{/-last}}{{/optionalParams}}), + ApiException = function(ex) ex + ) +# In case of error, print the error object +if(!is.null(result$ApiException)) { + cat(result$ApiException$toString()) + } else { +{{#returnType}} +# deserialized response object +response.object <- result$content +{{/returnType}} +# response headers +response.headers <- result$response$headers +# response status code +response.status.code <- result$response$status_code +} +{{/useRlangExceptionHandling}} +{{/returnExceptionOnFailure}} +{{^useRlangExceptionHandling}} {{#returnType}}result <- {{/returnType}}api.instance${{{operationId}}}({{#requiredParams}}var.{{{paramName}}}{{^-last}}, {{/-last}}{{/requiredParams}}{{#optionalParams}}{{#-first}}{{#requiredParams.0}}, {{/requiredParams.0}}{{/-first}}{{{paramName}}}=var.{{{paramName}}}{{^-last}}, {{/-last}}{{/optionalParams}}) {{#returnType}} dput(result) {{/returnType}} +{{/useRlangExceptionHandling}} ``` ### Parameters {{^allParams}}This endpoint does not need any parameter.{{/allParams}}{{#allParams}}{{#-last}} Name | Type | Description | Notes ------------- | ------------- | ------------- | -------------{{/-last}}{{/allParams}} -{{#requiredParams}} **{{paramName}}** | {{#isPrimitiveType}}**{{dataType}}**{{/isPrimitiveType}}{{^isPrimitiveType}}{{#isFile}}**{{dataType}}**{{/isFile}}{{^isFile}}[**{{dataType}}**]({{baseType}}.md){{/isFile}}{{/isPrimitiveType}}| {{description}} | {{^required}}[optional] {{/required}}{{#defaultValue}}[default to {{defaultValue}}]{{/defaultValue}} -{{/requiredParams}} -{{#optionalParams}} **{{paramName}}** | {{#isPrimitiveType}}**{{dataType}}**{{/isPrimitiveType}}{{^isPrimitiveType}}{{#isFile}}**{{dataType}}**{{/isFile}}{{^isFile}}[**{{dataType}}**]({{baseType}}.md){{/isFile}}{{/isPrimitiveType}}| {{description}} | {{^required}}[optional] {{/required}}{{#defaultValue}}[default to {{defaultValue}}]{{/defaultValue}} -{{/optionalParams}} +{{#allParams}} **{{paramName}}** | {{#isEnum}}Enum {{#allowableValues}}{{values}}{{/allowableValues}} {{/isEnum}}{{^isEnum}}{{#isContainer}}{{#isListContainer}}{{#items}}{{#isPrimitiveType}}list( **{{dataType}}** ){{/isPrimitiveType}}{{^isPrimitiveType}}{{#isFile}}**{{dataType}}**{{/isFile}}{{^isFile}}list( [**{{dataType}}**]({{baseType}}.md) ){{/isFile}}{{/isPrimitiveType}}{{/items}}{{/isListContainer}}{{#isMapContainer}}{{#isPrimitiveType}}named list( **{{dataType}}** ){{/isPrimitiveType}}{{^isPrimitiveType}}{{#isFile}}**{{dataType}}**{{/isFile}}{{^isFile}}named list( [**{{dataType}}**]({{baseType}}.md) ){{/isFile}}{{/isPrimitiveType}}{{/isMapContainer}}{{/isContainer}}{{^isContainer}}{{#isPrimitiveType}}**{{dataType}}**{{/isPrimitiveType}}{{^isPrimitiveType}}{{#isFile}}**{{dataType}}**{{/isFile}}{{^isFile}}[**{{dataType}}**]({{baseType}}.md){{/isFile}}{{/isPrimitiveType}}{{/isContainer}}{{/isEnum}}| {{description}} | {{^required}}[optional] {{/required}}{{#defaultValue}}[default to {{defaultValue}}]{{/defaultValue}} +{{/allParams}} ### Return type diff --git a/samples/client/petstore/R/docs/PetApi.md b/samples/client/petstore/R/docs/PetApi.md index fe69ffb556f..1e782619f41 100644 --- a/samples/client/petstore/R/docs/PetApi.md +++ b/samples/client/petstore/R/docs/PetApi.md @@ -119,7 +119,7 @@ dput(result) Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **status** | [**array[character]**](character.md)| Status values that need to be considered for filter | + **status** | Enum [available, pending, sold] | Status values that need to be considered for filter | ### Return type @@ -161,7 +161,7 @@ dput(result) Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **tags** | [**array[character]**](character.md)| Tags to filter by | + **tags** | list( **character** )| Tags to filter by | ### Return type diff --git a/samples/client/petstore/R/docs/UserApi.md b/samples/client/petstore/R/docs/UserApi.md index c69c5987ed0..a0fe81e5fec 100644 --- a/samples/client/petstore/R/docs/UserApi.md +++ b/samples/client/petstore/R/docs/UserApi.md @@ -73,7 +73,7 @@ api.instance$CreateUsersWithArrayInput(var.body) Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **body** | [**array[User]**](User.md)| List of user object | + **body** | list( [**User**](User.md) )| List of user object | ### Return type @@ -110,7 +110,7 @@ api.instance$CreateUsersWithListInput(var.body) Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **body** | [**array[User]**](User.md)| List of user object | + **body** | list( [**User**](User.md) )| List of user object | ### Return type