public/immich
1
0
Fork 0
mirror of https://github.com/immich-app/immich.git synced 2025-11-01 20:47: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

26
mobile/openapi/lib/api/sync_api.dart generated
View File

@@ -16,7 +16,10 @@ class SyncApi {
final ApiClient apiClient;
/// Performs an HTTP 'DELETE /sync/ack' operation and returns the [Response].
/// This endpoint requires the `syncCheckpoint.delete` permission.
///
/// Note: This method returns the HTTP [Response].
///
/// Parameters:
///
/// * [SyncAckDeleteDto] syncAckDeleteDto (required):
@@ -45,6 +48,8 @@ class SyncApi {
);
}
/// This endpoint requires the `syncCheckpoint.delete` permission.
///
/// Parameters:
///
/// * [SyncAckDeleteDto] syncAckDeleteDto (required):
@@ -152,7 +157,9 @@ class SyncApi {
return null;
}
/// Performs an HTTP 'GET /sync/ack' operation and returns the [Response].
/// This endpoint requires the `syncCheckpoint.read` permission.
///
/// Note: This method returns the HTTP [Response].
Future<Response> getSyncAckWithHttpInfo() async {
// ignore: prefer_const_declarations
final apiPath = r'/sync/ack';
@@ -178,6 +185,7 @@ class SyncApi {
);
}
/// This endpoint requires the `syncCheckpoint.read` permission.
Future<List<SyncAckDto>?> getSyncAck() async {
final response = await getSyncAckWithHttpInfo();
if (response.statusCode >= HttpStatus.badRequest) {
@@ -196,7 +204,10 @@ class SyncApi {
return null;
}
/// Performs an HTTP 'POST /sync/stream' operation and returns the [Response].
/// This endpoint requires the `sync.stream` permission.
///
/// Note: This method returns the HTTP [Response].
///
/// Parameters:
///
/// * [SyncStreamDto] syncStreamDto (required):
@@ -225,6 +236,8 @@ class SyncApi {
);
}
/// This endpoint requires the `sync.stream` permission.
///
/// Parameters:
///
/// * [SyncStreamDto] syncStreamDto (required):
@@ -235,7 +248,10 @@ class SyncApi {
}
}
/// Performs an HTTP 'POST /sync/ack' operation and returns the [Response].
/// This endpoint requires the `syncCheckpoint.update` permission.
///
/// Note: This method returns the HTTP [Response].
///
/// Parameters:
///
/// * [SyncAckSetDto] syncAckSetDto (required):
@@ -264,6 +280,8 @@ class SyncApi {
);
}
/// This endpoint requires the `syncCheckpoint.update` permission.
///
/// Parameters:
///
/// * [SyncAckSetDto] syncAckSetDto (required):