Skip to content

Latest commit

 

History

History
115 lines (94 loc) · 6.04 KB

post.md

File metadata and controls

115 lines (94 loc) · 6.04 KB
Raw

unit_test_api.paths.request_body_post_required_with_empty_array_request_body.operation

Operation Method Name

Method Name Api Class Notes
post_required_with_empty_array_request_body OperationRequestBodyApi This api is only for tag=operation.requestBody
post_required_with_empty_array_request_body PathPostApi This api is only for tag=path.post
post_required_with_empty_array_request_body ContentTypeJsonApi This api is only for tag=contentType_json
post_required_with_empty_array_request_body RequiredApi This api is only for tag=required
post ApiForPost This api is only for this endpoint
post RequestBodyPostRequiredWithEmptyArrayRequestBody This api is only for path=/requestBody/postRequiredWithEmptyArrayRequestBody

Table of Contents

General Info

Field Value
Path "/requestBody/postRequiredWithEmptyArrayRequestBody"
HTTP Method post

Arguments

Name Type Description Notes
body typing.Union[required_with_empty_array.RequiredWithEmptyArrayDictInput, required_with_empty_array.RequiredWithEmptyArrayDict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader] required
content_type str optional, default is 'application/json' Selects the schema and serialization of the request body. value must be one of ['application/json']
server_index typing.Optional[int] default is None Allows one to select a different server. If not None, must be one of [0]
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
"application/json" content.application_json.Schema2

RequestBody content ApplicationJson Schema2

type: schemas.Schema
Ref Schema Info
Ref Schema Input Type Output Type
required_with_empty_array.RequiredWithEmptyArray required_with_empty_array.RequiredWithEmptyArrayDictInput, required_with_empty_array.RequiredWithEmptyArrayDict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader required_with_empty_array.RequiredWithEmptyArrayDict, str, float, int, bool, None, tuple, bytes, io.FileIO

Return Types

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

ResponseFor200

Description

success

ResponseFor200 ApiResponse

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

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.

server_index Class Description
0 Server0

Code Sample

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

    # example passing only required values which don't have defaults set
    body = required_with_empty_array.RequiredWithEmptyArray.validate(None)
    try:
        api_response = api_instance.post_required_with_empty_array_request_body(
            body=body,
        )
        pprint(api_response)
    except unit_test_api.ApiException as e:
        print("Exception when calling OperationRequestBodyApi->post_required_with_empty_array_request_body: %s\n" % e)

[Back to top] [Back to OperationRequestBodyApi API] [Back to PathPostApi API] [Back to ContentTypeJsonApi API] [Back to RequiredApi API] [Back to Endpoints] [Back to README]