|
| 1 | +petstore_api.paths.fake_pem_content_type.operation |
| 2 | +# Operation Method Name |
| 3 | + |
| 4 | +| Method Name | Api Class | Notes | |
| 5 | +| ----------- | --------- | ----- | |
| 6 | +| pem_content_type | [FakeApi](../../apis/tags/fake_api.md) | This api is only for tag=fake | |
| 7 | +| get | ApiForGet | This api is only for this endpoint | |
| 8 | +| get | FakePemContentType | This api is only for path=/fake/pemContentType | |
| 9 | + |
| 10 | +## Table of Contents |
| 11 | +- [General Info](#general-info) |
| 12 | +- [Arguments](#arguments) |
| 13 | +- [Return Types](#return-types) |
| 14 | +- [Servers](#servers) |
| 15 | +- [Code Sample](#code-sample) |
| 16 | + |
| 17 | +## General Info |
| 18 | +| Field | Value | |
| 19 | +| ----- | ----- | |
| 20 | +| Summary | route with tx and rx pem content type | |
| 21 | +| Path | "/fake/pemContentType" | |
| 22 | +| HTTP Method | get | |
| 23 | + |
| 24 | +## Arguments |
| 25 | + |
| 26 | +Name | Type | Description | Notes |
| 27 | +------------- | ------------- | ------------- | ------------- |
| 28 | +[body](#requestbody) | typing.Union[str, schemas.Unset] | optional, default is unset | |
| 29 | +content_type | str | optional, default is 'application/x-pem-file' | Selects the schema and serialization of the request body. value must be one of ['application/x-pem-file'] |
| 30 | +accept_content_types | typing.Tuple[str] | default is ("application/x-pem-file", ) | Tells the server the content type(s) that are accepted by the client |
| 31 | +server_index | typing.Optional[int] | default is None | Allows one to select a different [server](#servers). If not None, must be one of [0, 1, 2] |
| 32 | +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 |
| 33 | +timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client |
| 34 | +skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_response.ApiResponseWithoutDeserialization will be returned |
| 35 | + |
| 36 | +### RequestBody |
| 37 | + |
| 38 | +#### Content Type To Schema |
| 39 | +Content-Type | Schema |
| 40 | +------------ | ------- |
| 41 | +"application/x-pem-file" | [content.application_x_pem_file.Schema](#requestbody-content-applicationxpemfile-schema) |
| 42 | + |
| 43 | +#### RequestBody content ApplicationXPemFile Schema |
| 44 | +``` |
| 45 | +type: schemas.Schema |
| 46 | +``` |
| 47 | + |
| 48 | +##### validate method |
| 49 | +Input Type | Return Type | Notes |
| 50 | +------------ | ------------- | ------------- |
| 51 | +str | str | |
| 52 | + |
| 53 | +## Return Types |
| 54 | + |
| 55 | +HTTP Status Code | Class | Description |
| 56 | +------------- | ------------- | ------------- |
| 57 | +n/a | api_response.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned |
| 58 | +200 | [ResponseFor200.ApiResponse](#responsefor200-apiresponse) | success |
| 59 | + |
| 60 | +## ResponseFor200 |
| 61 | + |
| 62 | +### Description |
| 63 | +success |
| 64 | + |
| 65 | +### ResponseFor200 ApiResponse |
| 66 | +Name | Type | Description | Notes |
| 67 | +------------- | ------------- | ------------- | ------------- |
| 68 | +response | urllib3.HTTPResponse | Raw response | |
| 69 | +[body](#responsefor200-body) | str | | |
| 70 | +headers | Unset | headers were not defined | |
| 71 | + |
| 72 | +### ResponseFor200 Body |
| 73 | +Content-Type | Schema |
| 74 | +------------ | ------- |
| 75 | +"application/x-pem-file" | [content.application_x_pem_file.Schema](#responsefor200-content-applicationxpemfile-schema) |
| 76 | + |
| 77 | +### Body Details |
| 78 | +#### ResponseFor200 content ApplicationXPemFile Schema |
| 79 | +``` |
| 80 | +type: schemas.Schema |
| 81 | +``` |
| 82 | + |
| 83 | +##### validate method |
| 84 | +Input Type | Return Type | Notes |
| 85 | +------------ | ------------- | ------------- |
| 86 | +str | str | |
| 87 | + |
| 88 | +## Servers |
| 89 | + |
| 90 | +Set the available servers by defining your used servers in ApiConfiguration.server_info |
| 91 | +Then select your server by setting a server index in ApiConfiguration.server_index_info or by |
| 92 | +passing server_index in to the endpoint method. |
| 93 | +- these servers are the general api servers |
| 94 | +- defaults to server_index=0, server.url = http://petstore.swagger.io:80/v2 |
| 95 | + |
| 96 | +server_index | Class | Description |
| 97 | +------------ | ----- | ------------ |
| 98 | +0 | [Server0](../../servers/server_0.md) | petstore server |
| 99 | +1 | [Server1](../../servers/server_1.md) | The local server |
| 100 | +2 | [Server2](../../servers/server_2.md) | staging server with no variables |
| 101 | + |
| 102 | +## Code Sample |
| 103 | + |
| 104 | +```python |
| 105 | +import petstore_api |
| 106 | +from petstore_api.configurations import api_configuration |
| 107 | +from petstore_api.apis.tags import fake_api |
| 108 | +from pprint import pprint |
| 109 | +used_configuration = api_configuration.ApiConfiguration( |
| 110 | +) |
| 111 | +# Enter a context with an instance of the API client |
| 112 | +with petstore_api.ApiClient(used_configuration) as api_client: |
| 113 | + # Create an instance of the API class |
| 114 | + api_instance = fake_api.FakeApi(api_client) |
| 115 | + |
| 116 | + # example passing only optional values |
| 117 | + body = "string_example" |
| 118 | + try: |
| 119 | + # route with tx and rx pem content type |
| 120 | + api_response = api_instance.pem_content_type( |
| 121 | + body=body, |
| 122 | + ) |
| 123 | + pprint(api_response) |
| 124 | + except petstore_api.ApiException as e: |
| 125 | + print("Exception when calling FakeApi->pem_content_type: %s\n" % e) |
| 126 | +``` |
| 127 | + |
| 128 | +[[Back to top]](#top) |
| 129 | +[[Back to FakeApi API]](../../apis/tags/fake_api.md) |
| 130 | +[[Back to Endpoints]](../../../README.md#Endpoints) [[Back to README]](../../../README.md) |
0 commit comments