public/immich
1
0
Fork 0
mirror of https://github.com/immich-app/immich.git synced 2025-11-02 09:07:42 +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

69
mobile/openapi/lib/api/shared_links_api.dart generated
View File

@@ -86,7 +86,10 @@ class SharedLinksApi {
return null;
}
/// Performs an HTTP 'POST /shared-links' operation and returns the [Response].
/// This endpoint requires the `sharedLink.create` permission.
///
/// Note: This method returns the HTTP [Response].
///
/// Parameters:
///
/// * [SharedLinkCreateDto] sharedLinkCreateDto (required):
@@ -115,6 +118,8 @@ class SharedLinksApi {
);
}
/// This endpoint requires the `sharedLink.create` permission.
///
/// Parameters:
///
/// * [SharedLinkCreateDto] sharedLinkCreateDto (required):
@@ -133,7 +138,10 @@ class SharedLinksApi {
return null;
}
/// Performs an HTTP 'GET /shared-links' operation and returns the [Response].
/// This endpoint requires the `sharedLink.read` permission.
///
/// Note: This method returns the HTTP [Response].
///
/// Parameters:
///
/// * [String] albumId:
@@ -166,6 +174,8 @@ class SharedLinksApi {
);
}
/// This endpoint requires the `sharedLink.read` permission.
///
/// Parameters:
///
/// * [String] albumId:
@@ -190,14 +200,14 @@ class SharedLinksApi {
/// Performs an HTTP 'GET /shared-links/me' operation and returns the [Response].
/// Parameters:
///
/// * [String] key:
///
/// * [String] password:
///
/// * [String] slug:
///
/// * [String] token:
Future<Response> getMySharedLinkWithHttpInfo({ String? key, String? password, String? slug, String? token, }) async {
///
/// * [String] key:
///
/// * [String] slug:
Future<Response> getMySharedLinkWithHttpInfo({ String? password, String? token, String? key, String? slug, }) async {
// ignore: prefer_const_declarations
final apiPath = r'/shared-links/me';
@@ -208,18 +218,18 @@ class SharedLinksApi {
final headerParams = <String, String>{};
final formParams = <String, String>{};
if (key != null) {
queryParams.addAll(_queryParams('', 'key', key));
}
if (password != null) {
queryParams.addAll(_queryParams('', 'password', password));
}
if (slug != null) {
queryParams.addAll(_queryParams('', 'slug', slug));
}
if (token != null) {
queryParams.addAll(_queryParams('', 'token', token));
}
if (key != null) {
queryParams.addAll(_queryParams('', 'key', key));
}
if (slug != null) {
queryParams.addAll(_queryParams('', 'slug', slug));
}
const contentTypes = <String>[];
@@ -237,15 +247,15 @@ class SharedLinksApi {
/// Parameters:
///
/// * [String] key:
///
/// * [String] password:
///
/// * [String] slug:
///
/// * [String] token:
Future<SharedLinkResponseDto?> getMySharedLink({ String? key, String? password, String? slug, String? token, }) async {
final response = await getMySharedLinkWithHttpInfo( key: key, password: password, slug: slug, token: token, );
///
/// * [String] key:
///
/// * [String] slug:
Future<SharedLinkResponseDto?> getMySharedLink({ String? password, String? token, String? key, String? slug, }) async {
final response = await getMySharedLinkWithHttpInfo( password: password, token: token, key: key, slug: slug, );
if (response.statusCode >= HttpStatus.badRequest) {
throw ApiException(response.statusCode, await _decodeBodyBytes(response));
}
@@ -259,7 +269,10 @@ class SharedLinksApi {
return null;
}
/// Performs an HTTP 'GET /shared-links/{id}' operation and returns the [Response].
/// This endpoint requires the `sharedLink.read` permission.
///
/// Note: This method returns the HTTP [Response].
///
/// Parameters:
///
/// * [String] id (required):
@@ -289,6 +302,8 @@ class SharedLinksApi {
);
}
/// This endpoint requires the `sharedLink.read` permission.
///
/// Parameters:
///
/// * [String] id (required):
@@ -307,7 +322,10 @@ class SharedLinksApi {
return null;
}
/// Performs an HTTP 'DELETE /shared-links/{id}' operation and returns the [Response].
/// This endpoint requires the `sharedLink.delete` permission.
///
/// Note: This method returns the HTTP [Response].
///
/// Parameters:
///
/// * [String] id (required):
@@ -337,6 +355,8 @@ class SharedLinksApi {
);
}
/// This endpoint requires the `sharedLink.delete` permission.
///
/// Parameters:
///
/// * [String] id (required):
@@ -417,7 +437,10 @@ class SharedLinksApi {
return null;
}
/// Performs an HTTP 'PATCH /shared-links/{id}' operation and returns the [Response].
/// This endpoint requires the `sharedLink.update` permission.
///
/// Note: This method returns the HTTP [Response].
///
/// Parameters:
///
/// * [String] id (required):
@@ -449,6 +472,8 @@ class SharedLinksApi {
);
}
/// This endpoint requires the `sharedLink.update` permission.
///
/// Parameters:
///
/// * [String] id (required):