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

feat: endpoint descriptions (#23813)

Browse source
This commit is contained in:
Jason Rasmussen 2025-11-11 17:01:14 -05:00 • committed by GitHub
parent 896665bca9
commit edde0f93ae
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
76 changed files with 4193 additions and 1663 deletions
Download patch file Download diff file Expand all files Collapse all files

48
mobile/openapi/lib/api/sessions_api.dart generated
View file

@ -16,7 +16,9 @@ class SessionsApi {
final ApiClient apiClient;
/// This endpoint requires the `session.create` permission.
/// Create a session
///
/// Create a session as a child to the current session. This endpoint is used for casting.
///
/// Note: This method returns the HTTP [Response].
///
@ -48,7 +50,9 @@ class SessionsApi {
);
}
/// This endpoint requires the `session.create` permission.
/// Create a session
///
/// Create a session as a child to the current session. This endpoint is used for casting.
///
/// Parameters:
///
@ -68,7 +72,9 @@ class SessionsApi {
return null;
}
/// This endpoint requires the `session.delete` permission.
/// Delete all sessions
///
/// Delete all sessions for the user. This will not delete the current session.
///
/// Note: This method returns the HTTP [Response].
Future<Response> deleteAllSessionsWithHttpInfo() async {
@ -96,7 +102,9 @@ class SessionsApi {
);
}
/// This endpoint requires the `session.delete` permission.
/// Delete all sessions
///
/// Delete all sessions for the user. This will not delete the current session.
Future<void> deleteAllSessions() async {
final response = await deleteAllSessionsWithHttpInfo();
if (response.statusCode >= HttpStatus.badRequest) {
@ -104,7 +112,9 @@ class SessionsApi {
}
}
/// This endpoint requires the `session.delete` permission.
/// Delete a session
///
/// Delete a specific session by id.
///
/// Note: This method returns the HTTP [Response].
///
@ -137,7 +147,9 @@ class SessionsApi {
);
}
/// This endpoint requires the `session.delete` permission.
/// Delete a session
///
/// Delete a specific session by id.
///
/// Parameters:
///
@ -149,7 +161,9 @@ class SessionsApi {
}
}
/// This endpoint requires the `session.read` permission.
/// Retrieve sessions
///
/// Retrieve a list of sessions for the user.
///
/// Note: This method returns the HTTP [Response].
Future<Response> getSessionsWithHttpInfo() async {
@ -177,7 +191,9 @@ class SessionsApi {
);
}
/// This endpoint requires the `session.read` permission.
/// Retrieve sessions
///
/// Retrieve a list of sessions for the user.
Future<List<SessionResponseDto>?> getSessions() async {
final response = await getSessionsWithHttpInfo();
if (response.statusCode >= HttpStatus.badRequest) {
@ -196,7 +212,9 @@ class SessionsApi {
return null;
}
/// This endpoint requires the `session.lock` permission.
/// Lock a session
///
/// Lock a specific session by id.
///
/// Note: This method returns the HTTP [Response].
///
@ -229,7 +247,9 @@ class SessionsApi {
);
}
/// This endpoint requires the `session.lock` permission.
/// Lock a session
///
/// Lock a specific session by id.
///
/// Parameters:
///
@ -241,7 +261,9 @@ class SessionsApi {
}
}
/// This endpoint requires the `session.update` permission.
/// Update a session
///
/// Update a specific session identified by id.
///
/// Note: This method returns the HTTP [Response].
///
@ -276,7 +298,9 @@ class SessionsApi {
);
}
/// This endpoint requires the `session.update` permission.
/// Update a session
///
/// Update a specific session identified by id.
///
/// Parameters:
///