R echo client tests (#17629)

* add r echo api client sample

* add r workflow

* fix

* add env

* set r version

* install curl

* install dep

* fix

* comment out installation
This commit is contained in:
William Cheng
2024-01-18 09:05:35 +08:00
committed by GitHub
parent eab34c9b3f
commit d810d7c534
69 changed files with 8498 additions and 0 deletions

View File

@@ -0,0 +1,99 @@
# AuthApi
All URIs are relative to *http://localhost:3000*
Method | HTTP request | Description
------------- | ------------- | -------------
[**TestAuthHttpBasic**](AuthApi.md#TestAuthHttpBasic) | **POST** /auth/http/basic | To test HTTP basic authentication
[**TestAuthHttpBearer**](AuthApi.md#TestAuthHttpBearer) | **POST** /auth/http/bearer | To test HTTP bearer authentication
# **TestAuthHttpBasic**
> character TestAuthHttpBasic()
To test HTTP basic authentication
To test HTTP basic authentication
### Example
```R
library(openapi)
# To test HTTP basic authentication
#
api_instance <- AuthApi$new()
# Configure HTTP basic authorization: http_auth
api_instance$api_client$username <- Sys.getenv("USERNAME")
api_instance$api_client$password <- Sys.getenv("PASSWORD")
# to save the result into a file, simply add the optional `data_file` parameter, e.g.
# result <- api_instance$TestAuthHttpBasic(data_file = "result.txt")
result <- api_instance$TestAuthHttpBasic()
dput(result)
```
### Parameters
This endpoint does not need any parameter.
### Return type
**character**
### Authorization
[http_auth](../README.md#http_auth)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: text/plain
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
| **200** | Successful operation | - |
# **TestAuthHttpBearer**
> character TestAuthHttpBearer()
To test HTTP bearer authentication
To test HTTP bearer authentication
### Example
```R
library(openapi)
# To test HTTP bearer authentication
#
api_instance <- AuthApi$new()
# Configure HTTP bearer authorization: http_bearer_auth
api_instance$api_client$bearer_token <- Sys.getenv("BEARER_TOKEN")
# to save the result into a file, simply add the optional `data_file` parameter, e.g.
# result <- api_instance$TestAuthHttpBearer(data_file = "result.txt")
result <- api_instance$TestAuthHttpBearer()
dput(result)
```
### Parameters
This endpoint does not need any parameter.
### Return type
**character**
### Authorization
[http_bearer_auth](../README.md#http_bearer_auth)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: text/plain
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
| **200** | Successful operation | - |

View File

@@ -0,0 +1,10 @@
# openapi::Bird
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**size** | **character** | | [optional]
**color** | **character** | | [optional]

View File

@@ -0,0 +1,435 @@
# BodyApi
All URIs are relative to *http://localhost:3000*
Method | HTTP request | Description
------------- | ------------- | -------------
[**TestBinaryGif**](BodyApi.md#TestBinaryGif) | **POST** /binary/gif | Test binary (gif) response body
[**TestBodyApplicationOctetstreamBinary**](BodyApi.md#TestBodyApplicationOctetstreamBinary) | **POST** /body/application/octetstream/binary | Test body parameter(s)
[**TestBodyMultipartFormdataArrayOfBinary**](BodyApi.md#TestBodyMultipartFormdataArrayOfBinary) | **POST** /body/application/octetstream/array_of_binary | Test array of binary in multipart mime
[**TestBodyMultipartFormdataSingleBinary**](BodyApi.md#TestBodyMultipartFormdataSingleBinary) | **POST** /body/application/octetstream/single_binary | Test single binary in multipart mime
[**TestEchoBodyAllOfPet**](BodyApi.md#TestEchoBodyAllOfPet) | **POST** /echo/body/allOf/Pet | Test body parameter(s)
[**TestEchoBodyFreeFormObjectResponseString**](BodyApi.md#TestEchoBodyFreeFormObjectResponseString) | **POST** /echo/body/FreeFormObject/response_string | Test free form object
[**TestEchoBodyPet**](BodyApi.md#TestEchoBodyPet) | **POST** /echo/body/Pet | Test body parameter(s)
[**TestEchoBodyPetResponseString**](BodyApi.md#TestEchoBodyPetResponseString) | **POST** /echo/body/Pet/response_string | Test empty response body
[**TestEchoBodyTagResponseString**](BodyApi.md#TestEchoBodyTagResponseString) | **POST** /echo/body/Tag/response_string | Test empty json (request body)
# **TestBinaryGif**
> data.frame TestBinaryGif()
Test binary (gif) response body
Test binary (gif) response body
### Example
```R
library(openapi)
# Test binary (gif) response body
#
api_instance <- BodyApi$new()
# to save the result into a file, simply add the optional `data_file` parameter, e.g.
# result <- api_instance$TestBinaryGif(data_file = "result.txt")
result <- api_instance$TestBinaryGif()
dput(result)
```
### Parameters
This endpoint does not need any parameter.
### Return type
**data.frame**
### Authorization
No authorization required
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: image/gif
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
| **200** | Successful operation | - |
# **TestBodyApplicationOctetstreamBinary**
> character TestBodyApplicationOctetstreamBinary(body = var.body)
Test body parameter(s)
Test body parameter(s)
### Example
```R
library(openapi)
# Test body parameter(s)
#
# prepare function argument(s)
var_body <- File.new('/path/to/file') # data.frame | (Optional)
api_instance <- BodyApi$new()
# to save the result into a file, simply add the optional `data_file` parameter, e.g.
# result <- api_instance$TestBodyApplicationOctetstreamBinary(body = var_bodydata_file = "result.txt")
result <- api_instance$TestBodyApplicationOctetstreamBinary(body = var_body)
dput(result)
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**body** | **data.frame**| | [optional]
### Return type
**character**
### Authorization
No authorization required
### HTTP request headers
- **Content-Type**: application/octet-stream
- **Accept**: text/plain
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
| **200** | Successful operation | - |
# **TestBodyMultipartFormdataArrayOfBinary**
> character TestBodyMultipartFormdataArrayOfBinary(files)
Test array of binary in multipart mime
Test array of binary in multipart mime
### Example
```R
library(openapi)
# Test array of binary in multipart mime
#
# prepare function argument(s)
var_files <- c(123) # array[data.frame] |
api_instance <- BodyApi$new()
# to save the result into a file, simply add the optional `data_file` parameter, e.g.
# result <- api_instance$TestBodyMultipartFormdataArrayOfBinary(var_filesdata_file = "result.txt")
result <- api_instance$TestBodyMultipartFormdataArrayOfBinary(var_files)
dput(result)
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**files** | list( **data.frame** )| |
### Return type
**character**
### Authorization
No authorization required
### HTTP request headers
- **Content-Type**: multipart/form-data
- **Accept**: text/plain
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
| **200** | Successful operation | - |
# **TestBodyMultipartFormdataSingleBinary**
> character TestBodyMultipartFormdataSingleBinary(my_file = var.my_file)
Test single binary in multipart mime
Test single binary in multipart mime
### Example
```R
library(openapi)
# Test single binary in multipart mime
#
# prepare function argument(s)
var_my_file <- File.new('/path/to/file') # data.frame | (Optional)
api_instance <- BodyApi$new()
# to save the result into a file, simply add the optional `data_file` parameter, e.g.
# result <- api_instance$TestBodyMultipartFormdataSingleBinary(my_file = var_my_filedata_file = "result.txt")
result <- api_instance$TestBodyMultipartFormdataSingleBinary(my_file = var_my_file)
dput(result)
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**my_file** | **data.frame**| | [optional]
### Return type
**character**
### Authorization
No authorization required
### HTTP request headers
- **Content-Type**: multipart/form-data
- **Accept**: text/plain
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
| **200** | Successful operation | - |
# **TestEchoBodyAllOfPet**
> Pet TestEchoBodyAllOfPet(pet = var.pet)
Test body parameter(s)
Test body parameter(s)
### Example
```R
library(openapi)
# Test body parameter(s)
#
# prepare function argument(s)
var_pet <- Pet$new("name_example", c("photoUrls_example"), 123, Category$new(123, "name_example"), c(Tag$new(123, "name_example")), "available") # Pet | Pet object that needs to be added to the store (Optional)
api_instance <- BodyApi$new()
# to save the result into a file, simply add the optional `data_file` parameter, e.g.
# result <- api_instance$TestEchoBodyAllOfPet(pet = var_petdata_file = "result.txt")
result <- api_instance$TestEchoBodyAllOfPet(pet = var_pet)
dput(result)
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**pet** | [**Pet**](Pet.md)| Pet object that needs to be added to the store | [optional]
### Return type
[**Pet**](Pet.md)
### Authorization
No authorization required
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: application/json
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
| **200** | Successful operation | - |
# **TestEchoBodyFreeFormObjectResponseString**
> character TestEchoBodyFreeFormObjectResponseString(body = var.body)
Test free form object
Test free form object
### Example
```R
library(openapi)
# Test free form object
#
# prepare function argument(s)
var_body <- c(key = TODO) # object | Free form object (Optional)
api_instance <- BodyApi$new()
# to save the result into a file, simply add the optional `data_file` parameter, e.g.
# result <- api_instance$TestEchoBodyFreeFormObjectResponseString(body = var_bodydata_file = "result.txt")
result <- api_instance$TestEchoBodyFreeFormObjectResponseString(body = var_body)
dput(result)
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**body** | **object**| Free form object | [optional]
### Return type
**character**
### Authorization
No authorization required
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: text/plain
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
| **200** | Successful operation | - |
# **TestEchoBodyPet**
> Pet TestEchoBodyPet(pet = var.pet)
Test body parameter(s)
Test body parameter(s)
### Example
```R
library(openapi)
# Test body parameter(s)
#
# prepare function argument(s)
var_pet <- Pet$new("name_example", c("photoUrls_example"), 123, Category$new(123, "name_example"), c(Tag$new(123, "name_example")), "available") # Pet | Pet object that needs to be added to the store (Optional)
api_instance <- BodyApi$new()
# to save the result into a file, simply add the optional `data_file` parameter, e.g.
# result <- api_instance$TestEchoBodyPet(pet = var_petdata_file = "result.txt")
result <- api_instance$TestEchoBodyPet(pet = var_pet)
dput(result)
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**pet** | [**Pet**](Pet.md)| Pet object that needs to be added to the store | [optional]
### Return type
[**Pet**](Pet.md)
### Authorization
No authorization required
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: application/json
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
| **200** | Successful operation | - |
# **TestEchoBodyPetResponseString**
> character TestEchoBodyPetResponseString(pet = var.pet)
Test empty response body
Test empty response body
### Example
```R
library(openapi)
# Test empty response body
#
# prepare function argument(s)
var_pet <- Pet$new("name_example", c("photoUrls_example"), 123, Category$new(123, "name_example"), c(Tag$new(123, "name_example")), "available") # Pet | Pet object that needs to be added to the store (Optional)
api_instance <- BodyApi$new()
# to save the result into a file, simply add the optional `data_file` parameter, e.g.
# result <- api_instance$TestEchoBodyPetResponseString(pet = var_petdata_file = "result.txt")
result <- api_instance$TestEchoBodyPetResponseString(pet = var_pet)
dput(result)
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**pet** | [**Pet**](Pet.md)| Pet object that needs to be added to the store | [optional]
### Return type
**character**
### Authorization
No authorization required
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: text/plain
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
| **200** | Successful operation | - |
# **TestEchoBodyTagResponseString**
> character TestEchoBodyTagResponseString(tag = var.tag)
Test empty json (request body)
Test empty json (request body)
### Example
```R
library(openapi)
# Test empty json (request body)
#
# prepare function argument(s)
var_tag <- Tag$new(123, "name_example") # Tag | Tag object (Optional)
api_instance <- BodyApi$new()
# to save the result into a file, simply add the optional `data_file` parameter, e.g.
# result <- api_instance$TestEchoBodyTagResponseString(tag = var_tagdata_file = "result.txt")
result <- api_instance$TestEchoBodyTagResponseString(tag = var_tag)
dput(result)
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**tag** | [**Tag**](Tag.md)| Tag object | [optional]
### Return type
**character**
### Authorization
No authorization required
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: text/plain
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
| **200** | Successful operation | - |

View File

@@ -0,0 +1,10 @@
# openapi::Category
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**id** | **integer** | | [optional]
**name** | **character** | | [optional]

View File

@@ -0,0 +1,13 @@
# openapi::DataQuery
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**id** | **integer** | Query | [optional]
**outcomes** | **array[character]** | | [optional] [default to [SUCCESS, FAILURE]] [Enum: ]
**suffix** | **character** | test suffix | [optional]
**text** | **character** | Some text containing white spaces | [optional]
**date** | **character** | A date | [optional]

View File

@@ -0,0 +1,17 @@
# openapi::DefaultValue
to test the default value of properties
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**array_string_enum_ref_default** | [**array[StringEnumRef]**](StringEnumRef.md) | | [optional] [default to [&quot;success&quot;,&quot;failure&quot;]]
**array_string_enum_default** | **array[character]** | | [optional] [default to [&quot;success&quot;,&quot;failure&quot;]] [Enum: ]
**array_string_default** | **array[character]** | | [optional] [default to [&quot;failure&quot;,&quot;skipped&quot;]]
**array_integer_default** | **array[integer]** | | [optional] [default to [1,3]]
**array_string** | **array[character]** | | [optional]
**array_string_nullable** | **array[character]** | | [optional]
**array_string_extension_nullable** | **array[character]** | | [optional]
**string_nullable** | **character** | | [optional]

View File

@@ -0,0 +1,118 @@
# FormApi
All URIs are relative to *http://localhost:3000*
Method | HTTP request | Description
------------- | ------------- | -------------
[**TestFormIntegerBooleanString**](FormApi.md#TestFormIntegerBooleanString) | **POST** /form/integer/boolean/string | Test form parameter(s)
[**TestFormOneof**](FormApi.md#TestFormOneof) | **POST** /form/oneof | Test form parameter(s) for oneOf schema
# **TestFormIntegerBooleanString**
> character TestFormIntegerBooleanString(integer_form = var.integer_form, boolean_form = var.boolean_form, string_form = var.string_form)
Test form parameter(s)
Test form parameter(s)
### Example
```R
library(openapi)
# Test form parameter(s)
#
# prepare function argument(s)
var_integer_form <- 56 # integer | (Optional)
var_boolean_form <- "boolean_form_example" # character | (Optional)
var_string_form <- "string_form_example" # character | (Optional)
api_instance <- FormApi$new()
# to save the result into a file, simply add the optional `data_file` parameter, e.g.
# result <- api_instance$TestFormIntegerBooleanString(integer_form = var_integer_form, boolean_form = var_boolean_form, string_form = var_string_formdata_file = "result.txt")
result <- api_instance$TestFormIntegerBooleanString(integer_form = var_integer_form, boolean_form = var_boolean_form, string_form = var_string_form)
dput(result)
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**integer_form** | **integer**| | [optional]
**boolean_form** | **character**| | [optional]
**string_form** | **character**| | [optional]
### Return type
**character**
### Authorization
No authorization required
### HTTP request headers
- **Content-Type**: application/x-www-form-urlencoded
- **Accept**: text/plain
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
| **200** | Successful operation | - |
# **TestFormOneof**
> character TestFormOneof(form1 = var.form1, form2 = var.form2, form3 = var.form3, form4 = var.form4, id = var.id, name = var.name)
Test form parameter(s) for oneOf schema
Test form parameter(s) for oneOf schema
### Example
```R
library(openapi)
# Test form parameter(s) for oneOf schema
#
# prepare function argument(s)
var_form1 <- "form1_example" # character | (Optional)
var_form2 <- 56 # integer | (Optional)
var_form3 <- "form3_example" # character | (Optional)
var_form4 <- "form4_example" # character | (Optional)
var_id <- 56 # integer | (Optional)
var_name <- "name_example" # character | (Optional)
api_instance <- FormApi$new()
# to save the result into a file, simply add the optional `data_file` parameter, e.g.
# result <- api_instance$TestFormOneof(form1 = var_form1, form2 = var_form2, form3 = var_form3, form4 = var_form4, id = var_id, name = var_namedata_file = "result.txt")
result <- api_instance$TestFormOneof(form1 = var_form1, form2 = var_form2, form3 = var_form3, form4 = var_form4, id = var_id, name = var_name)
dput(result)
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**form1** | **character**| | [optional]
**form2** | **integer**| | [optional]
**form3** | **character**| | [optional]
**form4** | **character**| | [optional]
**id** | **integer**| | [optional]
**name** | **character**| | [optional]
### Return type
**character**
### Authorization
No authorization required
### HTTP request headers
- **Content-Type**: application/x-www-form-urlencoded
- **Accept**: text/plain
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
| **200** | Successful operation | - |

View File

@@ -0,0 +1,64 @@
# HeaderApi
All URIs are relative to *http://localhost:3000*
Method | HTTP request | Description
------------- | ------------- | -------------
[**TestHeaderIntegerBooleanStringEnums**](HeaderApi.md#TestHeaderIntegerBooleanStringEnums) | **GET** /header/integer/boolean/string/enums | Test header parameter(s)
# **TestHeaderIntegerBooleanStringEnums**
> character TestHeaderIntegerBooleanStringEnums(integer_header = var.integer_header, boolean_header = var.boolean_header, string_header = var.string_header, enum_nonref_string_header = var.enum_nonref_string_header, enum_ref_string_header = var.enum_ref_string_header)
Test header parameter(s)
Test header parameter(s)
### Example
```R
library(openapi)
# Test header parameter(s)
#
# prepare function argument(s)
var_integer_header <- 56 # integer | (Optional)
var_boolean_header <- "boolean_header_example" # character | (Optional)
var_string_header <- "string_header_example" # character | (Optional)
var_enum_nonref_string_header <- "enum_nonref_string_header_example" # character | (Optional)
var_enum_ref_string_header <- StringEnumRef$new() # StringEnumRef | (Optional)
api_instance <- HeaderApi$new()
# to save the result into a file, simply add the optional `data_file` parameter, e.g.
# result <- api_instance$TestHeaderIntegerBooleanStringEnums(integer_header = var_integer_header, boolean_header = var_boolean_header, string_header = var_string_header, enum_nonref_string_header = var_enum_nonref_string_header, enum_ref_string_header = var_enum_ref_string_headerdata_file = "result.txt")
result <- api_instance$TestHeaderIntegerBooleanStringEnums(integer_header = var_integer_header, boolean_header = var_boolean_header, string_header = var_string_header, enum_nonref_string_header = var_enum_nonref_string_header, enum_ref_string_header = var_enum_ref_string_header)
dput(result)
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**integer_header** | **integer**| | [optional]
**boolean_header** | **character**| | [optional]
**string_header** | **character**| | [optional]
**enum_nonref_string_header** | Enum [success, failure, unclassified] | | [optional]
**enum_ref_string_header** | [**StringEnumRef**](.md)| | [optional]
### Return type
**character**
### Authorization
No authorization required
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: text/plain
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
| **200** | Successful operation | - |

View File

@@ -0,0 +1,11 @@
# openapi::NumberPropertiesOnly
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**number** | **numeric** | | [optional]
**float** | **numeric** | | [optional]
**double** | **numeric** | | [optional] [Max: 50.2] [Min: 0.8]

View File

@@ -0,0 +1,62 @@
# PathApi
All URIs are relative to *http://localhost:3000*
Method | HTTP request | Description
------------- | ------------- | -------------
[**TestsPathStringPathStringIntegerPathIntegerEnumNonrefStringPathEnumRefStringPath**](PathApi.md#TestsPathStringPathStringIntegerPathIntegerEnumNonrefStringPathEnumRefStringPath) | **GET** /path/string/{path_string}/integer/{path_integer}/{enum_nonref_string_path}/{enum_ref_string_path} | Test path parameter(s)
# **TestsPathStringPathStringIntegerPathIntegerEnumNonrefStringPathEnumRefStringPath**
> character TestsPathStringPathStringIntegerPathIntegerEnumNonrefStringPathEnumRefStringPath(path_string, path_integer, enum_nonref_string_path, enum_ref_string_path)
Test path parameter(s)
Test path parameter(s)
### Example
```R
library(openapi)
# Test path parameter(s)
#
# prepare function argument(s)
var_path_string <- "path_string_example" # character |
var_path_integer <- 56 # integer |
var_enum_nonref_string_path <- "enum_nonref_string_path_example" # character |
var_enum_ref_string_path <- StringEnumRef$new() # StringEnumRef |
api_instance <- PathApi$new()
# to save the result into a file, simply add the optional `data_file` parameter, e.g.
# result <- api_instance$TestsPathStringPathStringIntegerPathIntegerEnumNonrefStringPathEnumRefStringPath(var_path_string, var_path_integer, var_enum_nonref_string_path, var_enum_ref_string_pathdata_file = "result.txt")
result <- api_instance$TestsPathStringPathStringIntegerPathIntegerEnumNonrefStringPathEnumRefStringPath(var_path_string, var_path_integer, var_enum_nonref_string_path, var_enum_ref_string_path)
dput(result)
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**path_string** | **character**| |
**path_integer** | **integer**| |
**enum_nonref_string_path** | Enum [success, failure, unclassified] | |
**enum_ref_string_path** | [**StringEnumRef**](.md)| |
### Return type
**character**
### Authorization
No authorization required
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: text/plain
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
| **200** | Successful operation | - |

View File

@@ -0,0 +1,14 @@
# openapi::Pet
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**id** | **integer** | | [optional]
**name** | **character** | |
**category** | [**Category**](Category.md) | | [optional]
**photoUrls** | **array[character]** | |
**tags** | [**array[Tag]**](Tag.md) | | [optional]
**status** | **character** | pet status in the store | [optional] [Enum: [available, pending, sold]]

View File

@@ -0,0 +1,10 @@
# openapi::Query
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**id** | **integer** | Query | [optional]
**outcomes** | **array[character]** | | [optional] [default to [&quot;SUCCESS&quot;,&quot;FAILURE&quot;]] [Enum: ]

View File

@@ -0,0 +1,402 @@
# QueryApi
All URIs are relative to *http://localhost:3000*
Method | HTTP request | Description
------------- | ------------- | -------------
[**TestEnumRefString**](QueryApi.md#TestEnumRefString) | **GET** /query/enum_ref_string | Test query parameter(s)
[**TestQueryDatetimeDateString**](QueryApi.md#TestQueryDatetimeDateString) | **GET** /query/datetime/date/string | Test query parameter(s)
[**TestQueryIntegerBooleanString**](QueryApi.md#TestQueryIntegerBooleanString) | **GET** /query/integer/boolean/string | Test query parameter(s)
[**TestQueryStyleDeepObjectExplodeTrueObject**](QueryApi.md#TestQueryStyleDeepObjectExplodeTrueObject) | **GET** /query/style_deepObject/explode_true/object | Test query parameter(s)
[**TestQueryStyleDeepObjectExplodeTrueObjectAllOf**](QueryApi.md#TestQueryStyleDeepObjectExplodeTrueObjectAllOf) | **GET** /query/style_deepObject/explode_true/object/allOf | Test query parameter(s)
[**TestQueryStyleFormExplodeTrueArrayString**](QueryApi.md#TestQueryStyleFormExplodeTrueArrayString) | **GET** /query/style_form/explode_true/array_string | Test query parameter(s)
[**TestQueryStyleFormExplodeTrueObject**](QueryApi.md#TestQueryStyleFormExplodeTrueObject) | **GET** /query/style_form/explode_true/object | Test query parameter(s)
[**TestQueryStyleFormExplodeTrueObjectAllOf**](QueryApi.md#TestQueryStyleFormExplodeTrueObjectAllOf) | **GET** /query/style_form/explode_true/object/allOf | Test query parameter(s)
# **TestEnumRefString**
> character TestEnumRefString(enum_nonref_string_query = var.enum_nonref_string_query, enum_ref_string_query = var.enum_ref_string_query)
Test query parameter(s)
Test query parameter(s)
### Example
```R
library(openapi)
# Test query parameter(s)
#
# prepare function argument(s)
var_enum_nonref_string_query <- "enum_nonref_string_query_example" # character | (Optional)
var_enum_ref_string_query <- StringEnumRef$new() # StringEnumRef | (Optional)
api_instance <- QueryApi$new()
# to save the result into a file, simply add the optional `data_file` parameter, e.g.
# result <- api_instance$TestEnumRefString(enum_nonref_string_query = var_enum_nonref_string_query, enum_ref_string_query = var_enum_ref_string_querydata_file = "result.txt")
result <- api_instance$TestEnumRefString(enum_nonref_string_query = var_enum_nonref_string_query, enum_ref_string_query = var_enum_ref_string_query)
dput(result)
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**enum_nonref_string_query** | Enum [success, failure, unclassified] | | [optional]
**enum_ref_string_query** | [**StringEnumRef**](.md)| | [optional]
### Return type
**character**
### Authorization
No authorization required
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: text/plain
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
| **200** | Successful operation | - |
# **TestQueryDatetimeDateString**
> character TestQueryDatetimeDateString(datetime_query = var.datetime_query, date_query = var.date_query, string_query = var.string_query)
Test query parameter(s)
Test query parameter(s)
### Example
```R
library(openapi)
# Test query parameter(s)
#
# prepare function argument(s)
var_datetime_query <- "datetime_query_example" # character | (Optional)
var_date_query <- "date_query_example" # character | (Optional)
var_string_query <- "string_query_example" # character | (Optional)
api_instance <- QueryApi$new()
# to save the result into a file, simply add the optional `data_file` parameter, e.g.
# result <- api_instance$TestQueryDatetimeDateString(datetime_query = var_datetime_query, date_query = var_date_query, string_query = var_string_querydata_file = "result.txt")
result <- api_instance$TestQueryDatetimeDateString(datetime_query = var_datetime_query, date_query = var_date_query, string_query = var_string_query)
dput(result)
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**datetime_query** | **character**| | [optional]
**date_query** | **character**| | [optional]
**string_query** | **character**| | [optional]
### Return type
**character**
### Authorization
No authorization required
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: text/plain
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
| **200** | Successful operation | - |
# **TestQueryIntegerBooleanString**
> character TestQueryIntegerBooleanString(integer_query = var.integer_query, boolean_query = var.boolean_query, string_query = var.string_query)
Test query parameter(s)
Test query parameter(s)
### Example
```R
library(openapi)
# Test query parameter(s)
#
# prepare function argument(s)
var_integer_query <- 56 # integer | (Optional)
var_boolean_query <- "boolean_query_example" # character | (Optional)
var_string_query <- "string_query_example" # character | (Optional)
api_instance <- QueryApi$new()
# to save the result into a file, simply add the optional `data_file` parameter, e.g.
# result <- api_instance$TestQueryIntegerBooleanString(integer_query = var_integer_query, boolean_query = var_boolean_query, string_query = var_string_querydata_file = "result.txt")
result <- api_instance$TestQueryIntegerBooleanString(integer_query = var_integer_query, boolean_query = var_boolean_query, string_query = var_string_query)
dput(result)
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**integer_query** | **integer**| | [optional]
**boolean_query** | **character**| | [optional]
**string_query** | **character**| | [optional]
### Return type
**character**
### Authorization
No authorization required
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: text/plain
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
| **200** | Successful operation | - |
# **TestQueryStyleDeepObjectExplodeTrueObject**
> character TestQueryStyleDeepObjectExplodeTrueObject(query_object = var.query_object)
Test query parameter(s)
Test query parameter(s)
### Example
```R
library(openapi)
# Test query parameter(s)
#
# prepare function argument(s)
var_query_object <- Pet$new("name_example", c("photoUrls_example"), 123, Category$new(123, "name_example"), c(Tag$new(123, "name_example")), "available") # Pet | (Optional)
api_instance <- QueryApi$new()
# to save the result into a file, simply add the optional `data_file` parameter, e.g.
# result <- api_instance$TestQueryStyleDeepObjectExplodeTrueObject(query_object = var_query_objectdata_file = "result.txt")
result <- api_instance$TestQueryStyleDeepObjectExplodeTrueObject(query_object = var_query_object)
dput(result)
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**query_object** | [**Pet**](.md)| | [optional]
### Return type
**character**
### Authorization
No authorization required
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: text/plain
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
| **200** | Successful operation | - |
# **TestQueryStyleDeepObjectExplodeTrueObjectAllOf**
> character TestQueryStyleDeepObjectExplodeTrueObjectAllOf(query_object = var.query_object)
Test query parameter(s)
Test query parameter(s)
### Example
```R
library(openapi)
# Test query parameter(s)
#
# prepare function argument(s)
var_query_object <- test_query_style_deepObject_explode_true_object_allOf_query_object_parameter$new("size_example", "color_example", 123, "name_example") # TestQueryStyleDeepObjectExplodeTrueObjectAllOfQueryObjectParameter | (Optional)
api_instance <- QueryApi$new()
# to save the result into a file, simply add the optional `data_file` parameter, e.g.
# result <- api_instance$TestQueryStyleDeepObjectExplodeTrueObjectAllOf(query_object = var_query_objectdata_file = "result.txt")
result <- api_instance$TestQueryStyleDeepObjectExplodeTrueObjectAllOf(query_object = var_query_object)
dput(result)
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**query_object** | [**TestQueryStyleDeepObjectExplodeTrueObjectAllOfQueryObjectParameter**](.md)| | [optional]
### Return type
**character**
### Authorization
No authorization required
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: text/plain
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
| **200** | Successful operation | - |
# **TestQueryStyleFormExplodeTrueArrayString**
> character TestQueryStyleFormExplodeTrueArrayString(query_object = var.query_object)
Test query parameter(s)
Test query parameter(s)
### Example
```R
library(openapi)
# Test query parameter(s)
#
# prepare function argument(s)
var_query_object <- test_query_style_form_explode_true_array_string_query_object_parameter$new(c("values_example")) # TestQueryStyleFormExplodeTrueArrayStringQueryObjectParameter | (Optional)
api_instance <- QueryApi$new()
# to save the result into a file, simply add the optional `data_file` parameter, e.g.
# result <- api_instance$TestQueryStyleFormExplodeTrueArrayString(query_object = var_query_objectdata_file = "result.txt")
result <- api_instance$TestQueryStyleFormExplodeTrueArrayString(query_object = var_query_object)
dput(result)
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**query_object** | [**TestQueryStyleFormExplodeTrueArrayStringQueryObjectParameter**](.md)| | [optional]
### Return type
**character**
### Authorization
No authorization required
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: text/plain
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
| **200** | Successful operation | - |
# **TestQueryStyleFormExplodeTrueObject**
> character TestQueryStyleFormExplodeTrueObject(query_object = var.query_object)
Test query parameter(s)
Test query parameter(s)
### Example
```R
library(openapi)
# Test query parameter(s)
#
# prepare function argument(s)
var_query_object <- Pet$new("name_example", c("photoUrls_example"), 123, Category$new(123, "name_example"), c(Tag$new(123, "name_example")), "available") # Pet | (Optional)
api_instance <- QueryApi$new()
# to save the result into a file, simply add the optional `data_file` parameter, e.g.
# result <- api_instance$TestQueryStyleFormExplodeTrueObject(query_object = var_query_objectdata_file = "result.txt")
result <- api_instance$TestQueryStyleFormExplodeTrueObject(query_object = var_query_object)
dput(result)
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**query_object** | [**Pet**](.md)| | [optional]
### Return type
**character**
### Authorization
No authorization required
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: text/plain
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
| **200** | Successful operation | - |
# **TestQueryStyleFormExplodeTrueObjectAllOf**
> character TestQueryStyleFormExplodeTrueObjectAllOf(query_object = var.query_object)
Test query parameter(s)
Test query parameter(s)
### Example
```R
library(openapi)
# Test query parameter(s)
#
# prepare function argument(s)
var_query_object <- DataQuery$new(123, c("SUCCESS"), "suffix_example", "text_example", "date_example") # DataQuery | (Optional)
api_instance <- QueryApi$new()
# to save the result into a file, simply add the optional `data_file` parameter, e.g.
# result <- api_instance$TestQueryStyleFormExplodeTrueObjectAllOf(query_object = var_query_objectdata_file = "result.txt")
result <- api_instance$TestQueryStyleFormExplodeTrueObjectAllOf(query_object = var_query_object)
dput(result)
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**query_object** | [**DataQuery**](.md)| | [optional]
### Return type
**character**
### Authorization
No authorization required
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: text/plain
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
| **200** | Successful operation | - |

View File

@@ -0,0 +1,8 @@
# openapi::StringEnumRef
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------

View File

@@ -0,0 +1,10 @@
# openapi::Tag
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**id** | **integer** | | [optional]
**name** | **character** | | [optional]

View File

@@ -0,0 +1,12 @@
# openapi::TestQueryStyleDeepObjectExplodeTrueObjectAllOfQueryObjectParameter
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**size** | **character** | | [optional]
**color** | **character** | | [optional]
**id** | **integer** | | [optional]
**name** | **character** | | [optional]

View File

@@ -0,0 +1,9 @@
# openapi::TestQueryStyleFormExplodeTrueArrayStringQueryObjectParameter
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**values** | **array[character]** | | [optional]