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

28
mobile/openapi/lib/api/partners_api.dart generated
View file

@ -16,7 +16,10 @@ class PartnersApi {
final ApiClient apiClient;
/// Performs an HTTP 'POST /partners/{id}' operation and returns the [Response].
/// This endpoint requires the `partner.create` permission.
///
/// Note: This method returns the HTTP [Response].
///
/// Parameters:
///
/// * [String] id (required):
@ -46,6 +49,8 @@ class PartnersApi {
);
}
/// This endpoint requires the `partner.create` permission.
///
/// Parameters:
///
/// * [String] id (required):
@ -64,7 +69,10 @@ class PartnersApi {
return null;
}
/// Performs an HTTP 'GET /partners' operation and returns the [Response].
/// This endpoint requires the `partner.read` permission.
///
/// Note: This method returns the HTTP [Response].
///
/// Parameters:
///
/// * [PartnerDirection] direction (required):
@ -95,6 +103,8 @@ class PartnersApi {
);
}
/// This endpoint requires the `partner.read` permission.
///
/// Parameters:
///
/// * [PartnerDirection] direction (required):
@ -116,7 +126,10 @@ class PartnersApi {
return null;
}
/// Performs an HTTP 'DELETE /partners/{id}' operation and returns the [Response].
/// This endpoint requires the `partner.delete` permission.
///
/// Note: This method returns the HTTP [Response].
///
/// Parameters:
///
/// * [String] id (required):
@ -146,6 +159,8 @@ class PartnersApi {
);
}
/// This endpoint requires the `partner.delete` permission.
///
/// Parameters:
///
/// * [String] id (required):
@ -156,7 +171,10 @@ class PartnersApi {
}
}
/// Performs an HTTP 'PUT /partners/{id}' operation and returns the [Response].
/// This endpoint requires the `partner.update` permission.
///
/// Note: This method returns the HTTP [Response].
///
/// Parameters:
///
/// * [String] id (required):
@ -188,6 +206,8 @@ class PartnersApi {
);
}
/// This endpoint requires the `partner.update` permission.
///
/// Parameters:
///
/// * [String] id (required):