mii/vrchatapi-rust
1
0
Fork 0
mirror of https://github.com/mii443/vrchatapi-rust.git synced 2025-08-22 15:45:35 +00:00
Code Issues Packages Projects Releases Wiki Activity

Bump openapi-generator to 7.7.0 (#14)

Browse Source 
* bump: openapi-generator to 7.7.0

* fix: remove empty doc comments to silence clippy

* bump: remove unessecary patches fixed by the update

* bump: run generate.sh
This commit is contained in:
DerTiedemann
2024-07-21 02:18:01 +02:00
committed by GitHub
parent 169cbe48b0
commit 2c4cf7d817
263 changed files with 1978 additions and 2062 deletions
Download Patch File Download Diff File Expand all files Collapse all files

34
docs/AuthenticationApi.md
View File

@ -17,7 +17,7 @@ Method | HTTP request | Description
## check_user_exists
> crate::models::UserExists check_user_exists(email, display_name, user_id, exclude_user_id)
> models::UserExists check_user_exists(email, display_name, user_id, exclude_user_id)
Check User Exists
Checks if a user by a given `username`, `displayName` or `email` exist. This is used during registration to check if a username has already been taken, during change of displayName to check if a displayName is available, and during change of email to check if the email is already used. In the later two cases the `excludeUserId` is used to exclude oneself, otherwise the result would always be true. It is **REQUIRED** to include **AT LEAST** `username`, `displayName` **or** `email` query parameter. Although they can be combined - in addition with `excludeUserId` (generally to exclude yourself) - to further fine-tune the search.
@ -34,7 +34,7 @@ Name | Type | Description | Required | Notes
### Return type
[**crate::models::UserExists**](UserExists.md)
[**models::UserExists**](UserExists.md)
### Authorization
@ -50,7 +50,7 @@ No authorization required
## delete_user
> crate::models::CurrentUser delete_user(user_id)
> models::CurrentUser delete_user(user_id)
Delete User
Deletes the account with given ID. Normal users only have permission to delete their own account. Account deletion is 14 days from this request, and will be cancelled if you do an authenticated request with the account afterwards. **VRC+ NOTE:** Despite the 14-days cooldown, any VRC+ subscription will be cancelled **immediately**. **METHOD NOTE:** Despite this being a Delete action, the method type required is PUT.
@ -64,7 +64,7 @@ Name | Type | Description | Required | Notes
### Return type
[**crate::models::CurrentUser**](CurrentUser.md)
[**models::CurrentUser**](CurrentUser.md)
### Authorization
@ -80,7 +80,7 @@ Name | Type | Description | Required | Notes
## get_current_user
> crate::models::CurrentUser get_current_user()
> models::CurrentUser get_current_user()
Login and/or Get Current User Info
This endpoint does the following two operations: 1) Checks if you are already logged in by looking for a valid `auth` cookie. If you are have a valid auth cookie then no additional auth-related actions are taken. If you are **not** logged in then it will log you in with the `Authorization` header and set the `auth` cookie. The `auth` cookie will only be sent once. 2) If logged in, this function will also return the CurrentUser object containing detailed information about the currently logged in user. The auth string after `Authorization: Basic {string}` is a base64-encoded string of the username and password, both individually url-encoded, and then joined with a colon. > base64(urlencode(username):urlencode(password)) **WARNING: Session Limit:** Each authentication with login credentials counts as a separate session, out of which you have a limited amount. Make sure to save and reuse the `auth` cookie if you are often restarting the program. The provided API libraries automatically save cookies during runtime, but does not persist during restart. While it can be fine to use username/password during development, expect in production to very fast run into the rate-limit and be temporarily blocked from making new sessions until older ones expire. The exact number of simultaneous sessions is unknown/undisclosed.
@ -91,11 +91,11 @@ This endpoint does not need any parameter.
### Return type
[**crate::models::CurrentUser**](CurrentUser.md)
[**models::CurrentUser**](CurrentUser.md)
### Authorization
[authCookie](../README.md#authCookie), [authHeader](../README.md#authHeader), [twoFactorAuthCookie](../README.md#twoFactorAuthCookie)
[authHeader](../README.md#authHeader), [twoFactorAuthCookie](../README.md#twoFactorAuthCookie), [authCookie](../README.md#authCookie)
### HTTP request headers
@ -107,7 +107,7 @@ This endpoint does not need any parameter.
## logout
> crate::models::Success logout()
> models::Success logout()
Logout
Invalidates the login session.
@ -118,7 +118,7 @@ This endpoint does not need any parameter.
### Return type
[**crate::models::Success**](Success.md)
[**models::Success**](Success.md)
### Authorization
@ -134,7 +134,7 @@ This endpoint does not need any parameter.
## verify2_fa
> crate::models::Verify2FaResult verify2_fa(two_factor_auth_code)
> models::Verify2FaResult verify2_fa(two_factor_auth_code)
Verify 2FA code
Finishes the login sequence with a normal 2FA-generated code for accounts with 2FA-protection enabled.
@ -148,7 +148,7 @@ Name | Type | Description | Required | Notes
### Return type
[**crate::models::Verify2FaResult**](Verify2FAResult.md)
[**models::Verify2FaResult**](Verify2FAResult.md)
### Authorization
@ -164,7 +164,7 @@ Name | Type | Description | Required | Notes
## verify2_fa_email_code
> crate::models::Verify2FaEmailCodeResult verify2_fa_email_code(two_factor_email_code)
> models::Verify2FaEmailCodeResult verify2_fa_email_code(two_factor_email_code)
Verify 2FA email code
Finishes the login sequence with an 2FA email code.
@ -178,7 +178,7 @@ Name | Type | Description | Required | Notes
### Return type
[**crate::models::Verify2FaEmailCodeResult**](Verify2FAEmailCodeResult.md)
[**models::Verify2FaEmailCodeResult**](Verify2FAEmailCodeResult.md)
### Authorization
@ -194,7 +194,7 @@ Name | Type | Description | Required | Notes
## verify_auth_token
> crate::models::VerifyAuthTokenResult verify_auth_token()
> models::VerifyAuthTokenResult verify_auth_token()
Verify Auth Token
Verify whether the currently provided Auth Token is valid.
@ -205,7 +205,7 @@ This endpoint does not need any parameter.
### Return type
[**crate::models::VerifyAuthTokenResult**](VerifyAuthTokenResult.md)
[**models::VerifyAuthTokenResult**](VerifyAuthTokenResult.md)
### Authorization
@ -221,7 +221,7 @@ This endpoint does not need any parameter.
## verify_recovery_code
> crate::models::Verify2FaResult verify_recovery_code(two_factor_auth_code)
> models::Verify2FaResult verify_recovery_code(two_factor_auth_code)
Verify 2FA code with Recovery code
Finishes the login sequence with an OTP (One Time Password) recovery code for accounts with 2FA-protection enabled.
@ -235,7 +235,7 @@ Name | Type | Description | Required | Notes
### Return type
[**crate::models::Verify2FaResult**](Verify2FAResult.md)
[**models::Verify2FaResult**](Verify2FAResult.md)
### Authorization