Skip to content
This repository was archived by the owner on Dec 25, 2024. It is now read-only.

get.md

Latest commit

 

History

History
79 lines (65 loc) · 3.17 KB

get.md

File metadata and controls

79 lines (65 loc) · 3.17 KB

petstore_api.paths..operation

Operation Method Name

Method Name Api Class Notes
slash_route FakeApi This api is only for tag=fake
get ApiForGet This api is only for this endpoint
get This api is only for path=/

Table of Contents

General Info

Field Value
Summary slash route
Path "/"
HTTP Method get

Arguments

Name Type Description Notes
server_index typing.Optional[int] default is None Allows one to select a different server
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_client.ApiResponseWithoutDeserialization will be returned

Return Types

HTTP Status Code Class Description
n/a api_client.ApiResponseWithoutDeserialization When skip_deserialization is True this response is returned
200 SuccessDescriptionOnly.response_cls Success

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, this endpoint has no required or optional parameters
    try:
        # slash route
        api_response = api_instance.slash_route()
        pprint(api_response)
    except petstore_api.ApiException as e:
        print("Exception when calling FakeApi->slash_route: %s\n" % e)

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