From d2fcf027daa7a4957a1cfc2c7bc9e0ef2667d37f Mon Sep 17 00:00:00 2001 From: William Cheng Date: Tue, 23 Jan 2024 17:15:41 +0800 Subject: [PATCH 1/3] add tests for query parameters in python client --- .../src/test/resources/3_0/echo_api.yaml | 46 ++ .../README.md | 2 + .../docs/QueryApi.md | 136 +++++ ...odeTrueArrayIntegerQueryObjectParameter.md | 29 + .../openapi_client/api/query_api.py | 522 +++++++++++++++++- ...ue_array_integer_query_object_parameter.py | 93 ++++ ...ue_array_integer_query_object_parameter.py | 54 ++ .../echo_api/python-pydantic-v1/README.md | 2 + .../python-pydantic-v1/docs/QueryApi.md | 134 +++++ ...odeTrueArrayIntegerQueryObjectParameter.md | 28 + .../openapi_client/api/query_api.py | 284 +++++++++- ...ue_array_integer_query_object_parameter.py | 72 +++ ...ue_array_integer_query_object_parameter.py | 55 ++ samples/client/echo_api/python/README.md | 2 + .../client/echo_api/python/docs/QueryApi.md | 136 +++++ ...odeTrueArrayIntegerQueryObjectParameter.md | 29 + .../python/openapi_client/api/query_api.py | 522 +++++++++++++++++- ...ue_array_integer_query_object_parameter.py | 88 +++ ...ue_array_integer_query_object_parameter.py | 54 ++ .../echo_api/python/tests/test_manual.py | 11 + 20 files changed, 2296 insertions(+), 3 deletions(-) create mode 100644 samples/client/echo_api/python-disallowAdditionalPropertiesIfNotPresent/docs/TestQueryStyleFormExplodeTrueArrayIntegerQueryObjectParameter.md create mode 100644 samples/client/echo_api/python-disallowAdditionalPropertiesIfNotPresent/openapi_client/models/test_query_style_form_explode_true_array_integer_query_object_parameter.py create mode 100644 samples/client/echo_api/python-disallowAdditionalPropertiesIfNotPresent/test/test_test_query_style_form_explode_true_array_integer_query_object_parameter.py create mode 100644 samples/client/echo_api/python-pydantic-v1/docs/TestQueryStyleFormExplodeTrueArrayIntegerQueryObjectParameter.md create mode 100644 samples/client/echo_api/python-pydantic-v1/openapi_client/models/test_query_style_form_explode_true_array_integer_query_object_parameter.py create mode 100644 samples/client/echo_api/python-pydantic-v1/test/test_test_query_style_form_explode_true_array_integer_query_object_parameter.py create mode 100644 samples/client/echo_api/python/docs/TestQueryStyleFormExplodeTrueArrayIntegerQueryObjectParameter.md create mode 100644 samples/client/echo_api/python/openapi_client/models/test_query_style_form_explode_true_array_integer_query_object_parameter.py create mode 100644 samples/client/echo_api/python/test/test_test_query_style_form_explode_true_array_integer_query_object_parameter.py diff --git a/modules/openapi-generator/src/test/resources/3_0/echo_api.yaml b/modules/openapi-generator/src/test/resources/3_0/echo_api.yaml index e43c37e23871..1914feedf9fa 100644 --- a/modules/openapi-generator/src/test/resources/3_0/echo_api.yaml +++ b/modules/openapi-generator/src/test/resources/3_0/echo_api.yaml @@ -307,6 +307,52 @@ paths: text/plain: schema: type: string + /query/style_form/explode_false/array_integer: + get: + tags: + - query + summary: Test query parameter(s) + description: Test query parameter(s) + operationId: test/query/style_form/explode_false/array_integer + parameters: + - in: query + name: query_object + style: form #default + explode: false + schema: + type: array + items: + type: integer + responses: + '200': + description: Successful operation + content: + text/plain: + schema: + type: string + /query/style_form/explode_false/array_string: + get: + tags: + - query + summary: Test query parameter(s) + description: Test query parameter(s) + operationId: test/query/style_form/explode_false/array_string + parameters: + - in: query + name: query_object + style: form #default + explode: false + schema: + type: array + items: + type: string + responses: + '200': + description: Successful operation + content: + text/plain: + schema: + type: string /query/style_form/explode_true/object: get: tags: diff --git a/samples/client/echo_api/python-disallowAdditionalPropertiesIfNotPresent/README.md b/samples/client/echo_api/python-disallowAdditionalPropertiesIfNotPresent/README.md index f44bd12c67c4..6140414aa428 100644 --- a/samples/client/echo_api/python-disallowAdditionalPropertiesIfNotPresent/README.md +++ b/samples/client/echo_api/python-disallowAdditionalPropertiesIfNotPresent/README.md @@ -113,6 +113,8 @@ Class | Method | HTTP request | Description *QueryApi* | [**test_query_integer_boolean_string**](docs/QueryApi.md#test_query_integer_boolean_string) | **GET** /query/integer/boolean/string | Test query parameter(s) *QueryApi* | [**test_query_style_deep_object_explode_true_object**](docs/QueryApi.md#test_query_style_deep_object_explode_true_object) | **GET** /query/style_deepObject/explode_true/object | Test query parameter(s) *QueryApi* | [**test_query_style_deep_object_explode_true_object_all_of**](docs/QueryApi.md#test_query_style_deep_object_explode_true_object_all_of) | **GET** /query/style_deepObject/explode_true/object/allOf | Test query parameter(s) +*QueryApi* | [**test_query_style_form_explode_false_array_integer**](docs/QueryApi.md#test_query_style_form_explode_false_array_integer) | **GET** /query/style_form/explode_false/array_integer | Test query parameter(s) +*QueryApi* | [**test_query_style_form_explode_false_array_string**](docs/QueryApi.md#test_query_style_form_explode_false_array_string) | **GET** /query/style_form/explode_false/array_string | Test query parameter(s) *QueryApi* | [**test_query_style_form_explode_true_array_string**](docs/QueryApi.md#test_query_style_form_explode_true_array_string) | **GET** /query/style_form/explode_true/array_string | Test query parameter(s) *QueryApi* | [**test_query_style_form_explode_true_object**](docs/QueryApi.md#test_query_style_form_explode_true_object) | **GET** /query/style_form/explode_true/object | Test query parameter(s) *QueryApi* | [**test_query_style_form_explode_true_object_all_of**](docs/QueryApi.md#test_query_style_form_explode_true_object_all_of) | **GET** /query/style_form/explode_true/object/allOf | Test query parameter(s) diff --git a/samples/client/echo_api/python-disallowAdditionalPropertiesIfNotPresent/docs/QueryApi.md b/samples/client/echo_api/python-disallowAdditionalPropertiesIfNotPresent/docs/QueryApi.md index e84a872066f8..8c8bf981a5f7 100644 --- a/samples/client/echo_api/python-disallowAdditionalPropertiesIfNotPresent/docs/QueryApi.md +++ b/samples/client/echo_api/python-disallowAdditionalPropertiesIfNotPresent/docs/QueryApi.md @@ -9,6 +9,8 @@ Method | HTTP request | Description [**test_query_integer_boolean_string**](QueryApi.md#test_query_integer_boolean_string) | **GET** /query/integer/boolean/string | Test query parameter(s) [**test_query_style_deep_object_explode_true_object**](QueryApi.md#test_query_style_deep_object_explode_true_object) | **GET** /query/style_deepObject/explode_true/object | Test query parameter(s) [**test_query_style_deep_object_explode_true_object_all_of**](QueryApi.md#test_query_style_deep_object_explode_true_object_all_of) | **GET** /query/style_deepObject/explode_true/object/allOf | Test query parameter(s) +[**test_query_style_form_explode_false_array_integer**](QueryApi.md#test_query_style_form_explode_false_array_integer) | **GET** /query/style_form/explode_false/array_integer | Test query parameter(s) +[**test_query_style_form_explode_false_array_string**](QueryApi.md#test_query_style_form_explode_false_array_string) | **GET** /query/style_form/explode_false/array_string | Test query parameter(s) [**test_query_style_form_explode_true_array_string**](QueryApi.md#test_query_style_form_explode_true_array_string) | **GET** /query/style_form/explode_true/array_string | Test query parameter(s) [**test_query_style_form_explode_true_object**](QueryApi.md#test_query_style_form_explode_true_object) | **GET** /query/style_form/explode_true/object | Test query parameter(s) [**test_query_style_form_explode_true_object_all_of**](QueryApi.md#test_query_style_form_explode_true_object_all_of) | **GET** /query/style_form/explode_true/object/allOf | Test query parameter(s) @@ -361,6 +363,140 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) +# **test_query_style_form_explode_false_array_integer** +> str test_query_style_form_explode_false_array_integer(query_object=query_object) + +Test query parameter(s) + +Test query parameter(s) + +### Example + + +```python +import openapi_client +from openapi_client.rest import ApiException +from pprint import pprint + +# Defining the host is optional and defaults to http://localhost:3000 +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "http://localhost:3000" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = openapi_client.QueryApi(api_client) + query_object = [56] # List[int] | (optional) + + try: + # Test query parameter(s) + api_response = api_instance.test_query_style_form_explode_false_array_integer(query_object=query_object) + print("The response of QueryApi->test_query_style_form_explode_false_array_integer:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling QueryApi->test_query_style_form_explode_false_array_integer: %s\n" % e) +``` + + + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **query_object** | [**List[int]**](int.md)| | [optional] + +### Return type + +**str** + +### 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 | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **test_query_style_form_explode_false_array_string** +> str test_query_style_form_explode_false_array_string(query_object=query_object) + +Test query parameter(s) + +Test query parameter(s) + +### Example + + +```python +import openapi_client +from openapi_client.rest import ApiException +from pprint import pprint + +# Defining the host is optional and defaults to http://localhost:3000 +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "http://localhost:3000" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = openapi_client.QueryApi(api_client) + query_object = ['query_object_example'] # List[str] | (optional) + + try: + # Test query parameter(s) + api_response = api_instance.test_query_style_form_explode_false_array_string(query_object=query_object) + print("The response of QueryApi->test_query_style_form_explode_false_array_string:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling QueryApi->test_query_style_form_explode_false_array_string: %s\n" % e) +``` + + + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **query_object** | [**List[str]**](str.md)| | [optional] + +### Return type + +**str** + +### 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 | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + # **test_query_style_form_explode_true_array_string** > str test_query_style_form_explode_true_array_string(query_object=query_object) diff --git a/samples/client/echo_api/python-disallowAdditionalPropertiesIfNotPresent/docs/TestQueryStyleFormExplodeTrueArrayIntegerQueryObjectParameter.md b/samples/client/echo_api/python-disallowAdditionalPropertiesIfNotPresent/docs/TestQueryStyleFormExplodeTrueArrayIntegerQueryObjectParameter.md new file mode 100644 index 000000000000..4c8f1af90f6f --- /dev/null +++ b/samples/client/echo_api/python-disallowAdditionalPropertiesIfNotPresent/docs/TestQueryStyleFormExplodeTrueArrayIntegerQueryObjectParameter.md @@ -0,0 +1,29 @@ +# TestQueryStyleFormExplodeTrueArrayIntegerQueryObjectParameter + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**values** | **List[int]** | | [optional] + +## Example + +```python +from openapi_client.models.test_query_style_form_explode_true_array_integer_query_object_parameter import TestQueryStyleFormExplodeTrueArrayIntegerQueryObjectParameter + +# TODO update the JSON string below +json = "{}" +# create an instance of TestQueryStyleFormExplodeTrueArrayIntegerQueryObjectParameter from a JSON string +test_query_style_form_explode_true_array_integer_query_object_parameter_instance = TestQueryStyleFormExplodeTrueArrayIntegerQueryObjectParameter.from_json(json) +# print the JSON string representation of the object +print TestQueryStyleFormExplodeTrueArrayIntegerQueryObjectParameter.to_json() + +# convert the object into a dict +test_query_style_form_explode_true_array_integer_query_object_parameter_dict = test_query_style_form_explode_true_array_integer_query_object_parameter_instance.to_dict() +# create an instance of TestQueryStyleFormExplodeTrueArrayIntegerQueryObjectParameter from a dict +test_query_style_form_explode_true_array_integer_query_object_parameter_form_dict = test_query_style_form_explode_true_array_integer_query_object_parameter.from_dict(test_query_style_form_explode_true_array_integer_query_object_parameter_dict) +``` +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/samples/client/echo_api/python-disallowAdditionalPropertiesIfNotPresent/openapi_client/api/query_api.py b/samples/client/echo_api/python-disallowAdditionalPropertiesIfNotPresent/openapi_client/api/query_api.py index e27b8f5ce617..3475995b55c1 100644 --- a/samples/client/echo_api/python-disallowAdditionalPropertiesIfNotPresent/openapi_client/api/query_api.py +++ b/samples/client/echo_api/python-disallowAdditionalPropertiesIfNotPresent/openapi_client/api/query_api.py @@ -19,7 +19,7 @@ from datetime import date, datetime from pydantic import StrictBool, StrictInt, StrictStr, field_validator -from typing import Any, Optional +from typing import Any, List, Optional from openapi_client.models.pet import Pet from openapi_client.models.string_enum_ref import StringEnumRef from openapi_client.models.test_query_style_form_explode_true_array_string_query_object_parameter import TestQueryStyleFormExplodeTrueArrayStringQueryObjectParameter @@ -1440,6 +1440,526 @@ def _test_query_style_deep_object_explode_true_object_all_of_serialize( + @validate_call + def test_query_style_form_explode_false_array_integer( + self, + query_object: Optional[List[StrictInt]] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> str: + """Test query parameter(s) + + Test query parameter(s) + + :param query_object: + :type query_object: List[int] + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._test_query_style_form_explode_false_array_integer_serialize( + query_object=query_object, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "str", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def test_query_style_form_explode_false_array_integer_with_http_info( + self, + query_object: Optional[List[StrictInt]] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[str]: + """Test query parameter(s) + + Test query parameter(s) + + :param query_object: + :type query_object: List[int] + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._test_query_style_form_explode_false_array_integer_serialize( + query_object=query_object, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "str", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def test_query_style_form_explode_false_array_integer_without_preload_content( + self, + query_object: Optional[List[StrictInt]] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Test query parameter(s) + + Test query parameter(s) + + :param query_object: + :type query_object: List[int] + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._test_query_style_form_explode_false_array_integer_serialize( + query_object=query_object, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "str", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _test_query_style_form_explode_false_array_integer_serialize( + self, + query_object, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + 'query_object': 'csv', + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[str, str] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + # process the query parameters + if query_object is not None: + + _query_params.append(('query_object', query_object)) + + # process the header parameters + # process the form parameters + # process the body parameter + + + # set the HTTP header `Accept` + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'text/plain' + ] + ) + + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='GET', + resource_path='/query/style_form/explode_false/array_integer', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def test_query_style_form_explode_false_array_string( + self, + query_object: Optional[List[StrictStr]] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> str: + """Test query parameter(s) + + Test query parameter(s) + + :param query_object: + :type query_object: List[str] + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._test_query_style_form_explode_false_array_string_serialize( + query_object=query_object, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "str", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def test_query_style_form_explode_false_array_string_with_http_info( + self, + query_object: Optional[List[StrictStr]] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[str]: + """Test query parameter(s) + + Test query parameter(s) + + :param query_object: + :type query_object: List[str] + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._test_query_style_form_explode_false_array_string_serialize( + query_object=query_object, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "str", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def test_query_style_form_explode_false_array_string_without_preload_content( + self, + query_object: Optional[List[StrictStr]] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Test query parameter(s) + + Test query parameter(s) + + :param query_object: + :type query_object: List[str] + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._test_query_style_form_explode_false_array_string_serialize( + query_object=query_object, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "str", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _test_query_style_form_explode_false_array_string_serialize( + self, + query_object, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + 'query_object': 'csv', + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[str, str] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + # process the query parameters + if query_object is not None: + + _query_params.append(('query_object', query_object)) + + # process the header parameters + # process the form parameters + # process the body parameter + + + # set the HTTP header `Accept` + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'text/plain' + ] + ) + + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='GET', + resource_path='/query/style_form/explode_false/array_string', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + @validate_call def test_query_style_form_explode_true_array_string( self, diff --git a/samples/client/echo_api/python-disallowAdditionalPropertiesIfNotPresent/openapi_client/models/test_query_style_form_explode_true_array_integer_query_object_parameter.py b/samples/client/echo_api/python-disallowAdditionalPropertiesIfNotPresent/openapi_client/models/test_query_style_form_explode_true_array_integer_query_object_parameter.py new file mode 100644 index 000000000000..52e50d5a5612 --- /dev/null +++ b/samples/client/echo_api/python-disallowAdditionalPropertiesIfNotPresent/openapi_client/models/test_query_style_form_explode_true_array_integer_query_object_parameter.py @@ -0,0 +1,93 @@ +# coding: utf-8 + +""" + Echo Server API + + Echo Server API + + The version of the OpenAPI document: 0.1.0 + Contact: team@openapitools.org + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, StrictInt +from typing import Any, ClassVar, Dict, List, Optional +from typing import Optional, Set +from typing_extensions import Self + +class TestQueryStyleFormExplodeTrueArrayIntegerQueryObjectParameter(BaseModel): + """ + TestQueryStyleFormExplodeTrueArrayIntegerQueryObjectParameter + """ # noqa: E501 + values: Optional[List[StrictInt]] = None + __properties: ClassVar[List[str]] = ["values"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of TestQueryStyleFormExplodeTrueArrayIntegerQueryObjectParameter from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of TestQueryStyleFormExplodeTrueArrayIntegerQueryObjectParameter from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + # raise errors for additional fields in the input + for _key in obj.keys(): + if _key not in cls.__properties: + raise ValueError("Error due to additional fields (not defined in TestQueryStyleFormExplodeTrueArrayIntegerQueryObjectParameter) in the input: " + _key) + + _obj = cls.model_validate({ + "values": obj.get("values") + }) + return _obj + + diff --git a/samples/client/echo_api/python-disallowAdditionalPropertiesIfNotPresent/test/test_test_query_style_form_explode_true_array_integer_query_object_parameter.py b/samples/client/echo_api/python-disallowAdditionalPropertiesIfNotPresent/test/test_test_query_style_form_explode_true_array_integer_query_object_parameter.py new file mode 100644 index 000000000000..2b35c46cb3f6 --- /dev/null +++ b/samples/client/echo_api/python-disallowAdditionalPropertiesIfNotPresent/test/test_test_query_style_form_explode_true_array_integer_query_object_parameter.py @@ -0,0 +1,54 @@ +# coding: utf-8 + +""" + Echo Server API + + Echo Server API + + The version of the OpenAPI document: 0.1.0 + Contact: team@openapitools.org + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from openapi_client.models.test_query_style_form_explode_true_array_integer_query_object_parameter import TestQueryStyleFormExplodeTrueArrayIntegerQueryObjectParameter + +class TestTestQueryStyleFormExplodeTrueArrayIntegerQueryObjectParameter(unittest.TestCase): + """TestQueryStyleFormExplodeTrueArrayIntegerQueryObjectParameter unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> TestQueryStyleFormExplodeTrueArrayIntegerQueryObjectParameter: + """Test TestQueryStyleFormExplodeTrueArrayIntegerQueryObjectParameter + include_option is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `TestQueryStyleFormExplodeTrueArrayIntegerQueryObjectParameter` + """ + model = TestQueryStyleFormExplodeTrueArrayIntegerQueryObjectParameter() + if include_optional: + return TestQueryStyleFormExplodeTrueArrayIntegerQueryObjectParameter( + values = [ + 56 + ] + ) + else: + return TestQueryStyleFormExplodeTrueArrayIntegerQueryObjectParameter( + ) + """ + + def testTestQueryStyleFormExplodeTrueArrayIntegerQueryObjectParameter(self): + """Test TestQueryStyleFormExplodeTrueArrayIntegerQueryObjectParameter""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/samples/client/echo_api/python-pydantic-v1/README.md b/samples/client/echo_api/python-pydantic-v1/README.md index fd797996cf68..a9d7af2677c0 100644 --- a/samples/client/echo_api/python-pydantic-v1/README.md +++ b/samples/client/echo_api/python-pydantic-v1/README.md @@ -114,6 +114,8 @@ Class | Method | HTTP request | Description *QueryApi* | [**test_query_integer_boolean_string**](docs/QueryApi.md#test_query_integer_boolean_string) | **GET** /query/integer/boolean/string | Test query parameter(s) *QueryApi* | [**test_query_style_deep_object_explode_true_object**](docs/QueryApi.md#test_query_style_deep_object_explode_true_object) | **GET** /query/style_deepObject/explode_true/object | Test query parameter(s) *QueryApi* | [**test_query_style_deep_object_explode_true_object_all_of**](docs/QueryApi.md#test_query_style_deep_object_explode_true_object_all_of) | **GET** /query/style_deepObject/explode_true/object/allOf | Test query parameter(s) +*QueryApi* | [**test_query_style_form_explode_false_array_integer**](docs/QueryApi.md#test_query_style_form_explode_false_array_integer) | **GET** /query/style_form/explode_false/array_integer | Test query parameter(s) +*QueryApi* | [**test_query_style_form_explode_false_array_string**](docs/QueryApi.md#test_query_style_form_explode_false_array_string) | **GET** /query/style_form/explode_false/array_string | Test query parameter(s) *QueryApi* | [**test_query_style_form_explode_true_array_string**](docs/QueryApi.md#test_query_style_form_explode_true_array_string) | **GET** /query/style_form/explode_true/array_string | Test query parameter(s) *QueryApi* | [**test_query_style_form_explode_true_object**](docs/QueryApi.md#test_query_style_form_explode_true_object) | **GET** /query/style_form/explode_true/object | Test query parameter(s) *QueryApi* | [**test_query_style_form_explode_true_object_all_of**](docs/QueryApi.md#test_query_style_form_explode_true_object_all_of) | **GET** /query/style_form/explode_true/object/allOf | Test query parameter(s) diff --git a/samples/client/echo_api/python-pydantic-v1/docs/QueryApi.md b/samples/client/echo_api/python-pydantic-v1/docs/QueryApi.md index d449cc3ea189..5d56e95efc23 100644 --- a/samples/client/echo_api/python-pydantic-v1/docs/QueryApi.md +++ b/samples/client/echo_api/python-pydantic-v1/docs/QueryApi.md @@ -9,6 +9,8 @@ Method | HTTP request | Description [**test_query_integer_boolean_string**](QueryApi.md#test_query_integer_boolean_string) | **GET** /query/integer/boolean/string | Test query parameter(s) [**test_query_style_deep_object_explode_true_object**](QueryApi.md#test_query_style_deep_object_explode_true_object) | **GET** /query/style_deepObject/explode_true/object | Test query parameter(s) [**test_query_style_deep_object_explode_true_object_all_of**](QueryApi.md#test_query_style_deep_object_explode_true_object_all_of) | **GET** /query/style_deepObject/explode_true/object/allOf | Test query parameter(s) +[**test_query_style_form_explode_false_array_integer**](QueryApi.md#test_query_style_form_explode_false_array_integer) | **GET** /query/style_form/explode_false/array_integer | Test query parameter(s) +[**test_query_style_form_explode_false_array_string**](QueryApi.md#test_query_style_form_explode_false_array_string) | **GET** /query/style_form/explode_false/array_string | Test query parameter(s) [**test_query_style_form_explode_true_array_string**](QueryApi.md#test_query_style_form_explode_true_array_string) | **GET** /query/style_form/explode_true/array_string | Test query parameter(s) [**test_query_style_form_explode_true_object**](QueryApi.md#test_query_style_form_explode_true_object) | **GET** /query/style_form/explode_true/object | Test query parameter(s) [**test_query_style_form_explode_true_object_all_of**](QueryApi.md#test_query_style_form_explode_true_object_all_of) | **GET** /query/style_form/explode_true/object/allOf | Test query parameter(s) @@ -356,6 +358,138 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) +# **test_query_style_form_explode_false_array_integer** +> str test_query_style_form_explode_false_array_integer(query_object=query_object) + +Test query parameter(s) + +Test query parameter(s) + +### Example + +```python +import time +import os +import openapi_client +from openapi_client.rest import ApiException +from pprint import pprint + +# Defining the host is optional and defaults to http://localhost:3000 +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "http://localhost:3000" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = openapi_client.QueryApi(api_client) + query_object = [56] # List[int] | (optional) + + try: + # Test query parameter(s) + api_response = api_instance.test_query_style_form_explode_false_array_integer(query_object=query_object) + print("The response of QueryApi->test_query_style_form_explode_false_array_integer:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling QueryApi->test_query_style_form_explode_false_array_integer: %s\n" % e) +``` + + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **query_object** | [**List[int]**](int.md)| | [optional] + +### Return type + +**str** + +### 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 | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **test_query_style_form_explode_false_array_string** +> str test_query_style_form_explode_false_array_string(query_object=query_object) + +Test query parameter(s) + +Test query parameter(s) + +### Example + +```python +import time +import os +import openapi_client +from openapi_client.rest import ApiException +from pprint import pprint + +# Defining the host is optional and defaults to http://localhost:3000 +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "http://localhost:3000" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = openapi_client.QueryApi(api_client) + query_object = ['query_object_example'] # List[str] | (optional) + + try: + # Test query parameter(s) + api_response = api_instance.test_query_style_form_explode_false_array_string(query_object=query_object) + print("The response of QueryApi->test_query_style_form_explode_false_array_string:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling QueryApi->test_query_style_form_explode_false_array_string: %s\n" % e) +``` + + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **query_object** | [**List[str]**](str.md)| | [optional] + +### Return type + +**str** + +### 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 | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + # **test_query_style_form_explode_true_array_string** > str test_query_style_form_explode_true_array_string(query_object=query_object) diff --git a/samples/client/echo_api/python-pydantic-v1/docs/TestQueryStyleFormExplodeTrueArrayIntegerQueryObjectParameter.md b/samples/client/echo_api/python-pydantic-v1/docs/TestQueryStyleFormExplodeTrueArrayIntegerQueryObjectParameter.md new file mode 100644 index 000000000000..98c3b7da3a25 --- /dev/null +++ b/samples/client/echo_api/python-pydantic-v1/docs/TestQueryStyleFormExplodeTrueArrayIntegerQueryObjectParameter.md @@ -0,0 +1,28 @@ +# TestQueryStyleFormExplodeTrueArrayIntegerQueryObjectParameter + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**values** | **List[int]** | | [optional] + +## Example + +```python +from openapi_client.models.test_query_style_form_explode_true_array_integer_query_object_parameter import TestQueryStyleFormExplodeTrueArrayIntegerQueryObjectParameter + +# TODO update the JSON string below +json = "{}" +# create an instance of TestQueryStyleFormExplodeTrueArrayIntegerQueryObjectParameter from a JSON string +test_query_style_form_explode_true_array_integer_query_object_parameter_instance = TestQueryStyleFormExplodeTrueArrayIntegerQueryObjectParameter.from_json(json) +# print the JSON string representation of the object +print TestQueryStyleFormExplodeTrueArrayIntegerQueryObjectParameter.to_json() + +# convert the object into a dict +test_query_style_form_explode_true_array_integer_query_object_parameter_dict = test_query_style_form_explode_true_array_integer_query_object_parameter_instance.to_dict() +# create an instance of TestQueryStyleFormExplodeTrueArrayIntegerQueryObjectParameter from a dict +test_query_style_form_explode_true_array_integer_query_object_parameter_form_dict = test_query_style_form_explode_true_array_integer_query_object_parameter.from_dict(test_query_style_form_explode_true_array_integer_query_object_parameter_dict) +``` +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/samples/client/echo_api/python-pydantic-v1/openapi_client/api/query_api.py b/samples/client/echo_api/python-pydantic-v1/openapi_client/api/query_api.py index bdd6a0f843af..680dbd3fba51 100644 --- a/samples/client/echo_api/python-pydantic-v1/openapi_client/api/query_api.py +++ b/samples/client/echo_api/python-pydantic-v1/openapi_client/api/query_api.py @@ -21,7 +21,7 @@ from datetime import date, datetime -from pydantic import StrictBool, StrictInt, StrictStr +from pydantic import StrictBool, StrictInt, StrictStr, conlist from typing import Any, Optional @@ -795,6 +795,288 @@ def test_query_style_deep_object_explode_true_object_all_of_with_http_info(self, collection_formats=_collection_formats, _request_auth=_params.get('_request_auth')) + @validate_arguments + def test_query_style_form_explode_false_array_integer(self, query_object : Optional[conlist(StrictInt)] = None, **kwargs) -> str: # noqa: E501 + """Test query parameter(s) # noqa: E501 + + Test query parameter(s) # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.test_query_style_form_explode_false_array_integer(query_object, async_req=True) + >>> result = thread.get() + + :param query_object: + :type query_object: List[int] + :param async_req: Whether to execute the request asynchronously. + :type async_req: bool, optional + :param _request_timeout: timeout setting for this request. + If one number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :return: Returns the result object. + If the method is called asynchronously, + returns the request thread. + :rtype: str + """ + kwargs['_return_http_data_only'] = True + if '_preload_content' in kwargs: + message = "Error! Please call the test_query_style_form_explode_false_array_integer_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501 + raise ValueError(message) + return self.test_query_style_form_explode_false_array_integer_with_http_info(query_object, **kwargs) # noqa: E501 + + @validate_arguments + def test_query_style_form_explode_false_array_integer_with_http_info(self, query_object : Optional[conlist(StrictInt)] = None, **kwargs) -> ApiResponse: # noqa: E501 + """Test query parameter(s) # noqa: E501 + + Test query parameter(s) # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.test_query_style_form_explode_false_array_integer_with_http_info(query_object, async_req=True) + >>> result = thread.get() + + :param query_object: + :type query_object: List[int] + :param async_req: Whether to execute the request asynchronously. + :type async_req: bool, optional + :param _preload_content: if False, the ApiResponse.data will + be set to none and raw_data will store the + HTTP response body without reading/decoding. + Default is True. + :type _preload_content: bool, optional + :param _return_http_data_only: response data instead of ApiResponse + object with status code, headers, etc + :type _return_http_data_only: bool, optional + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + :type _request_auth: dict, optional + :type _content_type: string, optional: force content-type for the request + :return: Returns the result object. + If the method is called asynchronously, + returns the request thread. + :rtype: tuple(str, status_code(int), headers(HTTPHeaderDict)) + """ + + _params = locals() + + _all_params = [ + 'query_object' + ] + _all_params.extend( + [ + 'async_req', + '_return_http_data_only', + '_preload_content', + '_request_timeout', + '_request_auth', + '_content_type', + '_headers' + ] + ) + + # validate the arguments + for _key, _val in _params['kwargs'].items(): + if _key not in _all_params: + raise ApiTypeError( + "Got an unexpected keyword argument '%s'" + " to method test_query_style_form_explode_false_array_integer" % _key + ) + _params[_key] = _val + del _params['kwargs'] + + _collection_formats = {} + + # process the path parameters + _path_params = {} + + # process the query parameters + _query_params = [] + if _params.get('query_object') is not None: # noqa: E501 + _query_params.append(('query_object', _params['query_object'])) + _collection_formats['query_object'] = 'csv' + + # process the header parameters + _header_params = dict(_params.get('_headers', {})) + # process the form parameters + _form_params = [] + _files = {} + # process the body parameter + _body_params = None + # set the HTTP header `Accept` + _header_params['Accept'] = self.api_client.select_header_accept( + ['text/plain']) # noqa: E501 + + # authentication setting + _auth_settings = [] # noqa: E501 + + _response_types_map = { + '200': "str", + } + + return self.api_client.call_api( + '/query/style_form/explode_false/array_integer', 'GET', + _path_params, + _query_params, + _header_params, + body=_body_params, + post_params=_form_params, + files=_files, + response_types_map=_response_types_map, + auth_settings=_auth_settings, + async_req=_params.get('async_req'), + _return_http_data_only=_params.get('_return_http_data_only'), # noqa: E501 + _preload_content=_params.get('_preload_content', True), + _request_timeout=_params.get('_request_timeout'), + collection_formats=_collection_formats, + _request_auth=_params.get('_request_auth')) + + @validate_arguments + def test_query_style_form_explode_false_array_string(self, query_object : Optional[conlist(StrictStr)] = None, **kwargs) -> str: # noqa: E501 + """Test query parameter(s) # noqa: E501 + + Test query parameter(s) # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.test_query_style_form_explode_false_array_string(query_object, async_req=True) + >>> result = thread.get() + + :param query_object: + :type query_object: List[str] + :param async_req: Whether to execute the request asynchronously. + :type async_req: bool, optional + :param _request_timeout: timeout setting for this request. + If one number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :return: Returns the result object. + If the method is called asynchronously, + returns the request thread. + :rtype: str + """ + kwargs['_return_http_data_only'] = True + if '_preload_content' in kwargs: + message = "Error! Please call the test_query_style_form_explode_false_array_string_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501 + raise ValueError(message) + return self.test_query_style_form_explode_false_array_string_with_http_info(query_object, **kwargs) # noqa: E501 + + @validate_arguments + def test_query_style_form_explode_false_array_string_with_http_info(self, query_object : Optional[conlist(StrictStr)] = None, **kwargs) -> ApiResponse: # noqa: E501 + """Test query parameter(s) # noqa: E501 + + Test query parameter(s) # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.test_query_style_form_explode_false_array_string_with_http_info(query_object, async_req=True) + >>> result = thread.get() + + :param query_object: + :type query_object: List[str] + :param async_req: Whether to execute the request asynchronously. + :type async_req: bool, optional + :param _preload_content: if False, the ApiResponse.data will + be set to none and raw_data will store the + HTTP response body without reading/decoding. + Default is True. + :type _preload_content: bool, optional + :param _return_http_data_only: response data instead of ApiResponse + object with status code, headers, etc + :type _return_http_data_only: bool, optional + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + :type _request_auth: dict, optional + :type _content_type: string, optional: force content-type for the request + :return: Returns the result object. + If the method is called asynchronously, + returns the request thread. + :rtype: tuple(str, status_code(int), headers(HTTPHeaderDict)) + """ + + _params = locals() + + _all_params = [ + 'query_object' + ] + _all_params.extend( + [ + 'async_req', + '_return_http_data_only', + '_preload_content', + '_request_timeout', + '_request_auth', + '_content_type', + '_headers' + ] + ) + + # validate the arguments + for _key, _val in _params['kwargs'].items(): + if _key not in _all_params: + raise ApiTypeError( + "Got an unexpected keyword argument '%s'" + " to method test_query_style_form_explode_false_array_string" % _key + ) + _params[_key] = _val + del _params['kwargs'] + + _collection_formats = {} + + # process the path parameters + _path_params = {} + + # process the query parameters + _query_params = [] + if _params.get('query_object') is not None: # noqa: E501 + _query_params.append(('query_object', _params['query_object'])) + _collection_formats['query_object'] = 'csv' + + # process the header parameters + _header_params = dict(_params.get('_headers', {})) + # process the form parameters + _form_params = [] + _files = {} + # process the body parameter + _body_params = None + # set the HTTP header `Accept` + _header_params['Accept'] = self.api_client.select_header_accept( + ['text/plain']) # noqa: E501 + + # authentication setting + _auth_settings = [] # noqa: E501 + + _response_types_map = { + '200': "str", + } + + return self.api_client.call_api( + '/query/style_form/explode_false/array_string', 'GET', + _path_params, + _query_params, + _header_params, + body=_body_params, + post_params=_form_params, + files=_files, + response_types_map=_response_types_map, + auth_settings=_auth_settings, + async_req=_params.get('async_req'), + _return_http_data_only=_params.get('_return_http_data_only'), # noqa: E501 + _preload_content=_params.get('_preload_content', True), + _request_timeout=_params.get('_request_timeout'), + collection_formats=_collection_formats, + _request_auth=_params.get('_request_auth')) + @validate_arguments def test_query_style_form_explode_true_array_string(self, query_object : Optional[TestQueryStyleFormExplodeTrueArrayStringQueryObjectParameter] = None, **kwargs) -> str: # noqa: E501 """Test query parameter(s) # noqa: E501 diff --git a/samples/client/echo_api/python-pydantic-v1/openapi_client/models/test_query_style_form_explode_true_array_integer_query_object_parameter.py b/samples/client/echo_api/python-pydantic-v1/openapi_client/models/test_query_style_form_explode_true_array_integer_query_object_parameter.py new file mode 100644 index 000000000000..03a79b1b707c --- /dev/null +++ b/samples/client/echo_api/python-pydantic-v1/openapi_client/models/test_query_style_form_explode_true_array_integer_query_object_parameter.py @@ -0,0 +1,72 @@ +# coding: utf-8 + +""" + Echo Server API + + Echo Server API + + The version of the OpenAPI document: 0.1.0 + Contact: team@openapitools.org + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + + +from typing import List, Optional +from pydantic import BaseModel, StrictInt, conlist + +class TestQueryStyleFormExplodeTrueArrayIntegerQueryObjectParameter(BaseModel): + """ + TestQueryStyleFormExplodeTrueArrayIntegerQueryObjectParameter + """ + values: Optional[conlist(StrictInt)] = None + __properties = ["values"] + + class Config: + """Pydantic configuration""" + allow_population_by_field_name = True + validate_assignment = True + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.dict(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> TestQueryStyleFormExplodeTrueArrayIntegerQueryObjectParameter: + """Create an instance of TestQueryStyleFormExplodeTrueArrayIntegerQueryObjectParameter from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self): + """Returns the dictionary representation of the model using alias""" + _dict = self.dict(by_alias=True, + exclude={ + }, + exclude_none=True) + return _dict + + @classmethod + def from_dict(cls, obj: dict) -> TestQueryStyleFormExplodeTrueArrayIntegerQueryObjectParameter: + """Create an instance of TestQueryStyleFormExplodeTrueArrayIntegerQueryObjectParameter from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return TestQueryStyleFormExplodeTrueArrayIntegerQueryObjectParameter.parse_obj(obj) + + _obj = TestQueryStyleFormExplodeTrueArrayIntegerQueryObjectParameter.parse_obj({ + "values": obj.get("values") + }) + return _obj + + diff --git a/samples/client/echo_api/python-pydantic-v1/test/test_test_query_style_form_explode_true_array_integer_query_object_parameter.py b/samples/client/echo_api/python-pydantic-v1/test/test_test_query_style_form_explode_true_array_integer_query_object_parameter.py new file mode 100644 index 000000000000..3fc17ba947e5 --- /dev/null +++ b/samples/client/echo_api/python-pydantic-v1/test/test_test_query_style_form_explode_true_array_integer_query_object_parameter.py @@ -0,0 +1,55 @@ +# coding: utf-8 + +""" + Echo Server API + + Echo Server API + + The version of the OpenAPI document: 0.1.0 + Contact: team@openapitools.org + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest +import datetime + +from openapi_client.models.test_query_style_form_explode_true_array_integer_query_object_parameter import TestQueryStyleFormExplodeTrueArrayIntegerQueryObjectParameter # noqa: E501 + +class TestTestQueryStyleFormExplodeTrueArrayIntegerQueryObjectParameter(unittest.TestCase): + """TestQueryStyleFormExplodeTrueArrayIntegerQueryObjectParameter unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> TestQueryStyleFormExplodeTrueArrayIntegerQueryObjectParameter: + """Test TestQueryStyleFormExplodeTrueArrayIntegerQueryObjectParameter + include_option is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `TestQueryStyleFormExplodeTrueArrayIntegerQueryObjectParameter` + """ + model = TestQueryStyleFormExplodeTrueArrayIntegerQueryObjectParameter() # noqa: E501 + if include_optional: + return TestQueryStyleFormExplodeTrueArrayIntegerQueryObjectParameter( + values = [ + 56 + ] + ) + else: + return TestQueryStyleFormExplodeTrueArrayIntegerQueryObjectParameter( + ) + """ + + def testTestQueryStyleFormExplodeTrueArrayIntegerQueryObjectParameter(self): + """Test TestQueryStyleFormExplodeTrueArrayIntegerQueryObjectParameter""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/samples/client/echo_api/python/README.md b/samples/client/echo_api/python/README.md index f44bd12c67c4..6140414aa428 100644 --- a/samples/client/echo_api/python/README.md +++ b/samples/client/echo_api/python/README.md @@ -113,6 +113,8 @@ Class | Method | HTTP request | Description *QueryApi* | [**test_query_integer_boolean_string**](docs/QueryApi.md#test_query_integer_boolean_string) | **GET** /query/integer/boolean/string | Test query parameter(s) *QueryApi* | [**test_query_style_deep_object_explode_true_object**](docs/QueryApi.md#test_query_style_deep_object_explode_true_object) | **GET** /query/style_deepObject/explode_true/object | Test query parameter(s) *QueryApi* | [**test_query_style_deep_object_explode_true_object_all_of**](docs/QueryApi.md#test_query_style_deep_object_explode_true_object_all_of) | **GET** /query/style_deepObject/explode_true/object/allOf | Test query parameter(s) +*QueryApi* | [**test_query_style_form_explode_false_array_integer**](docs/QueryApi.md#test_query_style_form_explode_false_array_integer) | **GET** /query/style_form/explode_false/array_integer | Test query parameter(s) +*QueryApi* | [**test_query_style_form_explode_false_array_string**](docs/QueryApi.md#test_query_style_form_explode_false_array_string) | **GET** /query/style_form/explode_false/array_string | Test query parameter(s) *QueryApi* | [**test_query_style_form_explode_true_array_string**](docs/QueryApi.md#test_query_style_form_explode_true_array_string) | **GET** /query/style_form/explode_true/array_string | Test query parameter(s) *QueryApi* | [**test_query_style_form_explode_true_object**](docs/QueryApi.md#test_query_style_form_explode_true_object) | **GET** /query/style_form/explode_true/object | Test query parameter(s) *QueryApi* | [**test_query_style_form_explode_true_object_all_of**](docs/QueryApi.md#test_query_style_form_explode_true_object_all_of) | **GET** /query/style_form/explode_true/object/allOf | Test query parameter(s) diff --git a/samples/client/echo_api/python/docs/QueryApi.md b/samples/client/echo_api/python/docs/QueryApi.md index e84a872066f8..8c8bf981a5f7 100644 --- a/samples/client/echo_api/python/docs/QueryApi.md +++ b/samples/client/echo_api/python/docs/QueryApi.md @@ -9,6 +9,8 @@ Method | HTTP request | Description [**test_query_integer_boolean_string**](QueryApi.md#test_query_integer_boolean_string) | **GET** /query/integer/boolean/string | Test query parameter(s) [**test_query_style_deep_object_explode_true_object**](QueryApi.md#test_query_style_deep_object_explode_true_object) | **GET** /query/style_deepObject/explode_true/object | Test query parameter(s) [**test_query_style_deep_object_explode_true_object_all_of**](QueryApi.md#test_query_style_deep_object_explode_true_object_all_of) | **GET** /query/style_deepObject/explode_true/object/allOf | Test query parameter(s) +[**test_query_style_form_explode_false_array_integer**](QueryApi.md#test_query_style_form_explode_false_array_integer) | **GET** /query/style_form/explode_false/array_integer | Test query parameter(s) +[**test_query_style_form_explode_false_array_string**](QueryApi.md#test_query_style_form_explode_false_array_string) | **GET** /query/style_form/explode_false/array_string | Test query parameter(s) [**test_query_style_form_explode_true_array_string**](QueryApi.md#test_query_style_form_explode_true_array_string) | **GET** /query/style_form/explode_true/array_string | Test query parameter(s) [**test_query_style_form_explode_true_object**](QueryApi.md#test_query_style_form_explode_true_object) | **GET** /query/style_form/explode_true/object | Test query parameter(s) [**test_query_style_form_explode_true_object_all_of**](QueryApi.md#test_query_style_form_explode_true_object_all_of) | **GET** /query/style_form/explode_true/object/allOf | Test query parameter(s) @@ -361,6 +363,140 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) +# **test_query_style_form_explode_false_array_integer** +> str test_query_style_form_explode_false_array_integer(query_object=query_object) + +Test query parameter(s) + +Test query parameter(s) + +### Example + + +```python +import openapi_client +from openapi_client.rest import ApiException +from pprint import pprint + +# Defining the host is optional and defaults to http://localhost:3000 +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "http://localhost:3000" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = openapi_client.QueryApi(api_client) + query_object = [56] # List[int] | (optional) + + try: + # Test query parameter(s) + api_response = api_instance.test_query_style_form_explode_false_array_integer(query_object=query_object) + print("The response of QueryApi->test_query_style_form_explode_false_array_integer:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling QueryApi->test_query_style_form_explode_false_array_integer: %s\n" % e) +``` + + + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **query_object** | [**List[int]**](int.md)| | [optional] + +### Return type + +**str** + +### 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 | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **test_query_style_form_explode_false_array_string** +> str test_query_style_form_explode_false_array_string(query_object=query_object) + +Test query parameter(s) + +Test query parameter(s) + +### Example + + +```python +import openapi_client +from openapi_client.rest import ApiException +from pprint import pprint + +# Defining the host is optional and defaults to http://localhost:3000 +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "http://localhost:3000" +) + + +# Enter a context with an instance of the API client +with openapi_client.ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = openapi_client.QueryApi(api_client) + query_object = ['query_object_example'] # List[str] | (optional) + + try: + # Test query parameter(s) + api_response = api_instance.test_query_style_form_explode_false_array_string(query_object=query_object) + print("The response of QueryApi->test_query_style_form_explode_false_array_string:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling QueryApi->test_query_style_form_explode_false_array_string: %s\n" % e) +``` + + + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **query_object** | [**List[str]**](str.md)| | [optional] + +### Return type + +**str** + +### 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 | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + # **test_query_style_form_explode_true_array_string** > str test_query_style_form_explode_true_array_string(query_object=query_object) diff --git a/samples/client/echo_api/python/docs/TestQueryStyleFormExplodeTrueArrayIntegerQueryObjectParameter.md b/samples/client/echo_api/python/docs/TestQueryStyleFormExplodeTrueArrayIntegerQueryObjectParameter.md new file mode 100644 index 000000000000..4c8f1af90f6f --- /dev/null +++ b/samples/client/echo_api/python/docs/TestQueryStyleFormExplodeTrueArrayIntegerQueryObjectParameter.md @@ -0,0 +1,29 @@ +# TestQueryStyleFormExplodeTrueArrayIntegerQueryObjectParameter + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**values** | **List[int]** | | [optional] + +## Example + +```python +from openapi_client.models.test_query_style_form_explode_true_array_integer_query_object_parameter import TestQueryStyleFormExplodeTrueArrayIntegerQueryObjectParameter + +# TODO update the JSON string below +json = "{}" +# create an instance of TestQueryStyleFormExplodeTrueArrayIntegerQueryObjectParameter from a JSON string +test_query_style_form_explode_true_array_integer_query_object_parameter_instance = TestQueryStyleFormExplodeTrueArrayIntegerQueryObjectParameter.from_json(json) +# print the JSON string representation of the object +print TestQueryStyleFormExplodeTrueArrayIntegerQueryObjectParameter.to_json() + +# convert the object into a dict +test_query_style_form_explode_true_array_integer_query_object_parameter_dict = test_query_style_form_explode_true_array_integer_query_object_parameter_instance.to_dict() +# create an instance of TestQueryStyleFormExplodeTrueArrayIntegerQueryObjectParameter from a dict +test_query_style_form_explode_true_array_integer_query_object_parameter_form_dict = test_query_style_form_explode_true_array_integer_query_object_parameter.from_dict(test_query_style_form_explode_true_array_integer_query_object_parameter_dict) +``` +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/samples/client/echo_api/python/openapi_client/api/query_api.py b/samples/client/echo_api/python/openapi_client/api/query_api.py index e27b8f5ce617..3475995b55c1 100644 --- a/samples/client/echo_api/python/openapi_client/api/query_api.py +++ b/samples/client/echo_api/python/openapi_client/api/query_api.py @@ -19,7 +19,7 @@ from datetime import date, datetime from pydantic import StrictBool, StrictInt, StrictStr, field_validator -from typing import Any, Optional +from typing import Any, List, Optional from openapi_client.models.pet import Pet from openapi_client.models.string_enum_ref import StringEnumRef from openapi_client.models.test_query_style_form_explode_true_array_string_query_object_parameter import TestQueryStyleFormExplodeTrueArrayStringQueryObjectParameter @@ -1440,6 +1440,526 @@ def _test_query_style_deep_object_explode_true_object_all_of_serialize( + @validate_call + def test_query_style_form_explode_false_array_integer( + self, + query_object: Optional[List[StrictInt]] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> str: + """Test query parameter(s) + + Test query parameter(s) + + :param query_object: + :type query_object: List[int] + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._test_query_style_form_explode_false_array_integer_serialize( + query_object=query_object, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "str", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def test_query_style_form_explode_false_array_integer_with_http_info( + self, + query_object: Optional[List[StrictInt]] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[str]: + """Test query parameter(s) + + Test query parameter(s) + + :param query_object: + :type query_object: List[int] + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._test_query_style_form_explode_false_array_integer_serialize( + query_object=query_object, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "str", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def test_query_style_form_explode_false_array_integer_without_preload_content( + self, + query_object: Optional[List[StrictInt]] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Test query parameter(s) + + Test query parameter(s) + + :param query_object: + :type query_object: List[int] + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._test_query_style_form_explode_false_array_integer_serialize( + query_object=query_object, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "str", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _test_query_style_form_explode_false_array_integer_serialize( + self, + query_object, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + 'query_object': 'csv', + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[str, str] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + # process the query parameters + if query_object is not None: + + _query_params.append(('query_object', query_object)) + + # process the header parameters + # process the form parameters + # process the body parameter + + + # set the HTTP header `Accept` + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'text/plain' + ] + ) + + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='GET', + resource_path='/query/style_form/explode_false/array_integer', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def test_query_style_form_explode_false_array_string( + self, + query_object: Optional[List[StrictStr]] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> str: + """Test query parameter(s) + + Test query parameter(s) + + :param query_object: + :type query_object: List[str] + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._test_query_style_form_explode_false_array_string_serialize( + query_object=query_object, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "str", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def test_query_style_form_explode_false_array_string_with_http_info( + self, + query_object: Optional[List[StrictStr]] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[str]: + """Test query parameter(s) + + Test query parameter(s) + + :param query_object: + :type query_object: List[str] + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._test_query_style_form_explode_false_array_string_serialize( + query_object=query_object, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "str", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def test_query_style_form_explode_false_array_string_without_preload_content( + self, + query_object: Optional[List[StrictStr]] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Test query parameter(s) + + Test query parameter(s) + + :param query_object: + :type query_object: List[str] + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._test_query_style_form_explode_false_array_string_serialize( + query_object=query_object, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "str", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _test_query_style_form_explode_false_array_string_serialize( + self, + query_object, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + 'query_object': 'csv', + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[str, str] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + # process the query parameters + if query_object is not None: + + _query_params.append(('query_object', query_object)) + + # process the header parameters + # process the form parameters + # process the body parameter + + + # set the HTTP header `Accept` + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'text/plain' + ] + ) + + + # authentication setting + _auth_settings: List[str] = [ + ] + + return self.api_client.param_serialize( + method='GET', + resource_path='/query/style_form/explode_false/array_string', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + @validate_call def test_query_style_form_explode_true_array_string( self, diff --git a/samples/client/echo_api/python/openapi_client/models/test_query_style_form_explode_true_array_integer_query_object_parameter.py b/samples/client/echo_api/python/openapi_client/models/test_query_style_form_explode_true_array_integer_query_object_parameter.py new file mode 100644 index 000000000000..93c6f0c1216d --- /dev/null +++ b/samples/client/echo_api/python/openapi_client/models/test_query_style_form_explode_true_array_integer_query_object_parameter.py @@ -0,0 +1,88 @@ +# coding: utf-8 + +""" + Echo Server API + + Echo Server API + + The version of the OpenAPI document: 0.1.0 + Contact: team@openapitools.org + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, StrictInt +from typing import Any, ClassVar, Dict, List, Optional +from typing import Optional, Set +from typing_extensions import Self + +class TestQueryStyleFormExplodeTrueArrayIntegerQueryObjectParameter(BaseModel): + """ + TestQueryStyleFormExplodeTrueArrayIntegerQueryObjectParameter + """ # noqa: E501 + values: Optional[List[StrictInt]] = None + __properties: ClassVar[List[str]] = ["values"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of TestQueryStyleFormExplodeTrueArrayIntegerQueryObjectParameter from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of TestQueryStyleFormExplodeTrueArrayIntegerQueryObjectParameter from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "values": obj.get("values") + }) + return _obj + + diff --git a/samples/client/echo_api/python/test/test_test_query_style_form_explode_true_array_integer_query_object_parameter.py b/samples/client/echo_api/python/test/test_test_query_style_form_explode_true_array_integer_query_object_parameter.py new file mode 100644 index 000000000000..2b35c46cb3f6 --- /dev/null +++ b/samples/client/echo_api/python/test/test_test_query_style_form_explode_true_array_integer_query_object_parameter.py @@ -0,0 +1,54 @@ +# coding: utf-8 + +""" + Echo Server API + + Echo Server API + + The version of the OpenAPI document: 0.1.0 + Contact: team@openapitools.org + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from openapi_client.models.test_query_style_form_explode_true_array_integer_query_object_parameter import TestQueryStyleFormExplodeTrueArrayIntegerQueryObjectParameter + +class TestTestQueryStyleFormExplodeTrueArrayIntegerQueryObjectParameter(unittest.TestCase): + """TestQueryStyleFormExplodeTrueArrayIntegerQueryObjectParameter unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> TestQueryStyleFormExplodeTrueArrayIntegerQueryObjectParameter: + """Test TestQueryStyleFormExplodeTrueArrayIntegerQueryObjectParameter + include_option is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `TestQueryStyleFormExplodeTrueArrayIntegerQueryObjectParameter` + """ + model = TestQueryStyleFormExplodeTrueArrayIntegerQueryObjectParameter() + if include_optional: + return TestQueryStyleFormExplodeTrueArrayIntegerQueryObjectParameter( + values = [ + 56 + ] + ) + else: + return TestQueryStyleFormExplodeTrueArrayIntegerQueryObjectParameter( + ) + """ + + def testTestQueryStyleFormExplodeTrueArrayIntegerQueryObjectParameter(self): + """Test TestQueryStyleFormExplodeTrueArrayIntegerQueryObjectParameter""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/samples/client/echo_api/python/tests/test_manual.py b/samples/client/echo_api/python/tests/test_manual.py index 525c08758544..5d3b0d9385ab 100644 --- a/samples/client/echo_api/python/tests/test_manual.py +++ b/samples/client/echo_api/python/tests/test_manual.py @@ -79,6 +79,17 @@ def testEnumQueryParameters(self): "/query/enum_ref_string?enum_nonref_string_query=success&enum_ref_string_query=unclassified", ) + def test_query_style_form_explode_false_array_integer_test(self): + api_instance = openapi_client.QueryApi() + api_response = api_instance.test_query_style_form_explode_false_array_integer([1,2,3]) + e = EchoServerResponseParser(api_response) + self.assertEqual(e.path, "/query/style_form/explode_false/array_integer?query_object=1,2,3") + + def test_query_style_form_explode_false_array_string_test(self): + api_instance = openapi_client.QueryApi() + api_response = api_instance.test_query_style_form_explode_false_array_string(["Oh, hello world","abc","DEF"]) + e = EchoServerResponseParser(api_response) + self.assertEqual(e.path, "/query/style_form/explode_false/array_string?query_object=Oh%2C%20hello%20world,abc,DEF") def testDateTimeQueryWithDateTimeFormat(self): api_instance = openapi_client.QueryApi() From 9020cf0390857c933ab36faf9752f5c768b5d673 Mon Sep 17 00:00:00 2001 From: William Cheng Date: Tue, 23 Jan 2024 17:21:06 +0800 Subject: [PATCH 2/3] update other samples --- .../echo_api/csharp-restsharp/README.md | 2 + .../csharp-restsharp/api/openapi.yaml | 48 ++ .../csharp-restsharp/docs/QueryApi.md | 184 +++++ .../src/Org.OpenAPITools/Api/QueryApi.cs | 372 ++++++++++ samples/client/echo_api/go/README.md | 2 + samples/client/echo_api/go/api/openapi.yaml | 48 ++ samples/client/echo_api/go/api_query.go | 216 ++++++ samples/client/echo_api/go/docs/QueryAPI.md | 134 ++++ .../echo_api/java/apache-httpclient/README.md | 2 + .../java/apache-httpclient/api/openapi.yaml | 50 ++ .../java/apache-httpclient/docs/QueryApi.md | 134 ++++ .../org/openapitools/client/api/QueryApi.java | 140 ++++ .../echo_api/java/feign-gson/api/openapi.yaml | 50 ++ .../org/openapitools/client/api/QueryApi.java | 154 +++++ samples/client/echo_api/java/native/README.md | 4 + .../echo_api/java/native/api/openapi.yaml | 50 ++ .../echo_api/java/native/docs/QueryApi.md | 272 ++++++++ .../org/openapitools/client/api/QueryApi.java | 180 +++++ .../echo_api/java/okhttp-gson/README.md | 2 + .../java/okhttp-gson/api/openapi.yaml | 50 ++ .../java/okhttp-gson/docs/QueryApi.md | 126 ++++ .../org/openapitools/client/api/QueryApi.java | 242 +++++++ .../client/echo_api/java/resteasy/README.md | 2 + .../echo_api/java/resteasy/api/openapi.yaml | 50 ++ .../echo_api/java/resteasy/docs/QueryApi.md | 134 ++++ .../org/openapitools/client/api/QueryApi.java | 78 +++ .../echo_api/java/resttemplate/README.md | 2 + .../java/resttemplate/api/openapi.yaml | 50 ++ .../java/resttemplate/docs/QueryApi.md | 134 ++++ .../org/openapitools/client/api/QueryApi.java | 88 +++ samples/client/echo_api/php-nextgen/README.md | 2 + .../echo_api/php-nextgen/docs/Api/QueryApi.md | 114 ++++ .../echo_api/php-nextgen/src/Api/QueryApi.php | 640 ++++++++++++++++++ samples/client/echo_api/powershell/README.md | 2 + .../echo_api/powershell/docs/QueryApi.md | 88 +++ .../src/PSOpenAPITools/Api/QueryApi.ps1 | 146 ++++ samples/client/echo_api/r/R/api_client.R | 2 +- samples/client/echo_api/r/R/api_response.R | 17 + samples/client/echo_api/r/R/auth_api.R | 4 +- samples/client/echo_api/r/R/body_api.R | 18 +- samples/client/echo_api/r/R/form_api.R | 4 +- samples/client/echo_api/r/R/header_api.R | 2 +- samples/client/echo_api/r/R/path_api.R | 2 +- samples/client/echo_api/r/R/query_api.R | 260 ++++++- samples/client/echo_api/r/README.md | 2 + samples/client/echo_api/r/docs/QueryApi.md | 96 +++ .../client/echo_api/ruby-faraday/README.md | 2 + .../echo_api/ruby-faraday/docs/QueryApi.md | 134 ++++ .../lib/openapi_client/api/query_api.rb | 120 ++++ samples/client/echo_api/ruby-httpx/README.md | 2 + .../echo_api/ruby-httpx/docs/QueryApi.md | 134 ++++ .../lib/openapi_client/api/query_api.rb | 120 ++++ .../client/echo_api/ruby-typhoeus/README.md | 2 + .../echo_api/ruby-typhoeus/docs/QueryApi.md | 134 ++++ .../lib/openapi_client/api/query_api.rb | 120 ++++ .../echo_api/typescript-axios/build/api.ts | 140 ++++ 56 files changed, 5283 insertions(+), 24 deletions(-) diff --git a/samples/client/echo_api/csharp-restsharp/README.md b/samples/client/echo_api/csharp-restsharp/README.md index c350eebaa413..acc1f9339e41 100644 --- a/samples/client/echo_api/csharp-restsharp/README.md +++ b/samples/client/echo_api/csharp-restsharp/README.md @@ -136,6 +136,8 @@ Class | Method | HTTP request | Description *QueryApi* | [**TestQueryIntegerBooleanString**](docs/QueryApi.md#testqueryintegerbooleanstring) | **GET** /query/integer/boolean/string | Test query parameter(s) *QueryApi* | [**TestQueryStyleDeepObjectExplodeTrueObject**](docs/QueryApi.md#testquerystyledeepobjectexplodetrueobject) | **GET** /query/style_deepObject/explode_true/object | Test query parameter(s) *QueryApi* | [**TestQueryStyleDeepObjectExplodeTrueObjectAllOf**](docs/QueryApi.md#testquerystyledeepobjectexplodetrueobjectallof) | **GET** /query/style_deepObject/explode_true/object/allOf | Test query parameter(s) +*QueryApi* | [**TestQueryStyleFormExplodeFalseArrayInteger**](docs/QueryApi.md#testquerystyleformexplodefalsearrayinteger) | **GET** /query/style_form/explode_false/array_integer | Test query parameter(s) +*QueryApi* | [**TestQueryStyleFormExplodeFalseArrayString**](docs/QueryApi.md#testquerystyleformexplodefalsearraystring) | **GET** /query/style_form/explode_false/array_string | Test query parameter(s) *QueryApi* | [**TestQueryStyleFormExplodeTrueArrayString**](docs/QueryApi.md#testquerystyleformexplodetruearraystring) | **GET** /query/style_form/explode_true/array_string | Test query parameter(s) *QueryApi* | [**TestQueryStyleFormExplodeTrueObject**](docs/QueryApi.md#testquerystyleformexplodetrueobject) | **GET** /query/style_form/explode_true/object | Test query parameter(s) *QueryApi* | [**TestQueryStyleFormExplodeTrueObjectAllOf**](docs/QueryApi.md#testquerystyleformexplodetrueobjectallof) | **GET** /query/style_form/explode_true/object/allOf | Test query parameter(s) diff --git a/samples/client/echo_api/csharp-restsharp/api/openapi.yaml b/samples/client/echo_api/csharp-restsharp/api/openapi.yaml index e4f825722a4f..de3dcca0a452 100644 --- a/samples/client/echo_api/csharp-restsharp/api/openapi.yaml +++ b/samples/client/echo_api/csharp-restsharp/api/openapi.yaml @@ -279,6 +279,54 @@ paths: summary: Test query parameter(s) tags: - query + /query/style_form/explode_false/array_integer: + get: + description: Test query parameter(s) + operationId: test/query/style_form/explode_false/array_integer + parameters: + - explode: false + in: query + name: query_object + required: false + schema: + items: + type: integer + type: array + style: form + responses: + "200": + content: + text/plain: + schema: + type: string + description: Successful operation + summary: Test query parameter(s) + tags: + - query + /query/style_form/explode_false/array_string: + get: + description: Test query parameter(s) + operationId: test/query/style_form/explode_false/array_string + parameters: + - explode: false + in: query + name: query_object + required: false + schema: + items: + type: string + type: array + style: form + responses: + "200": + content: + text/plain: + schema: + type: string + description: Successful operation + summary: Test query parameter(s) + tags: + - query /query/style_form/explode_true/object: get: description: Test query parameter(s) diff --git a/samples/client/echo_api/csharp-restsharp/docs/QueryApi.md b/samples/client/echo_api/csharp-restsharp/docs/QueryApi.md index 227f3fa7494d..c740ebd3c275 100644 --- a/samples/client/echo_api/csharp-restsharp/docs/QueryApi.md +++ b/samples/client/echo_api/csharp-restsharp/docs/QueryApi.md @@ -9,6 +9,8 @@ All URIs are relative to *http://localhost:3000* | [**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) | +| [**TestQueryStyleFormExplodeFalseArrayInteger**](QueryApi.md#testquerystyleformexplodefalsearrayinteger) | **GET** /query/style_form/explode_false/array_integer | Test query parameter(s) | +| [**TestQueryStyleFormExplodeFalseArrayString**](QueryApi.md#testquerystyleformexplodefalsearraystring) | **GET** /query/style_form/explode_false/array_string | 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) | @@ -471,6 +473,188 @@ No authorization required - **Accept**: text/plain +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +| **200** | Successful operation | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + + +# **TestQueryStyleFormExplodeFalseArrayInteger** +> string TestQueryStyleFormExplodeFalseArrayInteger (List? queryObject = null) + +Test query parameter(s) + +Test query parameter(s) + +### Example +```csharp +using System.Collections.Generic; +using System.Diagnostics; +using Org.OpenAPITools.Api; +using Org.OpenAPITools.Client; +using Org.OpenAPITools.Model; + +namespace Example +{ + public class TestQueryStyleFormExplodeFalseArrayIntegerExample + { + public static void Main() + { + Configuration config = new Configuration(); + config.BasePath = "http://localhost:3000"; + var apiInstance = new QueryApi(config); + var queryObject = new List?(); // List? | (optional) + + try + { + // Test query parameter(s) + string result = apiInstance.TestQueryStyleFormExplodeFalseArrayInteger(queryObject); + Debug.WriteLine(result); + } + catch (ApiException e) + { + Debug.Print("Exception when calling QueryApi.TestQueryStyleFormExplodeFalseArrayInteger: " + e.Message); + Debug.Print("Status Code: " + e.ErrorCode); + Debug.Print(e.StackTrace); + } + } + } +} +``` + +#### Using the TestQueryStyleFormExplodeFalseArrayIntegerWithHttpInfo variant +This returns an ApiResponse object which contains the response data, status code and headers. + +```csharp +try +{ + // Test query parameter(s) + ApiResponse response = apiInstance.TestQueryStyleFormExplodeFalseArrayIntegerWithHttpInfo(queryObject); + Debug.Write("Status Code: " + response.StatusCode); + Debug.Write("Response Headers: " + response.Headers); + Debug.Write("Response Body: " + response.Data); +} +catch (ApiException e) +{ + Debug.Print("Exception when calling QueryApi.TestQueryStyleFormExplodeFalseArrayIntegerWithHttpInfo: " + e.Message); + Debug.Print("Status Code: " + e.ErrorCode); + Debug.Print(e.StackTrace); +} +``` + +### Parameters + +| Name | Type | Description | Notes | +|------|------|-------------|-------| +| **queryObject** | [**List<int>?**](int.md) | | [optional] | + +### Return type + +**string** + +### 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 | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + + +# **TestQueryStyleFormExplodeFalseArrayString** +> string TestQueryStyleFormExplodeFalseArrayString (List? queryObject = null) + +Test query parameter(s) + +Test query parameter(s) + +### Example +```csharp +using System.Collections.Generic; +using System.Diagnostics; +using Org.OpenAPITools.Api; +using Org.OpenAPITools.Client; +using Org.OpenAPITools.Model; + +namespace Example +{ + public class TestQueryStyleFormExplodeFalseArrayStringExample + { + public static void Main() + { + Configuration config = new Configuration(); + config.BasePath = "http://localhost:3000"; + var apiInstance = new QueryApi(config); + var queryObject = new List?(); // List? | (optional) + + try + { + // Test query parameter(s) + string result = apiInstance.TestQueryStyleFormExplodeFalseArrayString(queryObject); + Debug.WriteLine(result); + } + catch (ApiException e) + { + Debug.Print("Exception when calling QueryApi.TestQueryStyleFormExplodeFalseArrayString: " + e.Message); + Debug.Print("Status Code: " + e.ErrorCode); + Debug.Print(e.StackTrace); + } + } + } +} +``` + +#### Using the TestQueryStyleFormExplodeFalseArrayStringWithHttpInfo variant +This returns an ApiResponse object which contains the response data, status code and headers. + +```csharp +try +{ + // Test query parameter(s) + ApiResponse response = apiInstance.TestQueryStyleFormExplodeFalseArrayStringWithHttpInfo(queryObject); + Debug.Write("Status Code: " + response.StatusCode); + Debug.Write("Response Headers: " + response.Headers); + Debug.Write("Response Body: " + response.Data); +} +catch (ApiException e) +{ + Debug.Print("Exception when calling QueryApi.TestQueryStyleFormExplodeFalseArrayStringWithHttpInfo: " + e.Message); + Debug.Print("Status Code: " + e.ErrorCode); + Debug.Print(e.StackTrace); +} +``` + +### Parameters + +| Name | Type | Description | Notes | +|------|------|-------------|-------| +| **queryObject** | [**List<string>?**](string.md) | | [optional] | + +### Return type + +**string** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: text/plain + + ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| diff --git a/samples/client/echo_api/csharp-restsharp/src/Org.OpenAPITools/Api/QueryApi.cs b/samples/client/echo_api/csharp-restsharp/src/Org.OpenAPITools/Api/QueryApi.cs index 9b54b9048f60..4765c77171ca 100644 --- a/samples/client/echo_api/csharp-restsharp/src/Org.OpenAPITools/Api/QueryApi.cs +++ b/samples/client/echo_api/csharp-restsharp/src/Org.OpenAPITools/Api/QueryApi.cs @@ -162,6 +162,52 @@ public interface IQueryApiSync : IApiAccessor /// (optional) /// Index associated with the operation. /// string + string TestQueryStyleFormExplodeFalseArrayInteger(List? queryObject = default(List?), int operationIndex = 0); + + /// + /// Test query parameter(s) + /// + /// + /// Test query parameter(s) + /// + /// Thrown when fails to make API call + /// (optional) + /// Index associated with the operation. + /// ApiResponse of string + ApiResponse TestQueryStyleFormExplodeFalseArrayIntegerWithHttpInfo(List? queryObject = default(List?), int operationIndex = 0); + /// + /// Test query parameter(s) + /// + /// + /// Test query parameter(s) + /// + /// Thrown when fails to make API call + /// (optional) + /// Index associated with the operation. + /// string + string TestQueryStyleFormExplodeFalseArrayString(List? queryObject = default(List?), int operationIndex = 0); + + /// + /// Test query parameter(s) + /// + /// + /// Test query parameter(s) + /// + /// Thrown when fails to make API call + /// (optional) + /// Index associated with the operation. + /// ApiResponse of string + ApiResponse TestQueryStyleFormExplodeFalseArrayStringWithHttpInfo(List? queryObject = default(List?), int operationIndex = 0); + /// + /// Test query parameter(s) + /// + /// + /// Test query parameter(s) + /// + /// Thrown when fails to make API call + /// (optional) + /// Index associated with the operation. + /// string string TestQueryStyleFormExplodeTrueArrayString(TestQueryStyleFormExplodeTrueArrayStringQueryObjectParameter? queryObject = default(TestQueryStyleFormExplodeTrueArrayStringQueryObjectParameter?), int operationIndex = 0); /// @@ -376,6 +422,56 @@ public interface IQueryApiAsync : IApiAccessor /// Index associated with the operation. /// Cancellation Token to cancel the request. /// Task of string + System.Threading.Tasks.Task TestQueryStyleFormExplodeFalseArrayIntegerAsync(List? queryObject = default(List?), int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)); + + /// + /// Test query parameter(s) + /// + /// + /// Test query parameter(s) + /// + /// Thrown when fails to make API call + /// (optional) + /// Index associated with the operation. + /// Cancellation Token to cancel the request. + /// Task of ApiResponse (string) + System.Threading.Tasks.Task> TestQueryStyleFormExplodeFalseArrayIntegerWithHttpInfoAsync(List? queryObject = default(List?), int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)); + /// + /// Test query parameter(s) + /// + /// + /// Test query parameter(s) + /// + /// Thrown when fails to make API call + /// (optional) + /// Index associated with the operation. + /// Cancellation Token to cancel the request. + /// Task of string + System.Threading.Tasks.Task TestQueryStyleFormExplodeFalseArrayStringAsync(List? queryObject = default(List?), int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)); + + /// + /// Test query parameter(s) + /// + /// + /// Test query parameter(s) + /// + /// Thrown when fails to make API call + /// (optional) + /// Index associated with the operation. + /// Cancellation Token to cancel the request. + /// Task of ApiResponse (string) + System.Threading.Tasks.Task> TestQueryStyleFormExplodeFalseArrayStringWithHttpInfoAsync(List? queryObject = default(List?), int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)); + /// + /// Test query parameter(s) + /// + /// + /// Test query parameter(s) + /// + /// Thrown when fails to make API call + /// (optional) + /// Index associated with the operation. + /// Cancellation Token to cancel the request. + /// Task of string System.Threading.Tasks.Task TestQueryStyleFormExplodeTrueArrayStringAsync(TestQueryStyleFormExplodeTrueArrayStringQueryObjectParameter? queryObject = default(TestQueryStyleFormExplodeTrueArrayStringQueryObjectParameter?), int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)); /// @@ -1354,6 +1450,282 @@ public Org.OpenAPITools.Client.ExceptionFactory ExceptionFactory return localVarResponse; } + /// + /// Test query parameter(s) Test query parameter(s) + /// + /// Thrown when fails to make API call + /// (optional) + /// Index associated with the operation. + /// string + public string TestQueryStyleFormExplodeFalseArrayInteger(List? queryObject = default(List?), int operationIndex = 0) + { + Org.OpenAPITools.Client.ApiResponse localVarResponse = TestQueryStyleFormExplodeFalseArrayIntegerWithHttpInfo(queryObject); + return localVarResponse.Data; + } + + /// + /// Test query parameter(s) Test query parameter(s) + /// + /// Thrown when fails to make API call + /// (optional) + /// Index associated with the operation. + /// ApiResponse of string + public Org.OpenAPITools.Client.ApiResponse TestQueryStyleFormExplodeFalseArrayIntegerWithHttpInfo(List? queryObject = default(List?), int operationIndex = 0) + { + Org.OpenAPITools.Client.RequestOptions localVarRequestOptions = new Org.OpenAPITools.Client.RequestOptions(); + + string[] _contentTypes = new string[] { + }; + + // to determine the Accept header + string[] _accepts = new string[] { + "text/plain" + }; + + var localVarContentType = Org.OpenAPITools.Client.ClientUtils.SelectHeaderContentType(_contentTypes); + if (localVarContentType != null) + { + localVarRequestOptions.HeaderParameters.Add("Content-Type", localVarContentType); + } + + var localVarAccept = Org.OpenAPITools.Client.ClientUtils.SelectHeaderAccept(_accepts); + if (localVarAccept != null) + { + localVarRequestOptions.HeaderParameters.Add("Accept", localVarAccept); + } + + if (queryObject != null) + { + localVarRequestOptions.QueryParameters.Add(Org.OpenAPITools.Client.ClientUtils.ParameterToMultiMap("csv", "query_object", queryObject)); + } + + localVarRequestOptions.Operation = "QueryApi.TestQueryStyleFormExplodeFalseArrayInteger"; + localVarRequestOptions.OperationIndex = operationIndex; + + + // make the HTTP request + var localVarResponse = this.Client.Get("/query/style_form/explode_false/array_integer", localVarRequestOptions, this.Configuration); + if (this.ExceptionFactory != null) + { + Exception _exception = this.ExceptionFactory("TestQueryStyleFormExplodeFalseArrayInteger", localVarResponse); + if (_exception != null) + { + throw _exception; + } + } + + return localVarResponse; + } + + /// + /// Test query parameter(s) Test query parameter(s) + /// + /// Thrown when fails to make API call + /// (optional) + /// Index associated with the operation. + /// Cancellation Token to cancel the request. + /// Task of string + public async System.Threading.Tasks.Task TestQueryStyleFormExplodeFalseArrayIntegerAsync(List? queryObject = default(List?), int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) + { + Org.OpenAPITools.Client.ApiResponse localVarResponse = await TestQueryStyleFormExplodeFalseArrayIntegerWithHttpInfoAsync(queryObject, operationIndex, cancellationToken).ConfigureAwait(false); + return localVarResponse.Data; + } + + /// + /// Test query parameter(s) Test query parameter(s) + /// + /// Thrown when fails to make API call + /// (optional) + /// Index associated with the operation. + /// Cancellation Token to cancel the request. + /// Task of ApiResponse (string) + public async System.Threading.Tasks.Task> TestQueryStyleFormExplodeFalseArrayIntegerWithHttpInfoAsync(List? queryObject = default(List?), int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) + { + + Org.OpenAPITools.Client.RequestOptions localVarRequestOptions = new Org.OpenAPITools.Client.RequestOptions(); + + string[] _contentTypes = new string[] { + }; + + // to determine the Accept header + string[] _accepts = new string[] { + "text/plain" + }; + + var localVarContentType = Org.OpenAPITools.Client.ClientUtils.SelectHeaderContentType(_contentTypes); + if (localVarContentType != null) + { + localVarRequestOptions.HeaderParameters.Add("Content-Type", localVarContentType); + } + + var localVarAccept = Org.OpenAPITools.Client.ClientUtils.SelectHeaderAccept(_accepts); + if (localVarAccept != null) + { + localVarRequestOptions.HeaderParameters.Add("Accept", localVarAccept); + } + + if (queryObject != null) + { + localVarRequestOptions.QueryParameters.Add(Org.OpenAPITools.Client.ClientUtils.ParameterToMultiMap("csv", "query_object", queryObject)); + } + + localVarRequestOptions.Operation = "QueryApi.TestQueryStyleFormExplodeFalseArrayInteger"; + localVarRequestOptions.OperationIndex = operationIndex; + + + // make the HTTP request + var localVarResponse = await this.AsynchronousClient.GetAsync("/query/style_form/explode_false/array_integer", localVarRequestOptions, this.Configuration, cancellationToken).ConfigureAwait(false); + + if (this.ExceptionFactory != null) + { + Exception _exception = this.ExceptionFactory("TestQueryStyleFormExplodeFalseArrayInteger", localVarResponse); + if (_exception != null) + { + throw _exception; + } + } + + return localVarResponse; + } + + /// + /// Test query parameter(s) Test query parameter(s) + /// + /// Thrown when fails to make API call + /// (optional) + /// Index associated with the operation. + /// string + public string TestQueryStyleFormExplodeFalseArrayString(List? queryObject = default(List?), int operationIndex = 0) + { + Org.OpenAPITools.Client.ApiResponse localVarResponse = TestQueryStyleFormExplodeFalseArrayStringWithHttpInfo(queryObject); + return localVarResponse.Data; + } + + /// + /// Test query parameter(s) Test query parameter(s) + /// + /// Thrown when fails to make API call + /// (optional) + /// Index associated with the operation. + /// ApiResponse of string + public Org.OpenAPITools.Client.ApiResponse TestQueryStyleFormExplodeFalseArrayStringWithHttpInfo(List? queryObject = default(List?), int operationIndex = 0) + { + Org.OpenAPITools.Client.RequestOptions localVarRequestOptions = new Org.OpenAPITools.Client.RequestOptions(); + + string[] _contentTypes = new string[] { + }; + + // to determine the Accept header + string[] _accepts = new string[] { + "text/plain" + }; + + var localVarContentType = Org.OpenAPITools.Client.ClientUtils.SelectHeaderContentType(_contentTypes); + if (localVarContentType != null) + { + localVarRequestOptions.HeaderParameters.Add("Content-Type", localVarContentType); + } + + var localVarAccept = Org.OpenAPITools.Client.ClientUtils.SelectHeaderAccept(_accepts); + if (localVarAccept != null) + { + localVarRequestOptions.HeaderParameters.Add("Accept", localVarAccept); + } + + if (queryObject != null) + { + localVarRequestOptions.QueryParameters.Add(Org.OpenAPITools.Client.ClientUtils.ParameterToMultiMap("csv", "query_object", queryObject)); + } + + localVarRequestOptions.Operation = "QueryApi.TestQueryStyleFormExplodeFalseArrayString"; + localVarRequestOptions.OperationIndex = operationIndex; + + + // make the HTTP request + var localVarResponse = this.Client.Get("/query/style_form/explode_false/array_string", localVarRequestOptions, this.Configuration); + if (this.ExceptionFactory != null) + { + Exception _exception = this.ExceptionFactory("TestQueryStyleFormExplodeFalseArrayString", localVarResponse); + if (_exception != null) + { + throw _exception; + } + } + + return localVarResponse; + } + + /// + /// Test query parameter(s) Test query parameter(s) + /// + /// Thrown when fails to make API call + /// (optional) + /// Index associated with the operation. + /// Cancellation Token to cancel the request. + /// Task of string + public async System.Threading.Tasks.Task TestQueryStyleFormExplodeFalseArrayStringAsync(List? queryObject = default(List?), int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) + { + Org.OpenAPITools.Client.ApiResponse localVarResponse = await TestQueryStyleFormExplodeFalseArrayStringWithHttpInfoAsync(queryObject, operationIndex, cancellationToken).ConfigureAwait(false); + return localVarResponse.Data; + } + + /// + /// Test query parameter(s) Test query parameter(s) + /// + /// Thrown when fails to make API call + /// (optional) + /// Index associated with the operation. + /// Cancellation Token to cancel the request. + /// Task of ApiResponse (string) + public async System.Threading.Tasks.Task> TestQueryStyleFormExplodeFalseArrayStringWithHttpInfoAsync(List? queryObject = default(List?), int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) + { + + Org.OpenAPITools.Client.RequestOptions localVarRequestOptions = new Org.OpenAPITools.Client.RequestOptions(); + + string[] _contentTypes = new string[] { + }; + + // to determine the Accept header + string[] _accepts = new string[] { + "text/plain" + }; + + var localVarContentType = Org.OpenAPITools.Client.ClientUtils.SelectHeaderContentType(_contentTypes); + if (localVarContentType != null) + { + localVarRequestOptions.HeaderParameters.Add("Content-Type", localVarContentType); + } + + var localVarAccept = Org.OpenAPITools.Client.ClientUtils.SelectHeaderAccept(_accepts); + if (localVarAccept != null) + { + localVarRequestOptions.HeaderParameters.Add("Accept", localVarAccept); + } + + if (queryObject != null) + { + localVarRequestOptions.QueryParameters.Add(Org.OpenAPITools.Client.ClientUtils.ParameterToMultiMap("csv", "query_object", queryObject)); + } + + localVarRequestOptions.Operation = "QueryApi.TestQueryStyleFormExplodeFalseArrayString"; + localVarRequestOptions.OperationIndex = operationIndex; + + + // make the HTTP request + var localVarResponse = await this.AsynchronousClient.GetAsync("/query/style_form/explode_false/array_string", localVarRequestOptions, this.Configuration, cancellationToken).ConfigureAwait(false); + + if (this.ExceptionFactory != null) + { + Exception _exception = this.ExceptionFactory("TestQueryStyleFormExplodeFalseArrayString", localVarResponse); + if (_exception != null) + { + throw _exception; + } + } + + return localVarResponse; + } + /// /// Test query parameter(s) Test query parameter(s) /// diff --git a/samples/client/echo_api/go/README.md b/samples/client/echo_api/go/README.md index 2f5df82beb0a..8baafbcbe1e4 100644 --- a/samples/client/echo_api/go/README.md +++ b/samples/client/echo_api/go/README.md @@ -97,6 +97,8 @@ Class | Method | HTTP request | Description *QueryAPI* | [**TestQueryIntegerBooleanString**](docs/QueryAPI.md#testqueryintegerbooleanstring) | **Get** /query/integer/boolean/string | Test query parameter(s) *QueryAPI* | [**TestQueryStyleDeepObjectExplodeTrueObject**](docs/QueryAPI.md#testquerystyledeepobjectexplodetrueobject) | **Get** /query/style_deepObject/explode_true/object | Test query parameter(s) *QueryAPI* | [**TestQueryStyleDeepObjectExplodeTrueObjectAllOf**](docs/QueryAPI.md#testquerystyledeepobjectexplodetrueobjectallof) | **Get** /query/style_deepObject/explode_true/object/allOf | Test query parameter(s) +*QueryAPI* | [**TestQueryStyleFormExplodeFalseArrayInteger**](docs/QueryAPI.md#testquerystyleformexplodefalsearrayinteger) | **Get** /query/style_form/explode_false/array_integer | Test query parameter(s) +*QueryAPI* | [**TestQueryStyleFormExplodeFalseArrayString**](docs/QueryAPI.md#testquerystyleformexplodefalsearraystring) | **Get** /query/style_form/explode_false/array_string | Test query parameter(s) *QueryAPI* | [**TestQueryStyleFormExplodeTrueArrayString**](docs/QueryAPI.md#testquerystyleformexplodetruearraystring) | **Get** /query/style_form/explode_true/array_string | Test query parameter(s) *QueryAPI* | [**TestQueryStyleFormExplodeTrueObject**](docs/QueryAPI.md#testquerystyleformexplodetrueobject) | **Get** /query/style_form/explode_true/object | Test query parameter(s) *QueryAPI* | [**TestQueryStyleFormExplodeTrueObjectAllOf**](docs/QueryAPI.md#testquerystyleformexplodetrueobjectallof) | **Get** /query/style_form/explode_true/object/allOf | Test query parameter(s) diff --git a/samples/client/echo_api/go/api/openapi.yaml b/samples/client/echo_api/go/api/openapi.yaml index bb31f3770bb4..749b73a2d795 100644 --- a/samples/client/echo_api/go/api/openapi.yaml +++ b/samples/client/echo_api/go/api/openapi.yaml @@ -279,6 +279,54 @@ paths: summary: Test query parameter(s) tags: - query + /query/style_form/explode_false/array_integer: + get: + description: Test query parameter(s) + operationId: test/query/style_form/explode_false/array_integer + parameters: + - explode: false + in: query + name: query_object + required: false + schema: + items: + type: integer + type: array + style: form + responses: + "200": + content: + text/plain: + schema: + type: string + description: Successful operation + summary: Test query parameter(s) + tags: + - query + /query/style_form/explode_false/array_string: + get: + description: Test query parameter(s) + operationId: test/query/style_form/explode_false/array_string + parameters: + - explode: false + in: query + name: query_object + required: false + schema: + items: + type: string + type: array + style: form + responses: + "200": + content: + text/plain: + schema: + type: string + description: Successful operation + summary: Test query parameter(s) + tags: + - query /query/style_form/explode_true/object: get: description: Test query parameter(s) diff --git a/samples/client/echo_api/go/api_query.go b/samples/client/echo_api/go/api_query.go index 81ff6c6dc4fc..2e45bf16b6d9 100644 --- a/samples/client/echo_api/go/api_query.go +++ b/samples/client/echo_api/go/api_query.go @@ -609,6 +609,222 @@ func (a *QueryAPIService) TestQueryStyleDeepObjectExplodeTrueObjectAllOfExecute( return localVarReturnValue, localVarHTTPResponse, nil } +type ApiTestQueryStyleFormExplodeFalseArrayIntegerRequest struct { + ctx context.Context + ApiService *QueryAPIService + queryObject *[]int32 +} + +func (r ApiTestQueryStyleFormExplodeFalseArrayIntegerRequest) QueryObject(queryObject []int32) ApiTestQueryStyleFormExplodeFalseArrayIntegerRequest { + r.queryObject = &queryObject + return r +} + +func (r ApiTestQueryStyleFormExplodeFalseArrayIntegerRequest) Execute() (string, *http.Response, error) { + return r.ApiService.TestQueryStyleFormExplodeFalseArrayIntegerExecute(r) +} + +/* +TestQueryStyleFormExplodeFalseArrayInteger Test query parameter(s) + +Test query parameter(s) + + @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). + @return ApiTestQueryStyleFormExplodeFalseArrayIntegerRequest +*/ +func (a *QueryAPIService) TestQueryStyleFormExplodeFalseArrayInteger(ctx context.Context) ApiTestQueryStyleFormExplodeFalseArrayIntegerRequest { + return ApiTestQueryStyleFormExplodeFalseArrayIntegerRequest{ + ApiService: a, + ctx: ctx, + } +} + +// Execute executes the request +// @return string +func (a *QueryAPIService) TestQueryStyleFormExplodeFalseArrayIntegerExecute(r ApiTestQueryStyleFormExplodeFalseArrayIntegerRequest) (string, *http.Response, error) { + var ( + localVarHTTPMethod = http.MethodGet + localVarPostBody interface{} + formFiles []formFile + localVarReturnValue string + ) + + localBasePath, err := a.client.cfg.ServerURLWithContext(r.ctx, "QueryAPIService.TestQueryStyleFormExplodeFalseArrayInteger") + if err != nil { + return localVarReturnValue, nil, &GenericOpenAPIError{error: err.Error()} + } + + localVarPath := localBasePath + "/query/style_form/explode_false/array_integer" + + localVarHeaderParams := make(map[string]string) + localVarQueryParams := url.Values{} + localVarFormParams := url.Values{} + + if r.queryObject != nil { + parameterAddToHeaderOrQuery(localVarQueryParams, "query_object", r.queryObject, "csv") + } + // to determine the Content-Type header + localVarHTTPContentTypes := []string{} + + // set Content-Type header + localVarHTTPContentType := selectHeaderContentType(localVarHTTPContentTypes) + if localVarHTTPContentType != "" { + localVarHeaderParams["Content-Type"] = localVarHTTPContentType + } + + // to determine the Accept header + localVarHTTPHeaderAccepts := []string{"text/plain"} + + // set Accept header + localVarHTTPHeaderAccept := selectHeaderAccept(localVarHTTPHeaderAccepts) + if localVarHTTPHeaderAccept != "" { + localVarHeaderParams["Accept"] = localVarHTTPHeaderAccept + } + req, err := a.client.prepareRequest(r.ctx, localVarPath, localVarHTTPMethod, localVarPostBody, localVarHeaderParams, localVarQueryParams, localVarFormParams, formFiles) + if err != nil { + return localVarReturnValue, nil, err + } + + localVarHTTPResponse, err := a.client.callAPI(req) + if err != nil || localVarHTTPResponse == nil { + return localVarReturnValue, localVarHTTPResponse, err + } + + localVarBody, err := io.ReadAll(localVarHTTPResponse.Body) + localVarHTTPResponse.Body.Close() + localVarHTTPResponse.Body = io.NopCloser(bytes.NewBuffer(localVarBody)) + if err != nil { + return localVarReturnValue, localVarHTTPResponse, err + } + + if localVarHTTPResponse.StatusCode >= 300 { + newErr := &GenericOpenAPIError{ + body: localVarBody, + error: localVarHTTPResponse.Status, + } + return localVarReturnValue, localVarHTTPResponse, newErr + } + + err = a.client.decode(&localVarReturnValue, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr := &GenericOpenAPIError{ + body: localVarBody, + error: err.Error(), + } + return localVarReturnValue, localVarHTTPResponse, newErr + } + + return localVarReturnValue, localVarHTTPResponse, nil +} + +type ApiTestQueryStyleFormExplodeFalseArrayStringRequest struct { + ctx context.Context + ApiService *QueryAPIService + queryObject *[]string +} + +func (r ApiTestQueryStyleFormExplodeFalseArrayStringRequest) QueryObject(queryObject []string) ApiTestQueryStyleFormExplodeFalseArrayStringRequest { + r.queryObject = &queryObject + return r +} + +func (r ApiTestQueryStyleFormExplodeFalseArrayStringRequest) Execute() (string, *http.Response, error) { + return r.ApiService.TestQueryStyleFormExplodeFalseArrayStringExecute(r) +} + +/* +TestQueryStyleFormExplodeFalseArrayString Test query parameter(s) + +Test query parameter(s) + + @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). + @return ApiTestQueryStyleFormExplodeFalseArrayStringRequest +*/ +func (a *QueryAPIService) TestQueryStyleFormExplodeFalseArrayString(ctx context.Context) ApiTestQueryStyleFormExplodeFalseArrayStringRequest { + return ApiTestQueryStyleFormExplodeFalseArrayStringRequest{ + ApiService: a, + ctx: ctx, + } +} + +// Execute executes the request +// @return string +func (a *QueryAPIService) TestQueryStyleFormExplodeFalseArrayStringExecute(r ApiTestQueryStyleFormExplodeFalseArrayStringRequest) (string, *http.Response, error) { + var ( + localVarHTTPMethod = http.MethodGet + localVarPostBody interface{} + formFiles []formFile + localVarReturnValue string + ) + + localBasePath, err := a.client.cfg.ServerURLWithContext(r.ctx, "QueryAPIService.TestQueryStyleFormExplodeFalseArrayString") + if err != nil { + return localVarReturnValue, nil, &GenericOpenAPIError{error: err.Error()} + } + + localVarPath := localBasePath + "/query/style_form/explode_false/array_string" + + localVarHeaderParams := make(map[string]string) + localVarQueryParams := url.Values{} + localVarFormParams := url.Values{} + + if r.queryObject != nil { + parameterAddToHeaderOrQuery(localVarQueryParams, "query_object", r.queryObject, "csv") + } + // to determine the Content-Type header + localVarHTTPContentTypes := []string{} + + // set Content-Type header + localVarHTTPContentType := selectHeaderContentType(localVarHTTPContentTypes) + if localVarHTTPContentType != "" { + localVarHeaderParams["Content-Type"] = localVarHTTPContentType + } + + // to determine the Accept header + localVarHTTPHeaderAccepts := []string{"text/plain"} + + // set Accept header + localVarHTTPHeaderAccept := selectHeaderAccept(localVarHTTPHeaderAccepts) + if localVarHTTPHeaderAccept != "" { + localVarHeaderParams["Accept"] = localVarHTTPHeaderAccept + } + req, err := a.client.prepareRequest(r.ctx, localVarPath, localVarHTTPMethod, localVarPostBody, localVarHeaderParams, localVarQueryParams, localVarFormParams, formFiles) + if err != nil { + return localVarReturnValue, nil, err + } + + localVarHTTPResponse, err := a.client.callAPI(req) + if err != nil || localVarHTTPResponse == nil { + return localVarReturnValue, localVarHTTPResponse, err + } + + localVarBody, err := io.ReadAll(localVarHTTPResponse.Body) + localVarHTTPResponse.Body.Close() + localVarHTTPResponse.Body = io.NopCloser(bytes.NewBuffer(localVarBody)) + if err != nil { + return localVarReturnValue, localVarHTTPResponse, err + } + + if localVarHTTPResponse.StatusCode >= 300 { + newErr := &GenericOpenAPIError{ + body: localVarBody, + error: localVarHTTPResponse.Status, + } + return localVarReturnValue, localVarHTTPResponse, newErr + } + + err = a.client.decode(&localVarReturnValue, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr := &GenericOpenAPIError{ + body: localVarBody, + error: err.Error(), + } + return localVarReturnValue, localVarHTTPResponse, newErr + } + + return localVarReturnValue, localVarHTTPResponse, nil +} + type ApiTestQueryStyleFormExplodeTrueArrayStringRequest struct { ctx context.Context ApiService *QueryAPIService diff --git a/samples/client/echo_api/go/docs/QueryAPI.md b/samples/client/echo_api/go/docs/QueryAPI.md index 766c0c9ba8e8..a62e1eb6bbcf 100644 --- a/samples/client/echo_api/go/docs/QueryAPI.md +++ b/samples/client/echo_api/go/docs/QueryAPI.md @@ -9,6 +9,8 @@ Method | HTTP request | Description [**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) +[**TestQueryStyleFormExplodeFalseArrayInteger**](QueryAPI.md#TestQueryStyleFormExplodeFalseArrayInteger) | **Get** /query/style_form/explode_false/array_integer | Test query parameter(s) +[**TestQueryStyleFormExplodeFalseArrayString**](QueryAPI.md#TestQueryStyleFormExplodeFalseArrayString) | **Get** /query/style_form/explode_false/array_string | 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) @@ -356,6 +358,138 @@ No authorization required [[Back to README]](../README.md) +## TestQueryStyleFormExplodeFalseArrayInteger + +> string TestQueryStyleFormExplodeFalseArrayInteger(ctx).QueryObject(queryObject).Execute() + +Test query parameter(s) + + + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + openapiclient "github.com/GIT_USER_ID/GIT_REPO_ID" +) + +func main() { + queryObject := []int32{int32(123)} // []int32 | (optional) + + configuration := openapiclient.NewConfiguration() + apiClient := openapiclient.NewAPIClient(configuration) + resp, r, err := apiClient.QueryAPI.TestQueryStyleFormExplodeFalseArrayInteger(context.Background()).QueryObject(queryObject).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `QueryAPI.TestQueryStyleFormExplodeFalseArrayInteger``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `TestQueryStyleFormExplodeFalseArrayInteger`: string + fmt.Fprintf(os.Stdout, "Response from `QueryAPI.TestQueryStyleFormExplodeFalseArrayInteger`: %v\n", resp) +} +``` + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiTestQueryStyleFormExplodeFalseArrayIntegerRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **queryObject** | **[]int32** | | + +### Return type + +**string** + +### Authorization + +No authorization required + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: text/plain + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) + + +## TestQueryStyleFormExplodeFalseArrayString + +> string TestQueryStyleFormExplodeFalseArrayString(ctx).QueryObject(queryObject).Execute() + +Test query parameter(s) + + + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + openapiclient "github.com/GIT_USER_ID/GIT_REPO_ID" +) + +func main() { + queryObject := []string{"Inner_example"} // []string | (optional) + + configuration := openapiclient.NewConfiguration() + apiClient := openapiclient.NewAPIClient(configuration) + resp, r, err := apiClient.QueryAPI.TestQueryStyleFormExplodeFalseArrayString(context.Background()).QueryObject(queryObject).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `QueryAPI.TestQueryStyleFormExplodeFalseArrayString``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `TestQueryStyleFormExplodeFalseArrayString`: string + fmt.Fprintf(os.Stdout, "Response from `QueryAPI.TestQueryStyleFormExplodeFalseArrayString`: %v\n", resp) +} +``` + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiTestQueryStyleFormExplodeFalseArrayStringRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **queryObject** | **[]string** | | + +### Return type + +**string** + +### Authorization + +No authorization required + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: text/plain + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) + + ## TestQueryStyleFormExplodeTrueArrayString > string TestQueryStyleFormExplodeTrueArrayString(ctx).QueryObject(queryObject).Execute() diff --git a/samples/client/echo_api/java/apache-httpclient/README.md b/samples/client/echo_api/java/apache-httpclient/README.md index ed181eb376c2..a665e3e5cfa3 100644 --- a/samples/client/echo_api/java/apache-httpclient/README.md +++ b/samples/client/echo_api/java/apache-httpclient/README.md @@ -130,6 +130,8 @@ Class | Method | HTTP request | Description *QueryApi* | [**testQueryIntegerBooleanString**](docs/QueryApi.md#testQueryIntegerBooleanString) | **GET** /query/integer/boolean/string | Test query parameter(s) *QueryApi* | [**testQueryStyleDeepObjectExplodeTrueObject**](docs/QueryApi.md#testQueryStyleDeepObjectExplodeTrueObject) | **GET** /query/style_deepObject/explode_true/object | Test query parameter(s) *QueryApi* | [**testQueryStyleDeepObjectExplodeTrueObjectAllOf**](docs/QueryApi.md#testQueryStyleDeepObjectExplodeTrueObjectAllOf) | **GET** /query/style_deepObject/explode_true/object/allOf | Test query parameter(s) +*QueryApi* | [**testQueryStyleFormExplodeFalseArrayInteger**](docs/QueryApi.md#testQueryStyleFormExplodeFalseArrayInteger) | **GET** /query/style_form/explode_false/array_integer | Test query parameter(s) +*QueryApi* | [**testQueryStyleFormExplodeFalseArrayString**](docs/QueryApi.md#testQueryStyleFormExplodeFalseArrayString) | **GET** /query/style_form/explode_false/array_string | Test query parameter(s) *QueryApi* | [**testQueryStyleFormExplodeTrueArrayString**](docs/QueryApi.md#testQueryStyleFormExplodeTrueArrayString) | **GET** /query/style_form/explode_true/array_string | Test query parameter(s) *QueryApi* | [**testQueryStyleFormExplodeTrueObject**](docs/QueryApi.md#testQueryStyleFormExplodeTrueObject) | **GET** /query/style_form/explode_true/object | Test query parameter(s) *QueryApi* | [**testQueryStyleFormExplodeTrueObjectAllOf**](docs/QueryApi.md#testQueryStyleFormExplodeTrueObjectAllOf) | **GET** /query/style_form/explode_true/object/allOf | Test query parameter(s) diff --git a/samples/client/echo_api/java/apache-httpclient/api/openapi.yaml b/samples/client/echo_api/java/apache-httpclient/api/openapi.yaml index f5d4fc9abbde..770ca687d7f3 100644 --- a/samples/client/echo_api/java/apache-httpclient/api/openapi.yaml +++ b/samples/client/echo_api/java/apache-httpclient/api/openapi.yaml @@ -289,6 +289,56 @@ paths: tags: - query x-accepts: text/plain + /query/style_form/explode_false/array_integer: + get: + description: Test query parameter(s) + operationId: test/query/style_form/explode_false/array_integer + parameters: + - explode: false + in: query + name: query_object + required: false + schema: + items: + type: integer + type: array + style: form + responses: + "200": + content: + text/plain: + schema: + type: string + description: Successful operation + summary: Test query parameter(s) + tags: + - query + x-accepts: text/plain + /query/style_form/explode_false/array_string: + get: + description: Test query parameter(s) + operationId: test/query/style_form/explode_false/array_string + parameters: + - explode: false + in: query + name: query_object + required: false + schema: + items: + type: string + type: array + style: form + responses: + "200": + content: + text/plain: + schema: + type: string + description: Successful operation + summary: Test query parameter(s) + tags: + - query + x-accepts: text/plain /query/style_form/explode_true/object: get: description: Test query parameter(s) diff --git a/samples/client/echo_api/java/apache-httpclient/docs/QueryApi.md b/samples/client/echo_api/java/apache-httpclient/docs/QueryApi.md index 2606c8e62ca9..45813a191fed 100644 --- a/samples/client/echo_api/java/apache-httpclient/docs/QueryApi.md +++ b/samples/client/echo_api/java/apache-httpclient/docs/QueryApi.md @@ -9,6 +9,8 @@ All URIs are relative to *http://localhost:3000* | [**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) | +| [**testQueryStyleFormExplodeFalseArrayInteger**](QueryApi.md#testQueryStyleFormExplodeFalseArrayInteger) | **GET** /query/style_form/explode_false/array_integer | Test query parameter(s) | +| [**testQueryStyleFormExplodeFalseArrayString**](QueryApi.md#testQueryStyleFormExplodeFalseArrayString) | **GET** /query/style_form/explode_false/array_string | 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) | @@ -355,6 +357,138 @@ No authorization required | **200** | Successful operation | - | +## testQueryStyleFormExplodeFalseArrayInteger + +> String testQueryStyleFormExplodeFalseArrayInteger(queryObject) + +Test query parameter(s) + +Test query parameter(s) + +### Example + +```java +// Import classes: +import org.openapitools.client.ApiClient; +import org.openapitools.client.ApiException; +import org.openapitools.client.Configuration; +import org.openapitools.client.models.*; +import org.openapitools.client.api.QueryApi; + +public class Example { + public static void main(String[] args) { + ApiClient defaultClient = Configuration.getDefaultApiClient(); + defaultClient.setBasePath("http://localhost:3000"); + + QueryApi apiInstance = new QueryApi(defaultClient); + List queryObject = Arrays.asList(); // List | + try { + String result = apiInstance.testQueryStyleFormExplodeFalseArrayInteger(queryObject); + System.out.println(result); + } catch (ApiException e) { + System.err.println("Exception when calling QueryApi#testQueryStyleFormExplodeFalseArrayInteger"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} +``` + +### Parameters + + +| Name | Type | Description | Notes | +|------------- | ------------- | ------------- | -------------| +| **queryObject** | [**List<Integer>**](Integer.md)| | [optional] | + +### Return type + +**String** + +### 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 | - | + + +## testQueryStyleFormExplodeFalseArrayString + +> String testQueryStyleFormExplodeFalseArrayString(queryObject) + +Test query parameter(s) + +Test query parameter(s) + +### Example + +```java +// Import classes: +import org.openapitools.client.ApiClient; +import org.openapitools.client.ApiException; +import org.openapitools.client.Configuration; +import org.openapitools.client.models.*; +import org.openapitools.client.api.QueryApi; + +public class Example { + public static void main(String[] args) { + ApiClient defaultClient = Configuration.getDefaultApiClient(); + defaultClient.setBasePath("http://localhost:3000"); + + QueryApi apiInstance = new QueryApi(defaultClient); + List queryObject = Arrays.asList(); // List | + try { + String result = apiInstance.testQueryStyleFormExplodeFalseArrayString(queryObject); + System.out.println(result); + } catch (ApiException e) { + System.err.println("Exception when calling QueryApi#testQueryStyleFormExplodeFalseArrayString"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} +``` + +### Parameters + + +| Name | Type | Description | Notes | +|------------- | ------------- | ------------- | -------------| +| **queryObject** | [**List<String>**](String.md)| | [optional] | + +### Return type + +**String** + +### 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 > String testQueryStyleFormExplodeTrueArrayString(queryObject) diff --git a/samples/client/echo_api/java/apache-httpclient/src/main/java/org/openapitools/client/api/QueryApi.java b/samples/client/echo_api/java/apache-httpclient/src/main/java/org/openapitools/client/api/QueryApi.java index d2a428528750..71cfe99bf264 100644 --- a/samples/client/echo_api/java/apache-httpclient/src/main/java/org/openapitools/client/api/QueryApi.java +++ b/samples/client/echo_api/java/apache-httpclient/src/main/java/org/openapitools/client/api/QueryApi.java @@ -394,6 +394,146 @@ public String testQueryStyleDeepObjectExplodeTrueObjectAllOf(TestQueryStyleDeepO + final String[] localVarAccepts = { + "text/plain" + }; + final String localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); + + final String[] localVarContentTypes = { + + }; + final String localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); + + String[] localVarAuthNames = new String[] { }; + + TypeReference localVarReturnType = new TypeReference() {}; + return apiClient.invokeAPI( + localVarPath, + "GET", + localVarQueryParams, + localVarCollectionQueryParams, + localVarQueryStringJoiner.toString(), + localVarPostBody, + localVarHeaderParams, + localVarCookieParams, + localVarFormParams, + localVarAccept, + localVarContentType, + localVarAuthNames, + localVarReturnType + ); + } + + /** + * Test query parameter(s) + * Test query parameter(s) + * @param queryObject (optional + * @return String + * @throws ApiException if fails to make API call + */ + public String testQueryStyleFormExplodeFalseArrayInteger(List queryObject) throws ApiException { + return this.testQueryStyleFormExplodeFalseArrayInteger(queryObject, Collections.emptyMap()); + } + + + /** + * Test query parameter(s) + * Test query parameter(s) + * @param queryObject (optional + * @param additionalHeaders additionalHeaders for this call + * @return String + * @throws ApiException if fails to make API call + */ + public String testQueryStyleFormExplodeFalseArrayInteger(List queryObject, Map additionalHeaders) throws ApiException { + Object localVarPostBody = null; + + // create path and map variables + String localVarPath = "/query/style_form/explode_false/array_integer"; + + StringJoiner localVarQueryStringJoiner = new StringJoiner("&"); + String localVarQueryParameterBaseName; + List localVarQueryParams = new ArrayList(); + List localVarCollectionQueryParams = new ArrayList(); + Map localVarHeaderParams = new HashMap(); + Map localVarCookieParams = new HashMap(); + Map localVarFormParams = new HashMap(); + + localVarCollectionQueryParams.addAll(apiClient.parameterToPairs("csv", "query_object", queryObject)); + + localVarHeaderParams.putAll(additionalHeaders); + + + + final String[] localVarAccepts = { + "text/plain" + }; + final String localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); + + final String[] localVarContentTypes = { + + }; + final String localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); + + String[] localVarAuthNames = new String[] { }; + + TypeReference localVarReturnType = new TypeReference() {}; + return apiClient.invokeAPI( + localVarPath, + "GET", + localVarQueryParams, + localVarCollectionQueryParams, + localVarQueryStringJoiner.toString(), + localVarPostBody, + localVarHeaderParams, + localVarCookieParams, + localVarFormParams, + localVarAccept, + localVarContentType, + localVarAuthNames, + localVarReturnType + ); + } + + /** + * Test query parameter(s) + * Test query parameter(s) + * @param queryObject (optional + * @return String + * @throws ApiException if fails to make API call + */ + public String testQueryStyleFormExplodeFalseArrayString(List queryObject) throws ApiException { + return this.testQueryStyleFormExplodeFalseArrayString(queryObject, Collections.emptyMap()); + } + + + /** + * Test query parameter(s) + * Test query parameter(s) + * @param queryObject (optional + * @param additionalHeaders additionalHeaders for this call + * @return String + * @throws ApiException if fails to make API call + */ + public String testQueryStyleFormExplodeFalseArrayString(List queryObject, Map additionalHeaders) throws ApiException { + Object localVarPostBody = null; + + // create path and map variables + String localVarPath = "/query/style_form/explode_false/array_string"; + + StringJoiner localVarQueryStringJoiner = new StringJoiner("&"); + String localVarQueryParameterBaseName; + List localVarQueryParams = new ArrayList(); + List localVarCollectionQueryParams = new ArrayList(); + Map localVarHeaderParams = new HashMap(); + Map localVarCookieParams = new HashMap(); + Map localVarFormParams = new HashMap(); + + localVarCollectionQueryParams.addAll(apiClient.parameterToPairs("csv", "query_object", queryObject)); + + localVarHeaderParams.putAll(additionalHeaders); + + + final String[] localVarAccepts = { "text/plain" }; diff --git a/samples/client/echo_api/java/feign-gson/api/openapi.yaml b/samples/client/echo_api/java/feign-gson/api/openapi.yaml index f5d4fc9abbde..770ca687d7f3 100644 --- a/samples/client/echo_api/java/feign-gson/api/openapi.yaml +++ b/samples/client/echo_api/java/feign-gson/api/openapi.yaml @@ -289,6 +289,56 @@ paths: tags: - query x-accepts: text/plain + /query/style_form/explode_false/array_integer: + get: + description: Test query parameter(s) + operationId: test/query/style_form/explode_false/array_integer + parameters: + - explode: false + in: query + name: query_object + required: false + schema: + items: + type: integer + type: array + style: form + responses: + "200": + content: + text/plain: + schema: + type: string + description: Successful operation + summary: Test query parameter(s) + tags: + - query + x-accepts: text/plain + /query/style_form/explode_false/array_string: + get: + description: Test query parameter(s) + operationId: test/query/style_form/explode_false/array_string + parameters: + - explode: false + in: query + name: query_object + required: false + schema: + items: + type: string + type: array + style: form + responses: + "200": + content: + text/plain: + schema: + type: string + description: Successful operation + summary: Test query parameter(s) + tags: + - query + x-accepts: text/plain /query/style_form/explode_true/object: get: description: Test query parameter(s) diff --git a/samples/client/echo_api/java/feign-gson/src/main/java/org/openapitools/client/api/QueryApi.java b/samples/client/echo_api/java/feign-gson/src/main/java/org/openapitools/client/api/QueryApi.java index 247b811f5c72..d7c92d3f3406 100644 --- a/samples/client/echo_api/java/feign-gson/src/main/java/org/openapitools/client/api/QueryApi.java +++ b/samples/client/echo_api/java/feign-gson/src/main/java/org/openapitools/client/api/QueryApi.java @@ -447,6 +447,160 @@ public TestQueryStyleDeepObjectExplodeTrueObjectAllOfQueryParams queryObject(fin } } + /** + * Test query parameter(s) + * Test query parameter(s) + * @param queryObject (optional) + * @return String + */ + @RequestLine("GET /query/style_form/explode_false/array_integer?query_object={queryObject}") + @Headers({ + "Accept: text/plain", + }) + String testQueryStyleFormExplodeFalseArrayInteger(@Param("queryObject") List queryObject); + + /** + * Test query parameter(s) + * Similar to testQueryStyleFormExplodeFalseArrayInteger but it also returns the http response headers . + * Test query parameter(s) + * @param queryObject (optional) + * @return A ApiResponse that wraps the response boyd and the http headers. + */ + @RequestLine("GET /query/style_form/explode_false/array_integer?query_object={queryObject}") + @Headers({ + "Accept: text/plain", + }) + ApiResponse testQueryStyleFormExplodeFalseArrayIntegerWithHttpInfo(@Param("queryObject") List queryObject); + + + /** + * Test query parameter(s) + * Test query parameter(s) + * Note, this is equivalent to the other testQueryStyleFormExplodeFalseArrayInteger method, + * but with the query parameters collected into a single Map parameter. This + * is convenient for services with optional query parameters, especially when + * used with the {@link TestQueryStyleFormExplodeFalseArrayIntegerQueryParams} class that allows for + * building up this map in a fluent style. + * @param queryParams Map of query parameters as name-value pairs + *

The following elements may be specified in the query map:

+ *
    + *
  • queryObject - (optional)
    • + *
+ * @return String + */ + @RequestLine("GET /query/style_form/explode_false/array_integer?query_object={queryObject}") + @Headers({ + "Accept: text/plain", + }) + String testQueryStyleFormExplodeFalseArrayInteger(@QueryMap(encoded=true) TestQueryStyleFormExplodeFalseArrayIntegerQueryParams queryParams); + + /** + * Test query parameter(s) + * Test query parameter(s) + * Note, this is equivalent to the other testQueryStyleFormExplodeFalseArrayInteger that receives the query parameters as a map, + * but this one also exposes the Http response headers + * @param queryParams Map of query parameters as name-value pairs + *

The following elements may be specified in the query map:

+ *
    + *
  • queryObject - (optional)
    • + *
+ * @return String + */ + @RequestLine("GET /query/style_form/explode_false/array_integer?query_object={queryObject}") + @Headers({ + "Accept: text/plain", + }) + ApiResponse testQueryStyleFormExplodeFalseArrayIntegerWithHttpInfo(@QueryMap(encoded=true) TestQueryStyleFormExplodeFalseArrayIntegerQueryParams queryParams); + + + /** + * A convenience class for generating query parameters for the + * testQueryStyleFormExplodeFalseArrayInteger method in a fluent style. + */ + public static class TestQueryStyleFormExplodeFalseArrayIntegerQueryParams extends HashMap { + public TestQueryStyleFormExplodeFalseArrayIntegerQueryParams queryObject(final List value) { + put("query_object", EncodingUtils.encodeCollection(value, "csv")); + return this; + } + } + + /** + * Test query parameter(s) + * Test query parameter(s) + * @param queryObject (optional) + * @return String + */ + @RequestLine("GET /query/style_form/explode_false/array_string?query_object={queryObject}") + @Headers({ + "Accept: text/plain", + }) + String testQueryStyleFormExplodeFalseArrayString(@Param("queryObject") List queryObject); + + /** + * Test query parameter(s) + * Similar to testQueryStyleFormExplodeFalseArrayString but it also returns the http response headers . + * Test query parameter(s) + * @param queryObject (optional) + * @return A ApiResponse that wraps the response boyd and the http headers. + */ + @RequestLine("GET /query/style_form/explode_false/array_string?query_object={queryObject}") + @Headers({ + "Accept: text/plain", + }) + ApiResponse testQueryStyleFormExplodeFalseArrayStringWithHttpInfo(@Param("queryObject") List queryObject); + + + /** + * Test query parameter(s) + * Test query parameter(s) + * Note, this is equivalent to the other testQueryStyleFormExplodeFalseArrayString method, + * but with the query parameters collected into a single Map parameter. This + * is convenient for services with optional query parameters, especially when + * used with the {@link TestQueryStyleFormExplodeFalseArrayStringQueryParams} class that allows for + * building up this map in a fluent style. + * @param queryParams Map of query parameters as name-value pairs + *

The following elements may be specified in the query map:

+ *
    + *
  • queryObject - (optional)
    • + *
+ * @return String + */ + @RequestLine("GET /query/style_form/explode_false/array_string?query_object={queryObject}") + @Headers({ + "Accept: text/plain", + }) + String testQueryStyleFormExplodeFalseArrayString(@QueryMap(encoded=true) TestQueryStyleFormExplodeFalseArrayStringQueryParams queryParams); + + /** + * Test query parameter(s) + * Test query parameter(s) + * Note, this is equivalent to the other testQueryStyleFormExplodeFalseArrayString that receives the query parameters as a map, + * but this one also exposes the Http response headers + * @param queryParams Map of query parameters as name-value pairs + *

The following elements may be specified in the query map:

+ *
    + *
  • queryObject - (optional)
    • + *
+ * @return String + */ + @RequestLine("GET /query/style_form/explode_false/array_string?query_object={queryObject}") + @Headers({ + "Accept: text/plain", + }) + ApiResponse testQueryStyleFormExplodeFalseArrayStringWithHttpInfo(@QueryMap(encoded=true) TestQueryStyleFormExplodeFalseArrayStringQueryParams queryParams); + + + /** + * A convenience class for generating query parameters for the + * testQueryStyleFormExplodeFalseArrayString method in a fluent style. + */ + public static class TestQueryStyleFormExplodeFalseArrayStringQueryParams extends HashMap { + public TestQueryStyleFormExplodeFalseArrayStringQueryParams queryObject(final List value) { + put("query_object", EncodingUtils.encodeCollection(value, "csv")); + return this; + } + } + /** * Test query parameter(s) * Test query parameter(s) diff --git a/samples/client/echo_api/java/native/README.md b/samples/client/echo_api/java/native/README.md index 4c8dec19ee26..2f33a12f9fc6 100644 --- a/samples/client/echo_api/java/native/README.md +++ b/samples/client/echo_api/java/native/README.md @@ -144,6 +144,10 @@ Class | Method | HTTP request | Description *QueryApi* | [**testQueryStyleDeepObjectExplodeTrueObjectWithHttpInfo**](docs/QueryApi.md#testQueryStyleDeepObjectExplodeTrueObjectWithHttpInfo) | **GET** /query/style_deepObject/explode_true/object | Test query parameter(s) *QueryApi* | [**testQueryStyleDeepObjectExplodeTrueObjectAllOf**](docs/QueryApi.md#testQueryStyleDeepObjectExplodeTrueObjectAllOf) | **GET** /query/style_deepObject/explode_true/object/allOf | Test query parameter(s) *QueryApi* | [**testQueryStyleDeepObjectExplodeTrueObjectAllOfWithHttpInfo**](docs/QueryApi.md#testQueryStyleDeepObjectExplodeTrueObjectAllOfWithHttpInfo) | **GET** /query/style_deepObject/explode_true/object/allOf | Test query parameter(s) +*QueryApi* | [**testQueryStyleFormExplodeFalseArrayInteger**](docs/QueryApi.md#testQueryStyleFormExplodeFalseArrayInteger) | **GET** /query/style_form/explode_false/array_integer | Test query parameter(s) +*QueryApi* | [**testQueryStyleFormExplodeFalseArrayIntegerWithHttpInfo**](docs/QueryApi.md#testQueryStyleFormExplodeFalseArrayIntegerWithHttpInfo) | **GET** /query/style_form/explode_false/array_integer | Test query parameter(s) +*QueryApi* | [**testQueryStyleFormExplodeFalseArrayString**](docs/QueryApi.md#testQueryStyleFormExplodeFalseArrayString) | **GET** /query/style_form/explode_false/array_string | Test query parameter(s) +*QueryApi* | [**testQueryStyleFormExplodeFalseArrayStringWithHttpInfo**](docs/QueryApi.md#testQueryStyleFormExplodeFalseArrayStringWithHttpInfo) | **GET** /query/style_form/explode_false/array_string | Test query parameter(s) *QueryApi* | [**testQueryStyleFormExplodeTrueArrayString**](docs/QueryApi.md#testQueryStyleFormExplodeTrueArrayString) | **GET** /query/style_form/explode_true/array_string | Test query parameter(s) *QueryApi* | [**testQueryStyleFormExplodeTrueArrayStringWithHttpInfo**](docs/QueryApi.md#testQueryStyleFormExplodeTrueArrayStringWithHttpInfo) | **GET** /query/style_form/explode_true/array_string | Test query parameter(s) *QueryApi* | [**testQueryStyleFormExplodeTrueObject**](docs/QueryApi.md#testQueryStyleFormExplodeTrueObject) | **GET** /query/style_form/explode_true/object | Test query parameter(s) diff --git a/samples/client/echo_api/java/native/api/openapi.yaml b/samples/client/echo_api/java/native/api/openapi.yaml index f5d4fc9abbde..770ca687d7f3 100644 --- a/samples/client/echo_api/java/native/api/openapi.yaml +++ b/samples/client/echo_api/java/native/api/openapi.yaml @@ -289,6 +289,56 @@ paths: tags: - query x-accepts: text/plain + /query/style_form/explode_false/array_integer: + get: + description: Test query parameter(s) + operationId: test/query/style_form/explode_false/array_integer + parameters: + - explode: false + in: query + name: query_object + required: false + schema: + items: + type: integer + type: array + style: form + responses: + "200": + content: + text/plain: + schema: + type: string + description: Successful operation + summary: Test query parameter(s) + tags: + - query + x-accepts: text/plain + /query/style_form/explode_false/array_string: + get: + description: Test query parameter(s) + operationId: test/query/style_form/explode_false/array_string + parameters: + - explode: false + in: query + name: query_object + required: false + schema: + items: + type: string + type: array + style: form + responses: + "200": + content: + text/plain: + schema: + type: string + description: Successful operation + summary: Test query parameter(s) + tags: + - query + x-accepts: text/plain /query/style_form/explode_true/object: get: description: Test query parameter(s) diff --git a/samples/client/echo_api/java/native/docs/QueryApi.md b/samples/client/echo_api/java/native/docs/QueryApi.md index 136a1b045768..5d29a7640be3 100644 --- a/samples/client/echo_api/java/native/docs/QueryApi.md +++ b/samples/client/echo_api/java/native/docs/QueryApi.md @@ -14,6 +14,10 @@ All URIs are relative to *http://localhost:3000* | [**testQueryStyleDeepObjectExplodeTrueObjectWithHttpInfo**](QueryApi.md#testQueryStyleDeepObjectExplodeTrueObjectWithHttpInfo) | **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) | | [**testQueryStyleDeepObjectExplodeTrueObjectAllOfWithHttpInfo**](QueryApi.md#testQueryStyleDeepObjectExplodeTrueObjectAllOfWithHttpInfo) | **GET** /query/style_deepObject/explode_true/object/allOf | Test query parameter(s) | +| [**testQueryStyleFormExplodeFalseArrayInteger**](QueryApi.md#testQueryStyleFormExplodeFalseArrayInteger) | **GET** /query/style_form/explode_false/array_integer | Test query parameter(s) | +| [**testQueryStyleFormExplodeFalseArrayIntegerWithHttpInfo**](QueryApi.md#testQueryStyleFormExplodeFalseArrayIntegerWithHttpInfo) | **GET** /query/style_form/explode_false/array_integer | Test query parameter(s) | +| [**testQueryStyleFormExplodeFalseArrayString**](QueryApi.md#testQueryStyleFormExplodeFalseArrayString) | **GET** /query/style_form/explode_false/array_string | Test query parameter(s) | +| [**testQueryStyleFormExplodeFalseArrayStringWithHttpInfo**](QueryApi.md#testQueryStyleFormExplodeFalseArrayStringWithHttpInfo) | **GET** /query/style_form/explode_false/array_string | Test query parameter(s) | | [**testQueryStyleFormExplodeTrueArrayString**](QueryApi.md#testQueryStyleFormExplodeTrueArrayString) | **GET** /query/style_form/explode_true/array_string | Test query parameter(s) | | [**testQueryStyleFormExplodeTrueArrayStringWithHttpInfo**](QueryApi.md#testQueryStyleFormExplodeTrueArrayStringWithHttpInfo) | **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) | @@ -713,6 +717,274 @@ No authorization required | **200** | Successful operation | - | +## testQueryStyleFormExplodeFalseArrayInteger + +> String testQueryStyleFormExplodeFalseArrayInteger(queryObject) + +Test query parameter(s) + +Test query parameter(s) + +### Example + +```java +// Import classes: +import org.openapitools.client.ApiClient; +import org.openapitools.client.ApiException; +import org.openapitools.client.Configuration; +import org.openapitools.client.models.*; +import org.openapitools.client.api.QueryApi; + +public class Example { + public static void main(String[] args) { + ApiClient defaultClient = Configuration.getDefaultApiClient(); + defaultClient.setBasePath("http://localhost:3000"); + + QueryApi apiInstance = new QueryApi(defaultClient); + List queryObject = Arrays.asList(); // List | + try { + String result = apiInstance.testQueryStyleFormExplodeFalseArrayInteger(queryObject); + System.out.println(result); + } catch (ApiException e) { + System.err.println("Exception when calling QueryApi#testQueryStyleFormExplodeFalseArrayInteger"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} +``` + +### Parameters + + +| Name | Type | Description | Notes | +|------------- | ------------- | ------------- | -------------| +| **queryObject** | [**List<Integer>**](Integer.md)| | [optional] | + +### Return type + +**String** + + +### 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 | - | + +## testQueryStyleFormExplodeFalseArrayIntegerWithHttpInfo + +> ApiResponse testQueryStyleFormExplodeFalseArrayInteger testQueryStyleFormExplodeFalseArrayIntegerWithHttpInfo(queryObject) + +Test query parameter(s) + +Test query parameter(s) + +### Example + +```java +// Import classes: +import org.openapitools.client.ApiClient; +import org.openapitools.client.ApiException; +import org.openapitools.client.ApiResponse; +import org.openapitools.client.Configuration; +import org.openapitools.client.models.*; +import org.openapitools.client.api.QueryApi; + +public class Example { + public static void main(String[] args) { + ApiClient defaultClient = Configuration.getDefaultApiClient(); + defaultClient.setBasePath("http://localhost:3000"); + + QueryApi apiInstance = new QueryApi(defaultClient); + List queryObject = Arrays.asList(); // List | + try { + ApiResponse response = apiInstance.testQueryStyleFormExplodeFalseArrayIntegerWithHttpInfo(queryObject); + System.out.println("Status code: " + response.getStatusCode()); + System.out.println("Response headers: " + response.getHeaders()); + System.out.println("Response body: " + response.getData()); + } catch (ApiException e) { + System.err.println("Exception when calling QueryApi#testQueryStyleFormExplodeFalseArrayInteger"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Response headers: " + e.getResponseHeaders()); + System.err.println("Reason: " + e.getResponseBody()); + e.printStackTrace(); + } + } +} +``` + +### Parameters + + +| Name | Type | Description | Notes | +|------------- | ------------- | ------------- | -------------| +| **queryObject** | [**List<Integer>**](Integer.md)| | [optional] | + +### Return type + +ApiResponse<**String**> + + +### 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 | - | + + +## testQueryStyleFormExplodeFalseArrayString + +> String testQueryStyleFormExplodeFalseArrayString(queryObject) + +Test query parameter(s) + +Test query parameter(s) + +### Example + +```java +// Import classes: +import org.openapitools.client.ApiClient; +import org.openapitools.client.ApiException; +import org.openapitools.client.Configuration; +import org.openapitools.client.models.*; +import org.openapitools.client.api.QueryApi; + +public class Example { + public static void main(String[] args) { + ApiClient defaultClient = Configuration.getDefaultApiClient(); + defaultClient.setBasePath("http://localhost:3000"); + + QueryApi apiInstance = new QueryApi(defaultClient); + List queryObject = Arrays.asList(); // List | + try { + String result = apiInstance.testQueryStyleFormExplodeFalseArrayString(queryObject); + System.out.println(result); + } catch (ApiException e) { + System.err.println("Exception when calling QueryApi#testQueryStyleFormExplodeFalseArrayString"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} +``` + +### Parameters + + +| Name | Type | Description | Notes | +|------------- | ------------- | ------------- | -------------| +| **queryObject** | [**List<String>**](String.md)| | [optional] | + +### Return type + +**String** + + +### 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 | - | + +## testQueryStyleFormExplodeFalseArrayStringWithHttpInfo + +> ApiResponse testQueryStyleFormExplodeFalseArrayString testQueryStyleFormExplodeFalseArrayStringWithHttpInfo(queryObject) + +Test query parameter(s) + +Test query parameter(s) + +### Example + +```java +// Import classes: +import org.openapitools.client.ApiClient; +import org.openapitools.client.ApiException; +import org.openapitools.client.ApiResponse; +import org.openapitools.client.Configuration; +import org.openapitools.client.models.*; +import org.openapitools.client.api.QueryApi; + +public class Example { + public static void main(String[] args) { + ApiClient defaultClient = Configuration.getDefaultApiClient(); + defaultClient.setBasePath("http://localhost:3000"); + + QueryApi apiInstance = new QueryApi(defaultClient); + List queryObject = Arrays.asList(); // List | + try { + ApiResponse response = apiInstance.testQueryStyleFormExplodeFalseArrayStringWithHttpInfo(queryObject); + System.out.println("Status code: " + response.getStatusCode()); + System.out.println("Response headers: " + response.getHeaders()); + System.out.println("Response body: " + response.getData()); + } catch (ApiException e) { + System.err.println("Exception when calling QueryApi#testQueryStyleFormExplodeFalseArrayString"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Response headers: " + e.getResponseHeaders()); + System.err.println("Reason: " + e.getResponseBody()); + e.printStackTrace(); + } + } +} +``` + +### Parameters + + +| Name | Type | Description | Notes | +|------------- | ------------- | ------------- | -------------| +| **queryObject** | [**List<String>**](String.md)| | [optional] | + +### Return type + +ApiResponse<**String**> + + +### 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 > String testQueryStyleFormExplodeTrueArrayString(queryObject) diff --git a/samples/client/echo_api/java/native/src/main/java/org/openapitools/client/api/QueryApi.java b/samples/client/echo_api/java/native/src/main/java/org/openapitools/client/api/QueryApi.java index 9e54d9377e90..dedef3116420 100644 --- a/samples/client/echo_api/java/native/src/main/java/org/openapitools/client/api/QueryApi.java +++ b/samples/client/echo_api/java/native/src/main/java/org/openapitools/client/api/QueryApi.java @@ -567,6 +567,186 @@ private HttpRequest.Builder testQueryStyleDeepObjectExplodeTrueObjectAllOfReques } return localVarRequestBuilder; } + /** + * Test query parameter(s) + * Test query parameter(s) + * @param queryObject (optional + * @return String + * @throws ApiException if fails to make API call + */ + public String testQueryStyleFormExplodeFalseArrayInteger(List queryObject) throws ApiException { + ApiResponse localVarResponse = testQueryStyleFormExplodeFalseArrayIntegerWithHttpInfo(queryObject); + return localVarResponse.getData(); + } + + /** + * Test query parameter(s) + * Test query parameter(s) + * @param queryObject (optional + * @return ApiResponse<String> + * @throws ApiException if fails to make API call + */ + public ApiResponse testQueryStyleFormExplodeFalseArrayIntegerWithHttpInfo(List queryObject) throws ApiException { + HttpRequest.Builder localVarRequestBuilder = testQueryStyleFormExplodeFalseArrayIntegerRequestBuilder(queryObject); + try { + HttpResponse localVarResponse = memberVarHttpClient.send( + localVarRequestBuilder.build(), + HttpResponse.BodyHandlers.ofInputStream()); + if (memberVarResponseInterceptor != null) { + memberVarResponseInterceptor.accept(localVarResponse); + } + try { + if (localVarResponse.statusCode()/ 100 != 2) { + throw getApiException("testQueryStyleFormExplodeFalseArrayInteger", localVarResponse); + } + // for plain text response + if (localVarResponse.headers().map().containsKey("Content-Type") && + "text/plain".equalsIgnoreCase(localVarResponse.headers().map().get("Content-Type").get(0).split(";")[0].trim())) { + java.util.Scanner s = new java.util.Scanner(localVarResponse.body()).useDelimiter("\\A"); + String responseBodyText = s.hasNext() ? s.next() : ""; + return new ApiResponse( + localVarResponse.statusCode(), + localVarResponse.headers().map(), + responseBodyText + ); + } else { + throw new RuntimeException("Error! The response Content-Type is supposed to be `text/plain` but it's not: " + localVarResponse); + } + } finally { + } + } catch (IOException e) { + throw new ApiException(e); + } + catch (InterruptedException e) { + Thread.currentThread().interrupt(); + throw new ApiException(e); + } + } + + private HttpRequest.Builder testQueryStyleFormExplodeFalseArrayIntegerRequestBuilder(List queryObject) throws ApiException { + + HttpRequest.Builder localVarRequestBuilder = HttpRequest.newBuilder(); + + String localVarPath = "/query/style_form/explode_false/array_integer"; + + List localVarQueryParams = new ArrayList<>(); + StringJoiner localVarQueryStringJoiner = new StringJoiner("&"); + String localVarQueryParameterBaseName; + localVarQueryParameterBaseName = "query_object"; + localVarQueryParams.addAll(ApiClient.parameterToPairs("csv", "query_object", queryObject)); + + if (!localVarQueryParams.isEmpty() || localVarQueryStringJoiner.length() != 0) { + StringJoiner queryJoiner = new StringJoiner("&"); + localVarQueryParams.forEach(p -> queryJoiner.add(p.getName() + '=' + p.getValue())); + if (localVarQueryStringJoiner.length() != 0) { + queryJoiner.add(localVarQueryStringJoiner.toString()); + } + localVarRequestBuilder.uri(URI.create(memberVarBaseUri + localVarPath + '?' + queryJoiner.toString())); + } else { + localVarRequestBuilder.uri(URI.create(memberVarBaseUri + localVarPath)); + } + + localVarRequestBuilder.header("Accept", "text/plain"); + + localVarRequestBuilder.method("GET", HttpRequest.BodyPublishers.noBody()); + if (memberVarReadTimeout != null) { + localVarRequestBuilder.timeout(memberVarReadTimeout); + } + if (memberVarInterceptor != null) { + memberVarInterceptor.accept(localVarRequestBuilder); + } + return localVarRequestBuilder; + } + /** + * Test query parameter(s) + * Test query parameter(s) + * @param queryObject (optional + * @return String + * @throws ApiException if fails to make API call + */ + public String testQueryStyleFormExplodeFalseArrayString(List queryObject) throws ApiException { + ApiResponse localVarResponse = testQueryStyleFormExplodeFalseArrayStringWithHttpInfo(queryObject); + return localVarResponse.getData(); + } + + /** + * Test query parameter(s) + * Test query parameter(s) + * @param queryObject (optional + * @return ApiResponse<String> + * @throws ApiException if fails to make API call + */ + public ApiResponse testQueryStyleFormExplodeFalseArrayStringWithHttpInfo(List queryObject) throws ApiException { + HttpRequest.Builder localVarRequestBuilder = testQueryStyleFormExplodeFalseArrayStringRequestBuilder(queryObject); + try { + HttpResponse localVarResponse = memberVarHttpClient.send( + localVarRequestBuilder.build(), + HttpResponse.BodyHandlers.ofInputStream()); + if (memberVarResponseInterceptor != null) { + memberVarResponseInterceptor.accept(localVarResponse); + } + try { + if (localVarResponse.statusCode()/ 100 != 2) { + throw getApiException("testQueryStyleFormExplodeFalseArrayString", localVarResponse); + } + // for plain text response + if (localVarResponse.headers().map().containsKey("Content-Type") && + "text/plain".equalsIgnoreCase(localVarResponse.headers().map().get("Content-Type").get(0).split(";")[0].trim())) { + java.util.Scanner s = new java.util.Scanner(localVarResponse.body()).useDelimiter("\\A"); + String responseBodyText = s.hasNext() ? s.next() : ""; + return new ApiResponse( + localVarResponse.statusCode(), + localVarResponse.headers().map(), + responseBodyText + ); + } else { + throw new RuntimeException("Error! The response Content-Type is supposed to be `text/plain` but it's not: " + localVarResponse); + } + } finally { + } + } catch (IOException e) { + throw new ApiException(e); + } + catch (InterruptedException e) { + Thread.currentThread().interrupt(); + throw new ApiException(e); + } + } + + private HttpRequest.Builder testQueryStyleFormExplodeFalseArrayStringRequestBuilder(List queryObject) throws ApiException { + + HttpRequest.Builder localVarRequestBuilder = HttpRequest.newBuilder(); + + String localVarPath = "/query/style_form/explode_false/array_string"; + + List localVarQueryParams = new ArrayList<>(); + StringJoiner localVarQueryStringJoiner = new StringJoiner("&"); + String localVarQueryParameterBaseName; + localVarQueryParameterBaseName = "query_object"; + localVarQueryParams.addAll(ApiClient.parameterToPairs("csv", "query_object", queryObject)); + + if (!localVarQueryParams.isEmpty() || localVarQueryStringJoiner.length() != 0) { + StringJoiner queryJoiner = new StringJoiner("&"); + localVarQueryParams.forEach(p -> queryJoiner.add(p.getName() + '=' + p.getValue())); + if (localVarQueryStringJoiner.length() != 0) { + queryJoiner.add(localVarQueryStringJoiner.toString()); + } + localVarRequestBuilder.uri(URI.create(memberVarBaseUri + localVarPath + '?' + queryJoiner.toString())); + } else { + localVarRequestBuilder.uri(URI.create(memberVarBaseUri + localVarPath)); + } + + localVarRequestBuilder.header("Accept", "text/plain"); + + localVarRequestBuilder.method("GET", HttpRequest.BodyPublishers.noBody()); + if (memberVarReadTimeout != null) { + localVarRequestBuilder.timeout(memberVarReadTimeout); + } + if (memberVarInterceptor != null) { + memberVarInterceptor.accept(localVarRequestBuilder); + } + return localVarRequestBuilder; + } /** * Test query parameter(s) * Test query parameter(s) diff --git a/samples/client/echo_api/java/okhttp-gson/README.md b/samples/client/echo_api/java/okhttp-gson/README.md index 3f0a774aff82..e9f11220ea2f 100644 --- a/samples/client/echo_api/java/okhttp-gson/README.md +++ b/samples/client/echo_api/java/okhttp-gson/README.md @@ -138,6 +138,8 @@ Class | Method | HTTP request | Description *QueryApi* | [**testQueryIntegerBooleanString**](docs/QueryApi.md#testQueryIntegerBooleanString) | **GET** /query/integer/boolean/string | Test query parameter(s) *QueryApi* | [**testQueryStyleDeepObjectExplodeTrueObject**](docs/QueryApi.md#testQueryStyleDeepObjectExplodeTrueObject) | **GET** /query/style_deepObject/explode_true/object | Test query parameter(s) *QueryApi* | [**testQueryStyleDeepObjectExplodeTrueObjectAllOf**](docs/QueryApi.md#testQueryStyleDeepObjectExplodeTrueObjectAllOf) | **GET** /query/style_deepObject/explode_true/object/allOf | Test query parameter(s) +*QueryApi* | [**testQueryStyleFormExplodeFalseArrayInteger**](docs/QueryApi.md#testQueryStyleFormExplodeFalseArrayInteger) | **GET** /query/style_form/explode_false/array_integer | Test query parameter(s) +*QueryApi* | [**testQueryStyleFormExplodeFalseArrayString**](docs/QueryApi.md#testQueryStyleFormExplodeFalseArrayString) | **GET** /query/style_form/explode_false/array_string | Test query parameter(s) *QueryApi* | [**testQueryStyleFormExplodeTrueArrayString**](docs/QueryApi.md#testQueryStyleFormExplodeTrueArrayString) | **GET** /query/style_form/explode_true/array_string | Test query parameter(s) *QueryApi* | [**testQueryStyleFormExplodeTrueObject**](docs/QueryApi.md#testQueryStyleFormExplodeTrueObject) | **GET** /query/style_form/explode_true/object | Test query parameter(s) *QueryApi* | [**testQueryStyleFormExplodeTrueObjectAllOf**](docs/QueryApi.md#testQueryStyleFormExplodeTrueObjectAllOf) | **GET** /query/style_form/explode_true/object/allOf | Test query parameter(s) diff --git a/samples/client/echo_api/java/okhttp-gson/api/openapi.yaml b/samples/client/echo_api/java/okhttp-gson/api/openapi.yaml index f5d4fc9abbde..770ca687d7f3 100644 --- a/samples/client/echo_api/java/okhttp-gson/api/openapi.yaml +++ b/samples/client/echo_api/java/okhttp-gson/api/openapi.yaml @@ -289,6 +289,56 @@ paths: tags: - query x-accepts: text/plain + /query/style_form/explode_false/array_integer: + get: + description: Test query parameter(s) + operationId: test/query/style_form/explode_false/array_integer + parameters: + - explode: false + in: query + name: query_object + required: false + schema: + items: + type: integer + type: array + style: form + responses: + "200": + content: + text/plain: + schema: + type: string + description: Successful operation + summary: Test query parameter(s) + tags: + - query + x-accepts: text/plain + /query/style_form/explode_false/array_string: + get: + description: Test query parameter(s) + operationId: test/query/style_form/explode_false/array_string + parameters: + - explode: false + in: query + name: query_object + required: false + schema: + items: + type: string + type: array + style: form + responses: + "200": + content: + text/plain: + schema: + type: string + description: Successful operation + summary: Test query parameter(s) + tags: + - query + x-accepts: text/plain /query/style_form/explode_true/object: get: description: Test query parameter(s) diff --git a/samples/client/echo_api/java/okhttp-gson/docs/QueryApi.md b/samples/client/echo_api/java/okhttp-gson/docs/QueryApi.md index feae225f1e62..28597ee3e735 100644 --- a/samples/client/echo_api/java/okhttp-gson/docs/QueryApi.md +++ b/samples/client/echo_api/java/okhttp-gson/docs/QueryApi.md @@ -9,6 +9,8 @@ All URIs are relative to *http://localhost:3000* | [**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) | +| [**testQueryStyleFormExplodeFalseArrayInteger**](QueryApi.md#testQueryStyleFormExplodeFalseArrayInteger) | **GET** /query/style_form/explode_false/array_integer | Test query parameter(s) | +| [**testQueryStyleFormExplodeFalseArrayString**](QueryApi.md#testQueryStyleFormExplodeFalseArrayString) | **GET** /query/style_form/explode_false/array_string | 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) | @@ -334,6 +336,130 @@ No authorization required |-------------|-------------|------------------| | **200** | Successful operation | - | + +# **testQueryStyleFormExplodeFalseArrayInteger** +> String testQueryStyleFormExplodeFalseArrayInteger(queryObject) + +Test query parameter(s) + +Test query parameter(s) + +### Example +```java +// Import classes: +import org.openapitools.client.ApiClient; +import org.openapitools.client.ApiException; +import org.openapitools.client.Configuration; +import org.openapitools.client.models.*; +import org.openapitools.client.api.QueryApi; + +public class Example { + public static void main(String[] args) { + ApiClient defaultClient = Configuration.getDefaultApiClient(); + defaultClient.setBasePath("http://localhost:3000"); + + QueryApi apiInstance = new QueryApi(defaultClient); + List queryObject = Arrays.asList(); // List | + try { + String result = apiInstance.testQueryStyleFormExplodeFalseArrayInteger(queryObject); + System.out.println(result); + } catch (ApiException e) { + System.err.println("Exception when calling QueryApi#testQueryStyleFormExplodeFalseArrayInteger"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} +``` + +### Parameters + +| Name | Type | Description | Notes | +|------------- | ------------- | ------------- | -------------| +| **queryObject** | [**List<Integer>**](Integer.md)| | [optional] | + +### Return type + +**String** + +### 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 | - | + + +# **testQueryStyleFormExplodeFalseArrayString** +> String testQueryStyleFormExplodeFalseArrayString(queryObject) + +Test query parameter(s) + +Test query parameter(s) + +### Example +```java +// Import classes: +import org.openapitools.client.ApiClient; +import org.openapitools.client.ApiException; +import org.openapitools.client.Configuration; +import org.openapitools.client.models.*; +import org.openapitools.client.api.QueryApi; + +public class Example { + public static void main(String[] args) { + ApiClient defaultClient = Configuration.getDefaultApiClient(); + defaultClient.setBasePath("http://localhost:3000"); + + QueryApi apiInstance = new QueryApi(defaultClient); + List queryObject = Arrays.asList(); // List | + try { + String result = apiInstance.testQueryStyleFormExplodeFalseArrayString(queryObject); + System.out.println(result); + } catch (ApiException e) { + System.err.println("Exception when calling QueryApi#testQueryStyleFormExplodeFalseArrayString"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} +``` + +### Parameters + +| Name | Type | Description | Notes | +|------------- | ------------- | ------------- | -------------| +| **queryObject** | [**List<String>**](String.md)| | [optional] | + +### Return type + +**String** + +### 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** > String testQueryStyleFormExplodeTrueArrayString(queryObject) diff --git a/samples/client/echo_api/java/okhttp-gson/src/main/java/org/openapitools/client/api/QueryApi.java b/samples/client/echo_api/java/okhttp-gson/src/main/java/org/openapitools/client/api/QueryApi.java index 0ade6b21bcd2..368b2b7d2095 100644 --- a/samples/client/echo_api/java/okhttp-gson/src/main/java/org/openapitools/client/api/QueryApi.java +++ b/samples/client/echo_api/java/okhttp-gson/src/main/java/org/openapitools/client/api/QueryApi.java @@ -723,6 +723,248 @@ public okhttp3.Call testQueryStyleDeepObjectExplodeTrueObjectAllOfAsync(TestQuer localVarApiClient.executeAsync(localVarCall, localVarReturnType, _callback); return localVarCall; } + /** + * Build call for testQueryStyleFormExplodeFalseArrayInteger + * @param queryObject (optional) + * @param _callback Callback for upload/download progress + * @return Call to execute + * @throws ApiException If fail to serialize the request body object + * @http.response.details + + + +
Status Code Description Response Headers
200 Successful operation -
+ */ + public okhttp3.Call testQueryStyleFormExplodeFalseArrayIntegerCall(List queryObject, final ApiCallback _callback) throws ApiException { + String basePath = null; + // Operation Servers + String[] localBasePaths = new String[] { }; + + // Determine Base Path to Use + if (localCustomBaseUrl != null){ + basePath = localCustomBaseUrl; + } else if ( localBasePaths.length > 0 ) { + basePath = localBasePaths[localHostIndex]; + } else { + basePath = null; + } + + Object localVarPostBody = null; + + // create path and map variables + String localVarPath = "/query/style_form/explode_false/array_integer"; + + List localVarQueryParams = new ArrayList(); + List localVarCollectionQueryParams = new ArrayList(); + Map localVarHeaderParams = new HashMap(); + Map localVarCookieParams = new HashMap(); + Map localVarFormParams = new HashMap(); + + if (queryObject != null) { + localVarCollectionQueryParams.addAll(localVarApiClient.parameterToPairs("csv", "query_object", queryObject)); + } + + final String[] localVarAccepts = { + "text/plain" + }; + final String localVarAccept = localVarApiClient.selectHeaderAccept(localVarAccepts); + if (localVarAccept != null) { + localVarHeaderParams.put("Accept", localVarAccept); + } + + final String[] localVarContentTypes = { + }; + final String localVarContentType = localVarApiClient.selectHeaderContentType(localVarContentTypes); + if (localVarContentType != null) { + localVarHeaderParams.put("Content-Type", localVarContentType); + } + + String[] localVarAuthNames = new String[] { }; + return localVarApiClient.buildCall(basePath, localVarPath, "GET", localVarQueryParams, localVarCollectionQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAuthNames, _callback); + } + + @SuppressWarnings("rawtypes") + private okhttp3.Call testQueryStyleFormExplodeFalseArrayIntegerValidateBeforeCall(List queryObject, final ApiCallback _callback) throws ApiException { + return testQueryStyleFormExplodeFalseArrayIntegerCall(queryObject, _callback); + + } + + /** + * Test query parameter(s) + * Test query parameter(s) + * @param queryObject (optional) + * @return String + * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body + * @http.response.details + + + +
Status Code Description Response Headers
200 Successful operation -
+ */ + public String testQueryStyleFormExplodeFalseArrayInteger(List queryObject) throws ApiException { + ApiResponse localVarResp = testQueryStyleFormExplodeFalseArrayIntegerWithHttpInfo(queryObject); + return localVarResp.getData(); + } + + /** + * Test query parameter(s) + * Test query parameter(s) + * @param queryObject (optional) + * @return ApiResponse<String> + * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body + * @http.response.details + + + +
Status Code Description Response Headers
200 Successful operation -
+ */ + public ApiResponse testQueryStyleFormExplodeFalseArrayIntegerWithHttpInfo(List queryObject) throws ApiException { + okhttp3.Call localVarCall = testQueryStyleFormExplodeFalseArrayIntegerValidateBeforeCall(queryObject, null); + Type localVarReturnType = new TypeToken(){}.getType(); + return localVarApiClient.execute(localVarCall, localVarReturnType); + } + + /** + * Test query parameter(s) (asynchronously) + * Test query parameter(s) + * @param queryObject (optional) + * @param _callback The callback to be executed when the API call finishes + * @return The request call + * @throws ApiException If fail to process the API call, e.g. serializing the request body object + * @http.response.details + + + +
Status Code Description Response Headers
200 Successful operation -
+ */ + public okhttp3.Call testQueryStyleFormExplodeFalseArrayIntegerAsync(List queryObject, final ApiCallback _callback) throws ApiException { + + okhttp3.Call localVarCall = testQueryStyleFormExplodeFalseArrayIntegerValidateBeforeCall(queryObject, _callback); + Type localVarReturnType = new TypeToken(){}.getType(); + localVarApiClient.executeAsync(localVarCall, localVarReturnType, _callback); + return localVarCall; + } + /** + * Build call for testQueryStyleFormExplodeFalseArrayString + * @param queryObject (optional) + * @param _callback Callback for upload/download progress + * @return Call to execute + * @throws ApiException If fail to serialize the request body object + * @http.response.details + + + +
Status Code Description Response Headers
200 Successful operation -
+ */ + public okhttp3.Call testQueryStyleFormExplodeFalseArrayStringCall(List queryObject, final ApiCallback _callback) throws ApiException { + String basePath = null; + // Operation Servers + String[] localBasePaths = new String[] { }; + + // Determine Base Path to Use + if (localCustomBaseUrl != null){ + basePath = localCustomBaseUrl; + } else if ( localBasePaths.length > 0 ) { + basePath = localBasePaths[localHostIndex]; + } else { + basePath = null; + } + + Object localVarPostBody = null; + + // create path and map variables + String localVarPath = "/query/style_form/explode_false/array_string"; + + List localVarQueryParams = new ArrayList(); + List localVarCollectionQueryParams = new ArrayList(); + Map localVarHeaderParams = new HashMap(); + Map localVarCookieParams = new HashMap(); + Map localVarFormParams = new HashMap(); + + if (queryObject != null) { + localVarCollectionQueryParams.addAll(localVarApiClient.parameterToPairs("csv", "query_object", queryObject)); + } + + final String[] localVarAccepts = { + "text/plain" + }; + final String localVarAccept = localVarApiClient.selectHeaderAccept(localVarAccepts); + if (localVarAccept != null) { + localVarHeaderParams.put("Accept", localVarAccept); + } + + final String[] localVarContentTypes = { + }; + final String localVarContentType = localVarApiClient.selectHeaderContentType(localVarContentTypes); + if (localVarContentType != null) { + localVarHeaderParams.put("Content-Type", localVarContentType); + } + + String[] localVarAuthNames = new String[] { }; + return localVarApiClient.buildCall(basePath, localVarPath, "GET", localVarQueryParams, localVarCollectionQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAuthNames, _callback); + } + + @SuppressWarnings("rawtypes") + private okhttp3.Call testQueryStyleFormExplodeFalseArrayStringValidateBeforeCall(List queryObject, final ApiCallback _callback) throws ApiException { + return testQueryStyleFormExplodeFalseArrayStringCall(queryObject, _callback); + + } + + /** + * Test query parameter(s) + * Test query parameter(s) + * @param queryObject (optional) + * @return String + * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body + * @http.response.details + + + +
Status Code Description Response Headers
200 Successful operation -
+ */ + public String testQueryStyleFormExplodeFalseArrayString(List queryObject) throws ApiException { + ApiResponse localVarResp = testQueryStyleFormExplodeFalseArrayStringWithHttpInfo(queryObject); + return localVarResp.getData(); + } + + /** + * Test query parameter(s) + * Test query parameter(s) + * @param queryObject (optional) + * @return ApiResponse<String> + * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body + * @http.response.details + + + +
Status Code Description Response Headers
200 Successful operation -
+ */ + public ApiResponse testQueryStyleFormExplodeFalseArrayStringWithHttpInfo(List queryObject) throws ApiException { + okhttp3.Call localVarCall = testQueryStyleFormExplodeFalseArrayStringValidateBeforeCall(queryObject, null); + Type localVarReturnType = new TypeToken(){}.getType(); + return localVarApiClient.execute(localVarCall, localVarReturnType); + } + + /** + * Test query parameter(s) (asynchronously) + * Test query parameter(s) + * @param queryObject (optional) + * @param _callback The callback to be executed when the API call finishes + * @return The request call + * @throws ApiException If fail to process the API call, e.g. serializing the request body object + * @http.response.details + + + +
Status Code Description Response Headers
200 Successful operation -
+ */ + public okhttp3.Call testQueryStyleFormExplodeFalseArrayStringAsync(List queryObject, final ApiCallback _callback) throws ApiException { + + okhttp3.Call localVarCall = testQueryStyleFormExplodeFalseArrayStringValidateBeforeCall(queryObject, _callback); + Type localVarReturnType = new TypeToken(){}.getType(); + localVarApiClient.executeAsync(localVarCall, localVarReturnType, _callback); + return localVarCall; + } /** * Build call for testQueryStyleFormExplodeTrueArrayString * @param queryObject (optional) diff --git a/samples/client/echo_api/java/resteasy/README.md b/samples/client/echo_api/java/resteasy/README.md index 2c53ad7593f9..4699843041d3 100644 --- a/samples/client/echo_api/java/resteasy/README.md +++ b/samples/client/echo_api/java/resteasy/README.md @@ -137,6 +137,8 @@ Class | Method | HTTP request | Description *QueryApi* | [**testQueryIntegerBooleanString**](docs/QueryApi.md#testQueryIntegerBooleanString) | **GET** /query/integer/boolean/string | Test query parameter(s) *QueryApi* | [**testQueryStyleDeepObjectExplodeTrueObject**](docs/QueryApi.md#testQueryStyleDeepObjectExplodeTrueObject) | **GET** /query/style_deepObject/explode_true/object | Test query parameter(s) *QueryApi* | [**testQueryStyleDeepObjectExplodeTrueObjectAllOf**](docs/QueryApi.md#testQueryStyleDeepObjectExplodeTrueObjectAllOf) | **GET** /query/style_deepObject/explode_true/object/allOf | Test query parameter(s) +*QueryApi* | [**testQueryStyleFormExplodeFalseArrayInteger**](docs/QueryApi.md#testQueryStyleFormExplodeFalseArrayInteger) | **GET** /query/style_form/explode_false/array_integer | Test query parameter(s) +*QueryApi* | [**testQueryStyleFormExplodeFalseArrayString**](docs/QueryApi.md#testQueryStyleFormExplodeFalseArrayString) | **GET** /query/style_form/explode_false/array_string | Test query parameter(s) *QueryApi* | [**testQueryStyleFormExplodeTrueArrayString**](docs/QueryApi.md#testQueryStyleFormExplodeTrueArrayString) | **GET** /query/style_form/explode_true/array_string | Test query parameter(s) *QueryApi* | [**testQueryStyleFormExplodeTrueObject**](docs/QueryApi.md#testQueryStyleFormExplodeTrueObject) | **GET** /query/style_form/explode_true/object | Test query parameter(s) *QueryApi* | [**testQueryStyleFormExplodeTrueObjectAllOf**](docs/QueryApi.md#testQueryStyleFormExplodeTrueObjectAllOf) | **GET** /query/style_form/explode_true/object/allOf | Test query parameter(s) diff --git a/samples/client/echo_api/java/resteasy/api/openapi.yaml b/samples/client/echo_api/java/resteasy/api/openapi.yaml index f5d4fc9abbde..770ca687d7f3 100644 --- a/samples/client/echo_api/java/resteasy/api/openapi.yaml +++ b/samples/client/echo_api/java/resteasy/api/openapi.yaml @@ -289,6 +289,56 @@ paths: tags: - query x-accepts: text/plain + /query/style_form/explode_false/array_integer: + get: + description: Test query parameter(s) + operationId: test/query/style_form/explode_false/array_integer + parameters: + - explode: false + in: query + name: query_object + required: false + schema: + items: + type: integer + type: array + style: form + responses: + "200": + content: + text/plain: + schema: + type: string + description: Successful operation + summary: Test query parameter(s) + tags: + - query + x-accepts: text/plain + /query/style_form/explode_false/array_string: + get: + description: Test query parameter(s) + operationId: test/query/style_form/explode_false/array_string + parameters: + - explode: false + in: query + name: query_object + required: false + schema: + items: + type: string + type: array + style: form + responses: + "200": + content: + text/plain: + schema: + type: string + description: Successful operation + summary: Test query parameter(s) + tags: + - query + x-accepts: text/plain /query/style_form/explode_true/object: get: description: Test query parameter(s) diff --git a/samples/client/echo_api/java/resteasy/docs/QueryApi.md b/samples/client/echo_api/java/resteasy/docs/QueryApi.md index 2606c8e62ca9..45813a191fed 100644 --- a/samples/client/echo_api/java/resteasy/docs/QueryApi.md +++ b/samples/client/echo_api/java/resteasy/docs/QueryApi.md @@ -9,6 +9,8 @@ All URIs are relative to *http://localhost:3000* | [**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) | +| [**testQueryStyleFormExplodeFalseArrayInteger**](QueryApi.md#testQueryStyleFormExplodeFalseArrayInteger) | **GET** /query/style_form/explode_false/array_integer | Test query parameter(s) | +| [**testQueryStyleFormExplodeFalseArrayString**](QueryApi.md#testQueryStyleFormExplodeFalseArrayString) | **GET** /query/style_form/explode_false/array_string | 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) | @@ -355,6 +357,138 @@ No authorization required | **200** | Successful operation | - | +## testQueryStyleFormExplodeFalseArrayInteger + +> String testQueryStyleFormExplodeFalseArrayInteger(queryObject) + +Test query parameter(s) + +Test query parameter(s) + +### Example + +```java +// Import classes: +import org.openapitools.client.ApiClient; +import org.openapitools.client.ApiException; +import org.openapitools.client.Configuration; +import org.openapitools.client.models.*; +import org.openapitools.client.api.QueryApi; + +public class Example { + public static void main(String[] args) { + ApiClient defaultClient = Configuration.getDefaultApiClient(); + defaultClient.setBasePath("http://localhost:3000"); + + QueryApi apiInstance = new QueryApi(defaultClient); + List queryObject = Arrays.asList(); // List | + try { + String result = apiInstance.testQueryStyleFormExplodeFalseArrayInteger(queryObject); + System.out.println(result); + } catch (ApiException e) { + System.err.println("Exception when calling QueryApi#testQueryStyleFormExplodeFalseArrayInteger"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} +``` + +### Parameters + + +| Name | Type | Description | Notes | +|------------- | ------------- | ------------- | -------------| +| **queryObject** | [**List<Integer>**](Integer.md)| | [optional] | + +### Return type + +**String** + +### 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 | - | + + +## testQueryStyleFormExplodeFalseArrayString + +> String testQueryStyleFormExplodeFalseArrayString(queryObject) + +Test query parameter(s) + +Test query parameter(s) + +### Example + +```java +// Import classes: +import org.openapitools.client.ApiClient; +import org.openapitools.client.ApiException; +import org.openapitools.client.Configuration; +import org.openapitools.client.models.*; +import org.openapitools.client.api.QueryApi; + +public class Example { + public static void main(String[] args) { + ApiClient defaultClient = Configuration.getDefaultApiClient(); + defaultClient.setBasePath("http://localhost:3000"); + + QueryApi apiInstance = new QueryApi(defaultClient); + List queryObject = Arrays.asList(); // List | + try { + String result = apiInstance.testQueryStyleFormExplodeFalseArrayString(queryObject); + System.out.println(result); + } catch (ApiException e) { + System.err.println("Exception when calling QueryApi#testQueryStyleFormExplodeFalseArrayString"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} +``` + +### Parameters + + +| Name | Type | Description | Notes | +|------------- | ------------- | ------------- | -------------| +| **queryObject** | [**List<String>**](String.md)| | [optional] | + +### Return type + +**String** + +### 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 > String testQueryStyleFormExplodeTrueArrayString(queryObject) diff --git a/samples/client/echo_api/java/resteasy/src/main/java/org/openapitools/client/api/QueryApi.java b/samples/client/echo_api/java/resteasy/src/main/java/org/openapitools/client/api/QueryApi.java index 56dca02c018b..97d5df16da55 100644 --- a/samples/client/echo_api/java/resteasy/src/main/java/org/openapitools/client/api/QueryApi.java +++ b/samples/client/echo_api/java/resteasy/src/main/java/org/openapitools/client/api/QueryApi.java @@ -230,6 +230,84 @@ public String testQueryStyleDeepObjectExplodeTrueObjectAllOf(TestQueryStyleDeepO + final String[] localVarAccepts = { + "text/plain" + }; + final String localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); + + final String[] localVarContentTypes = { + + }; + final String localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); + + String[] localVarAuthNames = new String[] { }; + + GenericType localVarReturnType = new GenericType() {}; + return apiClient.invokeAPI(localVarPath, "GET", localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localVarReturnType); + } + /** + * Test query parameter(s) + * Test query parameter(s) + * @param queryObject (optional) + * @return a {@code String} + * @throws ApiException if fails to make API call + */ + public String testQueryStyleFormExplodeFalseArrayInteger(List queryObject) throws ApiException { + Object localVarPostBody = null; + + // create path and map variables + String localVarPath = "/query/style_form/explode_false/array_integer".replaceAll("\\{format\\}","json"); + + // query params + List localVarQueryParams = new ArrayList(); + Map localVarHeaderParams = new HashMap(); + Map localVarCookieParams = new HashMap(); + Map localVarFormParams = new HashMap(); + + localVarQueryParams.addAll(apiClient.parameterToPairs("csv", "query_object", queryObject)); + + + + + final String[] localVarAccepts = { + "text/plain" + }; + final String localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); + + final String[] localVarContentTypes = { + + }; + final String localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); + + String[] localVarAuthNames = new String[] { }; + + GenericType localVarReturnType = new GenericType() {}; + return apiClient.invokeAPI(localVarPath, "GET", localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localVarReturnType); + } + /** + * Test query parameter(s) + * Test query parameter(s) + * @param queryObject (optional) + * @return a {@code String} + * @throws ApiException if fails to make API call + */ + public String testQueryStyleFormExplodeFalseArrayString(List queryObject) throws ApiException { + Object localVarPostBody = null; + + // create path and map variables + String localVarPath = "/query/style_form/explode_false/array_string".replaceAll("\\{format\\}","json"); + + // query params + List localVarQueryParams = new ArrayList(); + Map localVarHeaderParams = new HashMap(); + Map localVarCookieParams = new HashMap(); + Map localVarFormParams = new HashMap(); + + localVarQueryParams.addAll(apiClient.parameterToPairs("csv", "query_object", queryObject)); + + + + final String[] localVarAccepts = { "text/plain" }; diff --git a/samples/client/echo_api/java/resttemplate/README.md b/samples/client/echo_api/java/resttemplate/README.md index 3950c9c3273b..09190155c429 100644 --- a/samples/client/echo_api/java/resttemplate/README.md +++ b/samples/client/echo_api/java/resttemplate/README.md @@ -137,6 +137,8 @@ Class | Method | HTTP request | Description *QueryApi* | [**testQueryIntegerBooleanString**](docs/QueryApi.md#testQueryIntegerBooleanString) | **GET** /query/integer/boolean/string | Test query parameter(s) *QueryApi* | [**testQueryStyleDeepObjectExplodeTrueObject**](docs/QueryApi.md#testQueryStyleDeepObjectExplodeTrueObject) | **GET** /query/style_deepObject/explode_true/object | Test query parameter(s) *QueryApi* | [**testQueryStyleDeepObjectExplodeTrueObjectAllOf**](docs/QueryApi.md#testQueryStyleDeepObjectExplodeTrueObjectAllOf) | **GET** /query/style_deepObject/explode_true/object/allOf | Test query parameter(s) +*QueryApi* | [**testQueryStyleFormExplodeFalseArrayInteger**](docs/QueryApi.md#testQueryStyleFormExplodeFalseArrayInteger) | **GET** /query/style_form/explode_false/array_integer | Test query parameter(s) +*QueryApi* | [**testQueryStyleFormExplodeFalseArrayString**](docs/QueryApi.md#testQueryStyleFormExplodeFalseArrayString) | **GET** /query/style_form/explode_false/array_string | Test query parameter(s) *QueryApi* | [**testQueryStyleFormExplodeTrueArrayString**](docs/QueryApi.md#testQueryStyleFormExplodeTrueArrayString) | **GET** /query/style_form/explode_true/array_string | Test query parameter(s) *QueryApi* | [**testQueryStyleFormExplodeTrueObject**](docs/QueryApi.md#testQueryStyleFormExplodeTrueObject) | **GET** /query/style_form/explode_true/object | Test query parameter(s) *QueryApi* | [**testQueryStyleFormExplodeTrueObjectAllOf**](docs/QueryApi.md#testQueryStyleFormExplodeTrueObjectAllOf) | **GET** /query/style_form/explode_true/object/allOf | Test query parameter(s) diff --git a/samples/client/echo_api/java/resttemplate/api/openapi.yaml b/samples/client/echo_api/java/resttemplate/api/openapi.yaml index f5d4fc9abbde..770ca687d7f3 100644 --- a/samples/client/echo_api/java/resttemplate/api/openapi.yaml +++ b/samples/client/echo_api/java/resttemplate/api/openapi.yaml @@ -289,6 +289,56 @@ paths: tags: - query x-accepts: text/plain + /query/style_form/explode_false/array_integer: + get: + description: Test query parameter(s) + operationId: test/query/style_form/explode_false/array_integer + parameters: + - explode: false + in: query + name: query_object + required: false + schema: + items: + type: integer + type: array + style: form + responses: + "200": + content: + text/plain: + schema: + type: string + description: Successful operation + summary: Test query parameter(s) + tags: + - query + x-accepts: text/plain + /query/style_form/explode_false/array_string: + get: + description: Test query parameter(s) + operationId: test/query/style_form/explode_false/array_string + parameters: + - explode: false + in: query + name: query_object + required: false + schema: + items: + type: string + type: array + style: form + responses: + "200": + content: + text/plain: + schema: + type: string + description: Successful operation + summary: Test query parameter(s) + tags: + - query + x-accepts: text/plain /query/style_form/explode_true/object: get: description: Test query parameter(s) diff --git a/samples/client/echo_api/java/resttemplate/docs/QueryApi.md b/samples/client/echo_api/java/resttemplate/docs/QueryApi.md index 2606c8e62ca9..45813a191fed 100644 --- a/samples/client/echo_api/java/resttemplate/docs/QueryApi.md +++ b/samples/client/echo_api/java/resttemplate/docs/QueryApi.md @@ -9,6 +9,8 @@ All URIs are relative to *http://localhost:3000* | [**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) | +| [**testQueryStyleFormExplodeFalseArrayInteger**](QueryApi.md#testQueryStyleFormExplodeFalseArrayInteger) | **GET** /query/style_form/explode_false/array_integer | Test query parameter(s) | +| [**testQueryStyleFormExplodeFalseArrayString**](QueryApi.md#testQueryStyleFormExplodeFalseArrayString) | **GET** /query/style_form/explode_false/array_string | 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) | @@ -355,6 +357,138 @@ No authorization required | **200** | Successful operation | - | +## testQueryStyleFormExplodeFalseArrayInteger + +> String testQueryStyleFormExplodeFalseArrayInteger(queryObject) + +Test query parameter(s) + +Test query parameter(s) + +### Example + +```java +// Import classes: +import org.openapitools.client.ApiClient; +import org.openapitools.client.ApiException; +import org.openapitools.client.Configuration; +import org.openapitools.client.models.*; +import org.openapitools.client.api.QueryApi; + +public class Example { + public static void main(String[] args) { + ApiClient defaultClient = Configuration.getDefaultApiClient(); + defaultClient.setBasePath("http://localhost:3000"); + + QueryApi apiInstance = new QueryApi(defaultClient); + List queryObject = Arrays.asList(); // List | + try { + String result = apiInstance.testQueryStyleFormExplodeFalseArrayInteger(queryObject); + System.out.println(result); + } catch (ApiException e) { + System.err.println("Exception when calling QueryApi#testQueryStyleFormExplodeFalseArrayInteger"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} +``` + +### Parameters + + +| Name | Type | Description | Notes | +|------------- | ------------- | ------------- | -------------| +| **queryObject** | [**List<Integer>**](Integer.md)| | [optional] | + +### Return type + +**String** + +### 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 | - | + + +## testQueryStyleFormExplodeFalseArrayString + +> String testQueryStyleFormExplodeFalseArrayString(queryObject) + +Test query parameter(s) + +Test query parameter(s) + +### Example + +```java +// Import classes: +import org.openapitools.client.ApiClient; +import org.openapitools.client.ApiException; +import org.openapitools.client.Configuration; +import org.openapitools.client.models.*; +import org.openapitools.client.api.QueryApi; + +public class Example { + public static void main(String[] args) { + ApiClient defaultClient = Configuration.getDefaultApiClient(); + defaultClient.setBasePath("http://localhost:3000"); + + QueryApi apiInstance = new QueryApi(defaultClient); + List queryObject = Arrays.asList(); // List | + try { + String result = apiInstance.testQueryStyleFormExplodeFalseArrayString(queryObject); + System.out.println(result); + } catch (ApiException e) { + System.err.println("Exception when calling QueryApi#testQueryStyleFormExplodeFalseArrayString"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} +``` + +### Parameters + + +| Name | Type | Description | Notes | +|------------- | ------------- | ------------- | -------------| +| **queryObject** | [**List<String>**](String.md)| | [optional] | + +### Return type + +**String** + +### 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 > String testQueryStyleFormExplodeTrueArrayString(queryObject) diff --git a/samples/client/echo_api/java/resttemplate/src/main/java/org/openapitools/client/api/QueryApi.java b/samples/client/echo_api/java/resttemplate/src/main/java/org/openapitools/client/api/QueryApi.java index d30cd1b058e4..71384eb55562 100644 --- a/samples/client/echo_api/java/resttemplate/src/main/java/org/openapitools/client/api/QueryApi.java +++ b/samples/client/echo_api/java/resttemplate/src/main/java/org/openapitools/client/api/QueryApi.java @@ -293,6 +293,94 @@ public ResponseEntity testQueryStyleDeepObjectExplodeTrueObjectAllOfWith ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; return apiClient.invokeAPI("/query/style_deepObject/explode_true/object/allOf", HttpMethod.GET, Collections.emptyMap(), localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); } + /** + * Test query parameter(s) + * Test query parameter(s) + *

200 - Successful operation + * @param queryObject (optional) + * @return String + * @throws RestClientException if an error occurs while attempting to invoke the API + */ + public String testQueryStyleFormExplodeFalseArrayInteger(List queryObject) throws RestClientException { + return testQueryStyleFormExplodeFalseArrayIntegerWithHttpInfo(queryObject).getBody(); + } + + /** + * Test query parameter(s) + * Test query parameter(s) + *

200 - Successful operation + * @param queryObject (optional) + * @return ResponseEntity<String> + * @throws RestClientException if an error occurs while attempting to invoke the API + */ + public ResponseEntity testQueryStyleFormExplodeFalseArrayIntegerWithHttpInfo(List queryObject) throws RestClientException { + Object localVarPostBody = null; + + + final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); + final HttpHeaders localVarHeaderParams = new HttpHeaders(); + final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); + final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); + + localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "query_object", queryObject)); + + + final String[] localVarAccepts = { + "text/plain" + }; + final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); + final String[] localVarContentTypes = { }; + final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); + + String[] localVarAuthNames = new String[] { }; + + ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; + return apiClient.invokeAPI("/query/style_form/explode_false/array_integer", HttpMethod.GET, Collections.emptyMap(), localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); + } + /** + * Test query parameter(s) + * Test query parameter(s) + *

200 - Successful operation + * @param queryObject (optional) + * @return String + * @throws RestClientException if an error occurs while attempting to invoke the API + */ + public String testQueryStyleFormExplodeFalseArrayString(List queryObject) throws RestClientException { + return testQueryStyleFormExplodeFalseArrayStringWithHttpInfo(queryObject).getBody(); + } + + /** + * Test query parameter(s) + * Test query parameter(s) + *

200 - Successful operation + * @param queryObject (optional) + * @return ResponseEntity<String> + * @throws RestClientException if an error occurs while attempting to invoke the API + */ + public ResponseEntity testQueryStyleFormExplodeFalseArrayStringWithHttpInfo(List queryObject) throws RestClientException { + Object localVarPostBody = null; + + + final MultiValueMap localVarQueryParams = new LinkedMultiValueMap(); + final HttpHeaders localVarHeaderParams = new HttpHeaders(); + final MultiValueMap localVarCookieParams = new LinkedMultiValueMap(); + final MultiValueMap localVarFormParams = new LinkedMultiValueMap(); + + localVarQueryParams.putAll(apiClient.parameterToMultiValueMap(ApiClient.CollectionFormat.valueOf("csv".toUpperCase(Locale.ROOT)), "query_object", queryObject)); + + + final String[] localVarAccepts = { + "text/plain" + }; + final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); + final String[] localVarContentTypes = { }; + final MediaType localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); + + String[] localVarAuthNames = new String[] { }; + + ParameterizedTypeReference localReturnType = new ParameterizedTypeReference() {}; + return apiClient.invokeAPI("/query/style_form/explode_false/array_string", HttpMethod.GET, Collections.emptyMap(), localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localReturnType); + } /** * Test query parameter(s) * Test query parameter(s) diff --git a/samples/client/echo_api/php-nextgen/README.md b/samples/client/echo_api/php-nextgen/README.md index cf811c24b44c..1477dddf6f64 100644 --- a/samples/client/echo_api/php-nextgen/README.md +++ b/samples/client/echo_api/php-nextgen/README.md @@ -96,6 +96,8 @@ Class | Method | HTTP request | Description *QueryApi* | [**testQueryIntegerBooleanString**](docs/Api/QueryApi.md#testqueryintegerbooleanstring) | **GET** /query/integer/boolean/string | Test query parameter(s) *QueryApi* | [**testQueryStyleDeepObjectExplodeTrueObject**](docs/Api/QueryApi.md#testquerystyledeepobjectexplodetrueobject) | **GET** /query/style_deepObject/explode_true/object | Test query parameter(s) *QueryApi* | [**testQueryStyleDeepObjectExplodeTrueObjectAllOf**](docs/Api/QueryApi.md#testquerystyledeepobjectexplodetrueobjectallof) | **GET** /query/style_deepObject/explode_true/object/allOf | Test query parameter(s) +*QueryApi* | [**testQueryStyleFormExplodeFalseArrayInteger**](docs/Api/QueryApi.md#testquerystyleformexplodefalsearrayinteger) | **GET** /query/style_form/explode_false/array_integer | Test query parameter(s) +*QueryApi* | [**testQueryStyleFormExplodeFalseArrayString**](docs/Api/QueryApi.md#testquerystyleformexplodefalsearraystring) | **GET** /query/style_form/explode_false/array_string | Test query parameter(s) *QueryApi* | [**testQueryStyleFormExplodeTrueArrayString**](docs/Api/QueryApi.md#testquerystyleformexplodetruearraystring) | **GET** /query/style_form/explode_true/array_string | Test query parameter(s) *QueryApi* | [**testQueryStyleFormExplodeTrueObject**](docs/Api/QueryApi.md#testquerystyleformexplodetrueobject) | **GET** /query/style_form/explode_true/object | Test query parameter(s) *QueryApi* | [**testQueryStyleFormExplodeTrueObjectAllOf**](docs/Api/QueryApi.md#testquerystyleformexplodetrueobjectallof) | **GET** /query/style_form/explode_true/object/allOf | Test query parameter(s) diff --git a/samples/client/echo_api/php-nextgen/docs/Api/QueryApi.md b/samples/client/echo_api/php-nextgen/docs/Api/QueryApi.md index 75b16e0b48ad..10208136e80f 100644 --- a/samples/client/echo_api/php-nextgen/docs/Api/QueryApi.md +++ b/samples/client/echo_api/php-nextgen/docs/Api/QueryApi.md @@ -9,6 +9,8 @@ All URIs are relative to http://localhost:3000, except if the operation defines | [**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) | +| [**testQueryStyleFormExplodeFalseArrayInteger()**](QueryApi.md#testQueryStyleFormExplodeFalseArrayInteger) | **GET** /query/style_form/explode_false/array_integer | Test query parameter(s) | +| [**testQueryStyleFormExplodeFalseArrayString()**](QueryApi.md#testQueryStyleFormExplodeFalseArrayString) | **GET** /query/style_form/explode_false/array_string | 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) | @@ -304,6 +306,118 @@ No authorization required [[Back to Model list]](../../README.md#models) [[Back to README]](../../README.md) +## `testQueryStyleFormExplodeFalseArrayInteger()` + +```php +testQueryStyleFormExplodeFalseArrayInteger($query_object): string +``` + +Test query parameter(s) + +Test query parameter(s) + +### Example + +```php +testQueryStyleFormExplodeFalseArrayInteger($query_object); + print_r($result); +} catch (Exception $e) { + echo 'Exception when calling QueryApi->testQueryStyleFormExplodeFalseArrayInteger: ', $e->getMessage(), PHP_EOL; +} +``` + +### Parameters + +| Name | Type | Description | Notes | +| ------------- | ------------- | ------------- | ------------- | +| **query_object** | [**int[]**](../Model/int.md)| | [optional] | + +### Return type + +**string** + +### Authorization + +No authorization required + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: `text/plain` + +[[Back to top]](#) [[Back to API list]](../../README.md#endpoints) +[[Back to Model list]](../../README.md#models) +[[Back to README]](../../README.md) + +## `testQueryStyleFormExplodeFalseArrayString()` + +```php +testQueryStyleFormExplodeFalseArrayString($query_object): string +``` + +Test query parameter(s) + +Test query parameter(s) + +### Example + +```php +testQueryStyleFormExplodeFalseArrayString($query_object); + print_r($result); +} catch (Exception $e) { + echo 'Exception when calling QueryApi->testQueryStyleFormExplodeFalseArrayString: ', $e->getMessage(), PHP_EOL; +} +``` + +### Parameters + +| Name | Type | Description | Notes | +| ------------- | ------------- | ------------- | ------------- | +| **query_object** | [**string[]**](../Model/string.md)| | [optional] | + +### Return type + +**string** + +### Authorization + +No authorization required + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: `text/plain` + +[[Back to top]](#) [[Back to API list]](../../README.md#endpoints) +[[Back to Model list]](../../README.md#models) +[[Back to README]](../../README.md) + ## `testQueryStyleFormExplodeTrueArrayString()` ```php diff --git a/samples/client/echo_api/php-nextgen/src/Api/QueryApi.php b/samples/client/echo_api/php-nextgen/src/Api/QueryApi.php index cecc621c4bb1..c2aea029925a 100644 --- a/samples/client/echo_api/php-nextgen/src/Api/QueryApi.php +++ b/samples/client/echo_api/php-nextgen/src/Api/QueryApi.php @@ -87,6 +87,12 @@ class QueryApi 'testQueryStyleDeepObjectExplodeTrueObjectAllOf' => [ 'application/json', ], + 'testQueryStyleFormExplodeFalseArrayInteger' => [ + 'application/json', + ], + 'testQueryStyleFormExplodeFalseArrayString' => [ + 'application/json', + ], 'testQueryStyleFormExplodeTrueArrayString' => [ 'application/json', ], @@ -1776,6 +1782,640 @@ public function testQueryStyleDeepObjectExplodeTrueObjectAllOfRequest( + $headers = $this->headerSelector->selectHeaders( + ['text/plain', ], + $contentType, + $multipart + ); + + // for model (json/xml) + if (count($formParams) > 0) { + if ($multipart) { + $multipartContents = []; + foreach ($formParams as $formParamName => $formParamValue) { + $formParamValueItems = is_array($formParamValue) ? $formParamValue : [$formParamValue]; + foreach ($formParamValueItems as $formParamValueItem) { + $multipartContents[] = [ + 'name' => $formParamName, + 'contents' => $formParamValueItem + ]; + } + } + // for HTTP post (form) + $httpBody = new MultipartStream($multipartContents); + + } elseif (stripos($headers['Content-Type'], 'application/json') !== false) { + # if Content-Type contains "application/json", json_encode the form parameters + $httpBody = \GuzzleHttp\Utils::jsonEncode($formParams); + } else { + // for HTTP post (form) + $httpBody = ObjectSerializer::buildQuery($formParams); + } + } + + + $defaultHeaders = []; + if ($this->config->getUserAgent()) { + $defaultHeaders['User-Agent'] = $this->config->getUserAgent(); + } + + $headers = array_merge( + $defaultHeaders, + $headerParams, + $headers + ); + + $operationHost = $this->config->getHost(); + $query = ObjectSerializer::buildQuery($queryParams); + return new Request( + 'GET', + $operationHost . $resourcePath . ($query ? "?{$query}" : ''), + $headers, + $httpBody + ); + } + + /** + * Operation testQueryStyleFormExplodeFalseArrayInteger + * + * Test query parameter(s) + * + * @param int[]|null $query_object query_object (optional) + * @param string $contentType The value for the Content-Type header. Check self::contentTypes['testQueryStyleFormExplodeFalseArrayInteger'] to see the possible values for this operation + * + * @throws ApiException on non-2xx response or if the response body is not in the expected format + * @throws InvalidArgumentException + * @return string + */ + public function testQueryStyleFormExplodeFalseArrayInteger( + ?array $query_object = null, + string $contentType = self::contentTypes['testQueryStyleFormExplodeFalseArrayInteger'][0] + ): string + { + list($response) = $this->testQueryStyleFormExplodeFalseArrayIntegerWithHttpInfo($query_object, $contentType); + return $response; + } + + /** + * Operation testQueryStyleFormExplodeFalseArrayIntegerWithHttpInfo + * + * Test query parameter(s) + * + * @param int[]|null $query_object (optional) + * @param string $contentType The value for the Content-Type header. Check self::contentTypes['testQueryStyleFormExplodeFalseArrayInteger'] to see the possible values for this operation + * + * @throws ApiException on non-2xx response or if the response body is not in the expected format + * @throws InvalidArgumentException + * @return array of string, HTTP status code, HTTP response headers (array of strings) + */ + public function testQueryStyleFormExplodeFalseArrayIntegerWithHttpInfo( + ?array $query_object = null, + string $contentType = self::contentTypes['testQueryStyleFormExplodeFalseArrayInteger'][0] + ): array + { + $request = $this->testQueryStyleFormExplodeFalseArrayIntegerRequest($query_object, $contentType); + + try { + $options = $this->createHttpClientOption(); + try { + $response = $this->client->send($request, $options); + } catch (RequestException $e) { + throw new ApiException( + "[{$e->getCode()}] {$e->getMessage()}", + (int) $e->getCode(), + $e->getResponse() ? $e->getResponse()->getHeaders() : null, + $e->getResponse() ? (string) $e->getResponse()->getBody() : null + ); + } catch (ConnectException $e) { + throw new ApiException( + "[{$e->getCode()}] {$e->getMessage()}", + (int) $e->getCode(), + null, + null + ); + } + + $statusCode = $response->getStatusCode(); + + if ($statusCode < 200 || $statusCode > 299) { + throw new ApiException( + sprintf( + '[%d] Error connecting to the API (%s)', + $statusCode, + (string) $request->getUri() + ), + $statusCode, + $response->getHeaders(), + (string) $response->getBody() + ); + } + + switch($statusCode) { + case 200: + if ('string' === '\SplFileObject') { + $content = $response->getBody(); //stream goes to serializer + } else { + $content = (string) $response->getBody(); + if ('string' !== 'string') { + try { + $content = json_decode($content, false, 512, JSON_THROW_ON_ERROR); + } catch (\JsonException $exception) { + throw new ApiException( + sprintf( + 'Error JSON decoding server response (%s)', + $request->getUri() + ), + $statusCode, + $response->getHeaders(), + $content + ); + } + } + } + + return [ + ObjectSerializer::deserialize($content, 'string', []), + $response->getStatusCode(), + $response->getHeaders() + ]; + } + + $returnType = 'string'; + if ($returnType === '\SplFileObject') { + $content = $response->getBody(); //stream goes to serializer + } else { + $content = (string) $response->getBody(); + if ($returnType !== 'string') { + try { + $content = json_decode($content, false, 512, JSON_THROW_ON_ERROR); + } catch (\JsonException $exception) { + throw new ApiException( + sprintf( + 'Error JSON decoding server response (%s)', + $request->getUri() + ), + $statusCode, + $response->getHeaders(), + $content + ); + } + } + } + + return [ + ObjectSerializer::deserialize($content, $returnType, []), + $response->getStatusCode(), + $response->getHeaders() + ]; + + } catch (ApiException $e) { + switch ($e->getCode()) { + case 200: + $data = ObjectSerializer::deserialize( + $e->getResponseBody(), + 'string', + $e->getResponseHeaders() + ); + $e->setResponseObject($data); + break; + } + throw $e; + } + } + + /** + * Operation testQueryStyleFormExplodeFalseArrayIntegerAsync + * + * Test query parameter(s) + * + * @param int[]|null $query_object (optional) + * @param string $contentType The value for the Content-Type header. Check self::contentTypes['testQueryStyleFormExplodeFalseArrayInteger'] to see the possible values for this operation + * + * @throws InvalidArgumentException + * @return PromiseInterface + */ + public function testQueryStyleFormExplodeFalseArrayIntegerAsync( + ?array $query_object = null, + string $contentType = self::contentTypes['testQueryStyleFormExplodeFalseArrayInteger'][0] + ): PromiseInterface + { + return $this->testQueryStyleFormExplodeFalseArrayIntegerAsyncWithHttpInfo($query_object, $contentType) + ->then( + function ($response) { + return $response[0]; + } + ); + } + + /** + * Operation testQueryStyleFormExplodeFalseArrayIntegerAsyncWithHttpInfo + * + * Test query parameter(s) + * + * @param int[]|null $query_object (optional) + * @param string $contentType The value for the Content-Type header. Check self::contentTypes['testQueryStyleFormExplodeFalseArrayInteger'] to see the possible values for this operation + * + * @throws InvalidArgumentException + * @return PromiseInterface + */ + public function testQueryStyleFormExplodeFalseArrayIntegerAsyncWithHttpInfo( + $query_object = null, + string $contentType = self::contentTypes['testQueryStyleFormExplodeFalseArrayInteger'][0] + ): PromiseInterface + { + $returnType = 'string'; + $request = $this->testQueryStyleFormExplodeFalseArrayIntegerRequest($query_object, $contentType); + + return $this->client + ->sendAsync($request, $this->createHttpClientOption()) + ->then( + function ($response) use ($returnType) { + if ($returnType === '\SplFileObject') { + $content = $response->getBody(); //stream goes to serializer + } else { + $content = (string) $response->getBody(); + if ($returnType !== 'string') { + $content = json_decode($content); + } + } + + return [ + ObjectSerializer::deserialize($content, $returnType, []), + $response->getStatusCode(), + $response->getHeaders() + ]; + }, + function ($exception) { + $response = $exception->getResponse(); + $statusCode = $response->getStatusCode(); + throw new ApiException( + sprintf( + '[%d] Error connecting to the API (%s)', + $statusCode, + $exception->getRequest()->getUri() + ), + $statusCode, + $response->getHeaders(), + (string) $response->getBody() + ); + } + ); + } + + /** + * Create request for operation 'testQueryStyleFormExplodeFalseArrayInteger' + * + * @param int[]|null $query_object (optional) + * @param string $contentType The value for the Content-Type header. Check self::contentTypes['testQueryStyleFormExplodeFalseArrayInteger'] to see the possible values for this operation + * + * @throws InvalidArgumentException + * @return \GuzzleHttp\Psr7\Request + */ + public function testQueryStyleFormExplodeFalseArrayIntegerRequest( + $query_object = null, + string $contentType = self::contentTypes['testQueryStyleFormExplodeFalseArrayInteger'][0] + ): Request + { + + + + $resourcePath = '/query/style_form/explode_false/array_integer'; + $formParams = []; + $queryParams = []; + $headerParams = []; + $httpBody = ''; + $multipart = false; + + // query params + $queryParams = array_merge($queryParams, ObjectSerializer::toQueryValue( + $query_object, + 'query_object', // param base name + 'array', // openApiType + 'form', // style + false, // explode + false // required + ) ?? []); + + + + + $headers = $this->headerSelector->selectHeaders( + ['text/plain', ], + $contentType, + $multipart + ); + + // for model (json/xml) + if (count($formParams) > 0) { + if ($multipart) { + $multipartContents = []; + foreach ($formParams as $formParamName => $formParamValue) { + $formParamValueItems = is_array($formParamValue) ? $formParamValue : [$formParamValue]; + foreach ($formParamValueItems as $formParamValueItem) { + $multipartContents[] = [ + 'name' => $formParamName, + 'contents' => $formParamValueItem + ]; + } + } + // for HTTP post (form) + $httpBody = new MultipartStream($multipartContents); + + } elseif (stripos($headers['Content-Type'], 'application/json') !== false) { + # if Content-Type contains "application/json", json_encode the form parameters + $httpBody = \GuzzleHttp\Utils::jsonEncode($formParams); + } else { + // for HTTP post (form) + $httpBody = ObjectSerializer::buildQuery($formParams); + } + } + + + $defaultHeaders = []; + if ($this->config->getUserAgent()) { + $defaultHeaders['User-Agent'] = $this->config->getUserAgent(); + } + + $headers = array_merge( + $defaultHeaders, + $headerParams, + $headers + ); + + $operationHost = $this->config->getHost(); + $query = ObjectSerializer::buildQuery($queryParams); + return new Request( + 'GET', + $operationHost . $resourcePath . ($query ? "?{$query}" : ''), + $headers, + $httpBody + ); + } + + /** + * Operation testQueryStyleFormExplodeFalseArrayString + * + * Test query parameter(s) + * + * @param string[]|null $query_object query_object (optional) + * @param string $contentType The value for the Content-Type header. Check self::contentTypes['testQueryStyleFormExplodeFalseArrayString'] to see the possible values for this operation + * + * @throws ApiException on non-2xx response or if the response body is not in the expected format + * @throws InvalidArgumentException + * @return string + */ + public function testQueryStyleFormExplodeFalseArrayString( + ?array $query_object = null, + string $contentType = self::contentTypes['testQueryStyleFormExplodeFalseArrayString'][0] + ): string + { + list($response) = $this->testQueryStyleFormExplodeFalseArrayStringWithHttpInfo($query_object, $contentType); + return $response; + } + + /** + * Operation testQueryStyleFormExplodeFalseArrayStringWithHttpInfo + * + * Test query parameter(s) + * + * @param string[]|null $query_object (optional) + * @param string $contentType The value for the Content-Type header. Check self::contentTypes['testQueryStyleFormExplodeFalseArrayString'] to see the possible values for this operation + * + * @throws ApiException on non-2xx response or if the response body is not in the expected format + * @throws InvalidArgumentException + * @return array of string, HTTP status code, HTTP response headers (array of strings) + */ + public function testQueryStyleFormExplodeFalseArrayStringWithHttpInfo( + ?array $query_object = null, + string $contentType = self::contentTypes['testQueryStyleFormExplodeFalseArrayString'][0] + ): array + { + $request = $this->testQueryStyleFormExplodeFalseArrayStringRequest($query_object, $contentType); + + try { + $options = $this->createHttpClientOption(); + try { + $response = $this->client->send($request, $options); + } catch (RequestException $e) { + throw new ApiException( + "[{$e->getCode()}] {$e->getMessage()}", + (int) $e->getCode(), + $e->getResponse() ? $e->getResponse()->getHeaders() : null, + $e->getResponse() ? (string) $e->getResponse()->getBody() : null + ); + } catch (ConnectException $e) { + throw new ApiException( + "[{$e->getCode()}] {$e->getMessage()}", + (int) $e->getCode(), + null, + null + ); + } + + $statusCode = $response->getStatusCode(); + + if ($statusCode < 200 || $statusCode > 299) { + throw new ApiException( + sprintf( + '[%d] Error connecting to the API (%s)', + $statusCode, + (string) $request->getUri() + ), + $statusCode, + $response->getHeaders(), + (string) $response->getBody() + ); + } + + switch($statusCode) { + case 200: + if ('string' === '\SplFileObject') { + $content = $response->getBody(); //stream goes to serializer + } else { + $content = (string) $response->getBody(); + if ('string' !== 'string') { + try { + $content = json_decode($content, false, 512, JSON_THROW_ON_ERROR); + } catch (\JsonException $exception) { + throw new ApiException( + sprintf( + 'Error JSON decoding server response (%s)', + $request->getUri() + ), + $statusCode, + $response->getHeaders(), + $content + ); + } + } + } + + return [ + ObjectSerializer::deserialize($content, 'string', []), + $response->getStatusCode(), + $response->getHeaders() + ]; + } + + $returnType = 'string'; + if ($returnType === '\SplFileObject') { + $content = $response->getBody(); //stream goes to serializer + } else { + $content = (string) $response->getBody(); + if ($returnType !== 'string') { + try { + $content = json_decode($content, false, 512, JSON_THROW_ON_ERROR); + } catch (\JsonException $exception) { + throw new ApiException( + sprintf( + 'Error JSON decoding server response (%s)', + $request->getUri() + ), + $statusCode, + $response->getHeaders(), + $content + ); + } + } + } + + return [ + ObjectSerializer::deserialize($content, $returnType, []), + $response->getStatusCode(), + $response->getHeaders() + ]; + + } catch (ApiException $e) { + switch ($e->getCode()) { + case 200: + $data = ObjectSerializer::deserialize( + $e->getResponseBody(), + 'string', + $e->getResponseHeaders() + ); + $e->setResponseObject($data); + break; + } + throw $e; + } + } + + /** + * Operation testQueryStyleFormExplodeFalseArrayStringAsync + * + * Test query parameter(s) + * + * @param string[]|null $query_object (optional) + * @param string $contentType The value for the Content-Type header. Check self::contentTypes['testQueryStyleFormExplodeFalseArrayString'] to see the possible values for this operation + * + * @throws InvalidArgumentException + * @return PromiseInterface + */ + public function testQueryStyleFormExplodeFalseArrayStringAsync( + ?array $query_object = null, + string $contentType = self::contentTypes['testQueryStyleFormExplodeFalseArrayString'][0] + ): PromiseInterface + { + return $this->testQueryStyleFormExplodeFalseArrayStringAsyncWithHttpInfo($query_object, $contentType) + ->then( + function ($response) { + return $response[0]; + } + ); + } + + /** + * Operation testQueryStyleFormExplodeFalseArrayStringAsyncWithHttpInfo + * + * Test query parameter(s) + * + * @param string[]|null $query_object (optional) + * @param string $contentType The value for the Content-Type header. Check self::contentTypes['testQueryStyleFormExplodeFalseArrayString'] to see the possible values for this operation + * + * @throws InvalidArgumentException + * @return PromiseInterface + */ + public function testQueryStyleFormExplodeFalseArrayStringAsyncWithHttpInfo( + $query_object = null, + string $contentType = self::contentTypes['testQueryStyleFormExplodeFalseArrayString'][0] + ): PromiseInterface + { + $returnType = 'string'; + $request = $this->testQueryStyleFormExplodeFalseArrayStringRequest($query_object, $contentType); + + return $this->client + ->sendAsync($request, $this->createHttpClientOption()) + ->then( + function ($response) use ($returnType) { + if ($returnType === '\SplFileObject') { + $content = $response->getBody(); //stream goes to serializer + } else { + $content = (string) $response->getBody(); + if ($returnType !== 'string') { + $content = json_decode($content); + } + } + + return [ + ObjectSerializer::deserialize($content, $returnType, []), + $response->getStatusCode(), + $response->getHeaders() + ]; + }, + function ($exception) { + $response = $exception->getResponse(); + $statusCode = $response->getStatusCode(); + throw new ApiException( + sprintf( + '[%d] Error connecting to the API (%s)', + $statusCode, + $exception->getRequest()->getUri() + ), + $statusCode, + $response->getHeaders(), + (string) $response->getBody() + ); + } + ); + } + + /** + * Create request for operation 'testQueryStyleFormExplodeFalseArrayString' + * + * @param string[]|null $query_object (optional) + * @param string $contentType The value for the Content-Type header. Check self::contentTypes['testQueryStyleFormExplodeFalseArrayString'] to see the possible values for this operation + * + * @throws InvalidArgumentException + * @return \GuzzleHttp\Psr7\Request + */ + public function testQueryStyleFormExplodeFalseArrayStringRequest( + $query_object = null, + string $contentType = self::contentTypes['testQueryStyleFormExplodeFalseArrayString'][0] + ): Request + { + + + + $resourcePath = '/query/style_form/explode_false/array_string'; + $formParams = []; + $queryParams = []; + $headerParams = []; + $httpBody = ''; + $multipart = false; + + // query params + $queryParams = array_merge($queryParams, ObjectSerializer::toQueryValue( + $query_object, + 'query_object', // param base name + 'array', // openApiType + 'form', // style + false, // explode + false // required + ) ?? []); + + + + $headers = $this->headerSelector->selectHeaders( ['text/plain', ], $contentType, diff --git a/samples/client/echo_api/powershell/README.md b/samples/client/echo_api/powershell/README.md index 163717284adf..fd5edce4e27f 100644 --- a/samples/client/echo_api/powershell/README.md +++ b/samples/client/echo_api/powershell/README.md @@ -71,6 +71,8 @@ Class | Method | HTTP request | Description *QueryApi* | [**Test-QueryIntegerBooleanString**](docs/QueryApi.md#Test-QueryIntegerBooleanString) | **GET** /query/integer/boolean/string | Test query parameter(s) *QueryApi* | [**Test-QueryStyleDeepObjectExplodeTrueObject**](docs/QueryApi.md#Test-QueryStyleDeepObjectExplodeTrueObject) | **GET** /query/style_deepObject/explode_true/object | Test query parameter(s) *QueryApi* | [**Test-QueryStyleDeepObjectExplodeTrueObjectAllOf**](docs/QueryApi.md#Test-QueryStyleDeepObjectExplodeTrueObjectAllOf) | **GET** /query/style_deepObject/explode_true/object/allOf | Test query parameter(s) +*QueryApi* | [**Test-QueryStyleFormExplodeFalseArrayInteger**](docs/QueryApi.md#Test-QueryStyleFormExplodeFalseArrayInteger) | **GET** /query/style_form/explode_false/array_integer | Test query parameter(s) +*QueryApi* | [**Test-QueryStyleFormExplodeFalseArrayString**](docs/QueryApi.md#Test-QueryStyleFormExplodeFalseArrayString) | **GET** /query/style_form/explode_false/array_string | Test query parameter(s) *QueryApi* | [**Test-QueryStyleFormExplodeTrueArrayString**](docs/QueryApi.md#Test-QueryStyleFormExplodeTrueArrayString) | **GET** /query/style_form/explode_true/array_string | Test query parameter(s) *QueryApi* | [**Test-QueryStyleFormExplodeTrueObject**](docs/QueryApi.md#Test-QueryStyleFormExplodeTrueObject) | **GET** /query/style_form/explode_true/object | Test query parameter(s) *QueryApi* | [**Test-QueryStyleFormExplodeTrueObjectAllOf**](docs/QueryApi.md#Test-QueryStyleFormExplodeTrueObjectAllOf) | **GET** /query/style_form/explode_true/object/allOf | Test query parameter(s) diff --git a/samples/client/echo_api/powershell/docs/QueryApi.md b/samples/client/echo_api/powershell/docs/QueryApi.md index 0af0d6193910..84f7bfcf1fca 100644 --- a/samples/client/echo_api/powershell/docs/QueryApi.md +++ b/samples/client/echo_api/powershell/docs/QueryApi.md @@ -9,6 +9,8 @@ Method | HTTP request | Description [**Test-QueryIntegerBooleanString**](QueryApi.md#Test-QueryIntegerBooleanString) | **GET** /query/integer/boolean/string | Test query parameter(s) [**Test-QueryStyleDeepObjectExplodeTrueObject**](QueryApi.md#Test-QueryStyleDeepObjectExplodeTrueObject) | **GET** /query/style_deepObject/explode_true/object | Test query parameter(s) [**Test-QueryStyleDeepObjectExplodeTrueObjectAllOf**](QueryApi.md#Test-QueryStyleDeepObjectExplodeTrueObjectAllOf) | **GET** /query/style_deepObject/explode_true/object/allOf | Test query parameter(s) +[**Test-QueryStyleFormExplodeFalseArrayInteger**](QueryApi.md#Test-QueryStyleFormExplodeFalseArrayInteger) | **GET** /query/style_form/explode_false/array_integer | Test query parameter(s) +[**Test-QueryStyleFormExplodeFalseArrayString**](QueryApi.md#Test-QueryStyleFormExplodeFalseArrayString) | **GET** /query/style_form/explode_false/array_string | Test query parameter(s) [**Test-QueryStyleFormExplodeTrueArrayString**](QueryApi.md#Test-QueryStyleFormExplodeTrueArrayString) | **GET** /query/style_form/explode_true/array_string | Test query parameter(s) [**Test-QueryStyleFormExplodeTrueObject**](QueryApi.md#Test-QueryStyleFormExplodeTrueObject) | **GET** /query/style_form/explode_true/object | Test query parameter(s) [**Test-QueryStyleFormExplodeTrueObjectAllOf**](QueryApi.md#Test-QueryStyleFormExplodeTrueObjectAllOf) | **GET** /query/style_form/explode_true/object/allOf | Test query parameter(s) @@ -246,6 +248,92 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **Test-QueryStyleFormExplodeFalseArrayInteger** +> String Test-QueryStyleFormExplodeFalseArrayInteger
+>         [-QueryObject]
+ +Test query parameter(s) + +Test query parameter(s) + +### Example +```powershell +$QueryObject = 0 # Int32[] | (optional) + +# Test query parameter(s) +try { + $Result = Test-QueryStyleFormExplodeFalseArrayInteger -QueryObject $QueryObject +} catch { + Write-Host ("Exception occurred when calling Test-QueryStyleFormExplodeFalseArrayInteger: {0}" -f ($_.ErrorDetails | ConvertFrom-Json)) + Write-Host ("Response headers: {0}" -f ($_.Exception.Response.Headers | ConvertTo-Json)) +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **QueryObject** | [**Int32[]**](Int32.md)| | [optional] + +### Return type + +**String** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: text/plain + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + + +# **Test-QueryStyleFormExplodeFalseArrayString** +> String Test-QueryStyleFormExplodeFalseArrayString
+>         [-QueryObject]
+ +Test query parameter(s) + +Test query parameter(s) + +### Example +```powershell +$QueryObject = "MyQueryObject" # String[] | (optional) + +# Test query parameter(s) +try { + $Result = Test-QueryStyleFormExplodeFalseArrayString -QueryObject $QueryObject +} catch { + Write-Host ("Exception occurred when calling Test-QueryStyleFormExplodeFalseArrayString: {0}" -f ($_.ErrorDetails | ConvertFrom-Json)) + Write-Host ("Response headers: {0}" -f ($_.Exception.Response.Headers | ConvertTo-Json)) +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **QueryObject** | [**String[]**](String.md)| | [optional] + +### Return type + +**String** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: text/plain + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + # **Test-QueryStyleFormExplodeTrueArrayString** > String Test-QueryStyleFormExplodeTrueArrayString
diff --git a/samples/client/echo_api/powershell/src/PSOpenAPITools/Api/QueryApi.ps1 b/samples/client/echo_api/powershell/src/PSOpenAPITools/Api/QueryApi.ps1 index 13bc99c15f46..91d20187ea70 100644 --- a/samples/client/echo_api/powershell/src/PSOpenAPITools/Api/QueryApi.ps1 +++ b/samples/client/echo_api/powershell/src/PSOpenAPITools/Api/QueryApi.ps1 @@ -440,6 +440,152 @@ A switch when turned on will return a hash table of Response, StatusCode and Hea .OUTPUTS +String +#> +function Test-QueryStyleFormExplodeFalseArrayInteger { + [CmdletBinding()] + Param ( + [Parameter(Position = 0, ValueFromPipeline = $true, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [System.Nullable[Int32][]] + ${QueryObject}, + [Switch] + $WithHttpInfo + ) + + Process { + 'Calling method: Test-QueryStyleFormExplodeFalseArrayInteger' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $LocalVarAccepts = @() + $LocalVarContentTypes = @() + $LocalVarQueryParameters = @{} + $LocalVarHeaderParameters = @{} + $LocalVarFormParameters = @{} + $LocalVarPathParameters = @{} + $LocalVarCookieParameters = @{} + $LocalVarBodyParameter = $null + + $Configuration = Get-Configuration + # HTTP header 'Accept' (if needed) + $LocalVarAccepts = @('text/plain') + + $LocalVarUri = '/query/style_form/explode_false/array_integer' + + if ($QueryObject) { + $LocalVarQueryParameters['query_object'] = $QueryObject + } + + $LocalVarResult = Invoke-ApiClient -Method 'GET' ` + -Uri $LocalVarUri ` + -Accepts $LocalVarAccepts ` + -ContentTypes $LocalVarContentTypes ` + -Body $LocalVarBodyParameter ` + -HeaderParameters $LocalVarHeaderParameters ` + -QueryParameters $LocalVarQueryParameters ` + -FormParameters $LocalVarFormParameters ` + -CookieParameters $LocalVarCookieParameters ` + -ReturnType "String" ` + -IsBodyNullable $false + + if ($WithHttpInfo.IsPresent) { + return $LocalVarResult + } else { + return $LocalVarResult["Response"] + } + } +} + +<# +.SYNOPSIS + +Test query parameter(s) + +.DESCRIPTION + +No description available. + +.PARAMETER QueryObject +No description available. + +.PARAMETER WithHttpInfo + +A switch when turned on will return a hash table of Response, StatusCode and Headers instead of just the Response + +.OUTPUTS + +String +#> +function Test-QueryStyleFormExplodeFalseArrayString { + [CmdletBinding()] + Param ( + [Parameter(Position = 0, ValueFromPipeline = $true, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] + [String[]] + ${QueryObject}, + [Switch] + $WithHttpInfo + ) + + Process { + 'Calling method: Test-QueryStyleFormExplodeFalseArrayString' | Write-Debug + $PSBoundParameters | Out-DebugParameter | Write-Debug + + $LocalVarAccepts = @() + $LocalVarContentTypes = @() + $LocalVarQueryParameters = @{} + $LocalVarHeaderParameters = @{} + $LocalVarFormParameters = @{} + $LocalVarPathParameters = @{} + $LocalVarCookieParameters = @{} + $LocalVarBodyParameter = $null + + $Configuration = Get-Configuration + # HTTP header 'Accept' (if needed) + $LocalVarAccepts = @('text/plain') + + $LocalVarUri = '/query/style_form/explode_false/array_string' + + if ($QueryObject) { + $LocalVarQueryParameters['query_object'] = $QueryObject + } + + $LocalVarResult = Invoke-ApiClient -Method 'GET' ` + -Uri $LocalVarUri ` + -Accepts $LocalVarAccepts ` + -ContentTypes $LocalVarContentTypes ` + -Body $LocalVarBodyParameter ` + -HeaderParameters $LocalVarHeaderParameters ` + -QueryParameters $LocalVarQueryParameters ` + -FormParameters $LocalVarFormParameters ` + -CookieParameters $LocalVarCookieParameters ` + -ReturnType "String" ` + -IsBodyNullable $false + + if ($WithHttpInfo.IsPresent) { + return $LocalVarResult + } else { + return $LocalVarResult["Response"] + } + } +} + +<# +.SYNOPSIS + +Test query parameter(s) + +.DESCRIPTION + +No description available. + +.PARAMETER QueryObject +No description available. + +.PARAMETER WithHttpInfo + +A switch when turned on will return a hash table of Response, StatusCode and Headers instead of just the Response + +.OUTPUTS + String #> function Test-QueryStyleFormExplodeTrueArrayString { diff --git a/samples/client/echo_api/r/R/api_client.R b/samples/client/echo_api/r/R/api_client.R index dedada13adce..9fbeffaa59f6 100644 --- a/samples/client/echo_api/r/R/api_client.R +++ b/samples/client/echo_api/r/R/api_client.R @@ -270,7 +270,7 @@ ApiClient <- R6::R6Class( api_response <- ApiResponse$new() api_response$status_code <- httr::status_code(httr_response) api_response$status_code_desc <- httr::http_status(httr_response)$reason - api_response$response <- httr::content(httr_response, "text", encoding = "UTF-8") + api_response$response <- httr::content(httr_response, "raw") api_response$headers <- httr::headers(httr_response) api_response diff --git a/samples/client/echo_api/r/R/api_response.R b/samples/client/echo_api/r/R/api_response.R index c6d45622464c..c98bb5122750 100644 --- a/samples/client/echo_api/r/R/api_response.R +++ b/samples/client/echo_api/r/R/api_response.R @@ -45,6 +45,23 @@ ApiResponse <- R6::R6Class( self$status_code <- status_code self$status_code_desc <- status_code_desc self$headers <- headers + }, + + #' Return the response as text + #' + #' @description + #' The response is stored as a raw vector. Use this to access the response after + #' converting it to text. If the response is not coercible to text NA is returned. + #' + #' @param from_encoding The encoding of the raw response. + #' @param to_encoding The target encoding of the return value. + #' @export + response_as_text = function(from_encoding = NULL, to_encoding = "UTF-8") { + text_response <- iconv(readBin(self$response, character()), from = from_encoding, to = to_encoding) + if (is.na(text_response)) { + warning("The response is binary and will not be converted to text.") + } + return(text_response) } ) ) diff --git a/samples/client/echo_api/r/R/auth_api.R b/samples/client/echo_api/r/R/auth_api.R index b78961ddbbf9..aa3d8e416bb5 100644 --- a/samples/client/echo_api/r/R/auth_api.R +++ b/samples/client/echo_api/r/R/auth_api.R @@ -176,7 +176,7 @@ AuthApi <- R6::R6Class( } deserialized_resp_obj <- tryCatch( - self$api_client$deserialize(local_var_resp$response, "character", loadNamespace("openapi")), + self$api_client$deserialize(local_var_resp$response_as_text(), "character", loadNamespace("openapi")), error = function(e) { stop("Failed to deserialize response") } @@ -266,7 +266,7 @@ AuthApi <- R6::R6Class( } deserialized_resp_obj <- tryCatch( - self$api_client$deserialize(local_var_resp$response, "character", loadNamespace("openapi")), + self$api_client$deserialize(local_var_resp$response_as_text(), "character", loadNamespace("openapi")), error = function(e) { stop("Failed to deserialize response") } diff --git a/samples/client/echo_api/r/R/body_api.R b/samples/client/echo_api/r/R/body_api.R index 7a22b2939cb9..9f3c751b2512 100644 --- a/samples/client/echo_api/r/R/body_api.R +++ b/samples/client/echo_api/r/R/body_api.R @@ -379,7 +379,7 @@ BodyApi <- R6::R6Class( } deserialized_resp_obj <- tryCatch( - self$api_client$deserialize(local_var_resp$response, "data.frame", loadNamespace("openapi")), + self$api_client$deserialize(local_var_resp$response_as_text(), "data.frame", loadNamespace("openapi")), error = function(e) { stop("Failed to deserialize response") } @@ -474,7 +474,7 @@ BodyApi <- R6::R6Class( } deserialized_resp_obj <- tryCatch( - self$api_client$deserialize(local_var_resp$response, "character", loadNamespace("openapi")), + self$api_client$deserialize(local_var_resp$response_as_text(), "character", loadNamespace("openapi")), error = function(e) { stop("Failed to deserialize response") } @@ -568,7 +568,7 @@ BodyApi <- R6::R6Class( } deserialized_resp_obj <- tryCatch( - self$api_client$deserialize(local_var_resp$response, "character", loadNamespace("openapi")), + self$api_client$deserialize(local_var_resp$response_as_text(), "character", loadNamespace("openapi")), error = function(e) { stop("Failed to deserialize response") } @@ -658,7 +658,7 @@ BodyApi <- R6::R6Class( } deserialized_resp_obj <- tryCatch( - self$api_client$deserialize(local_var_resp$response, "character", loadNamespace("openapi")), + self$api_client$deserialize(local_var_resp$response_as_text(), "character", loadNamespace("openapi")), error = function(e) { stop("Failed to deserialize response") } @@ -753,7 +753,7 @@ BodyApi <- R6::R6Class( } deserialized_resp_obj <- tryCatch( - self$api_client$deserialize(local_var_resp$response, "Pet", loadNamespace("openapi")), + self$api_client$deserialize(local_var_resp$response_as_text(), "Pet", loadNamespace("openapi")), error = function(e) { stop("Failed to deserialize response") } @@ -848,7 +848,7 @@ BodyApi <- R6::R6Class( } deserialized_resp_obj <- tryCatch( - self$api_client$deserialize(local_var_resp$response, "character", loadNamespace("openapi")), + self$api_client$deserialize(local_var_resp$response_as_text(), "character", loadNamespace("openapi")), error = function(e) { stop("Failed to deserialize response") } @@ -943,7 +943,7 @@ BodyApi <- R6::R6Class( } deserialized_resp_obj <- tryCatch( - self$api_client$deserialize(local_var_resp$response, "Pet", loadNamespace("openapi")), + self$api_client$deserialize(local_var_resp$response_as_text(), "Pet", loadNamespace("openapi")), error = function(e) { stop("Failed to deserialize response") } @@ -1038,7 +1038,7 @@ BodyApi <- R6::R6Class( } deserialized_resp_obj <- tryCatch( - self$api_client$deserialize(local_var_resp$response, "character", loadNamespace("openapi")), + self$api_client$deserialize(local_var_resp$response_as_text(), "character", loadNamespace("openapi")), error = function(e) { stop("Failed to deserialize response") } @@ -1133,7 +1133,7 @@ BodyApi <- R6::R6Class( } deserialized_resp_obj <- tryCatch( - self$api_client$deserialize(local_var_resp$response, "character", loadNamespace("openapi")), + self$api_client$deserialize(local_var_resp$response_as_text(), "character", loadNamespace("openapi")), error = function(e) { stop("Failed to deserialize response") } diff --git a/samples/client/echo_api/r/R/form_api.R b/samples/client/echo_api/r/R/form_api.R index 188c5a29db26..a25adbde0619 100644 --- a/samples/client/echo_api/r/R/form_api.R +++ b/samples/client/echo_api/r/R/form_api.R @@ -195,7 +195,7 @@ FormApi <- R6::R6Class( } deserialized_resp_obj <- tryCatch( - self$api_client$deserialize(local_var_resp$response, "character", loadNamespace("openapi")), + self$api_client$deserialize(local_var_resp$response_as_text(), "character", loadNamespace("openapi")), error = function(e) { stop("Failed to deserialize response") } @@ -305,7 +305,7 @@ FormApi <- R6::R6Class( } deserialized_resp_obj <- tryCatch( - self$api_client$deserialize(local_var_resp$response, "character", loadNamespace("openapi")), + self$api_client$deserialize(local_var_resp$response_as_text(), "character", loadNamespace("openapi")), error = function(e) { stop("Failed to deserialize response") } diff --git a/samples/client/echo_api/r/R/header_api.R b/samples/client/echo_api/r/R/header_api.R index e561a35c304c..35ea7700e76f 100644 --- a/samples/client/echo_api/r/R/header_api.R +++ b/samples/client/echo_api/r/R/header_api.R @@ -172,7 +172,7 @@ HeaderApi <- R6::R6Class( } deserialized_resp_obj <- tryCatch( - self$api_client$deserialize(local_var_resp$response, "character", loadNamespace("openapi")), + self$api_client$deserialize(local_var_resp$response_as_text(), "character", loadNamespace("openapi")), error = function(e) { stop("Failed to deserialize response") } diff --git a/samples/client/echo_api/r/R/path_api.R b/samples/client/echo_api/r/R/path_api.R index 7d0b9ba2e374..75b09d76eca4 100644 --- a/samples/client/echo_api/r/R/path_api.R +++ b/samples/client/echo_api/r/R/path_api.R @@ -189,7 +189,7 @@ PathApi <- R6::R6Class( } deserialized_resp_obj <- tryCatch( - self$api_client$deserialize(local_var_resp$response, "character", loadNamespace("openapi")), + self$api_client$deserialize(local_var_resp$response_as_text(), "character", loadNamespace("openapi")), error = function(e) { stop("Failed to deserialize response") } diff --git a/samples/client/echo_api/r/R/query_api.R b/samples/client/echo_api/r/R/query_api.R index c9a97540cc55..c1c62acd7e02 100644 --- a/samples/client/echo_api/r/R/query_api.R +++ b/samples/client/echo_api/r/R/query_api.R @@ -99,6 +99,38 @@ #' } #' } #' +#' \strong{ TestQueryStyleFormExplodeFalseArrayInteger } \emph{ Test query parameter(s) } +#' Test query parameter(s) +#' +#' \itemize{ +#' \item \emph{ @param } query_object list( integer ) +#' +#' +#' \item status code : 200 | Successful operation +#' +#' \item return type : character +#' \item response headers : +#' +#' \tabular{ll}{ +#' } +#' } +#' +#' \strong{ TestQueryStyleFormExplodeFalseArrayString } \emph{ Test query parameter(s) } +#' Test query parameter(s) +#' +#' \itemize{ +#' \item \emph{ @param } query_object list( character ) +#' +#' +#' \item status code : 200 | Successful operation +#' +#' \item return type : character +#' \item response headers : +#' +#' \tabular{ll}{ +#' } +#' } +#' #' \strong{ TestQueryStyleFormExplodeTrueArrayString } \emph{ Test query parameter(s) } #' Test query parameter(s) #' @@ -227,6 +259,34 @@ #' dput(result) #' #' +#' #################### TestQueryStyleFormExplodeFalseArrayInteger #################### +#' +#' library(openapi) +#' var_query_object <- c(123) # array[integer] | (Optional) +#' +#' #Test query parameter(s) +#' api_instance <- QueryApi$new() +#' +#' # to save the result into a file, simply add the optional `data_file` parameter, e.g. +#' # result <- api_instance$TestQueryStyleFormExplodeFalseArrayInteger(query_object = var_query_objectdata_file = "result.txt") +#' result <- api_instance$TestQueryStyleFormExplodeFalseArrayInteger(query_object = var_query_object) +#' dput(result) +#' +#' +#' #################### TestQueryStyleFormExplodeFalseArrayString #################### +#' +#' library(openapi) +#' var_query_object <- c("inner_example") # array[character] | (Optional) +#' +#' #Test query parameter(s) +#' api_instance <- QueryApi$new() +#' +#' # to save the result into a file, simply add the optional `data_file` parameter, e.g. +#' # result <- api_instance$TestQueryStyleFormExplodeFalseArrayString(query_object = var_query_objectdata_file = "result.txt") +#' result <- api_instance$TestQueryStyleFormExplodeFalseArrayString(query_object = var_query_object) +#' dput(result) +#' +#' #' #################### TestQueryStyleFormExplodeTrueArrayString #################### #' #' library(openapi) @@ -372,7 +432,7 @@ QueryApi <- R6::R6Class( } deserialized_resp_obj <- tryCatch( - self$api_client$deserialize(local_var_resp$response, "character", loadNamespace("openapi")), + self$api_client$deserialize(local_var_resp$response_as_text(), "character", loadNamespace("openapi")), error = function(e) { stop("Failed to deserialize response") } @@ -473,7 +533,7 @@ QueryApi <- R6::R6Class( } deserialized_resp_obj <- tryCatch( - self$api_client$deserialize(local_var_resp$response, "character", loadNamespace("openapi")), + self$api_client$deserialize(local_var_resp$response_as_text(), "character", loadNamespace("openapi")), error = function(e) { stop("Failed to deserialize response") } @@ -574,7 +634,7 @@ QueryApi <- R6::R6Class( } deserialized_resp_obj <- tryCatch( - self$api_client$deserialize(local_var_resp$response, "character", loadNamespace("openapi")), + self$api_client$deserialize(local_var_resp$response_as_text(), "character", loadNamespace("openapi")), error = function(e) { stop("Failed to deserialize response") } @@ -665,7 +725,7 @@ QueryApi <- R6::R6Class( } deserialized_resp_obj <- tryCatch( - self$api_client$deserialize(local_var_resp$response, "character", loadNamespace("openapi")), + self$api_client$deserialize(local_var_resp$response_as_text(), "character", loadNamespace("openapi")), error = function(e) { stop("Failed to deserialize response") } @@ -756,7 +816,191 @@ QueryApi <- R6::R6Class( } deserialized_resp_obj <- tryCatch( - self$api_client$deserialize(local_var_resp$response, "character", loadNamespace("openapi")), + self$api_client$deserialize(local_var_resp$response_as_text(), "character", loadNamespace("openapi")), + error = function(e) { + stop("Failed to deserialize response") + } + ) + local_var_resp$content <- deserialized_resp_obj + local_var_resp + } else if (local_var_resp$status_code >= 300 && local_var_resp$status_code <= 399) { + ApiResponse$new(paste("Server returned ", local_var_resp$status_code, " response status code."), local_var_resp) + } else if (local_var_resp$status_code >= 400 && local_var_resp$status_code <= 499) { + ApiResponse$new("API client error", local_var_resp) + } else if (local_var_resp$status_code >= 500 && local_var_resp$status_code <= 599) { + if (is.null(local_var_resp$response) || local_var_resp$response == "") { + local_var_resp$response <- "API server error" + } + local_var_resp + } + }, + #' Test query parameter(s) + #' + #' @description + #' Test query parameter(s) + #' + #' @param query_object (optional) No description + #' @param data_file (optional) name of the data file to save the result + #' @param ... Other optional arguments + #' @return character + #' @export + TestQueryStyleFormExplodeFalseArrayInteger = function(query_object = NULL, data_file = NULL, ...) { + local_var_response <- self$TestQueryStyleFormExplodeFalseArrayIntegerWithHttpInfo(query_object, data_file = data_file, ...) + if (local_var_response$status_code >= 200 && local_var_response$status_code <= 299) { + local_var_response$content + } else if (local_var_response$status_code >= 300 && local_var_response$status_code <= 399) { + local_var_response + } else if (local_var_response$status_code >= 400 && local_var_response$status_code <= 499) { + local_var_response + } else if (local_var_response$status_code >= 500 && local_var_response$status_code <= 599) { + local_var_response + } + }, + #' Test query parameter(s) + #' + #' @description + #' Test query parameter(s) + #' + #' @param query_object (optional) No description + #' @param data_file (optional) name of the data file to save the result + #' @param ... Other optional arguments + #' @return API response (character) with additional information such as HTTP status code, headers + #' @export + TestQueryStyleFormExplodeFalseArrayIntegerWithHttpInfo = function(query_object = NULL, data_file = NULL, ...) { + args <- list(...) + query_params <- list() + header_params <- c() + form_params <- list() + file_params <- list() + local_var_body <- NULL + oauth_scopes <- NULL + is_oauth <- FALSE + + + # no explore + query_params[["query_object"]] <- I(paste(lapply(`query_object`, URLencode, reserved = TRUE), collapse = ",")) + + local_var_url_path <- "/query/style_form/explode_false/array_integer" + + # The Accept request HTTP header + local_var_accepts <- list("text/plain") + + # The Content-Type representation header + local_var_content_types <- list() + + local_var_resp <- self$api_client$CallApi(url = paste0(self$api_client$base_path, local_var_url_path), + method = "GET", + query_params = query_params, + header_params = header_params, + form_params = form_params, + file_params = file_params, + accepts = local_var_accepts, + content_types = local_var_content_types, + body = local_var_body, + is_oauth = is_oauth, + oauth_scopes = oauth_scopes, + ...) + + if (local_var_resp$status_code >= 200 && local_var_resp$status_code <= 299) { + # save response in a file + if (!is.null(data_file)) { + write(local_var_resp$response, data_file) + } + + deserialized_resp_obj <- tryCatch( + self$api_client$deserialize(local_var_resp$response_as_text(), "character", loadNamespace("openapi")), + error = function(e) { + stop("Failed to deserialize response") + } + ) + local_var_resp$content <- deserialized_resp_obj + local_var_resp + } else if (local_var_resp$status_code >= 300 && local_var_resp$status_code <= 399) { + ApiResponse$new(paste("Server returned ", local_var_resp$status_code, " response status code."), local_var_resp) + } else if (local_var_resp$status_code >= 400 && local_var_resp$status_code <= 499) { + ApiResponse$new("API client error", local_var_resp) + } else if (local_var_resp$status_code >= 500 && local_var_resp$status_code <= 599) { + if (is.null(local_var_resp$response) || local_var_resp$response == "") { + local_var_resp$response <- "API server error" + } + local_var_resp + } + }, + #' Test query parameter(s) + #' + #' @description + #' Test query parameter(s) + #' + #' @param query_object (optional) No description + #' @param data_file (optional) name of the data file to save the result + #' @param ... Other optional arguments + #' @return character + #' @export + TestQueryStyleFormExplodeFalseArrayString = function(query_object = NULL, data_file = NULL, ...) { + local_var_response <- self$TestQueryStyleFormExplodeFalseArrayStringWithHttpInfo(query_object, data_file = data_file, ...) + if (local_var_response$status_code >= 200 && local_var_response$status_code <= 299) { + local_var_response$content + } else if (local_var_response$status_code >= 300 && local_var_response$status_code <= 399) { + local_var_response + } else if (local_var_response$status_code >= 400 && local_var_response$status_code <= 499) { + local_var_response + } else if (local_var_response$status_code >= 500 && local_var_response$status_code <= 599) { + local_var_response + } + }, + #' Test query parameter(s) + #' + #' @description + #' Test query parameter(s) + #' + #' @param query_object (optional) No description + #' @param data_file (optional) name of the data file to save the result + #' @param ... Other optional arguments + #' @return API response (character) with additional information such as HTTP status code, headers + #' @export + TestQueryStyleFormExplodeFalseArrayStringWithHttpInfo = function(query_object = NULL, data_file = NULL, ...) { + args <- list(...) + query_params <- list() + header_params <- c() + form_params <- list() + file_params <- list() + local_var_body <- NULL + oauth_scopes <- NULL + is_oauth <- FALSE + + + # no explore + query_params[["query_object"]] <- I(paste(lapply(`query_object`, URLencode, reserved = TRUE), collapse = ",")) + + local_var_url_path <- "/query/style_form/explode_false/array_string" + + # The Accept request HTTP header + local_var_accepts <- list("text/plain") + + # The Content-Type representation header + local_var_content_types <- list() + + local_var_resp <- self$api_client$CallApi(url = paste0(self$api_client$base_path, local_var_url_path), + method = "GET", + query_params = query_params, + header_params = header_params, + form_params = form_params, + file_params = file_params, + accepts = local_var_accepts, + content_types = local_var_content_types, + body = local_var_body, + is_oauth = is_oauth, + oauth_scopes = oauth_scopes, + ...) + + if (local_var_resp$status_code >= 200 && local_var_resp$status_code <= 299) { + # save response in a file + if (!is.null(data_file)) { + write(local_var_resp$response, data_file) + } + + deserialized_resp_obj <- tryCatch( + self$api_client$deserialize(local_var_resp$response_as_text(), "character", loadNamespace("openapi")), error = function(e) { stop("Failed to deserialize response") } @@ -847,7 +1091,7 @@ QueryApi <- R6::R6Class( } deserialized_resp_obj <- tryCatch( - self$api_client$deserialize(local_var_resp$response, "character", loadNamespace("openapi")), + self$api_client$deserialize(local_var_resp$response_as_text(), "character", loadNamespace("openapi")), error = function(e) { stop("Failed to deserialize response") } @@ -938,7 +1182,7 @@ QueryApi <- R6::R6Class( } deserialized_resp_obj <- tryCatch( - self$api_client$deserialize(local_var_resp$response, "character", loadNamespace("openapi")), + self$api_client$deserialize(local_var_resp$response_as_text(), "character", loadNamespace("openapi")), error = function(e) { stop("Failed to deserialize response") } @@ -1029,7 +1273,7 @@ QueryApi <- R6::R6Class( } deserialized_resp_obj <- tryCatch( - self$api_client$deserialize(local_var_resp$response, "character", loadNamespace("openapi")), + self$api_client$deserialize(local_var_resp$response_as_text(), "character", loadNamespace("openapi")), error = function(e) { stop("Failed to deserialize response") } diff --git a/samples/client/echo_api/r/README.md b/samples/client/echo_api/r/README.md index 19e750a47e5a..509644c61bc4 100644 --- a/samples/client/echo_api/r/README.md +++ b/samples/client/echo_api/r/README.md @@ -92,6 +92,8 @@ Class | Method | HTTP request | Description *QueryApi* | [**TestQueryIntegerBooleanString**](docs/QueryApi.md#TestQueryIntegerBooleanString) | **GET** /query/integer/boolean/string | Test query parameter(s) *QueryApi* | [**TestQueryStyleDeepObjectExplodeTrueObject**](docs/QueryApi.md#TestQueryStyleDeepObjectExplodeTrueObject) | **GET** /query/style_deepObject/explode_true/object | Test query parameter(s) *QueryApi* | [**TestQueryStyleDeepObjectExplodeTrueObjectAllOf**](docs/QueryApi.md#TestQueryStyleDeepObjectExplodeTrueObjectAllOf) | **GET** /query/style_deepObject/explode_true/object/allOf | Test query parameter(s) +*QueryApi* | [**TestQueryStyleFormExplodeFalseArrayInteger**](docs/QueryApi.md#TestQueryStyleFormExplodeFalseArrayInteger) | **GET** /query/style_form/explode_false/array_integer | Test query parameter(s) +*QueryApi* | [**TestQueryStyleFormExplodeFalseArrayString**](docs/QueryApi.md#TestQueryStyleFormExplodeFalseArrayString) | **GET** /query/style_form/explode_false/array_string | Test query parameter(s) *QueryApi* | [**TestQueryStyleFormExplodeTrueArrayString**](docs/QueryApi.md#TestQueryStyleFormExplodeTrueArrayString) | **GET** /query/style_form/explode_true/array_string | Test query parameter(s) *QueryApi* | [**TestQueryStyleFormExplodeTrueObject**](docs/QueryApi.md#TestQueryStyleFormExplodeTrueObject) | **GET** /query/style_form/explode_true/object | Test query parameter(s) *QueryApi* | [**TestQueryStyleFormExplodeTrueObjectAllOf**](docs/QueryApi.md#TestQueryStyleFormExplodeTrueObjectAllOf) | **GET** /query/style_form/explode_true/object/allOf | Test query parameter(s) diff --git a/samples/client/echo_api/r/docs/QueryApi.md b/samples/client/echo_api/r/docs/QueryApi.md index fda052d2b814..1c9807fa862f 100644 --- a/samples/client/echo_api/r/docs/QueryApi.md +++ b/samples/client/echo_api/r/docs/QueryApi.md @@ -9,6 +9,8 @@ Method | HTTP request | Description [**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) +[**TestQueryStyleFormExplodeFalseArrayInteger**](QueryApi.md#TestQueryStyleFormExplodeFalseArrayInteger) | **GET** /query/style_form/explode_false/array_integer | Test query parameter(s) +[**TestQueryStyleFormExplodeFalseArrayString**](QueryApi.md#TestQueryStyleFormExplodeFalseArrayString) | **GET** /query/style_form/explode_false/array_string | 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) @@ -259,6 +261,100 @@ No authorization required |-------------|-------------|------------------| | **200** | Successful operation | - | +# **TestQueryStyleFormExplodeFalseArrayInteger** +> character TestQueryStyleFormExplodeFalseArrayInteger(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 <- c(123) # array[integer] | (Optional) + +api_instance <- QueryApi$new() +# to save the result into a file, simply add the optional `data_file` parameter, e.g. +# result <- api_instance$TestQueryStyleFormExplodeFalseArrayInteger(query_object = var_query_objectdata_file = "result.txt") +result <- api_instance$TestQueryStyleFormExplodeFalseArrayInteger(query_object = var_query_object) +dput(result) +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **query_object** | list( **integer** )| | [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 | - | + +# **TestQueryStyleFormExplodeFalseArrayString** +> character TestQueryStyleFormExplodeFalseArrayString(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 <- c("inner_example") # array[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$TestQueryStyleFormExplodeFalseArrayString(query_object = var_query_objectdata_file = "result.txt") +result <- api_instance$TestQueryStyleFormExplodeFalseArrayString(query_object = var_query_object) +dput(result) +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **query_object** | list( **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 | - | + # **TestQueryStyleFormExplodeTrueArrayString** > character TestQueryStyleFormExplodeTrueArrayString(query_object = var.query_object) diff --git a/samples/client/echo_api/ruby-faraday/README.md b/samples/client/echo_api/ruby-faraday/README.md index 0c10000333e9..184300558b5a 100644 --- a/samples/client/echo_api/ruby-faraday/README.md +++ b/samples/client/echo_api/ruby-faraday/README.md @@ -103,6 +103,8 @@ Class | Method | HTTP request | Description *OpenapiClient::QueryApi* | [**test_query_integer_boolean_string**](docs/QueryApi.md#test_query_integer_boolean_string) | **GET** /query/integer/boolean/string | Test query parameter(s) *OpenapiClient::QueryApi* | [**test_query_style_deep_object_explode_true_object**](docs/QueryApi.md#test_query_style_deep_object_explode_true_object) | **GET** /query/style_deepObject/explode_true/object | Test query parameter(s) *OpenapiClient::QueryApi* | [**test_query_style_deep_object_explode_true_object_all_of**](docs/QueryApi.md#test_query_style_deep_object_explode_true_object_all_of) | **GET** /query/style_deepObject/explode_true/object/allOf | Test query parameter(s) +*OpenapiClient::QueryApi* | [**test_query_style_form_explode_false_array_integer**](docs/QueryApi.md#test_query_style_form_explode_false_array_integer) | **GET** /query/style_form/explode_false/array_integer | Test query parameter(s) +*OpenapiClient::QueryApi* | [**test_query_style_form_explode_false_array_string**](docs/QueryApi.md#test_query_style_form_explode_false_array_string) | **GET** /query/style_form/explode_false/array_string | Test query parameter(s) *OpenapiClient::QueryApi* | [**test_query_style_form_explode_true_array_string**](docs/QueryApi.md#test_query_style_form_explode_true_array_string) | **GET** /query/style_form/explode_true/array_string | Test query parameter(s) *OpenapiClient::QueryApi* | [**test_query_style_form_explode_true_object**](docs/QueryApi.md#test_query_style_form_explode_true_object) | **GET** /query/style_form/explode_true/object | Test query parameter(s) *OpenapiClient::QueryApi* | [**test_query_style_form_explode_true_object_all_of**](docs/QueryApi.md#test_query_style_form_explode_true_object_all_of) | **GET** /query/style_form/explode_true/object/allOf | Test query parameter(s) diff --git a/samples/client/echo_api/ruby-faraday/docs/QueryApi.md b/samples/client/echo_api/ruby-faraday/docs/QueryApi.md index 2dd28c34060b..128b8cdc4b91 100644 --- a/samples/client/echo_api/ruby-faraday/docs/QueryApi.md +++ b/samples/client/echo_api/ruby-faraday/docs/QueryApi.md @@ -9,6 +9,8 @@ All URIs are relative to *http://localhost:3000* | [**test_query_integer_boolean_string**](QueryApi.md#test_query_integer_boolean_string) | **GET** /query/integer/boolean/string | Test query parameter(s) | | [**test_query_style_deep_object_explode_true_object**](QueryApi.md#test_query_style_deep_object_explode_true_object) | **GET** /query/style_deepObject/explode_true/object | Test query parameter(s) | | [**test_query_style_deep_object_explode_true_object_all_of**](QueryApi.md#test_query_style_deep_object_explode_true_object_all_of) | **GET** /query/style_deepObject/explode_true/object/allOf | Test query parameter(s) | +| [**test_query_style_form_explode_false_array_integer**](QueryApi.md#test_query_style_form_explode_false_array_integer) | **GET** /query/style_form/explode_false/array_integer | Test query parameter(s) | +| [**test_query_style_form_explode_false_array_string**](QueryApi.md#test_query_style_form_explode_false_array_string) | **GET** /query/style_form/explode_false/array_string | Test query parameter(s) | | [**test_query_style_form_explode_true_array_string**](QueryApi.md#test_query_style_form_explode_true_array_string) | **GET** /query/style_form/explode_true/array_string | Test query parameter(s) | | [**test_query_style_form_explode_true_object**](QueryApi.md#test_query_style_form_explode_true_object) | **GET** /query/style_form/explode_true/object | Test query parameter(s) | | [**test_query_style_form_explode_true_object_all_of**](QueryApi.md#test_query_style_form_explode_true_object_all_of) | **GET** /query/style_form/explode_true/object/allOf | Test query parameter(s) | @@ -354,6 +356,138 @@ No authorization required - **Accept**: text/plain +## test_query_style_form_explode_false_array_integer + +> String test_query_style_form_explode_false_array_integer(opts) + +Test query parameter(s) + +Test query parameter(s) + +### Examples + +```ruby +require 'time' +require 'openapi_client' + +api_instance = OpenapiClient::QueryApi.new +opts = { + query_object: [37] # Array | +} + +begin + # Test query parameter(s) + result = api_instance.test_query_style_form_explode_false_array_integer(opts) + p result +rescue OpenapiClient::ApiError => e + puts "Error when calling QueryApi->test_query_style_form_explode_false_array_integer: #{e}" +end +``` + +#### Using the test_query_style_form_explode_false_array_integer_with_http_info variant + +This returns an Array which contains the response data, status code and headers. + +> test_query_style_form_explode_false_array_integer_with_http_info(opts) + +```ruby +begin + # Test query parameter(s) + data, status_code, headers = api_instance.test_query_style_form_explode_false_array_integer_with_http_info(opts) + p status_code # => 2xx + p headers # => { ... } + p data # => String +rescue OpenapiClient::ApiError => e + puts "Error when calling QueryApi->test_query_style_form_explode_false_array_integer_with_http_info: #{e}" +end +``` + +### Parameters + +| Name | Type | Description | Notes | +| ---- | ---- | ----------- | ----- | +| **query_object** | [**Array<Integer>**](Integer.md) | | [optional] | + +### Return type + +**String** + +### Authorization + +No authorization required + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: text/plain + + +## test_query_style_form_explode_false_array_string + +> String test_query_style_form_explode_false_array_string(opts) + +Test query parameter(s) + +Test query parameter(s) + +### Examples + +```ruby +require 'time' +require 'openapi_client' + +api_instance = OpenapiClient::QueryApi.new +opts = { + query_object: ['inner_example'] # Array | +} + +begin + # Test query parameter(s) + result = api_instance.test_query_style_form_explode_false_array_string(opts) + p result +rescue OpenapiClient::ApiError => e + puts "Error when calling QueryApi->test_query_style_form_explode_false_array_string: #{e}" +end +``` + +#### Using the test_query_style_form_explode_false_array_string_with_http_info variant + +This returns an Array which contains the response data, status code and headers. + +> test_query_style_form_explode_false_array_string_with_http_info(opts) + +```ruby +begin + # Test query parameter(s) + data, status_code, headers = api_instance.test_query_style_form_explode_false_array_string_with_http_info(opts) + p status_code # => 2xx + p headers # => { ... } + p data # => String +rescue OpenapiClient::ApiError => e + puts "Error when calling QueryApi->test_query_style_form_explode_false_array_string_with_http_info: #{e}" +end +``` + +### Parameters + +| Name | Type | Description | Notes | +| ---- | ---- | ----------- | ----- | +| **query_object** | [**Array<String>**](String.md) | | [optional] | + +### Return type + +**String** + +### Authorization + +No authorization required + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: text/plain + + ## test_query_style_form_explode_true_array_string > String test_query_style_form_explode_true_array_string(opts) diff --git a/samples/client/echo_api/ruby-faraday/lib/openapi_client/api/query_api.rb b/samples/client/echo_api/ruby-faraday/lib/openapi_client/api/query_api.rb index 5871d351e006..81fdcb491971 100644 --- a/samples/client/echo_api/ruby-faraday/lib/openapi_client/api/query_api.rb +++ b/samples/client/echo_api/ruby-faraday/lib/openapi_client/api/query_api.rb @@ -338,6 +338,126 @@ def test_query_style_deep_object_explode_true_object_all_of_with_http_info(opts return data, status_code, headers end + # Test query parameter(s) + # Test query parameter(s) + # @param [Hash] opts the optional parameters + # @option opts [Array] :query_object + # @return [String] + def test_query_style_form_explode_false_array_integer(opts = {}) + data, _status_code, _headers = test_query_style_form_explode_false_array_integer_with_http_info(opts) + data + end + + # Test query parameter(s) + # Test query parameter(s) + # @param [Hash] opts the optional parameters + # @option opts [Array] :query_object + # @return [Array<(String, Integer, Hash)>] String data, response status code and response headers + def test_query_style_form_explode_false_array_integer_with_http_info(opts = {}) + if @api_client.config.debugging + @api_client.config.logger.debug 'Calling API: QueryApi.test_query_style_form_explode_false_array_integer ...' + end + # resource path + local_var_path = '/query/style_form/explode_false/array_integer' + + # query parameters + query_params = opts[:query_params] || {} + query_params[:'query_object'] = @api_client.build_collection_param(opts[:'query_object'], :csv) if !opts[:'query_object'].nil? + + # header parameters + header_params = opts[:header_params] || {} + # HTTP header 'Accept' (if needed) + header_params['Accept'] = @api_client.select_header_accept(['text/plain']) + + # form parameters + form_params = opts[:form_params] || {} + + # http body (model) + post_body = opts[:debug_body] + + # return_type + return_type = opts[:debug_return_type] || 'String' + + # auth_names + auth_names = opts[:debug_auth_names] || [] + + new_options = opts.merge( + :operation => :"QueryApi.test_query_style_form_explode_false_array_integer", + :header_params => header_params, + :query_params => query_params, + :form_params => form_params, + :body => post_body, + :auth_names => auth_names, + :return_type => return_type + ) + + data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options) + if @api_client.config.debugging + @api_client.config.logger.debug "API called: QueryApi#test_query_style_form_explode_false_array_integer\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" + end + return data, status_code, headers + end + + # Test query parameter(s) + # Test query parameter(s) + # @param [Hash] opts the optional parameters + # @option opts [Array] :query_object + # @return [String] + def test_query_style_form_explode_false_array_string(opts = {}) + data, _status_code, _headers = test_query_style_form_explode_false_array_string_with_http_info(opts) + data + end + + # Test query parameter(s) + # Test query parameter(s) + # @param [Hash] opts the optional parameters + # @option opts [Array] :query_object + # @return [Array<(String, Integer, Hash)>] String data, response status code and response headers + def test_query_style_form_explode_false_array_string_with_http_info(opts = {}) + if @api_client.config.debugging + @api_client.config.logger.debug 'Calling API: QueryApi.test_query_style_form_explode_false_array_string ...' + end + # resource path + local_var_path = '/query/style_form/explode_false/array_string' + + # query parameters + query_params = opts[:query_params] || {} + query_params[:'query_object'] = @api_client.build_collection_param(opts[:'query_object'], :csv) if !opts[:'query_object'].nil? + + # header parameters + header_params = opts[:header_params] || {} + # HTTP header 'Accept' (if needed) + header_params['Accept'] = @api_client.select_header_accept(['text/plain']) + + # form parameters + form_params = opts[:form_params] || {} + + # http body (model) + post_body = opts[:debug_body] + + # return_type + return_type = opts[:debug_return_type] || 'String' + + # auth_names + auth_names = opts[:debug_auth_names] || [] + + new_options = opts.merge( + :operation => :"QueryApi.test_query_style_form_explode_false_array_string", + :header_params => header_params, + :query_params => query_params, + :form_params => form_params, + :body => post_body, + :auth_names => auth_names, + :return_type => return_type + ) + + data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options) + if @api_client.config.debugging + @api_client.config.logger.debug "API called: QueryApi#test_query_style_form_explode_false_array_string\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" + end + return data, status_code, headers + end + # Test query parameter(s) # Test query parameter(s) # @param [Hash] opts the optional parameters diff --git a/samples/client/echo_api/ruby-httpx/README.md b/samples/client/echo_api/ruby-httpx/README.md index d389064972b1..ea9a964bec08 100644 --- a/samples/client/echo_api/ruby-httpx/README.md +++ b/samples/client/echo_api/ruby-httpx/README.md @@ -103,6 +103,8 @@ Class | Method | HTTP request | Description *OpenapiClient::QueryApi* | [**test_query_integer_boolean_string**](docs/QueryApi.md#test_query_integer_boolean_string) | **GET** /query/integer/boolean/string | Test query parameter(s) *OpenapiClient::QueryApi* | [**test_query_style_deep_object_explode_true_object**](docs/QueryApi.md#test_query_style_deep_object_explode_true_object) | **GET** /query/style_deepObject/explode_true/object | Test query parameter(s) *OpenapiClient::QueryApi* | [**test_query_style_deep_object_explode_true_object_all_of**](docs/QueryApi.md#test_query_style_deep_object_explode_true_object_all_of) | **GET** /query/style_deepObject/explode_true/object/allOf | Test query parameter(s) +*OpenapiClient::QueryApi* | [**test_query_style_form_explode_false_array_integer**](docs/QueryApi.md#test_query_style_form_explode_false_array_integer) | **GET** /query/style_form/explode_false/array_integer | Test query parameter(s) +*OpenapiClient::QueryApi* | [**test_query_style_form_explode_false_array_string**](docs/QueryApi.md#test_query_style_form_explode_false_array_string) | **GET** /query/style_form/explode_false/array_string | Test query parameter(s) *OpenapiClient::QueryApi* | [**test_query_style_form_explode_true_array_string**](docs/QueryApi.md#test_query_style_form_explode_true_array_string) | **GET** /query/style_form/explode_true/array_string | Test query parameter(s) *OpenapiClient::QueryApi* | [**test_query_style_form_explode_true_object**](docs/QueryApi.md#test_query_style_form_explode_true_object) | **GET** /query/style_form/explode_true/object | Test query parameter(s) *OpenapiClient::QueryApi* | [**test_query_style_form_explode_true_object_all_of**](docs/QueryApi.md#test_query_style_form_explode_true_object_all_of) | **GET** /query/style_form/explode_true/object/allOf | Test query parameter(s) diff --git a/samples/client/echo_api/ruby-httpx/docs/QueryApi.md b/samples/client/echo_api/ruby-httpx/docs/QueryApi.md index 2dd28c34060b..128b8cdc4b91 100644 --- a/samples/client/echo_api/ruby-httpx/docs/QueryApi.md +++ b/samples/client/echo_api/ruby-httpx/docs/QueryApi.md @@ -9,6 +9,8 @@ All URIs are relative to *http://localhost:3000* | [**test_query_integer_boolean_string**](QueryApi.md#test_query_integer_boolean_string) | **GET** /query/integer/boolean/string | Test query parameter(s) | | [**test_query_style_deep_object_explode_true_object**](QueryApi.md#test_query_style_deep_object_explode_true_object) | **GET** /query/style_deepObject/explode_true/object | Test query parameter(s) | | [**test_query_style_deep_object_explode_true_object_all_of**](QueryApi.md#test_query_style_deep_object_explode_true_object_all_of) | **GET** /query/style_deepObject/explode_true/object/allOf | Test query parameter(s) | +| [**test_query_style_form_explode_false_array_integer**](QueryApi.md#test_query_style_form_explode_false_array_integer) | **GET** /query/style_form/explode_false/array_integer | Test query parameter(s) | +| [**test_query_style_form_explode_false_array_string**](QueryApi.md#test_query_style_form_explode_false_array_string) | **GET** /query/style_form/explode_false/array_string | Test query parameter(s) | | [**test_query_style_form_explode_true_array_string**](QueryApi.md#test_query_style_form_explode_true_array_string) | **GET** /query/style_form/explode_true/array_string | Test query parameter(s) | | [**test_query_style_form_explode_true_object**](QueryApi.md#test_query_style_form_explode_true_object) | **GET** /query/style_form/explode_true/object | Test query parameter(s) | | [**test_query_style_form_explode_true_object_all_of**](QueryApi.md#test_query_style_form_explode_true_object_all_of) | **GET** /query/style_form/explode_true/object/allOf | Test query parameter(s) | @@ -354,6 +356,138 @@ No authorization required - **Accept**: text/plain +## test_query_style_form_explode_false_array_integer + +> String test_query_style_form_explode_false_array_integer(opts) + +Test query parameter(s) + +Test query parameter(s) + +### Examples + +```ruby +require 'time' +require 'openapi_client' + +api_instance = OpenapiClient::QueryApi.new +opts = { + query_object: [37] # Array | +} + +begin + # Test query parameter(s) + result = api_instance.test_query_style_form_explode_false_array_integer(opts) + p result +rescue OpenapiClient::ApiError => e + puts "Error when calling QueryApi->test_query_style_form_explode_false_array_integer: #{e}" +end +``` + +#### Using the test_query_style_form_explode_false_array_integer_with_http_info variant + +This returns an Array which contains the response data, status code and headers. + +> test_query_style_form_explode_false_array_integer_with_http_info(opts) + +```ruby +begin + # Test query parameter(s) + data, status_code, headers = api_instance.test_query_style_form_explode_false_array_integer_with_http_info(opts) + p status_code # => 2xx + p headers # => { ... } + p data # => String +rescue OpenapiClient::ApiError => e + puts "Error when calling QueryApi->test_query_style_form_explode_false_array_integer_with_http_info: #{e}" +end +``` + +### Parameters + +| Name | Type | Description | Notes | +| ---- | ---- | ----------- | ----- | +| **query_object** | [**Array<Integer>**](Integer.md) | | [optional] | + +### Return type + +**String** + +### Authorization + +No authorization required + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: text/plain + + +## test_query_style_form_explode_false_array_string + +> String test_query_style_form_explode_false_array_string(opts) + +Test query parameter(s) + +Test query parameter(s) + +### Examples + +```ruby +require 'time' +require 'openapi_client' + +api_instance = OpenapiClient::QueryApi.new +opts = { + query_object: ['inner_example'] # Array | +} + +begin + # Test query parameter(s) + result = api_instance.test_query_style_form_explode_false_array_string(opts) + p result +rescue OpenapiClient::ApiError => e + puts "Error when calling QueryApi->test_query_style_form_explode_false_array_string: #{e}" +end +``` + +#### Using the test_query_style_form_explode_false_array_string_with_http_info variant + +This returns an Array which contains the response data, status code and headers. + +> test_query_style_form_explode_false_array_string_with_http_info(opts) + +```ruby +begin + # Test query parameter(s) + data, status_code, headers = api_instance.test_query_style_form_explode_false_array_string_with_http_info(opts) + p status_code # => 2xx + p headers # => { ... } + p data # => String +rescue OpenapiClient::ApiError => e + puts "Error when calling QueryApi->test_query_style_form_explode_false_array_string_with_http_info: #{e}" +end +``` + +### Parameters + +| Name | Type | Description | Notes | +| ---- | ---- | ----------- | ----- | +| **query_object** | [**Array<String>**](String.md) | | [optional] | + +### Return type + +**String** + +### Authorization + +No authorization required + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: text/plain + + ## test_query_style_form_explode_true_array_string > String test_query_style_form_explode_true_array_string(opts) diff --git a/samples/client/echo_api/ruby-httpx/lib/openapi_client/api/query_api.rb b/samples/client/echo_api/ruby-httpx/lib/openapi_client/api/query_api.rb index 5871d351e006..81fdcb491971 100644 --- a/samples/client/echo_api/ruby-httpx/lib/openapi_client/api/query_api.rb +++ b/samples/client/echo_api/ruby-httpx/lib/openapi_client/api/query_api.rb @@ -338,6 +338,126 @@ def test_query_style_deep_object_explode_true_object_all_of_with_http_info(opts return data, status_code, headers end + # Test query parameter(s) + # Test query parameter(s) + # @param [Hash] opts the optional parameters + # @option opts [Array] :query_object + # @return [String] + def test_query_style_form_explode_false_array_integer(opts = {}) + data, _status_code, _headers = test_query_style_form_explode_false_array_integer_with_http_info(opts) + data + end + + # Test query parameter(s) + # Test query parameter(s) + # @param [Hash] opts the optional parameters + # @option opts [Array] :query_object + # @return [Array<(String, Integer, Hash)>] String data, response status code and response headers + def test_query_style_form_explode_false_array_integer_with_http_info(opts = {}) + if @api_client.config.debugging + @api_client.config.logger.debug 'Calling API: QueryApi.test_query_style_form_explode_false_array_integer ...' + end + # resource path + local_var_path = '/query/style_form/explode_false/array_integer' + + # query parameters + query_params = opts[:query_params] || {} + query_params[:'query_object'] = @api_client.build_collection_param(opts[:'query_object'], :csv) if !opts[:'query_object'].nil? + + # header parameters + header_params = opts[:header_params] || {} + # HTTP header 'Accept' (if needed) + header_params['Accept'] = @api_client.select_header_accept(['text/plain']) + + # form parameters + form_params = opts[:form_params] || {} + + # http body (model) + post_body = opts[:debug_body] + + # return_type + return_type = opts[:debug_return_type] || 'String' + + # auth_names + auth_names = opts[:debug_auth_names] || [] + + new_options = opts.merge( + :operation => :"QueryApi.test_query_style_form_explode_false_array_integer", + :header_params => header_params, + :query_params => query_params, + :form_params => form_params, + :body => post_body, + :auth_names => auth_names, + :return_type => return_type + ) + + data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options) + if @api_client.config.debugging + @api_client.config.logger.debug "API called: QueryApi#test_query_style_form_explode_false_array_integer\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" + end + return data, status_code, headers + end + + # Test query parameter(s) + # Test query parameter(s) + # @param [Hash] opts the optional parameters + # @option opts [Array] :query_object + # @return [String] + def test_query_style_form_explode_false_array_string(opts = {}) + data, _status_code, _headers = test_query_style_form_explode_false_array_string_with_http_info(opts) + data + end + + # Test query parameter(s) + # Test query parameter(s) + # @param [Hash] opts the optional parameters + # @option opts [Array] :query_object + # @return [Array<(String, Integer, Hash)>] String data, response status code and response headers + def test_query_style_form_explode_false_array_string_with_http_info(opts = {}) + if @api_client.config.debugging + @api_client.config.logger.debug 'Calling API: QueryApi.test_query_style_form_explode_false_array_string ...' + end + # resource path + local_var_path = '/query/style_form/explode_false/array_string' + + # query parameters + query_params = opts[:query_params] || {} + query_params[:'query_object'] = @api_client.build_collection_param(opts[:'query_object'], :csv) if !opts[:'query_object'].nil? + + # header parameters + header_params = opts[:header_params] || {} + # HTTP header 'Accept' (if needed) + header_params['Accept'] = @api_client.select_header_accept(['text/plain']) + + # form parameters + form_params = opts[:form_params] || {} + + # http body (model) + post_body = opts[:debug_body] + + # return_type + return_type = opts[:debug_return_type] || 'String' + + # auth_names + auth_names = opts[:debug_auth_names] || [] + + new_options = opts.merge( + :operation => :"QueryApi.test_query_style_form_explode_false_array_string", + :header_params => header_params, + :query_params => query_params, + :form_params => form_params, + :body => post_body, + :auth_names => auth_names, + :return_type => return_type + ) + + data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options) + if @api_client.config.debugging + @api_client.config.logger.debug "API called: QueryApi#test_query_style_form_explode_false_array_string\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" + end + return data, status_code, headers + end + # Test query parameter(s) # Test query parameter(s) # @param [Hash] opts the optional parameters diff --git a/samples/client/echo_api/ruby-typhoeus/README.md b/samples/client/echo_api/ruby-typhoeus/README.md index cdaea764c1be..6c194cbdc433 100644 --- a/samples/client/echo_api/ruby-typhoeus/README.md +++ b/samples/client/echo_api/ruby-typhoeus/README.md @@ -101,6 +101,8 @@ Class | Method | HTTP request | Description *OpenapiClient::QueryApi* | [**test_query_integer_boolean_string**](docs/QueryApi.md#test_query_integer_boolean_string) | **GET** /query/integer/boolean/string | Test query parameter(s) *OpenapiClient::QueryApi* | [**test_query_style_deep_object_explode_true_object**](docs/QueryApi.md#test_query_style_deep_object_explode_true_object) | **GET** /query/style_deepObject/explode_true/object | Test query parameter(s) *OpenapiClient::QueryApi* | [**test_query_style_deep_object_explode_true_object_all_of**](docs/QueryApi.md#test_query_style_deep_object_explode_true_object_all_of) | **GET** /query/style_deepObject/explode_true/object/allOf | Test query parameter(s) +*OpenapiClient::QueryApi* | [**test_query_style_form_explode_false_array_integer**](docs/QueryApi.md#test_query_style_form_explode_false_array_integer) | **GET** /query/style_form/explode_false/array_integer | Test query parameter(s) +*OpenapiClient::QueryApi* | [**test_query_style_form_explode_false_array_string**](docs/QueryApi.md#test_query_style_form_explode_false_array_string) | **GET** /query/style_form/explode_false/array_string | Test query parameter(s) *OpenapiClient::QueryApi* | [**test_query_style_form_explode_true_array_string**](docs/QueryApi.md#test_query_style_form_explode_true_array_string) | **GET** /query/style_form/explode_true/array_string | Test query parameter(s) *OpenapiClient::QueryApi* | [**test_query_style_form_explode_true_object**](docs/QueryApi.md#test_query_style_form_explode_true_object) | **GET** /query/style_form/explode_true/object | Test query parameter(s) *OpenapiClient::QueryApi* | [**test_query_style_form_explode_true_object_all_of**](docs/QueryApi.md#test_query_style_form_explode_true_object_all_of) | **GET** /query/style_form/explode_true/object/allOf | Test query parameter(s) diff --git a/samples/client/echo_api/ruby-typhoeus/docs/QueryApi.md b/samples/client/echo_api/ruby-typhoeus/docs/QueryApi.md index 2dd28c34060b..128b8cdc4b91 100644 --- a/samples/client/echo_api/ruby-typhoeus/docs/QueryApi.md +++ b/samples/client/echo_api/ruby-typhoeus/docs/QueryApi.md @@ -9,6 +9,8 @@ All URIs are relative to *http://localhost:3000* | [**test_query_integer_boolean_string**](QueryApi.md#test_query_integer_boolean_string) | **GET** /query/integer/boolean/string | Test query parameter(s) | | [**test_query_style_deep_object_explode_true_object**](QueryApi.md#test_query_style_deep_object_explode_true_object) | **GET** /query/style_deepObject/explode_true/object | Test query parameter(s) | | [**test_query_style_deep_object_explode_true_object_all_of**](QueryApi.md#test_query_style_deep_object_explode_true_object_all_of) | **GET** /query/style_deepObject/explode_true/object/allOf | Test query parameter(s) | +| [**test_query_style_form_explode_false_array_integer**](QueryApi.md#test_query_style_form_explode_false_array_integer) | **GET** /query/style_form/explode_false/array_integer | Test query parameter(s) | +| [**test_query_style_form_explode_false_array_string**](QueryApi.md#test_query_style_form_explode_false_array_string) | **GET** /query/style_form/explode_false/array_string | Test query parameter(s) | | [**test_query_style_form_explode_true_array_string**](QueryApi.md#test_query_style_form_explode_true_array_string) | **GET** /query/style_form/explode_true/array_string | Test query parameter(s) | | [**test_query_style_form_explode_true_object**](QueryApi.md#test_query_style_form_explode_true_object) | **GET** /query/style_form/explode_true/object | Test query parameter(s) | | [**test_query_style_form_explode_true_object_all_of**](QueryApi.md#test_query_style_form_explode_true_object_all_of) | **GET** /query/style_form/explode_true/object/allOf | Test query parameter(s) | @@ -354,6 +356,138 @@ No authorization required - **Accept**: text/plain +## test_query_style_form_explode_false_array_integer + +> String test_query_style_form_explode_false_array_integer(opts) + +Test query parameter(s) + +Test query parameter(s) + +### Examples + +```ruby +require 'time' +require 'openapi_client' + +api_instance = OpenapiClient::QueryApi.new +opts = { + query_object: [37] # Array | +} + +begin + # Test query parameter(s) + result = api_instance.test_query_style_form_explode_false_array_integer(opts) + p result +rescue OpenapiClient::ApiError => e + puts "Error when calling QueryApi->test_query_style_form_explode_false_array_integer: #{e}" +end +``` + +#### Using the test_query_style_form_explode_false_array_integer_with_http_info variant + +This returns an Array which contains the response data, status code and headers. + +> test_query_style_form_explode_false_array_integer_with_http_info(opts) + +```ruby +begin + # Test query parameter(s) + data, status_code, headers = api_instance.test_query_style_form_explode_false_array_integer_with_http_info(opts) + p status_code # => 2xx + p headers # => { ... } + p data # => String +rescue OpenapiClient::ApiError => e + puts "Error when calling QueryApi->test_query_style_form_explode_false_array_integer_with_http_info: #{e}" +end +``` + +### Parameters + +| Name | Type | Description | Notes | +| ---- | ---- | ----------- | ----- | +| **query_object** | [**Array<Integer>**](Integer.md) | | [optional] | + +### Return type + +**String** + +### Authorization + +No authorization required + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: text/plain + + +## test_query_style_form_explode_false_array_string + +> String test_query_style_form_explode_false_array_string(opts) + +Test query parameter(s) + +Test query parameter(s) + +### Examples + +```ruby +require 'time' +require 'openapi_client' + +api_instance = OpenapiClient::QueryApi.new +opts = { + query_object: ['inner_example'] # Array | +} + +begin + # Test query parameter(s) + result = api_instance.test_query_style_form_explode_false_array_string(opts) + p result +rescue OpenapiClient::ApiError => e + puts "Error when calling QueryApi->test_query_style_form_explode_false_array_string: #{e}" +end +``` + +#### Using the test_query_style_form_explode_false_array_string_with_http_info variant + +This returns an Array which contains the response data, status code and headers. + +> test_query_style_form_explode_false_array_string_with_http_info(opts) + +```ruby +begin + # Test query parameter(s) + data, status_code, headers = api_instance.test_query_style_form_explode_false_array_string_with_http_info(opts) + p status_code # => 2xx + p headers # => { ... } + p data # => String +rescue OpenapiClient::ApiError => e + puts "Error when calling QueryApi->test_query_style_form_explode_false_array_string_with_http_info: #{e}" +end +``` + +### Parameters + +| Name | Type | Description | Notes | +| ---- | ---- | ----------- | ----- | +| **query_object** | [**Array<String>**](String.md) | | [optional] | + +### Return type + +**String** + +### Authorization + +No authorization required + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: text/plain + + ## test_query_style_form_explode_true_array_string > String test_query_style_form_explode_true_array_string(opts) diff --git a/samples/client/echo_api/ruby-typhoeus/lib/openapi_client/api/query_api.rb b/samples/client/echo_api/ruby-typhoeus/lib/openapi_client/api/query_api.rb index 5871d351e006..81fdcb491971 100644 --- a/samples/client/echo_api/ruby-typhoeus/lib/openapi_client/api/query_api.rb +++ b/samples/client/echo_api/ruby-typhoeus/lib/openapi_client/api/query_api.rb @@ -338,6 +338,126 @@ def test_query_style_deep_object_explode_true_object_all_of_with_http_info(opts return data, status_code, headers end + # Test query parameter(s) + # Test query parameter(s) + # @param [Hash] opts the optional parameters + # @option opts [Array] :query_object + # @return [String] + def test_query_style_form_explode_false_array_integer(opts = {}) + data, _status_code, _headers = test_query_style_form_explode_false_array_integer_with_http_info(opts) + data + end + + # Test query parameter(s) + # Test query parameter(s) + # @param [Hash] opts the optional parameters + # @option opts [Array] :query_object + # @return [Array<(String, Integer, Hash)>] String data, response status code and response headers + def test_query_style_form_explode_false_array_integer_with_http_info(opts = {}) + if @api_client.config.debugging + @api_client.config.logger.debug 'Calling API: QueryApi.test_query_style_form_explode_false_array_integer ...' + end + # resource path + local_var_path = '/query/style_form/explode_false/array_integer' + + # query parameters + query_params = opts[:query_params] || {} + query_params[:'query_object'] = @api_client.build_collection_param(opts[:'query_object'], :csv) if !opts[:'query_object'].nil? + + # header parameters + header_params = opts[:header_params] || {} + # HTTP header 'Accept' (if needed) + header_params['Accept'] = @api_client.select_header_accept(['text/plain']) + + # form parameters + form_params = opts[:form_params] || {} + + # http body (model) + post_body = opts[:debug_body] + + # return_type + return_type = opts[:debug_return_type] || 'String' + + # auth_names + auth_names = opts[:debug_auth_names] || [] + + new_options = opts.merge( + :operation => :"QueryApi.test_query_style_form_explode_false_array_integer", + :header_params => header_params, + :query_params => query_params, + :form_params => form_params, + :body => post_body, + :auth_names => auth_names, + :return_type => return_type + ) + + data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options) + if @api_client.config.debugging + @api_client.config.logger.debug "API called: QueryApi#test_query_style_form_explode_false_array_integer\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" + end + return data, status_code, headers + end + + # Test query parameter(s) + # Test query parameter(s) + # @param [Hash] opts the optional parameters + # @option opts [Array] :query_object + # @return [String] + def test_query_style_form_explode_false_array_string(opts = {}) + data, _status_code, _headers = test_query_style_form_explode_false_array_string_with_http_info(opts) + data + end + + # Test query parameter(s) + # Test query parameter(s) + # @param [Hash] opts the optional parameters + # @option opts [Array] :query_object + # @return [Array<(String, Integer, Hash)>] String data, response status code and response headers + def test_query_style_form_explode_false_array_string_with_http_info(opts = {}) + if @api_client.config.debugging + @api_client.config.logger.debug 'Calling API: QueryApi.test_query_style_form_explode_false_array_string ...' + end + # resource path + local_var_path = '/query/style_form/explode_false/array_string' + + # query parameters + query_params = opts[:query_params] || {} + query_params[:'query_object'] = @api_client.build_collection_param(opts[:'query_object'], :csv) if !opts[:'query_object'].nil? + + # header parameters + header_params = opts[:header_params] || {} + # HTTP header 'Accept' (if needed) + header_params['Accept'] = @api_client.select_header_accept(['text/plain']) + + # form parameters + form_params = opts[:form_params] || {} + + # http body (model) + post_body = opts[:debug_body] + + # return_type + return_type = opts[:debug_return_type] || 'String' + + # auth_names + auth_names = opts[:debug_auth_names] || [] + + new_options = opts.merge( + :operation => :"QueryApi.test_query_style_form_explode_false_array_string", + :header_params => header_params, + :query_params => query_params, + :form_params => form_params, + :body => post_body, + :auth_names => auth_names, + :return_type => return_type + ) + + data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options) + if @api_client.config.debugging + @api_client.config.logger.debug "API called: QueryApi#test_query_style_form_explode_false_array_string\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" + end + return data, status_code, headers + end + # Test query parameter(s) # Test query parameter(s) # @param [Hash] opts the optional parameters diff --git a/samples/client/echo_api/typescript-axios/build/api.ts b/samples/client/echo_api/typescript-axios/build/api.ts index 6ab7d46ec26c..9c021d6d21de 100644 --- a/samples/client/echo_api/typescript-axios/build/api.ts +++ b/samples/client/echo_api/typescript-axios/build/api.ts @@ -1916,6 +1916,76 @@ export const QueryApiAxiosParamCreator = function (configuration?: Configuration + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; + + return { + url: toPathString(localVarUrlObj), + options: localVarRequestOptions, + }; + }, + /** + * Test query parameter(s) + * @summary Test query parameter(s) + * @param {Array} [queryObject] + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + testQueryStyleFormExplodeFalseArrayInteger: async (queryObject?: Array, options: RawAxiosRequestConfig = {}): Promise => { + const localVarPath = `/query/style_form/explode_false/array_integer`; + // use dummy base URL string because the URL constructor only accepts absolute URLs. + const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); + let baseOptions; + if (configuration) { + baseOptions = configuration.baseOptions; + } + + const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options}; + const localVarHeaderParameter = {} as any; + const localVarQueryParameter = {} as any; + + if (queryObject) { + localVarQueryParameter['query_object'] = queryObject.join(COLLECTION_FORMATS.csv); + } + + + + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; + + return { + url: toPathString(localVarUrlObj), + options: localVarRequestOptions, + }; + }, + /** + * Test query parameter(s) + * @summary Test query parameter(s) + * @param {Array} [queryObject] + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + testQueryStyleFormExplodeFalseArrayString: async (queryObject?: Array, options: RawAxiosRequestConfig = {}): Promise => { + const localVarPath = `/query/style_form/explode_false/array_string`; + // use dummy base URL string because the URL constructor only accepts absolute URLs. + const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); + let baseOptions; + if (configuration) { + baseOptions = configuration.baseOptions; + } + + const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options}; + const localVarHeaderParameter = {} as any; + const localVarQueryParameter = {} as any; + + if (queryObject) { + localVarQueryParameter['query_object'] = queryObject.join(COLLECTION_FORMATS.csv); + } + + + setSearchParams(localVarUrlObj, localVarQueryParameter); let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; @@ -2116,6 +2186,32 @@ export const QueryApiFp = function(configuration?: Configuration) { const localVarOperationServerBasePath = operationServerMap['QueryApi.testQueryStyleDeepObjectExplodeTrueObjectAllOf']?.[localVarOperationServerIndex]?.url; return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); }, + /** + * Test query parameter(s) + * @summary Test query parameter(s) + * @param {Array} [queryObject] + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + async testQueryStyleFormExplodeFalseArrayInteger(queryObject?: Array, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.testQueryStyleFormExplodeFalseArrayInteger(queryObject, options); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['QueryApi.testQueryStyleFormExplodeFalseArrayInteger']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * Test query parameter(s) + * @summary Test query parameter(s) + * @param {Array} [queryObject] + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + async testQueryStyleFormExplodeFalseArrayString(queryObject?: Array, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.testQueryStyleFormExplodeFalseArrayString(queryObject, options); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['QueryApi.testQueryStyleFormExplodeFalseArrayString']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, /** * Test query parameter(s) * @summary Test query parameter(s) @@ -2220,6 +2316,26 @@ export const QueryApiFactory = function (configuration?: Configuration, basePath testQueryStyleDeepObjectExplodeTrueObjectAllOf(queryObject?: TestQueryStyleDeepObjectExplodeTrueObjectAllOfQueryObjectParameter, options?: any): AxiosPromise { return localVarFp.testQueryStyleDeepObjectExplodeTrueObjectAllOf(queryObject, options).then((request) => request(axios, basePath)); }, + /** + * Test query parameter(s) + * @summary Test query parameter(s) + * @param {Array} [queryObject] + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + testQueryStyleFormExplodeFalseArrayInteger(queryObject?: Array, options?: any): AxiosPromise { + return localVarFp.testQueryStyleFormExplodeFalseArrayInteger(queryObject, options).then((request) => request(axios, basePath)); + }, + /** + * Test query parameter(s) + * @summary Test query parameter(s) + * @param {Array} [queryObject] + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + testQueryStyleFormExplodeFalseArrayString(queryObject?: Array, options?: any): AxiosPromise { + return localVarFp.testQueryStyleFormExplodeFalseArrayString(queryObject, options).then((request) => request(axios, basePath)); + }, /** * Test query parameter(s) * @summary Test query parameter(s) @@ -2325,6 +2441,30 @@ export class QueryApi extends BaseAPI { return QueryApiFp(this.configuration).testQueryStyleDeepObjectExplodeTrueObjectAllOf(queryObject, options).then((request) => request(this.axios, this.basePath)); } + /** + * Test query parameter(s) + * @summary Test query parameter(s) + * @param {Array} [queryObject] + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof QueryApi + */ + public testQueryStyleFormExplodeFalseArrayInteger(queryObject?: Array, options?: RawAxiosRequestConfig) { + return QueryApiFp(this.configuration).testQueryStyleFormExplodeFalseArrayInteger(queryObject, options).then((request) => request(this.axios, this.basePath)); + } + + /** + * Test query parameter(s) + * @summary Test query parameter(s) + * @param {Array} [queryObject] + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof QueryApi + */ + public testQueryStyleFormExplodeFalseArrayString(queryObject?: Array, options?: RawAxiosRequestConfig) { + return QueryApiFp(this.configuration).testQueryStyleFormExplodeFalseArrayString(queryObject, options).then((request) => request(this.axios, this.basePath)); + } + /** * Test query parameter(s) * @summary Test query parameter(s) From e7d6cfd0a00bd44166fcc31c4c00a7ee6ce0754b Mon Sep 17 00:00:00 2001 From: William Cheng Date: Tue, 23 Jan 2024 18:55:08 +0800 Subject: [PATCH 3/3] update samples --- samples/client/echo_api/r/R/query_api.R | 3 --- 1 file changed, 3 deletions(-) diff --git a/samples/client/echo_api/r/R/query_api.R b/samples/client/echo_api/r/R/query_api.R index f920147325c6..c1c62acd7e02 100644 --- a/samples/client/echo_api/r/R/query_api.R +++ b/samples/client/echo_api/r/R/query_api.R @@ -817,7 +817,6 @@ QueryApi <- R6::R6Class( deserialized_resp_obj <- tryCatch( self$api_client$deserialize(local_var_resp$response_as_text(), "character", loadNamespace("openapi")), -<<<<<<< HEAD error = function(e) { stop("Failed to deserialize response") } @@ -1002,8 +1001,6 @@ QueryApi <- R6::R6Class( deserialized_resp_obj <- tryCatch( self$api_client$deserialize(local_var_resp$response_as_text(), "character", loadNamespace("openapi")), -======= ->>>>>>> origin/master error = function(e) { stop("Failed to deserialize response") }