openapi-generator/samples/openapi3/client/petstore/python-experimental/docs/FakeApi.md

petstore_api.FakeApi

All URIs are relative to http://petstore.swagger.io:80/v2

Method	HTTP request	Description
fake_health_get	GET /fake/health	Health check endpoint
fake_outer_boolean_serialize	POST /fake/outer/boolean
fake_outer_composite_serialize	POST /fake/outer/composite
fake_outer_number_serialize	POST /fake/outer/number
fake_outer_string_serialize	POST /fake/outer/string
test_body_with_file_schema	PUT /fake/body-with-file-schema
test_body_with_query_params	PUT /fake/body-with-query-params
test_client_model	PATCH /fake	To test "client" model
test_endpoint_parameters	POST /fake	Fake endpoint for testing various parameters 假端點 偽のエンドポイント 가짜 엔드 포인트
test_enum_parameters	GET /fake	To test enum parameters
test_group_parameters	DELETE /fake	Fake endpoint to test group parameters (optional)
test_inline_additional_properties	POST /fake/inline-additionalProperties	test inline additionalProperties
test_json_form_data	GET /fake/jsonFormData	test json serialization of form data
test_query_parameter_collection_format	PUT /fake/test-query-paramters

fake_health_get

health_check_result.HealthCheckResult fake_health_get()

Health check endpoint

Example

from __future__ import print_function
import time
import petstore_api
from pprint import pprint

# Create an instance of the API class
api_instance = petstore_api.FakeApi()

# example, this endpoint has no required or optional parameters
try:
    # Health check endpoint
    api_response = api_instance.fake_health_get()
    pprint(api_response)
except petstore_api.ApiException as e:
    print("Exception when calling FakeApi->fake_health_get: %s\n" % e)

Parameters

This endpoint does not need any parameter.

Return type

health_check_result.HealthCheckResult

Authorization

No authorization required

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

HTTP response details

Status code	Description	Response headers
200	The instance started successfully	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

fake_outer_boolean_serialize

bool fake_outer_boolean_serialize()

Test serialization of outer boolean types

Example

from __future__ import print_function
import time
import petstore_api
from pprint import pprint

# Create an instance of the API class
api_instance = petstore_api.FakeApi()
body = True # bool | Input boolean as post body (optional)

# example passing only required values which don't have defaults set
# and optional values
try:
    api_response = api_instance.fake_outer_boolean_serialize(body=body)
    pprint(api_response)
except petstore_api.ApiException as e:
    print("Exception when calling FakeApi->fake_outer_boolean_serialize: %s\n" % e)

Parameters

Name	Type	Description	Notes
body	bool	Input boolean as post body	[optional]

Return type

bool

Authorization

No authorization required

HTTP request headers

• Content-Type: application/json
• Accept: /

HTTP response details

Status code	Description	Response headers
200	Output boolean	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

fake_outer_composite_serialize

outer_composite.OuterComposite fake_outer_composite_serialize()

Test serialization of object with outer number type

Example

from __future__ import print_function
import time
import petstore_api
from pprint import pprint

# Create an instance of the API class
api_instance = petstore_api.FakeApi()
outer_composite_outer_composite = petstore_api.OuterComposite() # outer_composite.OuterComposite | Input composite as post body (optional)

# example passing only required values which don't have defaults set
# and optional values
try:
    api_response = api_instance.fake_outer_composite_serialize(outer_composite_outer_composite=outer_composite_outer_composite)
    pprint(api_response)
except petstore_api.ApiException as e:
    print("Exception when calling FakeApi->fake_outer_composite_serialize: %s\n" % e)

Parameters

Name	Type	Description	Notes
outer_composite_outer_composite	outer_composite.OuterComposite	Input composite as post body	[optional]

Return type

outer_composite.OuterComposite

Authorization

No authorization required

HTTP request headers

• Content-Type: application/json
• Accept: /

HTTP response details

Status code	Description	Response headers
200	Output composite	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

fake_outer_number_serialize

float fake_outer_number_serialize()

Test serialization of outer number types

Example

from __future__ import print_function
import time
import petstore_api
from pprint import pprint

# Create an instance of the API class
api_instance = petstore_api.FakeApi()
body = 3.4 # float | Input number as post body (optional)

# example passing only required values which don't have defaults set
# and optional values
try:
    api_response = api_instance.fake_outer_number_serialize(body=body)
    pprint(api_response)
except petstore_api.ApiException as e:
    print("Exception when calling FakeApi->fake_outer_number_serialize: %s\n" % e)

Parameters

Name	Type	Description	Notes
body	float	Input number as post body	[optional]

Return type

float

Authorization

No authorization required

HTTP request headers

• Content-Type: application/json
• Accept: /

HTTP response details

Status code	Description	Response headers
200	Output number	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

fake_outer_string_serialize

str fake_outer_string_serialize()

Test serialization of outer string types

Example

from __future__ import print_function
import time
import petstore_api
from pprint import pprint

# Create an instance of the API class
api_instance = petstore_api.FakeApi()
body = 'body_example' # str | Input string as post body (optional)

# example passing only required values which don't have defaults set
# and optional values
try:
    api_response = api_instance.fake_outer_string_serialize(body=body)
    pprint(api_response)
except petstore_api.ApiException as e:
    print("Exception when calling FakeApi->fake_outer_string_serialize: %s\n" % e)

Parameters

Name	Type	Description	Notes
body	str	Input string as post body	[optional]

Return type

str

Authorization

No authorization required

HTTP request headers

• Content-Type: application/json
• Accept: /

HTTP response details

Status code	Description	Response headers
200	Output string	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

test_body_with_file_schema

test_body_with_file_schema(file_schema_test_class_file_schema_test_class)

For this test, the body for this request much reference a schema named File.

Example

from __future__ import print_function
import time
import petstore_api
from pprint import pprint

# Create an instance of the API class
api_instance = petstore_api.FakeApi()
file_schema_test_class_file_schema_test_class = petstore_api.FileSchemaTestClass() # file_schema_test_class.FileSchemaTestClass | 

# example passing only required values which don't have defaults set
try:
    api_instance.test_body_with_file_schema(file_schema_test_class_file_schema_test_class)
except petstore_api.ApiException as e:
    print("Exception when calling FakeApi->test_body_with_file_schema: %s\n" % e)

Parameters

Name	Type	Description	Notes
file_schema_test_class_file_schema_test_class	file_schema_test_class.FileSchemaTestClass

Return type

void (empty response body)

Authorization

No authorization required

HTTP request headers

• Content-Type: application/json
• Accept: Not defined

HTTP response details

Status code	Description	Response headers
200	Success	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

test_body_with_query_params

test_body_with_query_params(query, user_user)

Example

from __future__ import print_function
import time
import petstore_api
from pprint import pprint

# Create an instance of the API class
api_instance = petstore_api.FakeApi()
query = 'query_example' # str | 
user_user = petstore_api.User() # user.User | 

# example passing only required values which don't have defaults set
try:
    api_instance.test_body_with_query_params(query, user_user)
except petstore_api.ApiException as e:
    print("Exception when calling FakeApi->test_body_with_query_params: %s\n" % e)

Parameters

Name	Type	Description	Notes
query	str
user_user	user.User

Return type

void (empty response body)

Authorization

No authorization required

HTTP request headers

• Content-Type: application/json
• Accept: Not defined

HTTP response details

Status code	Description	Response headers
200	Success	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

test_client_model

client.Client test_client_model(client_client)

To test "client" model

To test "client" model

Example

from __future__ import print_function
import time
import petstore_api
from pprint import pprint

# Create an instance of the API class
api_instance = petstore_api.FakeApi()
client_client = petstore_api.Client() # client.Client | client model

# example passing only required values which don't have defaults set
try:
    # To test \"client\" model
    api_response = api_instance.test_client_model(client_client)
    pprint(api_response)
except petstore_api.ApiException as e:
    print("Exception when calling FakeApi->test_client_model: %s\n" % e)

Parameters

Name	Type	Description	Notes
client_client	client.Client	client model

Return type

client.Client

Authorization

No authorization required

HTTP request headers

• Content-Type: application/json
• Accept: application/json

HTTP response details

Status code	Description	Response headers
200	successful operation	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

test_endpoint_parameters

test_endpoint_parameters(number, double, pattern_without_delimiter, byte)

Fake endpoint for testing various parameters 假端點 偽のエンドポイント 가짜 엔드 포인트

Fake endpoint for testing various parameters 假端點 偽のエンドポイント 가짜 엔드 포인트

Example

• Basic Authentication (http_basic_test):

from __future__ import print_function
import time
import petstore_api
from pprint import pprint
configuration = petstore_api.Configuration()
# Configure HTTP basic authorization: http_basic_test
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'

# Defining host is optional and default to http://petstore.swagger.io:80/v2
configuration.host = "http://petstore.swagger.io:80/v2"
# Create an instance of the API class
api_instance = petstore_api.FakeApi(petstore_api.ApiClient(configuration))
number = 3.4 # float | None
double = 3.4 # float | None
pattern_without_delimiter = 'pattern_without_delimiter_example' # str | None
byte = 'byte_example' # str | None
integer = 56 # int | None (optional)
int32 = 56 # int | None (optional)
int64 = 56 # int | None (optional)
float = 3.4 # float | None (optional)
string = 'string_example' # str | None (optional)
binary = open('/path/to/file', 'rb') # file_type | None (optional)
date = '2013-10-20' # date | None (optional)
date_time = '2013-10-20T19:20:30+01:00' # datetime | None (optional)
password = 'password_example' # str | None (optional)
param_callback = 'param_callback_example' # str | None (optional)

# example passing only required values which don't have defaults set
try:
    # Fake endpoint for testing various parameters 假端點 偽のエンドポイント 가짜 엔드 포인트 
    api_instance.test_endpoint_parameters(number, double, pattern_without_delimiter, byte)
except petstore_api.ApiException as e:
    print("Exception when calling FakeApi->test_endpoint_parameters: %s\n" % e)

# example passing only required values which don't have defaults set
# and optional values
try:
    # Fake endpoint for testing various parameters 假端點 偽のエンドポイント 가짜 엔드 포인트 
    api_instance.test_endpoint_parameters(number, double, pattern_without_delimiter, byte, integer=integer, int32=int32, int64=int64, float=float, string=string, binary=binary, date=date, date_time=date_time, password=password, param_callback=param_callback)
except petstore_api.ApiException as e:
    print("Exception when calling FakeApi->test_endpoint_parameters: %s\n" % e)

Parameters

Name	Type	Description	Notes
number	float	None
double	float	None
pattern_without_delimiter	str	None
byte	str	None
integer	int	None	[optional]
int32	int	None	[optional]
int64	int	None	[optional]
float	float	None	[optional]
string	str	None	[optional]
binary	file_type	None	[optional]
date	date	None	[optional]
date_time	datetime	None	[optional]
password	str	None	[optional]
param_callback	str	None	[optional]

Return type

void (empty response body)

Authorization

http_basic_test

HTTP request headers

• Content-Type: application/x-www-form-urlencoded
• Accept: Not defined

HTTP response details

Status code	Description	Response headers
400	Invalid username supplied	-
404	User not found	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

test_enum_parameters

test_enum_parameters()

To test enum parameters

To test enum parameters

Example

from __future__ import print_function
import time
import petstore_api
from pprint import pprint

# Create an instance of the API class
api_instance = petstore_api.FakeApi()
enum_header_string_array = ['enum_header_string_array_example'] # [str] | Header parameter enum test (string array) (optional)
enum_header_string = '-efg' # str | Header parameter enum test (string) (optional) if omitted the server will use the default value of '-efg'
enum_query_string_array = ['enum_query_string_array_example'] # [str] | Query parameter enum test (string array) (optional)
enum_query_string = '-efg' # str | Query parameter enum test (string) (optional) if omitted the server will use the default value of '-efg'
enum_query_integer = 56 # int | Query parameter enum test (double) (optional)
enum_query_double = 3.4 # float | Query parameter enum test (double) (optional)
enum_form_string_array = '$' # [str] | Form parameter enum test (string array) (optional) if omitted the server will use the default value of '$'
enum_form_string = '-efg' # str | Form parameter enum test (string) (optional) if omitted the server will use the default value of '-efg'

# example passing only required values which don't have defaults set
# and optional values
try:
    # To test enum parameters
    api_instance.test_enum_parameters(enum_header_string_array=enum_header_string_array, enum_header_string=enum_header_string, enum_query_string_array=enum_query_string_array, enum_query_string=enum_query_string, enum_query_integer=enum_query_integer, enum_query_double=enum_query_double, enum_form_string_array=enum_form_string_array, enum_form_string=enum_form_string)
except petstore_api.ApiException as e:
    print("Exception when calling FakeApi->test_enum_parameters: %s\n" % e)

Parameters

Name	Type	Description	Notes
enum_header_string_array	[str]	Header parameter enum test (string array)	[optional]
enum_header_string	str	Header parameter enum test (string)	[optional] if omitted the server will use the default value of '-efg'
enum_query_string_array	[str]	Query parameter enum test (string array)	[optional]
enum_query_string	str	Query parameter enum test (string)	[optional] if omitted the server will use the default value of '-efg'
enum_query_integer	int	Query parameter enum test (double)	[optional]
enum_query_double	float	Query parameter enum test (double)	[optional]
enum_form_string_array	[str]	Form parameter enum test (string array)	[optional] if omitted the server will use the default value of '$'
enum_form_string	str	Form parameter enum test (string)	[optional] if omitted the server will use the default value of '-efg'

Return type

void (empty response body)

Authorization

No authorization required

HTTP request headers

• Content-Type: application/x-www-form-urlencoded
• Accept: Not defined

HTTP response details

Status code	Description	Response headers
400	Invalid request	-
404	Not found	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

test_group_parameters

test_group_parameters(required_string_group, required_boolean_group, required_int64_group)

Fake endpoint to test group parameters (optional)

Fake endpoint to test group parameters (optional)

Example

• Bearer (JWT) Authentication (bearer_test):

from __future__ import print_function
import time
import petstore_api
from pprint import pprint
configuration = petstore_api.Configuration()
# Configure Bearer authorization (JWT): bearer_test
configuration.access_token = 'YOUR_BEARER_TOKEN'

# Defining host is optional and default to http://petstore.swagger.io:80/v2
configuration.host = "http://petstore.swagger.io:80/v2"
# Create an instance of the API class
api_instance = petstore_api.FakeApi(petstore_api.ApiClient(configuration))
required_string_group = 56 # int | Required String in group parameters
required_boolean_group = True # bool | Required Boolean in group parameters
required_int64_group = 56 # int | Required Integer in group parameters
string_group = 56 # int | String in group parameters (optional)
boolean_group = True # bool | Boolean in group parameters (optional)
int64_group = 56 # int | Integer in group parameters (optional)

# example passing only required values which don't have defaults set
try:
    # Fake endpoint to test group parameters (optional)
    api_instance.test_group_parameters(required_string_group, required_boolean_group, required_int64_group)
except petstore_api.ApiException as e:
    print("Exception when calling FakeApi->test_group_parameters: %s\n" % e)

# example passing only required values which don't have defaults set
# and optional values
try:
    # Fake endpoint to test group parameters (optional)
    api_instance.test_group_parameters(required_string_group, required_boolean_group, required_int64_group, string_group=string_group, boolean_group=boolean_group, int64_group=int64_group)
except petstore_api.ApiException as e:
    print("Exception when calling FakeApi->test_group_parameters: %s\n" % e)

Parameters

Name	Type	Description	Notes
required_string_group	int	Required String in group parameters
required_boolean_group	bool	Required Boolean in group parameters
required_int64_group	int	Required Integer in group parameters
string_group	int	String in group parameters	[optional]
boolean_group	bool	Boolean in group parameters	[optional]
int64_group	int	Integer in group parameters	[optional]

Return type

void (empty response body)

Authorization

bearer_test

HTTP request headers

• Content-Type: Not defined
• Accept: Not defined

HTTP response details

Status code	Description	Response headers
400	Someting wrong	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

test_inline_additional_properties

test_inline_additional_properties(request_body)

test inline additionalProperties

Example

from __future__ import print_function
import time
import petstore_api
from pprint import pprint

# Create an instance of the API class
api_instance = petstore_api.FakeApi()
request_body = {'key': 'request_body_example'} # {str: (str,)} | request body

# example passing only required values which don't have defaults set
try:
    # test inline additionalProperties
    api_instance.test_inline_additional_properties(request_body)
except petstore_api.ApiException as e:
    print("Exception when calling FakeApi->test_inline_additional_properties: %s\n" % e)

Parameters

Name	Type	Description	Notes
request_body	{str: (str,)}	request body

Return type

void (empty response body)

Authorization

No authorization required

HTTP request headers

• Content-Type: application/json
• Accept: Not defined

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_json_form_data

test_json_form_data(param, param2)

test json serialization of form data

Example

from __future__ import print_function
import time
import petstore_api
from pprint import pprint

# Create an instance of the API class
api_instance = petstore_api.FakeApi()
param = 'param_example' # str | field1
param2 = 'param2_example' # str | field2

# example passing only required values which don't have defaults set
try:
    # test json serialization of form data
    api_instance.test_json_form_data(param, param2)
except petstore_api.ApiException as e:
    print("Exception when calling FakeApi->test_json_form_data: %s\n" % e)

Parameters

Name	Type	Description	Notes
param	str	field1
param2	str	field2

Return type

void (empty response body)

Authorization

No authorization required

HTTP request headers

• Content-Type: application/x-www-form-urlencoded
• Accept: Not defined

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_parameter_collection_format

test_query_parameter_collection_format(pipe, ioutil, http, url, context)

To test the collection format in query parameters

Example

from __future__ import print_function
import time
import petstore_api
from pprint import pprint

# Create an instance of the API class
api_instance = petstore_api.FakeApi()
pipe = ['pipe_example'] # [str] | 
ioutil = ['ioutil_example'] # [str] | 
http = ['http_example'] # [str] | 
url = ['url_example'] # [str] | 
context = ['context_example'] # [str] | 

# example passing only required values which don't have defaults set
try:
    api_instance.test_query_parameter_collection_format(pipe, ioutil, http, url, context)
except petstore_api.ApiException as e:
    print("Exception when calling FakeApi->test_query_parameter_collection_format: %s\n" % e)

Parameters

Name	Type	Description	Notes
pipe	[str]
ioutil	[str]
http	[str]
url	[str]
context	[str]

Return type

void (empty response body)

Authorization

No authorization required

HTTP request headers

• Content-Type: Not defined
• Accept: Not defined

HTTP response details

Status code	Description	Response headers
200	Success	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]