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-18 03:10:24 +03:00 · 2026-01-29 14:49:15 +01:00
parent eadb2f89af
commit 8db61d341f
377 changed files with 5554 additions and 735 deletions
@@ -82,6 +82,7 @@ class DeprecatedApi {
  /// Parameters:
  ///
  /// * [String] deviceId (required):
+  ///   Device ID
  Future<Response> getAllUserAssetsByDeviceIdWithHttpInfo(String deviceId,) async {
    // ignore: prefer_const_declarations
    final apiPath = r'/assets/device/{deviceId}'
@@ -115,6 +116,7 @@ class DeprecatedApi {
  /// Parameters:
  ///
  /// * [String] deviceId (required):
+  ///   Device ID
  Future<List<String>?> getAllUserAssetsByDeviceId(String deviceId,) async {
    final response = await getAllUserAssetsByDeviceIdWithHttpInfo(deviceId,);
    if (response.statusCode >= HttpStatus.badRequest) {
@@ -305,6 +307,7 @@ class DeprecatedApi {
  /// Parameters:
  ///
  /// * [num] count:
+  ///   Number of random assets to return
  Future<Response> getRandomWithHttpInfo({ num? count, }) async {
    // ignore: prefer_const_declarations
    final apiPath = r'/assets/random';
@@ -341,6 +344,7 @@ class DeprecatedApi {
  /// Parameters:
  ///
  /// * [num] count:
+  ///   Number of random assets to return
  Future<List<AssetResponseDto>?> getRandom({ num? count, }) async {
    final response = await getRandomWithHttpInfo( count: count, );
    if (response.statusCode >= HttpStatus.badRequest) {
@@ -370,22 +374,29 @@ class DeprecatedApi {
  /// * [String] id (required):
  ///
  /// * [MultipartFile] assetData (required):
+  ///   Asset file data
  ///
  /// * [String] deviceAssetId (required):
+  ///   Device asset ID
  ///
  /// * [String] deviceId (required):
+  ///   Device ID
  ///
  /// * [DateTime] fileCreatedAt (required):
+  ///   File creation date
  ///
  /// * [DateTime] fileModifiedAt (required):
+  ///   File modification date
  ///
  /// * [String] key:
  ///
  /// * [String] slug:
  ///
  /// * [String] duration:
+  ///   Duration (for videos)
  ///
  /// * [String] filename:
+  ///   Filename
  Future<Response> replaceAssetWithHttpInfo(String id, MultipartFile assetData, String deviceAssetId, String deviceId, DateTime fileCreatedAt, DateTime fileModifiedAt, { String? key, String? slug, String? duration, String? filename, }) async {
    // ignore: prefer_const_declarations
    final apiPath = r'/assets/{id}/original'
@@ -462,22 +473,29 @@ class DeprecatedApi {
  /// * [String] id (required):
  ///
  /// * [MultipartFile] assetData (required):
+  ///   Asset file data
  ///
  /// * [String] deviceAssetId (required):
+  ///   Device asset ID
  ///
  /// * [String] deviceId (required):
+  ///   Device ID
  ///
  /// * [DateTime] fileCreatedAt (required):
+  ///   File creation date
  ///
  /// * [DateTime] fileModifiedAt (required):
+  ///   File modification date
  ///
  /// * [String] key:
  ///
  /// * [String] slug:
  ///
  /// * [String] duration:
+  ///   Duration (for videos)
  ///
  /// * [String] filename:
+  ///   Filename
  Future<AssetMediaResponseDto?> replaceAsset(String id, MultipartFile assetData, String deviceAssetId, String deviceId, DateTime fileCreatedAt, DateTime fileModifiedAt, { String? key, String? slug, String? duration, String? filename, }) async {
    final response = await replaceAssetWithHttpInfo(id, assetData, deviceAssetId, deviceId, fileCreatedAt, fileModifiedAt,  key: key, slug: slug, duration: duration, filename: filename, );
    if (response.statusCode >= HttpStatus.badRequest) {
@@ -502,6 +520,7 @@ class DeprecatedApi {
  /// Parameters:
  ///
  /// * [QueueName] name (required):
+  ///   Queue name
  ///
  /// * [QueueCommandDto] queueCommandDto (required):
  Future<Response> runQueueCommandLegacyWithHttpInfo(QueueName name, QueueCommandDto queueCommandDto,) async {
@@ -537,6 +556,7 @@ class DeprecatedApi {
  /// Parameters:
  ///
  /// * [QueueName] name (required):
+  ///   Queue name
  ///
  /// * [QueueCommandDto] queueCommandDto (required):
  Future<QueueResponseLegacyDto?> runQueueCommandLegacy(QueueName name, QueueCommandDto queueCommandDto,) async {