helpy4/immich
1
0
Fork 0
mirror of https://github.com/immich-app/immich synced 2025-10-17 18:19:27 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

feat: better endpoint descriptions (#20439)

Browse source
This commit is contained in:
Jason Rasmussen 2025-07-30 12:29:36 -04:00 • committed by GitHub
parent d5a01c0310
commit 749f999f2a
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
34 changed files with 1918 additions and 428 deletions
Download patch file Download diff file Expand all files Collapse all files

28
mobile/openapi/lib/api/authentication_api.dart generated
View file

@ -16,7 +16,10 @@ class AuthenticationApi {
final ApiClient apiClient;
/// Performs an HTTP 'POST /auth/change-password' operation and returns the [Response].
/// This endpoint requires the `auth.changePassword` permission.
///
/// Note: This method returns the HTTP [Response].
///
/// Parameters:
///
/// * [ChangePasswordDto] changePasswordDto (required):
@ -45,6 +48,8 @@ class AuthenticationApi {
);
}
/// This endpoint requires the `auth.changePassword` permission.
///
/// Parameters:
///
/// * [ChangePasswordDto] changePasswordDto (required):
@ -63,7 +68,10 @@ class AuthenticationApi {
return null;
}
/// Performs an HTTP 'PUT /auth/pin-code' operation and returns the [Response].
/// This endpoint requires the `pinCode.update` permission.
///
/// Note: This method returns the HTTP [Response].
///
/// Parameters:
///
/// * [PinCodeChangeDto] pinCodeChangeDto (required):
@ -92,6 +100,8 @@ class AuthenticationApi {
);
}
/// This endpoint requires the `pinCode.update` permission.
///
/// Parameters:
///
/// * [PinCodeChangeDto] pinCodeChangeDto (required):
@ -264,7 +274,10 @@ class AuthenticationApi {
return null;
}
/// Performs an HTTP 'DELETE /auth/pin-code' operation and returns the [Response].
/// This endpoint requires the `pinCode.delete` permission.
///
/// Note: This method returns the HTTP [Response].
///
/// Parameters:
///
/// * [PinCodeResetDto] pinCodeResetDto (required):
@ -293,6 +306,8 @@ class AuthenticationApi {
);
}
/// This endpoint requires the `pinCode.delete` permission.
///
/// Parameters:
///
/// * [PinCodeResetDto] pinCodeResetDto (required):
@ -303,7 +318,10 @@ class AuthenticationApi {
}
}
/// Performs an HTTP 'POST /auth/pin-code' operation and returns the [Response].
/// This endpoint requires the `pinCode.create` permission.
///
/// Note: This method returns the HTTP [Response].
///
/// Parameters:
///
/// * [PinCodeSetupDto] pinCodeSetupDto (required):
@ -332,6 +350,8 @@ class AuthenticationApi {
);
}
/// This endpoint requires the `pinCode.create` permission.
///
/// Parameters:
///
/// * [PinCodeSetupDto] pinCodeSetupDto (required):