Skip to content

Latest commit

 

History

History
110 lines (90 loc) · 5.16 KB

post.md

File metadata and controls

110 lines (90 loc) · 5.16 KB
Raw

unit_test_api.paths.response_body_post_object_type_matches_objects_response_body_for_content_types.operation

Operation Method Name

Method Name Api Class Notes
post_object_type_matches_objects_response_body_for_content_types PathPostApi This api is only for tag=path.post
post_object_type_matches_objects_response_body_for_content_types ContentTypeJsonApi This api is only for tag=contentType_json
post_object_type_matches_objects_response_body_for_content_types TypeApi This api is only for tag=type
post_object_type_matches_objects_response_body_for_content_types ResponseContentContentTypeSchemaApi This api is only for tag=response.content.contentType.schema
post ApiForPost This api is only for this endpoint
post ResponseBodyPostObjectTypeMatchesObjectsResponseBodyForContentTypes This api is only for path=/responseBody/postObjectTypeMatchesObjectsResponseBodyForContentTypes

Table of Contents

General Info

Field Value
Path "/responseBody/postObjectTypeMatchesObjectsResponseBodyForContentTypes"
HTTP Method post

Arguments

Name Type Description Notes
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]
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

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 schemas.immutabledict
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
object_type_matches_objects.ObjectTypeMatchesObjects dict, schemas.immutabledict schemas.immutabledict

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 path_post_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 = path_post_api.PathPostApi(api_client)

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

[Back to top] [Back to PathPostApi API] [Back to ContentTypeJsonApi API] [Back to TypeApi API] [Back to ResponseContentContentTypeSchemaApi API] [Back to Endpoints] [Back to README]