forked from loafle/openapi-generator-original
		
	fix(r): updated example in doc(.md) file (#3429)
* fix(r): updated doc(.md) files * fix(r): changed enum representation
This commit is contained in:
		
							parent
							
								
									2c4fdd0792
								
							
						
					
					
						commit
						a4b1c269d8
					
				@ -46,20 +46,41 @@ api.instance$apiClient$accessToken <- 'TODO_YOUR_ACCESS_TOKEN';
 | 
				
			|||||||
{{/isOAuth}}
 | 
					{{/isOAuth}}
 | 
				
			||||||
{{/authMethods}}
 | 
					{{/authMethods}}
 | 
				
			||||||
{{/hasAuthMethods}}
 | 
					{{/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}}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}}
 | 
					{{#returnType}}
 | 
				
			||||||
dput(result)
 | 
					dput(result)
 | 
				
			||||||
{{/returnType}}
 | 
					{{/returnType}}
 | 
				
			||||||
 | 
					{{/useRlangExceptionHandling}}
 | 
				
			||||||
```
 | 
					```
 | 
				
			||||||
 | 
					
 | 
				
			||||||
### Parameters
 | 
					### Parameters
 | 
				
			||||||
{{^allParams}}This endpoint does not need any parameter.{{/allParams}}{{#allParams}}{{#-last}}
 | 
					{{^allParams}}This endpoint does not need any parameter.{{/allParams}}{{#allParams}}{{#-last}}
 | 
				
			||||||
Name | Type | Description  | Notes
 | 
					Name | Type | Description  | Notes
 | 
				
			||||||
------------- | ------------- | ------------- | -------------{{/-last}}{{/allParams}}
 | 
					------------- | ------------- | ------------- | -------------{{/-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}}
 | 
					{{#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}}
 | 
				
			||||||
{{/requiredParams}}
 | 
					{{/allParams}}
 | 
				
			||||||
{{#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}}
 | 
					 | 
				
			||||||
 | 
					
 | 
				
			||||||
### Return type
 | 
					### Return type
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
				
			|||||||
@ -119,7 +119,7 @@ dput(result)
 | 
				
			|||||||
 | 
					
 | 
				
			||||||
Name | Type | Description  | Notes
 | 
					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
 | 
					### Return type
 | 
				
			||||||
 | 
					
 | 
				
			||||||
@ -161,7 +161,7 @@ dput(result)
 | 
				
			|||||||
 | 
					
 | 
				
			||||||
Name | Type | Description  | Notes
 | 
					Name | Type | Description  | Notes
 | 
				
			||||||
------------- | ------------- | ------------- | -------------
 | 
					------------- | ------------- | ------------- | -------------
 | 
				
			||||||
 **tags** | [**array[character]**](character.md)| Tags to filter by | 
 | 
					 **tags** | list( **character** )| Tags to filter by | 
 | 
				
			||||||
 | 
					
 | 
				
			||||||
### Return type
 | 
					### Return type
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
				
			|||||||
@ -73,7 +73,7 @@ api.instance$CreateUsersWithArrayInput(var.body)
 | 
				
			|||||||
 | 
					
 | 
				
			||||||
Name | Type | Description  | Notes
 | 
					Name | Type | Description  | Notes
 | 
				
			||||||
------------- | ------------- | ------------- | -------------
 | 
					------------- | ------------- | ------------- | -------------
 | 
				
			||||||
 **body** | [**array[User]**](User.md)| List of user object | 
 | 
					 **body** | list( [**User**](User.md) )| List of user object | 
 | 
				
			||||||
 | 
					
 | 
				
			||||||
### Return type
 | 
					### Return type
 | 
				
			||||||
 | 
					
 | 
				
			||||||
@ -110,7 +110,7 @@ api.instance$CreateUsersWithListInput(var.body)
 | 
				
			|||||||
 | 
					
 | 
				
			||||||
Name | Type | Description  | Notes
 | 
					Name | Type | Description  | Notes
 | 
				
			||||||
------------- | ------------- | ------------- | -------------
 | 
					------------- | ------------- | ------------- | -------------
 | 
				
			||||||
 **body** | [**array[User]**](User.md)| List of user object | 
 | 
					 **body** | list( [**User**](User.md) )| List of user object | 
 | 
				
			||||||
 | 
					
 | 
				
			||||||
### Return type
 | 
					### Return type
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
				
			|||||||
		Loading…
	
	
			
			x
			
			
		
	
		Reference in New Issue
	
	Block a user