|
| 1 | +issue259_sample1.paths.users_user_id.operation |
| 2 | +# Operation Method Name |
| 3 | + |
| 4 | +| Method Name | Api Class | Notes | |
| 5 | +| ----------- | --------- | ----- | |
| 6 | +| users_user_id_get | [DefaultApi](../../apis/tags/default_api.md) | This api is only for tag=default | |
| 7 | +| get | ApiForGet | This api is only for this endpoint | |
| 8 | +| get | UsersUserID | This api is only for path=/users/{UserID} | |
| 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 | Get user info: name and role. | |
| 21 | +| Path | "/users/{UserID}" | |
| 22 | +| HTTP Method | get | |
| 23 | + |
| 24 | +## Arguments |
| 25 | + |
| 26 | +Name | Type | Description | Notes |
| 27 | +------------- | ------------- | ------------- | ------------- |
| 28 | +accept_content_types | typing.Tuple[str] | default is ("application/json", ) | Tells the server the content type(s) that are accepted by the client |
| 29 | +server_index | typing.Optional[int] | default is None | Allows one to select a different [server](#servers). If not None, must be one of [0] |
| 30 | +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 |
| 31 | +timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client |
| 32 | +skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_response.ApiResponseWithoutDeserialization will be returned |
| 33 | + |
| 34 | +## Return Types |
| 35 | + |
| 36 | +HTTP Status Code | Class | Description |
| 37 | +------------- | ------------- | ------------- |
| 38 | +n/a | api_response.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned |
| 39 | +200 | [ResponseFor200.ApiResponse](#responsefor200-apiresponse) | |
| 40 | + |
| 41 | +## ResponseFor200 |
| 42 | + |
| 43 | +### ResponseFor200 ApiResponse |
| 44 | +Name | Type | Description | Notes |
| 45 | +------------- | ------------- | ------------- | ------------- |
| 46 | +response | urllib3.HTTPResponse | Raw response | |
| 47 | +[body](#responsefor200-body) | str | | |
| 48 | +headers | Unset | headers were not defined | |
| 49 | + |
| 50 | +### ResponseFor200 Body |
| 51 | +Content-Type | Schema |
| 52 | +------------ | ------- |
| 53 | +"application/json" | [content.application_json.Schema](#responsefor200-content-applicationjson-schema) |
| 54 | + |
| 55 | +### Body Details |
| 56 | +#### ResponseFor200 content ApplicationJson Schema |
| 57 | +issue259_sample1.paths.users_user_id.get.responses.response_200.content.application_json.schema |
| 58 | +``` |
| 59 | +type: schemas.Schema |
| 60 | +``` |
| 61 | + |
| 62 | +##### validate method |
| 63 | +Input Type | Return Type | Notes |
| 64 | +------------ | ------------- | ------------- |
| 65 | +str | str | |
| 66 | + |
| 67 | +## Servers |
| 68 | + |
| 69 | +Set the available servers by defining your used servers in ApiConfiguration.server_info |
| 70 | +Then select your server by setting a server index in ApiConfiguration.server_index_info or by |
| 71 | +passing server_index in to the endpoint method. |
| 72 | +- these servers are the general api servers |
| 73 | +- defaults to server_index=0, server.url = https://localhost:8443/api/v1 |
| 74 | + |
| 75 | +server_index | Class | Description |
| 76 | +------------ | ----- | ------------ |
| 77 | +0 | [Server0](../../servers/server_0.md) | |
| 78 | + |
| 79 | +## Code Sample |
| 80 | + |
| 81 | +```python |
| 82 | +import issue259_sample1 |
| 83 | +from issue259_sample1.configurations import api_configuration |
| 84 | +from issue259_sample1.apis.tags import default_api |
| 85 | +from pprint import pprint |
| 86 | +used_configuration = api_configuration.ApiConfiguration( |
| 87 | +) |
| 88 | +# Enter a context with an instance of the API client |
| 89 | +with issue259_sample1.ApiClient(used_configuration) as api_client: |
| 90 | + # Create an instance of the API class |
| 91 | + api_instance = default_api.DefaultApi(api_client) |
| 92 | + |
| 93 | + # example, this endpoint has no required or optional parameters |
| 94 | + try: |
| 95 | + api_response = api_instance.users_user_id_get() |
| 96 | + pprint(api_response) |
| 97 | + except issue259_sample1.ApiException as e: |
| 98 | + print("Exception when calling DefaultApi->users_user_id_get: %s\n" % e) |
| 99 | +``` |
| 100 | + |
| 101 | +[[Back to top]](#top) |
| 102 | +[[Back to DefaultApi API]](../../apis/tags/default_api.md) |
| 103 | +[[Back to Endpoints]](../../../README.md#Endpoints) [[Back to README]](../../../README.md) |
0 commit comments