public/immich
1
0
Fork 0
mirror of https://github.com/immich-app/immich.git synced 2025-11-01 14:37:41 +09:00
Code Issues Actions 7 Packages Projects Releases Wiki Activity

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
34 changed files with 1918 additions and 428 deletions
Download Patch File Download Diff File Expand all files Collapse all files

38
mobile/openapi/lib/api/sessions_api.dart generated
View File

@@ -16,7 +16,10 @@ class SessionsApi {
final ApiClient apiClient;
/// Performs an HTTP 'POST /sessions' operation and returns the [Response].
/// This endpoint requires the `session.create` permission.
///
/// Note: This method returns the HTTP [Response].
///
/// Parameters:
///
/// * [SessionCreateDto] sessionCreateDto (required):
@@ -45,6 +48,8 @@ class SessionsApi {
);
}
/// This endpoint requires the `session.create` permission.
///
/// Parameters:
///
/// * [SessionCreateDto] sessionCreateDto (required):
@@ -63,7 +68,9 @@ class SessionsApi {
return null;
}
/// Performs an HTTP 'DELETE /sessions' operation and returns the [Response].
/// This endpoint requires the `session.delete` permission.
///
/// Note: This method returns the HTTP [Response].
Future<Response> deleteAllSessionsWithHttpInfo() async {
// ignore: prefer_const_declarations
final apiPath = r'/sessions';
@@ -89,6 +96,7 @@ class SessionsApi {
);
}
/// This endpoint requires the `session.delete` permission.
Future<void> deleteAllSessions() async {
final response = await deleteAllSessionsWithHttpInfo();
if (response.statusCode >= HttpStatus.badRequest) {
@@ -96,7 +104,10 @@ class SessionsApi {
}
}
/// Performs an HTTP 'DELETE /sessions/{id}' operation and returns the [Response].
/// This endpoint requires the `session.delete` permission.
///
/// Note: This method returns the HTTP [Response].
///
/// Parameters:
///
/// * [String] id (required):
@@ -126,6 +137,8 @@ class SessionsApi {
);
}
/// This endpoint requires the `session.delete` permission.
///
/// Parameters:
///
/// * [String] id (required):
@@ -136,7 +149,9 @@ class SessionsApi {
}
}
/// Performs an HTTP 'GET /sessions' operation and returns the [Response].
/// This endpoint requires the `session.read` permission.
///
/// Note: This method returns the HTTP [Response].
Future<Response> getSessionsWithHttpInfo() async {
// ignore: prefer_const_declarations
final apiPath = r'/sessions';
@@ -162,6 +177,7 @@ class SessionsApi {
);
}
/// This endpoint requires the `session.read` permission.
Future<List<SessionResponseDto>?> getSessions() async {
final response = await getSessionsWithHttpInfo();
if (response.statusCode >= HttpStatus.badRequest) {
@@ -180,7 +196,10 @@ class SessionsApi {
return null;
}
/// Performs an HTTP 'POST /sessions/{id}/lock' operation and returns the [Response].
/// This endpoint requires the `session.lock` permission.
///
/// Note: This method returns the HTTP [Response].
///
/// Parameters:
///
/// * [String] id (required):
@@ -210,6 +229,8 @@ class SessionsApi {
);
}
/// This endpoint requires the `session.lock` permission.
///
/// Parameters:
///
/// * [String] id (required):
@@ -220,7 +241,10 @@ class SessionsApi {
}
}
/// Performs an HTTP 'PUT /sessions/{id}' operation and returns the [Response].
/// This endpoint requires the `session.update` permission.
///
/// Note: This method returns the HTTP [Response].
///
/// Parameters:
///
/// * [String] id (required):
@@ -252,6 +276,8 @@ class SessionsApi {
);
}
/// This endpoint requires the `session.update` permission.
///
/// Parameters:
///
/// * [String] id (required):