Skip to content

Latest commit

 

History

History
132 lines (107 loc) · 4.83 KB

post.md

File metadata and controls

132 lines (107 loc) · 4.83 KB
Raw

petstore_api.paths.fake_refs_string.operation

Operation Method Name

Method Name Api Class Notes
string FakeApi This api is only for tag=fake
post ApiForPost This api is only for this endpoint
post FakeRefsString This api is only for path=/fake/refs/string

Table of Contents

General Info

Field Value
Description Test serialization of outer string types
Path "/fake/refs/string"
HTTP Method post

Arguments

Name Type Description Notes
body typing.Union[str, schemas.Unset] optional, default is unset
content_type str optional, default is 'application/json' Selects the schema and serialization of the request body. value must be one of ['application/json']
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

Description

Input string as post body

Content Type To Schema

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

RequestBody content ApplicationJson Schema

type: schemas.Schema
Ref Schema Info
Ref Schema Input Type Output Type
string.String str str

Return Types

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

ResponseFor200

Description

Output string

ResponseFor200 ApiResponse

Name Type Description Notes
response urllib3.HTTPResponse Raw response
body str
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
string.String str str

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 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 = string.String.validate("string_example")
    try:
        api_response = api_instance.string(
            body=body,
        )
        pprint(api_response)
    except petstore_api.ApiException as e:
        print("Exception when calling FakeApi->string: %s\n" % e)

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