github-mirrors/immich
1
0
Fork 0
mirror of https://github.com/immich-app/immich.git synced 2026-02-28 09:38:43 +03:00
Code Issues Packages Projects Releases Wiki Activity

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

Browse Source 
* 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>
This commit is contained in:
Timon
2026-01-29 14:49:15 +01:00
committed by GitHub
parent eadb2f89af
commit 8db61d341f
377 changed files with 5554 additions and 735 deletions
Download Patch File Download Diff File Expand all files Collapse all files

38
mobile/openapi/lib/model/smart_search_dto.dart generated
View File

@@ -50,12 +50,16 @@ class SmartSearchDto {
this.withExif,
});
/// Filter by album IDs
List<String> albumIds;
/// Filter by city name
String? city;
/// Filter by country name
String? country;
/// Filter by creation date (after)
///
/// Please note: This property should have been non-nullable! Since the specification file
/// does not include a default value (using the "default:" property), however, the generated
@@ -64,6 +68,7 @@ class SmartSearchDto {
///
DateTime? createdAfter;
/// Filter by creation date (before)
///
/// Please note: This property should have been non-nullable! Since the specification file
/// does not include a default value (using the "default:" property), however, the generated
@@ -72,6 +77,7 @@ class SmartSearchDto {
///
DateTime? createdBefore;
/// Device ID to filter by
///
/// Please note: This property should have been non-nullable! Since the specification file
/// does not include a default value (using the "default:" property), however, the generated
@@ -80,6 +86,7 @@ class SmartSearchDto {
///
String? deviceId;
/// Filter by encoded status
///
/// Please note: This property should have been non-nullable! Since the specification file
/// does not include a default value (using the "default:" property), however, the generated
@@ -88,6 +95,7 @@ class SmartSearchDto {
///
bool? isEncoded;
/// Filter by favorite status
///
/// Please note: This property should have been non-nullable! Since the specification file
/// does not include a default value (using the "default:" property), however, the generated
@@ -96,6 +104,7 @@ class SmartSearchDto {
///
bool? isFavorite;
/// Filter by motion photo status
///
/// Please note: This property should have been non-nullable! Since the specification file
/// does not include a default value (using the "default:" property), however, the generated
@@ -104,6 +113,7 @@ class SmartSearchDto {
///
bool? isMotion;
/// Filter assets not in any album
///
/// Please note: This property should have been non-nullable! Since the specification file
/// does not include a default value (using the "default:" property), however, the generated
@@ -112,6 +122,7 @@ class SmartSearchDto {
///
bool? isNotInAlbum;
/// Filter by offline status
///
/// Please note: This property should have been non-nullable! Since the specification file
/// does not include a default value (using the "default:" property), however, the generated
@@ -120,6 +131,7 @@ class SmartSearchDto {
///
bool? isOffline;
/// Search language code
///
/// Please note: This property should have been non-nullable! Since the specification file
/// does not include a default value (using the "default:" property), however, the generated
@@ -128,10 +140,13 @@ class SmartSearchDto {
///
String? language;
/// Filter by lens model
String? lensModel;
/// Library ID to filter by
String? libraryId;
/// Filter by camera make
///
/// Please note: This property should have been non-nullable! Since the specification file
/// does not include a default value (using the "default:" property), however, the generated
@@ -140,8 +155,10 @@ class SmartSearchDto {
///
String? make;
/// Filter by camera model
String? model;
/// Filter by OCR text content
///
/// Please note: This property should have been non-nullable! Since the specification file
/// does not include a default value (using the "default:" property), however, the generated
@@ -150,6 +167,8 @@ class SmartSearchDto {
///
String? ocr;
/// Page number
///
/// Minimum value: 1
///
/// Please note: This property should have been non-nullable! Since the specification file
@@ -159,8 +178,10 @@ class SmartSearchDto {
///
num? page;
/// Filter by person IDs
List<String> personIds;
/// Natural language search query
///
/// Please note: This property should have been non-nullable! Since the specification file
/// does not include a default value (using the "default:" property), however, the generated
@@ -169,6 +190,7 @@ class SmartSearchDto {
///
String? query;
/// Asset ID to use as search reference
///
/// Please note: This property should have been non-nullable! Since the specification file
/// does not include a default value (using the "default:" property), however, the generated
@@ -177,6 +199,8 @@ class SmartSearchDto {
///
String? queryAssetId;
/// Filter by rating
///
/// Minimum value: -1
/// Maximum value: 5
///
@@ -187,6 +211,8 @@ class SmartSearchDto {
///
num? rating;
/// Number of results to return
///
/// Minimum value: 1
/// Maximum value: 1000
///
@@ -197,10 +223,13 @@ class SmartSearchDto {
///
num? size;
/// Filter by state/province name
String? state;
/// Filter by tag IDs
List<String>? tagIds;
/// Filter by taken date (after)
///
/// Please note: This property should have been non-nullable! Since the specification file
/// does not include a default value (using the "default:" property), however, the generated
@@ -209,6 +238,7 @@ class SmartSearchDto {
///
DateTime? takenAfter;
/// Filter by taken date (before)
///
/// Please note: This property should have been non-nullable! Since the specification file
/// does not include a default value (using the "default:" property), however, the generated
@@ -217,6 +247,7 @@ class SmartSearchDto {
///
DateTime? takenBefore;
/// Filter by trash date (after)
///
/// Please note: This property should have been non-nullable! Since the specification file
/// does not include a default value (using the "default:" property), however, the generated
@@ -225,6 +256,7 @@ class SmartSearchDto {
///
DateTime? trashedAfter;
/// Filter by trash date (before)
///
/// Please note: This property should have been non-nullable! Since the specification file
/// does not include a default value (using the "default:" property), however, the generated
@@ -233,6 +265,7 @@ class SmartSearchDto {
///
DateTime? trashedBefore;
/// Asset type filter
///
/// Please note: This property should have been non-nullable! Since the specification file
/// does not include a default value (using the "default:" property), however, the generated
@@ -241,6 +274,7 @@ class SmartSearchDto {
///
AssetTypeEnum? type;
/// Filter by update date (after)
///
/// Please note: This property should have been non-nullable! Since the specification file
/// does not include a default value (using the "default:" property), however, the generated
@@ -249,6 +283,7 @@ class SmartSearchDto {
///
DateTime? updatedAfter;
/// Filter by update date (before)
///
/// Please note: This property should have been non-nullable! Since the specification file
/// does not include a default value (using the "default:" property), however, the generated
@@ -257,6 +292,7 @@ class SmartSearchDto {
///
DateTime? updatedBefore;
/// Filter by visibility
///
/// Please note: This property should have been non-nullable! Since the specification file
/// does not include a default value (using the "default:" property), however, the generated
@@ -265,6 +301,7 @@ class SmartSearchDto {
///
AssetVisibility? visibility;
/// Include deleted assets
///
/// Please note: This property should have been non-nullable! Since the specification file
/// does not include a default value (using the "default:" property), however, the generated
@@ -273,6 +310,7 @@ class SmartSearchDto {
///
bool? withDeleted;
/// Include EXIF data in response
///
/// Please note: This property should have been non-nullable! Since the specification file
/// does not include a default value (using the "default:" property), however, the generated