docs(openapi): add descriptions to OpenAPI specification (#25185)

* faces * add openapi descriptions * remove dto descriptions * gen openapi * dtos * fix dtos * fix more * fix build * more * complete dtos * descriptions on rebase * gen rebase * revert correct integer type conversion * gen after revert * revert correct nullables * regen after revert * actually incorrect adding default here * revert correct number type conversion * regen after revert * revert nullable usage * regen fully * readd some comments * one more * one more * use enum * add missing * add missing controllers * add missing dtos * complete it * more * describe global key and slug * add remaining body and param descriptions * lint and format * cleanup * response and schema descriptions * test patch according to suggestion * revert added api response objects * revert added api body objects * revert added api param object * revert added api query objects * revert reorganized http code objects * revert reorganize ApiOkResponse objects * revert added api response objects (2) * revert added api tag object * revert added api schema objects * migrate missing asset.dto.ts * regenerate openapi builds * delete generated mustache files * remove descriptions from properties that are schemas * lint * revert nullable type changes * revert int/num type changes * remove explicit default * readd comment * lint * pr fixes * last bits and pieces * lint and format * chore: remove rejected patches * fix: deleting asset from asset-viewer on search results (#25596) * fix: escape handling in search asset viewer (#25621) * fix: correctly show owner in album options modal (#25618) * fix: validation issues * fix: validation issues --------- Co-authored-by: Jason Rasmussen <jason@rasm.me> Co-authored-by: Min Idzelis <min123@gmail.com> Co-authored-by: Daniel Dietzler <36593685+danieldietzler@users.noreply.github.com> Co-authored-by: Paul Makles <me@insrt.uk>
2026-05-22 15:02:32 -04:00 · 2026-01-29 14:49:15 +01:00
parent eadb2f89af
commit 8db61d341f
377 changed files with 5554 additions and 735 deletions
@@ -318,10 +318,13 @@ class UsersAdminApi {
  /// * [String] id (required):
  ///
  /// * [bool] isFavorite:
+  ///   Filter by favorite status
  ///
  /// * [bool] isTrashed:
+  ///   Filter by trash status
  ///
  /// * [AssetVisibility] visibility:
+  ///   Filter by visibility
  Future<Response> getUserStatisticsAdminWithHttpInfo(String id, { bool? isFavorite, bool? isTrashed, AssetVisibility? visibility, }) async {
    // ignore: prefer_const_declarations
    final apiPath = r'/admin/users/{id}/statistics'
@@ -367,10 +370,13 @@ class UsersAdminApi {
  /// * [String] id (required):
  ///
  /// * [bool] isFavorite:
+  ///   Filter by favorite status
  ///
  /// * [bool] isTrashed:
+  ///   Filter by trash status
  ///
  /// * [AssetVisibility] visibility:
+  ///   Filter by visibility
  Future<AssetStatsResponseDto?> getUserStatisticsAdmin(String id, { bool? isFavorite, bool? isTrashed, AssetVisibility? visibility, }) async {
    final response = await getUserStatisticsAdminWithHttpInfo(id,  isFavorite: isFavorite, isTrashed: isTrashed, visibility: visibility, );
    if (response.statusCode >= HttpStatus.badRequest) {
@@ -452,8 +458,10 @@ class UsersAdminApi {
  /// Parameters:
  ///
  /// * [String] id:
+  ///   User ID filter
  ///
  /// * [bool] withDeleted:
+  ///   Include deleted users
  Future<Response> searchUsersAdminWithHttpInfo({ String? id, bool? withDeleted, }) async {
    // ignore: prefer_const_declarations
    final apiPath = r'/admin/users';
@@ -493,8 +501,10 @@ class UsersAdminApi {
  /// Parameters:
  ///
  /// * [String] id:
+  ///   User ID filter
  ///
  /// * [bool] withDeleted:
+  ///   Include deleted users
  Future<List<UserAdminResponseDto>?> searchUsersAdmin({ String? id, bool? withDeleted, }) async {
    final response = await searchUsersAdminWithHttpInfo( id: id, withDeleted: withDeleted, );
    if (response.statusCode >= HttpStatus.badRequest) {