forked from loafle/openapi-generator-original

Robert Schweizer a0418c2855

[python][client] Clean up samples and CI (#17509 )

* chore: Remove leftover Github action file

This was probably added by mistake. A similar file is active in
.github/workflows/samples-python-pydantic-v1-petstore.yaml.

* chore: Remove leftover VERSION from old python-experimental sample

* ci: Stop running Python integration tests in Circle CI

These Python clients are all tested with Github Actions already, which
is faster, more cleanly separated and only runs on modifications.

I'm not cleaning up the pydantic-v1 client, I expect it to be removed soon anyway.

* chore: Remove true from sample folder name

python-disallowAdditionalPropertiesIfNotPresent-true
-> python-disallowAdditionalPropertiesIfNotPresent

2024-01-16 10:34:04 +08:00

18 KiB

Raw Blame History

openapi_client.QueryApi

All URIs are relative to http://localhost:3000

Method	HTTP request	Description
test_enum_ref_string	GET /query/enum_ref_string	Test query parameter(s)
test_query_datetime_date_string	GET /query/datetime/date/string	Test query parameter(s)
test_query_integer_boolean_string	GET /query/integer/boolean/string	Test query parameter(s)
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	GET /query/style_deepObject/explode_true/object/allOf	Test query parameter(s)
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	GET /query/style_form/explode_true/object	Test query parameter(s)
test_query_style_form_explode_true_object_all_of	GET /query/style_form/explode_true/object/allOf	Test query parameter(s)

test_enum_ref_string

str test_enum_ref_string(enum_nonref_string_query=enum_nonref_string_query, enum_ref_string_query=enum_ref_string_query)

Test query parameter(s)

Example

import openapi_client
from openapi_client.models.string_enum_ref import StringEnumRef
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)
    enum_nonref_string_query = 'enum_nonref_string_query_example' # str |  (optional)
    enum_ref_string_query = openapi_client.StringEnumRef() # StringEnumRef |  (optional)

    try:
        # Test query parameter(s)
        api_response = api_instance.test_enum_ref_string(enum_nonref_string_query=enum_nonref_string_query, enum_ref_string_query=enum_ref_string_query)
        print("The response of QueryApi->test_enum_ref_string:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling QueryApi->test_enum_ref_string: %s\n" % e)

Parameters

Name	Type	Description	Notes
enum_nonref_string_query	str		[optional]
enum_ref_string_query	StringEnumRef		[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] [Back to Model list] [Back to README]

test_query_datetime_date_string

str test_query_datetime_date_string(datetime_query=datetime_query, date_query=date_query, string_query=string_query)

Test query parameter(s)

Example

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)
    datetime_query = '2013-10-20T19:20:30+01:00' # datetime |  (optional)
    date_query = '2013-10-20' # date |  (optional)
    string_query = 'string_query_example' # str |  (optional)

    try:
        # Test query parameter(s)
        api_response = api_instance.test_query_datetime_date_string(datetime_query=datetime_query, date_query=date_query, string_query=string_query)
        print("The response of QueryApi->test_query_datetime_date_string:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling QueryApi->test_query_datetime_date_string: %s\n" % e)

Parameters

Name	Type	Notes
datetime_query	datetime	[optional]
date_query	date	[optional]
string_query	str	[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] [Back to Model list] [Back to README]

test_query_integer_boolean_string

str test_query_integer_boolean_string(integer_query=integer_query, boolean_query=boolean_query, string_query=string_query)

Test query parameter(s)

Example

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)
    integer_query = 56 # int |  (optional)
    boolean_query = True # bool |  (optional)
    string_query = 'string_query_example' # str |  (optional)

    try:
        # Test query parameter(s)
        api_response = api_instance.test_query_integer_boolean_string(integer_query=integer_query, boolean_query=boolean_query, string_query=string_query)
        print("The response of QueryApi->test_query_integer_boolean_string:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling QueryApi->test_query_integer_boolean_string: %s\n" % e)

Parameters

Name	Type	Notes
integer_query	int	[optional]
boolean_query	bool	[optional]
string_query	str	[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] [Back to Model list] [Back to README]

test_query_style_deep_object_explode_true_object

str test_query_style_deep_object_explode_true_object(query_object=query_object)

Test query parameter(s)

Example

import openapi_client
from openapi_client.models.pet import Pet
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 = openapi_client.Pet() # Pet |  (optional)

    try:
        # Test query parameter(s)
        api_response = api_instance.test_query_style_deep_object_explode_true_object(query_object=query_object)
        print("The response of QueryApi->test_query_style_deep_object_explode_true_object:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling QueryApi->test_query_style_deep_object_explode_true_object: %s\n" % e)

Parameters

Name	Type	Description	Notes
query_object	Pet		[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] [Back to Model list] [Back to README]

test_query_style_deep_object_explode_true_object_all_of

str test_query_style_deep_object_explode_true_object_all_of(query_object=query_object)

Test query parameter(s)

Example

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 = openapi_client.TestQueryStyleDeepObjectExplodeTrueObjectAllOfQueryObjectParameter() # TestQueryStyleDeepObjectExplodeTrueObjectAllOfQueryObjectParameter |  (optional)

    try:
        # Test query parameter(s)
        api_response = api_instance.test_query_style_deep_object_explode_true_object_all_of(query_object=query_object)
        print("The response of QueryApi->test_query_style_deep_object_explode_true_object_all_of:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling QueryApi->test_query_style_deep_object_explode_true_object_all_of: %s\n" % e)

Parameters

Name	Type	Description	Notes
query_object	TestQueryStyleDeepObjectExplodeTrueObjectAllOfQueryObjectParameter		[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] [Back to Model list] [Back to README]

test_query_style_form_explode_true_array_string

str test_query_style_form_explode_true_array_string(query_object=query_object)

Test query parameter(s)

Example

import openapi_client
from openapi_client.models.test_query_style_form_explode_true_array_string_query_object_parameter import TestQueryStyleFormExplodeTrueArrayStringQueryObjectParameter
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 = openapi_client.TestQueryStyleFormExplodeTrueArrayStringQueryObjectParameter() # TestQueryStyleFormExplodeTrueArrayStringQueryObjectParameter |  (optional)

    try:
        # Test query parameter(s)
        api_response = api_instance.test_query_style_form_explode_true_array_string(query_object=query_object)
        print("The response of QueryApi->test_query_style_form_explode_true_array_string:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling QueryApi->test_query_style_form_explode_true_array_string: %s\n" % e)

Parameters

Name	Type	Description	Notes
query_object	TestQueryStyleFormExplodeTrueArrayStringQueryObjectParameter		[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] [Back to Model list] [Back to README]

test_query_style_form_explode_true_object

str test_query_style_form_explode_true_object(query_object=query_object)

Test query parameter(s)

Example

import openapi_client
from openapi_client.models.pet import Pet
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 = openapi_client.Pet() # Pet |  (optional)

    try:
        # Test query parameter(s)
        api_response = api_instance.test_query_style_form_explode_true_object(query_object=query_object)
        print("The response of QueryApi->test_query_style_form_explode_true_object:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling QueryApi->test_query_style_form_explode_true_object: %s\n" % e)

Parameters

Name	Type	Description	Notes
query_object	Pet		[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] [Back to Model list] [Back to README]

test_query_style_form_explode_true_object_all_of

str test_query_style_form_explode_true_object_all_of(query_object=query_object)

Test query parameter(s)

Example

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 = openapi_client.DataQuery() # DataQuery |  (optional)

    try:
        # Test query parameter(s)
        api_response = api_instance.test_query_style_form_explode_true_object_all_of(query_object=query_object)
        print("The response of QueryApi->test_query_style_form_explode_true_object_all_of:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling QueryApi->test_query_style_form_explode_true_object_all_of: %s\n" % e)

Parameters

Name	Type	Description	Notes
query_object	DataQuery		[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] [Back to Model list] [Back to README]

18 KiB Raw Blame History

openapi_client.QueryApi

test_enum_ref_string

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

test_query_datetime_date_string

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

test_query_integer_boolean_string

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

test_query_style_deep_object_explode_true_object

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

test_query_style_deep_object_explode_true_object_all_of

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

test_query_style_form_explode_true_array_string

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

test_query_style_form_explode_true_object

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

test_query_style_form_explode_true_object_all_of

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

18 KiB

Raw Blame History