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

42
mobile/openapi/lib/api/notifications_api.dart generated
View file

@ -16,7 +16,10 @@ class NotificationsApi {
final ApiClient apiClient;
/// Performs an HTTP 'DELETE /notifications/{id}' operation and returns the [Response].
/// This endpoint requires the `notification.delete` permission.
///
/// Note: This method returns the HTTP [Response].
///
/// Parameters:
///
/// * [String] id (required):
@ -46,6 +49,8 @@ class NotificationsApi {
);
}
/// This endpoint requires the `notification.delete` permission.
///
/// Parameters:
///
/// * [String] id (required):
@ -56,7 +61,10 @@ class NotificationsApi {
}
}
/// Performs an HTTP 'DELETE /notifications' operation and returns the [Response].
/// This endpoint requires the `notification.delete` permission.
///
/// Note: This method returns the HTTP [Response].
///
/// Parameters:
///
/// * [NotificationDeleteAllDto] notificationDeleteAllDto (required):
@ -85,6 +93,8 @@ class NotificationsApi {
);
}
/// This endpoint requires the `notification.delete` permission.
///
/// Parameters:
///
/// * [NotificationDeleteAllDto] notificationDeleteAllDto (required):
@ -95,7 +105,10 @@ class NotificationsApi {
}
}
/// Performs an HTTP 'GET /notifications/{id}' operation and returns the [Response].
/// This endpoint requires the `notification.read` permission.
///
/// Note: This method returns the HTTP [Response].
///
/// Parameters:
///
/// * [String] id (required):
@ -125,6 +138,8 @@ class NotificationsApi {
);
}
/// This endpoint requires the `notification.read` permission.
///
/// Parameters:
///
/// * [String] id (required):
@ -143,7 +158,10 @@ class NotificationsApi {
return null;
}
/// Performs an HTTP 'GET /notifications' operation and returns the [Response].
/// This endpoint requires the `notification.read` permission.
///
/// Note: This method returns the HTTP [Response].
///
/// Parameters:
///
/// * [String] id:
@ -191,6 +209,8 @@ class NotificationsApi {
);
}
/// This endpoint requires the `notification.read` permission.
///
/// Parameters:
///
/// * [String] id:
@ -218,7 +238,10 @@ class NotificationsApi {
return null;
}
/// Performs an HTTP 'PUT /notifications/{id}' operation and returns the [Response].
/// This endpoint requires the `notification.update` permission.
///
/// Note: This method returns the HTTP [Response].
///
/// Parameters:
///
/// * [String] id (required):
@ -250,6 +273,8 @@ class NotificationsApi {
);
}
/// This endpoint requires the `notification.update` permission.
///
/// Parameters:
///
/// * [String] id (required):
@ -270,7 +295,10 @@ class NotificationsApi {
return null;
}
/// Performs an HTTP 'PUT /notifications' operation and returns the [Response].
/// This endpoint requires the `notification.update` permission.
///
/// Note: This method returns the HTTP [Response].
///
/// Parameters:
///
/// * [NotificationUpdateAllDto] notificationUpdateAllDto (required):
@ -299,6 +327,8 @@ class NotificationsApi {
);
}
/// This endpoint requires the `notification.update` permission.
///
/// Parameters:
///
/// * [NotificationUpdateAllDto] notificationUpdateAllDto (required):