|
| 1 | +petstore_api.paths.common_param_sub_dir.operation |
| 2 | +# Operation Method Name |
| 3 | + |
| 4 | +| Method Name | Api Class | Notes | |
| 5 | +| ----------- | --------- | ----- | |
| 6 | +| delete_common_param | [FakeApi](../../apis/tags/fake_api.md) | This api is only for tag=fake | |
| 7 | +| delete | ApiForDelete | This api is only for this endpoint | |
| 8 | +| delete | CommonParamSubDir | This api is only for path=/commonParam/{subDir}/ | |
| 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 | +| Description | common param is overwritten | |
| 21 | +| Path | "/commonParam/{subDir}/" | |
| 22 | +| HTTP Method | delete | |
| 23 | + |
| 24 | +## Arguments |
| 25 | + |
| 26 | +Name | Type | Description | Notes |
| 27 | +------------- | ------------- | ------------- | ------------- |
| 28 | +[header_params](#header_params) | [HeaderParametersDictInput](#headerparameters-headerparametersdictinput), [HeaderParametersDict](#headerparameters-headerparametersdict) | | |
| 29 | +[path_params](#path_params) | [PathParametersDictInput](#pathparameters-pathparametersdictinput), [PathParametersDict](#pathparameters-pathparametersdict) | | |
| 30 | +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] |
| 31 | +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 |
| 32 | +timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client |
| 33 | +skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_response.ApiResponseWithoutDeserialization will be returned |
| 34 | +### header_params |
| 35 | +### HeaderParameters |
| 36 | +``` |
| 37 | +type: schemas.Schema |
| 38 | +``` |
| 39 | + |
| 40 | +#### validate method |
| 41 | +Input Type | Return Type | Notes |
| 42 | +------------ | ------------- | ------------- |
| 43 | +[HeaderParametersDictInput](#headerparameters-headerparametersdictinput), [HeaderParametersDict](#headerparameters-headerparametersdict) | [HeaderParametersDict](#headerparameters-headerparametersdict) | |
| 44 | + |
| 45 | +#### HeaderParameters HeaderParametersDictInput |
| 46 | +``` |
| 47 | +type: typing.TypedDict |
| 48 | +``` |
| 49 | +Key | Type | Description | Notes |
| 50 | +------------ | ------------- | ------------- | ------------- |
| 51 | +**someHeader** | str | | [optional] |
| 52 | + |
| 53 | +#### HeaderParameters HeaderParametersDict |
| 54 | +``` |
| 55 | +base class: schemas.immutabledict[str, str] |
| 56 | +
|
| 57 | +``` |
| 58 | +##### __new__ method |
| 59 | +Keyword Argument | Type | Description | Notes |
| 60 | +---------------- | ---- | ----------- | ----- |
| 61 | +**someHeader** | str, schemas.Unset | | [optional] |
| 62 | + |
| 63 | +##### properties |
| 64 | +Property | Type | Description | Notes |
| 65 | +-------- | ---- | ----------- | ----- |
| 66 | +**someHeader** | str, schemas.Unset | | [optional] |
| 67 | + |
| 68 | +##### methods |
| 69 | +Method | Input Type | Return Type | Notes |
| 70 | +------ | ---------- | ----------- | ------ |
| 71 | +from_dict_ | [HeaderParametersDictInput](#headerparameters-headerparametersdictinput), [HeaderParametersDict](#headerparameters-headerparametersdict) | [HeaderParametersDict](#headerparameters-headerparametersdict) | a constructor |
| 72 | +### path_params |
| 73 | +### PathParameters |
| 74 | +``` |
| 75 | +type: schemas.Schema |
| 76 | +``` |
| 77 | + |
| 78 | +#### validate method |
| 79 | +Input Type | Return Type | Notes |
| 80 | +------------ | ------------- | ------------- |
| 81 | +[PathParametersDictInput](#pathparameters-pathparametersdictinput), [PathParametersDict](#pathparameters-pathparametersdict) | [PathParametersDict](#pathparameters-pathparametersdict) | |
| 82 | + |
| 83 | +#### PathParameters PathParametersDictInput |
| 84 | +``` |
| 85 | +type: typing.TypedDict |
| 86 | +``` |
| 87 | +Key | Type | Description | Notes |
| 88 | +------------ | ------------- | ------------- | ------------- |
| 89 | +**subDir** | typing.Literal["c", "d"] | | |
| 90 | + |
| 91 | +#### PathParameters PathParametersDict |
| 92 | +``` |
| 93 | +base class: schemas.immutabledict[str, typing.Literal["c", "d"]] |
| 94 | +
|
| 95 | +``` |
| 96 | +##### __new__ method |
| 97 | +Keyword Argument | Type | Description | Notes |
| 98 | +---------------- | ---- | ----------- | ----- |
| 99 | +**subDir** | typing.Literal["c", "d"] | | |
| 100 | + |
| 101 | +##### properties |
| 102 | +Property | Type | Description | Notes |
| 103 | +-------- | ---- | ----------- | ----- |
| 104 | +**subDir** | typing.Literal["c", "d"] | | |
| 105 | + |
| 106 | +##### methods |
| 107 | +Method | Input Type | Return Type | Notes |
| 108 | +------ | ---------- | ----------- | ------ |
| 109 | +from_dict_ | [PathParametersDictInput](#pathparameters-pathparametersdictinput), [PathParametersDict](#pathparameters-pathparametersdict) | [PathParametersDict](#pathparameters-pathparametersdict) | a constructor |
| 110 | + |
| 111 | +## Return Types |
| 112 | + |
| 113 | +HTTP Status Code | Class | Description |
| 114 | +------------- | ------------- | ------------- |
| 115 | +n/a | api_response.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned |
| 116 | +200 | [SuccessDescriptionOnly.ApiResponse](../../components/responses/response_success_description_only.md#apiresponse) | Success |
| 117 | + |
| 118 | +## Servers |
| 119 | + |
| 120 | +Set the available servers by defining your used servers in ApiConfiguration.server_info |
| 121 | +Then select your server by setting a server index in ApiConfiguration.server_index_info or by |
| 122 | +passing server_index in to the endpoint method. |
| 123 | +- these servers are the general api servers |
| 124 | +- defaults to server_index=0, server.url = http://petstore.swagger.io:80/v2 |
| 125 | + |
| 126 | +server_index | Class | Description |
| 127 | +------------ | ----- | ------------ |
| 128 | +0 | [Server0](../../servers/server_0.md) | petstore server |
| 129 | +1 | [Server1](../../servers/server_1.md) | The local server |
| 130 | +2 | [Server2](../../servers/server_2.md) | staging server with no variables |
| 131 | + |
| 132 | +## Code Sample |
| 133 | + |
| 134 | +```python |
| 135 | +import petstore_api |
| 136 | +from petstore_api.configurations import api_configuration |
| 137 | +from petstore_api.apis.tags import fake_api |
| 138 | +from petstore_api.paths.common_param_sub_dir.delete import operation |
| 139 | +from pprint import pprint |
| 140 | +used_configuration = api_configuration.ApiConfiguration( |
| 141 | +) |
| 142 | +# Enter a context with an instance of the API client |
| 143 | +with petstore_api.ApiClient(used_configuration) as api_client: |
| 144 | + # Create an instance of the API class |
| 145 | + api_instance = fake_api.FakeApi(api_client) |
| 146 | + |
| 147 | + # example passing only required values which don't have defaults set |
| 148 | + path_params: operation.PathParametersDictInput = { |
| 149 | + 'subDir': "c", |
| 150 | + } |
| 151 | + header_params: operation.HeaderParametersDictInput = { |
| 152 | + } |
| 153 | + try: |
| 154 | + api_response = api_instance.delete_common_param( |
| 155 | + path_params=path_params, |
| 156 | + header_params=header_params, |
| 157 | + ) |
| 158 | + pprint(api_response) |
| 159 | + except petstore_api.ApiException as e: |
| 160 | + print("Exception when calling FakeApi->delete_common_param: %s\n" % e) |
| 161 | + |
| 162 | + # example passing only optional values |
| 163 | + path_params = { |
| 164 | + 'subDir': "c", |
| 165 | + } |
| 166 | + header_params: operation.HeaderParametersDictInput = { |
| 167 | + 'someHeader': "someHeader_example", |
| 168 | + } |
| 169 | + try: |
| 170 | + api_response = api_instance.delete_common_param( |
| 171 | + path_params=path_params, |
| 172 | + header_params=header_params, |
| 173 | + ) |
| 174 | + pprint(api_response) |
| 175 | + except petstore_api.ApiException as e: |
| 176 | + print("Exception when calling FakeApi->delete_common_param: %s\n" % e) |
| 177 | +``` |
| 178 | + |
| 179 | +[[Back to top]](#top) |
| 180 | +[[Back to FakeApi API]](../../apis/tags/fake_api.md) |
| 181 | +[[Back to Endpoints]](../../../README.md#Endpoints) [[Back to README]](../../../README.md) |
0 commit comments