mirror of
https://github.com/immich-app/immich.git
synced 2025-12-18 01:11:07 +03:00
feat: endpoint descriptions (#23813)
This commit is contained in:
40
mobile/openapi/lib/api/partners_api.dart
generated
40
mobile/openapi/lib/api/partners_api.dart
generated
@@ -16,7 +16,9 @@ class PartnersApi {
|
||||
|
||||
final ApiClient apiClient;
|
||||
|
||||
/// This endpoint requires the `partner.create` permission.
|
||||
/// Create a partner
|
||||
///
|
||||
/// Create a new partner to share assets with.
|
||||
///
|
||||
/// Note: This method returns the HTTP [Response].
|
||||
///
|
||||
@@ -48,7 +50,9 @@ class PartnersApi {
|
||||
);
|
||||
}
|
||||
|
||||
/// This endpoint requires the `partner.create` permission.
|
||||
/// Create a partner
|
||||
///
|
||||
/// Create a new partner to share assets with.
|
||||
///
|
||||
/// Parameters:
|
||||
///
|
||||
@@ -68,7 +72,9 @@ class PartnersApi {
|
||||
return null;
|
||||
}
|
||||
|
||||
/// This property was deprecated in v1.141.0. This endpoint requires the `partner.create` permission.
|
||||
/// Create a partner
|
||||
///
|
||||
/// This property was deprecated in v1.141.0. Create a new partner to share assets with.
|
||||
///
|
||||
/// Note: This method returns the HTTP [Response].
|
||||
///
|
||||
@@ -101,7 +107,9 @@ class PartnersApi {
|
||||
);
|
||||
}
|
||||
|
||||
/// This property was deprecated in v1.141.0. This endpoint requires the `partner.create` permission.
|
||||
/// Create a partner
|
||||
///
|
||||
/// This property was deprecated in v1.141.0. Create a new partner to share assets with.
|
||||
///
|
||||
/// Parameters:
|
||||
///
|
||||
@@ -121,7 +129,9 @@ class PartnersApi {
|
||||
return null;
|
||||
}
|
||||
|
||||
/// This endpoint requires the `partner.read` permission.
|
||||
/// Retrieve partners
|
||||
///
|
||||
/// Retrieve a list of partners with whom assets are shared.
|
||||
///
|
||||
/// Note: This method returns the HTTP [Response].
|
||||
///
|
||||
@@ -155,7 +165,9 @@ class PartnersApi {
|
||||
);
|
||||
}
|
||||
|
||||
/// This endpoint requires the `partner.read` permission.
|
||||
/// Retrieve partners
|
||||
///
|
||||
/// Retrieve a list of partners with whom assets are shared.
|
||||
///
|
||||
/// Parameters:
|
||||
///
|
||||
@@ -178,7 +190,9 @@ class PartnersApi {
|
||||
return null;
|
||||
}
|
||||
|
||||
/// This endpoint requires the `partner.delete` permission.
|
||||
/// Remove a partner
|
||||
///
|
||||
/// Stop sharing assets with a partner.
|
||||
///
|
||||
/// Note: This method returns the HTTP [Response].
|
||||
///
|
||||
@@ -211,7 +225,9 @@ class PartnersApi {
|
||||
);
|
||||
}
|
||||
|
||||
/// This endpoint requires the `partner.delete` permission.
|
||||
/// Remove a partner
|
||||
///
|
||||
/// Stop sharing assets with a partner.
|
||||
///
|
||||
/// Parameters:
|
||||
///
|
||||
@@ -223,7 +239,9 @@ class PartnersApi {
|
||||
}
|
||||
}
|
||||
|
||||
/// This endpoint requires the `partner.update` permission.
|
||||
/// Update a partner
|
||||
///
|
||||
/// Specify whether a partner's assets should appear in the user's timeline.
|
||||
///
|
||||
/// Note: This method returns the HTTP [Response].
|
||||
///
|
||||
@@ -258,7 +276,9 @@ class PartnersApi {
|
||||
);
|
||||
}
|
||||
|
||||
/// This endpoint requires the `partner.update` permission.
|
||||
/// Update a partner
|
||||
///
|
||||
/// Specify whether a partner's assets should appear in the user's timeline.
|
||||
///
|
||||
/// Parameters:
|
||||
///
|
||||
|
||||
Reference in New Issue
Block a user