post.md

petstore_api.paths.fake_upload_file.operation

Operation Method Name

Method Name	Api Class	Notes
upload_file	FakeApi	This api is only for tag=fake
post	ApiForPost	This api is only for this endpoint
post	FakeUploadFile	This api is only for path=/fake/uploadFile

Table of Contents

• General Info
• Arguments
• Return Types
• Servers
• Code Sample

General Info

Field	Value
Summary	uploads a file using multipart/form-data
Description
Path	"/fake/uploadFile"
HTTP Method	post

Arguments

Name	Type	Description	Notes
body	typing.Union[schema.SchemaDictInput, schema.SchemaDict, schemas.Unset]	optional, default is unset
content_type	str	optional, default is 'multipart/form-data'	Selects the schema and serialization of the request body. value must be one of ['multipart/form-data']
accept_content_types	typing.Tuple[str]	default is ("application/json", )	Tells the server the content type(s) that are accepted by the client
server_index	typing.Optional[int]	default is None	Allows one to select a different server. If not None, must be one of [0, 1, 2]
stream	bool	default is False	if True then the response.content will be streamed and loaded from a file like object. When downloading a file, set this to True to force the code to deserialize the content to a FileSchema file
timeout	typing.Optional[typing.Union[int, typing.Tuple]]	default is None	the timeout used by the rest client
skip_deserialization	bool	default is False	when True, headers and body will be unset and an instance of api_response.ApiResponseWithoutDeserialization will be returned

RequestBody

Content Type To Schema

Content-Type	Schema
"multipart/form-data"	content.multipart_form_data.Schema

RequestBody content MultipartFormData Schema

type: schemas.Schema

validate method

Input Type	Return Type	Notes
SchemaDictInput, SchemaDict	SchemaDict

RequestBody content MultipartFormData Schema SchemaDictInput

type: typing.Mapping[str, schemas.INPUT_TYPES_ALL]

Key	Type	Description	Notes
file	bytes, io.FileIO, io.BufferedReader	file to upload
additionalMetadata	str	Additional data to pass to server	[optional]
any_string_name	dict, schemas.immutabledict, list, tuple, decimal.Decimal, float, int, str, datetime.date, datetime.datetime, uuid.UUID, bool, None, bytes, io.FileIO, io.BufferedReader, schemas.FileIO	any string name can be used but the value must be the correct type	[optional]

RequestBody content MultipartFormData Schema SchemaDict

base class: schemas.immutabledict[str, schemas.OUTPUT_BASE_TYPES]

__new__ method

Keyword Argument	Type	Description	Notes
file	bytes, io.FileIO, io.BufferedReader	file to upload
additionalMetadata	str, schemas.Unset	Additional data to pass to server	[optional]
kwargs	schemas.immutabledict, tuple, float, int, str, bool, None, bytes, schemas.FileIO	any string name can be used but the value must be the correct type	[optional] typed value is accessed with the get_additional_property_ method

properties

Property	Type	Description	Notes
file	bytes, io.FileIO	file to upload
additionalMetadata	str, schemas.Unset	Additional data to pass to server	[optional]

methods

Method	Input Type	Return Type	Notes
from_dict_	SchemaDictInput, SchemaDict	SchemaDict	a constructor
get_additional_property_	str	schemas.immutabledict, tuple, float, int, str, bool, None, bytes, schemas.FileIO, schemas.Unset	provides type safety for additional properties

Return Types

HTTP Status Code	Class	Description
n/a	api_response.ApiResponseWithoutDeserialization	When skip_deserialization is True this response is returned
200	ResponseFor200.ApiResponse	successful operation

ResponseFor200

Description

successful operation

ResponseFor200 ApiResponse

Name	Type	Description	Notes
response	urllib3.HTTPResponse	Raw response
body	api_response.ApiResponseDict
headers	Unset	headers were not defined

ResponseFor200 Body

Content-Type	Schema
"application/json"	content.application_json.Schema

Body Details

ResponseFor200 content ApplicationJson Schema

type: schemas.Schema

Ref Schema Info

Ref Schema	Input Type	Output Type
api_response.ApiResponse	api_response.ApiResponseDictInput, api_response.ApiResponseDict	api_response.ApiResponseDict

Servers

Set the available servers by defining your used servers in ApiConfiguration.server_info Then select your server by setting a server index in ApiConfiguration.server_index_info or by passing server_index in to the endpoint method.

• these servers are the general api servers
• defaults to server_index=0, server.url = http://petstore.swagger.io:80/v2

server_index	Class	Description
0	Server0	petstore server
1	Server1	The local server
2	Server2	staging server with no variables

Code Sample

import petstore_api
from petstore_api.configurations import api_configuration
from petstore_api.apis.tags import fake_api
from pprint import pprint
used_configuration = api_configuration.ApiConfiguration(
)
# Enter a context with an instance of the API client
with petstore_api.ApiClient(used_configuration) as api_client:
    # Create an instance of the API class
    api_instance = fake_api.FakeApi(api_client)

    # example passing only optional values
    body = {
        "additional_metadata": "additional_metadata_example",
        "file": open('/path/to/file', 'rb'),
    }
    try:
        # uploads a file using multipart/form-data
        api_response = api_instance.upload_file(
            body=body,
        )
        pprint(api_response)
    except petstore_api.ApiException as e:
        print("Exception when calling FakeApi->upload_file: %s\n" % e)

[Back to top] [Back to FakeApi API] [Back to Endpoints] [Back to README]