loafle/openapi-generator-original
3
0
Fork 1
mirror of https://github.com/OpenAPITools/openapi-generator.git synced 2025-12-07 18:06:08 +00:00
Code Issues Packages Projects Releases Wiki Activity

[Python] cleanup documentation (#15301)

Browse Source 
* [Python] fix documentation of API authorization in README files

fix hierarchy level + add internal links + align wording across generators

* [Python] fix anchor links in documentation
This commit is contained in:
Tiffany Marrel
2023-05-09 18:24:56 +02:00
committed by GitHub
parent da9ad4a008
commit c251202869
55 changed files with 944 additions and 908 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
samples/openapi3/client/petstore/python/docs/apis/tags/AnotherFakeApi.md
View File

@@ -1,4 +1,4 @@
<a name="__pageTop"></a>
<a id="__pageTop"></a>
# petstore_api.apis.tags.another_fake_api.AnotherFakeApi
All URIs are relative to *http://petstore.swagger.io:80/v2*
@@ -8,7 +8,7 @@ Method | HTTP request | Description
[**call_123_test_special_tags**](#call_123_test_special_tags) | **patch** /another-fake/dummy | To test special tags
# **call_123_test_special_tags**
<a name="call_123_test_special_tags"></a>
<a id="call_123_test_special_tags"></a>
> Client call_123_test_special_tags(client)
To test special tags

4
samples/openapi3/client/petstore/python/docs/apis/tags/DefaultApi.md
View File

@@ -1,4 +1,4 @@
<a name="__pageTop"></a>
<a id="__pageTop"></a>
# petstore_api.apis.tags.default_api.DefaultApi
All URIs are relative to *http://petstore.swagger.io:80/v2*
@@ -8,7 +8,7 @@ Method | HTTP request | Description
[**foo_get**](#foo_get) | **get** /foo |
# **foo_get**
<a name="foo_get"></a>
<a id="foo_get"></a>
> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} foo_get()

68
samples/openapi3/client/petstore/python/docs/apis/tags/FakeApi.md
View File

@@ -1,4 +1,4 @@
<a name="__pageTop"></a>
<a id="__pageTop"></a>
# petstore_api.apis.tags.fake_api.FakeApi
All URIs are relative to *http://petstore.swagger.io:80/v2*
@@ -40,7 +40,7 @@ Method | HTTP request | Description
[**upload_files**](#upload_files) | **post** /fake/uploadFiles | uploads files using multipart/form-data
# **additional_properties_with_array_of_enums**
<a name="additional_properties_with_array_of_enums"></a>
<a id="additional_properties_with_array_of_enums"></a>
> AdditionalPropertiesWithArrayOfEnums additional_properties_with_array_of_enums()
Additional Properties with Array of Enums
@@ -124,7 +124,7 @@ No authorization required
[[Back to top]](#__pageTop) [[Back to API list]](../../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../../README.md#documentation-for-models) [[Back to README]](../../../README.md)
# **array_model**
<a name="array_model"></a>
<a id="array_model"></a>
> AnimalFarm array_model()
@@ -207,7 +207,7 @@ No authorization required
[[Back to top]](#__pageTop) [[Back to API list]](../../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../../README.md#documentation-for-models) [[Back to README]](../../../README.md)
# **array_of_enums**
<a name="array_of_enums"></a>
<a id="array_of_enums"></a>
> ArrayOfEnums array_of_enums()
Array of Enums
@@ -289,7 +289,7 @@ No authorization required
[[Back to top]](#__pageTop) [[Back to API list]](../../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../../README.md#documentation-for-models) [[Back to README]](../../../README.md)
# **body_with_file_schema**
<a name="body_with_file_schema"></a>
<a id="body_with_file_schema"></a>
> body_with_file_schema(file_schema_test_class)
@@ -369,7 +369,7 @@ No authorization required
[[Back to top]](#__pageTop) [[Back to API list]](../../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../../README.md#documentation-for-models) [[Back to README]](../../../README.md)
# **body_with_query_params**
<a name="body_with_query_params"></a>
<a id="body_with_query_params"></a>
> body_with_query_params(queryuser)
@@ -474,7 +474,7 @@ No authorization required
[[Back to top]](#__pageTop) [[Back to API list]](../../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../../README.md#documentation-for-models) [[Back to README]](../../../README.md)
# **boolean**
<a name="boolean"></a>
<a id="boolean"></a>
> bool boolean()
@@ -556,7 +556,7 @@ No authorization required
[[Back to top]](#__pageTop) [[Back to API list]](../../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../../README.md#documentation-for-models) [[Back to README]](../../../README.md)
# **case_sensitive_params**
<a name="case_sensitive_params"></a>
<a id="case_sensitive_params"></a>
> case_sensitive_params(some_varsome_var2some_var3)
@@ -654,7 +654,7 @@ No authorization required
[[Back to top]](#__pageTop) [[Back to API list]](../../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../../README.md#documentation-for-models) [[Back to README]](../../../README.md)
# **client_model**
<a name="client_model"></a>
<a id="client_model"></a>
> Client client_model(client)
To test \"client\" model
@@ -738,7 +738,7 @@ No authorization required
[[Back to top]](#__pageTop) [[Back to API list]](../../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../../README.md#documentation-for-models) [[Back to README]](../../../README.md)
# **composed_one_of_different_types**
<a name="composed_one_of_different_types"></a>
<a id="composed_one_of_different_types"></a>
> ComposedOneOfDifferentTypes composed_one_of_different_types()
@@ -819,7 +819,7 @@ No authorization required
[[Back to top]](#__pageTop) [[Back to API list]](../../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../../README.md#documentation-for-models) [[Back to README]](../../../README.md)
# **delete_coffee**
<a name="delete_coffee"></a>
<a id="delete_coffee"></a>
> delete_coffee(id)
Delete coffee
@@ -930,7 +930,7 @@ No authorization required
[[Back to top]](#__pageTop) [[Back to API list]](../../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../../README.md#documentation-for-models) [[Back to README]](../../../README.md)
# **endpoint_parameters**
<a name="endpoint_parameters"></a>
<a id="endpoint_parameters"></a>
> endpoint_parameters()
Fake endpoint for testing various parameters 假端點 偽のエンドポイント 가짜 엔드 포인트
@@ -1057,7 +1057,7 @@ headers | Unset | headers were not defined |
[[Back to top]](#__pageTop) [[Back to API list]](../../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../../README.md#documentation-for-models) [[Back to README]](../../../README.md)
# **enum_parameters**
<a name="enum_parameters"></a>
<a id="enum_parameters"></a>
> enum_parameters()
To test enum parameters
@@ -1262,7 +1262,7 @@ No authorization required
[[Back to top]](#__pageTop) [[Back to API list]](../../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../../README.md#documentation-for-models) [[Back to README]](../../../README.md)
# **fake_health_get**
<a name="fake_health_get"></a>
<a id="fake_health_get"></a>
> HealthCheckResult fake_health_get()
Health check endpoint
@@ -1323,7 +1323,7 @@ No authorization required
[[Back to top]](#__pageTop) [[Back to API list]](../../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../../README.md#documentation-for-models) [[Back to README]](../../../README.md)
# **group_parameters**
<a name="group_parameters"></a>
<a id="group_parameters"></a>
> group_parameters(required_string_grouprequired_boolean_grouprequired_int64_group)
Fake endpoint to test group parameters (optional)
@@ -1486,7 +1486,7 @@ headers | Unset | headers were not defined |
[[Back to top]](#__pageTop) [[Back to API list]](../../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../../README.md#documentation-for-models) [[Back to README]](../../../README.md)
# **inline_additional_properties**
<a name="inline_additional_properties"></a>
<a id="inline_additional_properties"></a>
> inline_additional_properties(request_body)
test inline additionalProperties
@@ -1565,7 +1565,7 @@ No authorization required
[[Back to top]](#__pageTop) [[Back to API list]](../../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../../README.md#documentation-for-models) [[Back to README]](../../../README.md)
# **inline_composition**
<a name="inline_composition"></a>
<a id="inline_composition"></a>
> bool, date, datetime, dict, float, int, list, str, none_type inline_composition()
testing composed schemas at inline locations
@@ -1808,7 +1808,7 @@ No authorization required
[[Back to top]](#__pageTop) [[Back to API list]](../../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../../README.md#documentation-for-models) [[Back to README]](../../../README.md)
# **json_form_data**
<a name="json_form_data"></a>
<a id="json_form_data"></a>
> json_form_data()
test json serialization of form data
@@ -1890,7 +1890,7 @@ No authorization required
[[Back to top]](#__pageTop) [[Back to API list]](../../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../../README.md#documentation-for-models) [[Back to README]](../../../README.md)
# **json_patch**
<a name="json_patch"></a>
<a id="json_patch"></a>
> json_patch()
json patch
@@ -1966,7 +1966,7 @@ No authorization required
[[Back to top]](#__pageTop) [[Back to API list]](../../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../../README.md#documentation-for-models) [[Back to README]](../../../README.md)
# **json_with_charset**
<a name="json_with_charset"></a>
<a id="json_with_charset"></a>
> bool, date, datetime, dict, float, int, list, str, none_type json_with_charset()
json with charset tx and rx
@@ -2047,7 +2047,7 @@ No authorization required
[[Back to top]](#__pageTop) [[Back to API list]](../../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../../README.md#documentation-for-models) [[Back to README]](../../../README.md)
# **mammal**
<a name="mammal"></a>
<a id="mammal"></a>
> Mammal mammal(mammal)
@@ -2132,7 +2132,7 @@ No authorization required
[[Back to top]](#__pageTop) [[Back to API list]](../../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../../README.md#documentation-for-models) [[Back to README]](../../../README.md)
# **number_with_validations**
<a name="number_with_validations"></a>
<a id="number_with_validations"></a>
> NumberWithValidations number_with_validations()
@@ -2213,7 +2213,7 @@ No authorization required
[[Back to top]](#__pageTop) [[Back to API list]](../../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../../README.md#documentation-for-models) [[Back to README]](../../../README.md)
# **object_in_query**
<a name="object_in_query"></a>
<a id="object_in_query"></a>
> object_in_query()
user list
@@ -2300,7 +2300,7 @@ No authorization required
[[Back to top]](#__pageTop) [[Back to API list]](../../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../../README.md#documentation-for-models) [[Back to README]](../../../README.md)
# **object_model_with_ref_props**
<a name="object_model_with_ref_props"></a>
<a id="object_model_with_ref_props"></a>
> ObjectModelWithRefProps object_model_with_ref_props()
@@ -2385,7 +2385,7 @@ No authorization required
[[Back to top]](#__pageTop) [[Back to API list]](../../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../../README.md#documentation-for-models) [[Back to README]](../../../README.md)
# **parameter_collisions**
<a name="parameter_collisions"></a>
<a id="parameter_collisions"></a>
> bool, date, datetime, dict, float, int, list, str, none_type parameter_collisions(_3a_b5ab2_self3a_b6)
parameter collision case
@@ -2704,7 +2704,7 @@ No authorization required
[[Back to top]](#__pageTop) [[Back to API list]](../../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../../README.md#documentation-for-models) [[Back to README]](../../../README.md)
# **query_param_with_json_content_type**
<a name="query_param_with_json_content_type"></a>
<a id="query_param_with_json_content_type"></a>
> bool, date, datetime, dict, float, int, list, str, none_type query_param_with_json_content_type(some_param)
query param with json content-type
@@ -2785,7 +2785,7 @@ No authorization required
[[Back to top]](#__pageTop) [[Back to API list]](../../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../../README.md#documentation-for-models) [[Back to README]](../../../README.md)
# **query_parameter_collection_format**
<a name="query_parameter_collection_format"></a>
<a id="query_parameter_collection_format"></a>
> query_parameter_collection_format(pipeioutilhttpurlcontextref_param)
@@ -2945,7 +2945,7 @@ No authorization required
[[Back to top]](#__pageTop) [[Back to API list]](../../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../../README.md#documentation-for-models) [[Back to README]](../../../README.md)
# **ref_object_in_query**
<a name="ref_object_in_query"></a>
<a id="ref_object_in_query"></a>
> ref_object_in_query()
user list
@@ -3026,7 +3026,7 @@ No authorization required
[[Back to top]](#__pageTop) [[Back to API list]](../../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../../README.md#documentation-for-models) [[Back to README]](../../../README.md)
# **response_without_schema**
<a name="response_without_schema"></a>
<a id="response_without_schema"></a>
> response_without_schema()
receives a response without schema
@@ -3079,7 +3079,7 @@ No authorization required
[[Back to top]](#__pageTop) [[Back to API list]](../../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../../README.md#documentation-for-models) [[Back to README]](../../../README.md)
# **string**
<a name="string"></a>
<a id="string"></a>
> str string()
@@ -3161,7 +3161,7 @@ No authorization required
[[Back to top]](#__pageTop) [[Back to API list]](../../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../../README.md#documentation-for-models) [[Back to README]](../../../README.md)
# **string_enum**
<a name="string_enum"></a>
<a id="string_enum"></a>
> StringEnum string_enum()
@@ -3242,7 +3242,7 @@ No authorization required
[[Back to top]](#__pageTop) [[Back to API list]](../../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../../README.md#documentation-for-models) [[Back to README]](../../../README.md)
# **upload_download_file**
<a name="upload_download_file"></a>
<a id="upload_download_file"></a>
> file_type upload_download_file(body)
uploads a file and downloads a file using application/octet-stream
@@ -3327,7 +3327,7 @@ No authorization required
[[Back to top]](#__pageTop) [[Back to API list]](../../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../../README.md#documentation-for-models) [[Back to README]](../../../README.md)
# **upload_file**
<a name="upload_file"></a>
<a id="upload_file"></a>
> ApiResponse upload_file()
uploads a file using multipart/form-data
@@ -3418,7 +3418,7 @@ No authorization required
[[Back to top]](#__pageTop) [[Back to API list]](../../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../../README.md#documentation-for-models) [[Back to README]](../../../README.md)
# **upload_files**
<a name="upload_files"></a>
<a id="upload_files"></a>
> ApiResponse upload_files()
uploads files using multipart/form-data

4
samples/openapi3/client/petstore/python/docs/apis/tags/FakeClassnameTags123Api.md
View File

@@ -1,4 +1,4 @@
<a name="__pageTop"></a>
<a id="__pageTop"></a>
# petstore_api.apis.tags.fake_classname_tags123_api.FakeClassnameTags123Api
All URIs are relative to *http://petstore.swagger.io:80/v2*
@@ -8,7 +8,7 @@ Method | HTTP request | Description
[**classname**](#classname) | **patch** /fake_classname_test | To test class name in snake case
# **classname**
<a name="classname"></a>
<a id="classname"></a>
> Client classname(client)
To test class name in snake case

20
samples/openapi3/client/petstore/python/docs/apis/tags/PetApi.md
View File

@@ -1,4 +1,4 @@
<a name="__pageTop"></a>
<a id="__pageTop"></a>
# petstore_api.apis.tags.pet_api.PetApi
All URIs are relative to *http://petstore.swagger.io:80/v2*
@@ -16,7 +16,7 @@ Method | HTTP request | Description
[**upload_image**](#upload_image) | **post** /pet/{petId}/uploadImage | uploads an image
# **add_pet**
<a name="add_pet"></a>
<a id="add_pet"></a>
> add_pet(pet)
Add a new pet to the store
@@ -193,7 +193,7 @@ headers | Unset | headers were not defined |
[[Back to top]](#__pageTop) [[Back to API list]](../../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../../README.md#documentation-for-models) [[Back to README]](../../../README.md)
# **delete_pet**
<a name="delete_pet"></a>
<a id="delete_pet"></a>
> delete_pet(pet_id)
Deletes a pet
@@ -316,7 +316,7 @@ headers | Unset | headers were not defined |
[[Back to top]](#__pageTop) [[Back to API list]](../../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../../README.md#documentation-for-models) [[Back to README]](../../../README.md)
# **find_pets_by_status**
<a name="find_pets_by_status"></a>
<a id="find_pets_by_status"></a>
> [Pet] find_pets_by_status(status)
Finds Pets by status
@@ -510,7 +510,7 @@ headers | Unset | headers were not defined |
[[Back to top]](#__pageTop) [[Back to API list]](../../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../../README.md#documentation-for-models) [[Back to README]](../../../README.md)
# **find_pets_by_tags**
<a name="find_pets_by_tags"></a>
<a id="find_pets_by_tags"></a>
> [Pet] find_pets_by_tags(tags)
Finds Pets by tags
@@ -704,7 +704,7 @@ headers | Unset | headers were not defined |
[[Back to top]](#__pageTop) [[Back to API list]](../../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../../README.md#documentation-for-models) [[Back to README]](../../../README.md)
# **get_pet_by_id**
<a name="get_pet_by_id"></a>
<a id="get_pet_by_id"></a>
> Pet get_pet_by_id(pet_id)
Find pet by ID
@@ -826,7 +826,7 @@ headers | Unset | headers were not defined |
[[Back to top]](#__pageTop) [[Back to API list]](../../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../../README.md#documentation-for-models) [[Back to README]](../../../README.md)
# **update_pet**
<a name="update_pet"></a>
<a id="update_pet"></a>
> update_pet(pet)
Update an existing pet
@@ -1009,7 +1009,7 @@ headers | Unset | headers were not defined |
[[Back to top]](#__pageTop) [[Back to API list]](../../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../../README.md#documentation-for-models) [[Back to README]](../../../README.md)
# **update_pet_with_form**
<a name="update_pet_with_form"></a>
<a id="update_pet_with_form"></a>
> update_pet_with_form(pet_id)
Updates a pet in the store with form data
@@ -1133,7 +1133,7 @@ headers | Unset | headers were not defined |
[[Back to top]](#__pageTop) [[Back to API list]](../../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../../README.md#documentation-for-models) [[Back to README]](../../../README.md)
# **upload_file_with_required_file**
<a name="upload_file_with_required_file"></a>
<a id="upload_file_with_required_file"></a>
> ApiResponse upload_file_with_required_file(pet_id)
uploads an image (required)
@@ -1267,7 +1267,7 @@ Type | Description | Notes
[[Back to top]](#__pageTop) [[Back to API list]](../../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../../README.md#documentation-for-models) [[Back to README]](../../../README.md)
# **upload_image**
<a name="upload_image"></a>
<a id="upload_image"></a>
> ApiResponse upload_image(pet_id)
uploads an image

10
samples/openapi3/client/petstore/python/docs/apis/tags/StoreApi.md
View File

@@ -1,4 +1,4 @@
<a name="__pageTop"></a>
<a id="__pageTop"></a>
# petstore_api.apis.tags.store_api.StoreApi
All URIs are relative to *http://petstore.swagger.io:80/v2*
@@ -11,7 +11,7 @@ Method | HTTP request | Description
[**place_order**](#place_order) | **post** /store/order | Place an order for a pet
# **delete_order**
<a name="delete_order"></a>
<a id="delete_order"></a>
> delete_order(order_id)
Delete purchase order by ID
@@ -99,7 +99,7 @@ No authorization required
[[Back to top]](#__pageTop) [[Back to API list]](../../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../../README.md#documentation-for-models) [[Back to README]](../../../README.md)
# **get_inventory**
<a name="get_inventory"></a>
<a id="get_inventory"></a>
> {str: (int,)} get_inventory()
Returns pet inventories by status
@@ -178,7 +178,7 @@ Key | Input Type | Accessed Type | Description | Notes
[[Back to top]](#__pageTop) [[Back to API list]](../../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../../README.md#documentation-for-models) [[Back to README]](../../../README.md)
# **get_order_by_id**
<a name="get_order_by_id"></a>
<a id="get_order_by_id"></a>
> Order get_order_by_id(order_id)
Find purchase order by ID
@@ -289,7 +289,7 @@ No authorization required
[[Back to top]](#__pageTop) [[Back to API list]](../../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../../README.md#documentation-for-models) [[Back to README]](../../../README.md)
# **place_order**
<a name="place_order"></a>
<a id="place_order"></a>
> Order place_order(order)
Place an order for a pet

18
samples/openapi3/client/petstore/python/docs/apis/tags/UserApi.md
View File

@@ -1,4 +1,4 @@
<a name="__pageTop"></a>
<a id="__pageTop"></a>
# petstore_api.apis.tags.user_api.UserApi
All URIs are relative to *http://petstore.swagger.io:80/v2*
@@ -15,7 +15,7 @@ Method | HTTP request | Description
[**update_user**](#update_user) | **put** /user/{username} | Updated user
# **create_user**
<a name="create_user"></a>
<a id="create_user"></a>
> create_user(user)
Create user
@@ -103,7 +103,7 @@ No authorization required
[[Back to top]](#__pageTop) [[Back to API list]](../../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../../README.md#documentation-for-models) [[Back to README]](../../../README.md)
# **create_users_with_array_input**
<a name="create_users_with_array_input"></a>
<a id="create_users_with_array_input"></a>
> create_users_with_array_input(user)
Creates list of users with given input array
@@ -197,7 +197,7 @@ No authorization required
[[Back to top]](#__pageTop) [[Back to API list]](../../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../../README.md#documentation-for-models) [[Back to README]](../../../README.md)
# **create_users_with_list_input**
<a name="create_users_with_list_input"></a>
<a id="create_users_with_list_input"></a>
> create_users_with_list_input(user)
Creates list of users with given input array
@@ -291,7 +291,7 @@ No authorization required
[[Back to top]](#__pageTop) [[Back to API list]](../../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../../README.md#documentation-for-models) [[Back to README]](../../../README.md)
# **delete_user**
<a name="delete_user"></a>
<a id="delete_user"></a>
> delete_user(username)
Delete user
@@ -379,7 +379,7 @@ No authorization required
[[Back to top]](#__pageTop) [[Back to API list]](../../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../../README.md#documentation-for-models) [[Back to README]](../../../README.md)
# **get_user_by_name**
<a name="get_user_by_name"></a>
<a id="get_user_by_name"></a>
> User get_user_by_name(username)
Get user by user name
@@ -488,7 +488,7 @@ No authorization required
[[Back to top]](#__pageTop) [[Back to API list]](../../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../../README.md#documentation-for-models) [[Back to README]](../../../README.md)
# **login_user**
<a name="login_user"></a>
<a id="login_user"></a>
> str login_user(usernamepassword)
Logs user into the system
@@ -625,7 +625,7 @@ No authorization required
[[Back to top]](#__pageTop) [[Back to API list]](../../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../../README.md#documentation-for-models) [[Back to README]](../../../README.md)
# **logout_user**
<a name="logout_user"></a>
<a id="logout_user"></a>
> logout_user()
Logs out current logged in user session
@@ -678,7 +678,7 @@ No authorization required
[[Back to top]](#__pageTop) [[Back to API list]](../../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../../README.md#documentation-for-models) [[Back to README]](../../../README.md)
# **update_user**
<a name="update_user"></a>
<a id="update_user"></a>
> update_user(usernameuser)
Updated user