helpy4/immich
1
0
Fork 0
mirror of https://github.com/immich-app/immich synced 2025-10-17 18:19:27 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

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

33
mobile/openapi/lib/api/api_keys_api.dart generated
View file

@ -16,7 +16,10 @@ class APIKeysApi {
final ApiClient apiClient;
/// Performs an HTTP 'POST /api-keys' operation and returns the [Response].
/// This endpoint requires the `apiKey.create` permission.
///
/// Note: This method returns the HTTP [Response].
///
/// Parameters:
///
/// * [APIKeyCreateDto] aPIKeyCreateDto (required):
@ -45,6 +48,8 @@ class APIKeysApi {
);
}
/// This endpoint requires the `apiKey.create` permission.
///
/// Parameters:
///
/// * [APIKeyCreateDto] aPIKeyCreateDto (required):
@ -63,7 +68,10 @@ class APIKeysApi {
return null;
}
/// Performs an HTTP 'DELETE /api-keys/{id}' operation and returns the [Response].
/// This endpoint requires the `apiKey.delete` permission.
///
/// Note: This method returns the HTTP [Response].
///
/// Parameters:
///
/// * [String] id (required):
@ -93,6 +101,8 @@ class APIKeysApi {
);
}
/// This endpoint requires the `apiKey.delete` permission.
///
/// Parameters:
///
/// * [String] id (required):
@ -103,7 +113,10 @@ class APIKeysApi {
}
}
/// Performs an HTTP 'GET /api-keys/{id}' operation and returns the [Response].
/// This endpoint requires the `apiKey.read` permission.
///
/// Note: This method returns the HTTP [Response].
///
/// Parameters:
///
/// * [String] id (required):
@ -133,6 +146,8 @@ class APIKeysApi {
);
}
/// This endpoint requires the `apiKey.read` permission.
///
/// Parameters:
///
/// * [String] id (required):
@ -151,7 +166,9 @@ class APIKeysApi {
return null;
}
/// Performs an HTTP 'GET /api-keys' operation and returns the [Response].
/// This endpoint requires the `apiKey.read` permission.
///
/// Note: This method returns the HTTP [Response].
Future<Response> getApiKeysWithHttpInfo() async {
// ignore: prefer_const_declarations
final apiPath = r'/api-keys';
@ -177,6 +194,7 @@ class APIKeysApi {
);
}
/// This endpoint requires the `apiKey.read` permission.
Future<List<APIKeyResponseDto>?> getApiKeys() async {
final response = await getApiKeysWithHttpInfo();
if (response.statusCode >= HttpStatus.badRequest) {
@ -195,7 +213,10 @@ class APIKeysApi {
return null;
}
/// Performs an HTTP 'PUT /api-keys/{id}' operation and returns the [Response].
/// This endpoint requires the `apiKey.update` permission.
///
/// Note: This method returns the HTTP [Response].
///
/// Parameters:
///
/// * [String] id (required):
@ -227,6 +248,8 @@ class APIKeysApi {
);
}
/// This endpoint requires the `apiKey.update` permission.
///
/// Parameters:
///
/// * [String] id (required):