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

22
mobile/openapi/lib/api/system_config_api.dart generated
View File

@@ -16,7 +16,9 @@ class SystemConfigApi {
final ApiClient apiClient;
/// Performs an HTTP 'GET /system-config' operation and returns the [Response].
/// This endpoint is an admin-only route, and requires the `systemConfig.read` permission.
///
/// Note: This method returns the HTTP [Response].
Future<Response> getConfigWithHttpInfo() async {
// ignore: prefer_const_declarations
final apiPath = r'/system-config';
@@ -42,6 +44,7 @@ class SystemConfigApi {
);
}
/// This endpoint is an admin-only route, and requires the `systemConfig.read` permission.
Future<SystemConfigDto?> getConfig() async {
final response = await getConfigWithHttpInfo();
if (response.statusCode >= HttpStatus.badRequest) {
@@ -57,7 +60,9 @@ class SystemConfigApi {
return null;
}
/// Performs an HTTP 'GET /system-config/defaults' operation and returns the [Response].
/// This endpoint is an admin-only route, and requires the `systemConfig.read` permission.
///
/// Note: This method returns the HTTP [Response].
Future<Response> getConfigDefaultsWithHttpInfo() async {
// ignore: prefer_const_declarations
final apiPath = r'/system-config/defaults';
@@ -83,6 +88,7 @@ class SystemConfigApi {
);
}
/// This endpoint is an admin-only route, and requires the `systemConfig.read` permission.
Future<SystemConfigDto?> getConfigDefaults() async {
final response = await getConfigDefaultsWithHttpInfo();
if (response.statusCode >= HttpStatus.badRequest) {
@@ -98,7 +104,9 @@ class SystemConfigApi {
return null;
}
/// Performs an HTTP 'GET /system-config/storage-template-options' operation and returns the [Response].
/// This endpoint is an admin-only route, and requires the `systemConfig.read` permission.
///
/// Note: This method returns the HTTP [Response].
Future<Response> getStorageTemplateOptionsWithHttpInfo() async {
// ignore: prefer_const_declarations
final apiPath = r'/system-config/storage-template-options';
@@ -124,6 +132,7 @@ class SystemConfigApi {
);
}
/// This endpoint is an admin-only route, and requires the `systemConfig.read` permission.
Future<SystemConfigTemplateStorageOptionDto?> getStorageTemplateOptions() async {
final response = await getStorageTemplateOptionsWithHttpInfo();
if (response.statusCode >= HttpStatus.badRequest) {
@@ -139,7 +148,10 @@ class SystemConfigApi {
return null;
}
/// Performs an HTTP 'PUT /system-config' operation and returns the [Response].
/// This endpoint is an admin-only route, and requires the `systemConfig.update` permission.
///
/// Note: This method returns the HTTP [Response].
///
/// Parameters:
///
/// * [SystemConfigDto] systemConfigDto (required):
@@ -168,6 +180,8 @@ class SystemConfigApi {
);
}
/// This endpoint is an admin-only route, and requires the `systemConfig.update` permission.
///
/// Parameters:
///
/// * [SystemConfigDto] systemConfigDto (required):