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

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/activities_api.dart generated
View file

@ -16,7 +16,10 @@ class ActivitiesApi {
final ApiClient apiClient;
/// Performs an HTTP 'POST /activities' operation and returns the [Response].
/// This endpoint requires the `activity.create` permission.
///
/// Note: This method returns the HTTP [Response].
///
/// Parameters:
///
/// * [ActivityCreateDto] activityCreateDto (required):
@ -45,6 +48,8 @@ class ActivitiesApi {
);
}
/// This endpoint requires the `activity.create` permission.
///
/// Parameters:
///
/// * [ActivityCreateDto] activityCreateDto (required):
@ -63,7 +68,10 @@ class ActivitiesApi {
return null;
}
/// Performs an HTTP 'DELETE /activities/{id}' operation and returns the [Response].
/// This endpoint requires the `activity.delete` permission.
///
/// Note: This method returns the HTTP [Response].
///
/// Parameters:
///
/// * [String] id (required):
@ -93,6 +101,8 @@ class ActivitiesApi {
);
}
/// This endpoint requires the `activity.delete` permission.
///
/// Parameters:
///
/// * [String] id (required):
@ -103,7 +113,10 @@ class ActivitiesApi {
}
}
/// Performs an HTTP 'GET /activities' operation and returns the [Response].
/// This endpoint requires the `activity.read` permission.
///
/// Note: This method returns the HTTP [Response].
///
/// Parameters:
///
/// * [String] albumId (required):
@ -154,6 +167,8 @@ class ActivitiesApi {
);
}
/// This endpoint requires the `activity.read` permission.
///
/// Parameters:
///
/// * [String] albumId (required):
@ -183,7 +198,10 @@ class ActivitiesApi {
return null;
}
/// Performs an HTTP 'GET /activities/statistics' operation and returns the [Response].
/// This endpoint requires the `activity.statistics` permission.
///
/// Note: This method returns the HTTP [Response].
///
/// Parameters:
///
/// * [String] albumId (required):
@ -219,6 +237,8 @@ class ActivitiesApi {
);
}
/// This endpoint requires the `activity.statistics` permission.
///
/// Parameters:
///
/// * [String] albumId (required):