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 1

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

19
mobile/openapi/lib/api/jobs_api.dart generated
View file

@ -16,7 +16,10 @@ class JobsApi {
final ApiClient apiClient;
/// Performs an HTTP 'POST /jobs' operation and returns the [Response].
/// This endpoint is an admin-only route, and requires the `job.create` permission.
///
/// Note: This method returns the HTTP [Response].
///
/// Parameters:
///
/// * [JobCreateDto] jobCreateDto (required):
@ -45,6 +48,8 @@ class JobsApi {
);
}
/// This endpoint is an admin-only route, and requires the `job.create` permission.
///
/// Parameters:
///
/// * [JobCreateDto] jobCreateDto (required):
@ -55,7 +60,9 @@ class JobsApi {
}
}
/// Performs an HTTP 'GET /jobs' operation and returns the [Response].
/// This endpoint is an admin-only route, and requires the `job.read` permission.
///
/// Note: This method returns the HTTP [Response].
Future<Response> getAllJobsStatusWithHttpInfo() async {
// ignore: prefer_const_declarations
final apiPath = r'/jobs';
@ -81,6 +88,7 @@ class JobsApi {
);
}
/// This endpoint is an admin-only route, and requires the `job.read` permission.
Future<AllJobStatusResponseDto?> getAllJobsStatus() async {
final response = await getAllJobsStatusWithHttpInfo();
if (response.statusCode >= HttpStatus.badRequest) {
@ -96,7 +104,10 @@ class JobsApi {
return null;
}
/// Performs an HTTP 'PUT /jobs/{id}' operation and returns the [Response].
/// This endpoint is an admin-only route, and requires the `job.create` permission.
///
/// Note: This method returns the HTTP [Response].
///
/// Parameters:
///
/// * [JobName] id (required):
@ -128,6 +139,8 @@ class JobsApi {
);
}
/// This endpoint is an admin-only route, and requires the `job.create` permission.
///
/// Parameters:
///
/// * [JobName] id (required):