mirror of
https://github.com/immich-app/immich.git
synced 2026-05-18 03:10:24 +03:00
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>
This commit is contained in:
@@ -36,6 +36,7 @@ class ServerAboutResponseDto {
|
||||
required this.versionUrl,
|
||||
});
|
||||
|
||||
/// Build identifier
|
||||
///
|
||||
/// 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
|
||||
@@ -44,6 +45,7 @@ class ServerAboutResponseDto {
|
||||
///
|
||||
String? build;
|
||||
|
||||
/// Build image name
|
||||
///
|
||||
/// 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
|
||||
@@ -52,6 +54,7 @@ class ServerAboutResponseDto {
|
||||
///
|
||||
String? buildImage;
|
||||
|
||||
/// Build image URL
|
||||
///
|
||||
/// 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
|
||||
@@ -60,6 +63,7 @@ class ServerAboutResponseDto {
|
||||
///
|
||||
String? buildImageUrl;
|
||||
|
||||
/// Build URL
|
||||
///
|
||||
/// 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
|
||||
@@ -68,6 +72,7 @@ class ServerAboutResponseDto {
|
||||
///
|
||||
String? buildUrl;
|
||||
|
||||
/// ExifTool version
|
||||
///
|
||||
/// 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
|
||||
@@ -76,6 +81,7 @@ class ServerAboutResponseDto {
|
||||
///
|
||||
String? exiftool;
|
||||
|
||||
/// FFmpeg version
|
||||
///
|
||||
/// 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
|
||||
@@ -84,6 +90,7 @@ class ServerAboutResponseDto {
|
||||
///
|
||||
String? ffmpeg;
|
||||
|
||||
/// ImageMagick version
|
||||
///
|
||||
/// 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
|
||||
@@ -92,6 +99,7 @@ class ServerAboutResponseDto {
|
||||
///
|
||||
String? imagemagick;
|
||||
|
||||
/// libvips version
|
||||
///
|
||||
/// 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
|
||||
@@ -100,8 +108,10 @@ class ServerAboutResponseDto {
|
||||
///
|
||||
String? libvips;
|
||||
|
||||
/// Whether the server is licensed
|
||||
bool licensed;
|
||||
|
||||
/// Node.js version
|
||||
///
|
||||
/// 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
|
||||
@@ -110,6 +120,7 @@ class ServerAboutResponseDto {
|
||||
///
|
||||
String? nodejs;
|
||||
|
||||
/// Repository name
|
||||
///
|
||||
/// 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
|
||||
@@ -118,6 +129,7 @@ class ServerAboutResponseDto {
|
||||
///
|
||||
String? repository;
|
||||
|
||||
/// Repository URL
|
||||
///
|
||||
/// 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
|
||||
@@ -126,6 +138,7 @@ class ServerAboutResponseDto {
|
||||
///
|
||||
String? repositoryUrl;
|
||||
|
||||
/// Source commit hash
|
||||
///
|
||||
/// 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
|
||||
@@ -134,6 +147,7 @@ class ServerAboutResponseDto {
|
||||
///
|
||||
String? sourceCommit;
|
||||
|
||||
/// Source reference (branch/tag)
|
||||
///
|
||||
/// 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
|
||||
@@ -142,6 +156,7 @@ class ServerAboutResponseDto {
|
||||
///
|
||||
String? sourceRef;
|
||||
|
||||
/// Source URL
|
||||
///
|
||||
/// 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 +165,7 @@ class ServerAboutResponseDto {
|
||||
///
|
||||
String? sourceUrl;
|
||||
|
||||
/// Third-party bug/feature URL
|
||||
///
|
||||
/// 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
|
||||
@@ -158,6 +174,7 @@ class ServerAboutResponseDto {
|
||||
///
|
||||
String? thirdPartyBugFeatureUrl;
|
||||
|
||||
/// Third-party documentation URL
|
||||
///
|
||||
/// 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
|
||||
@@ -166,6 +183,7 @@ class ServerAboutResponseDto {
|
||||
///
|
||||
String? thirdPartyDocumentationUrl;
|
||||
|
||||
/// Third-party source URL
|
||||
///
|
||||
/// 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
|
||||
@@ -174,6 +192,7 @@ class ServerAboutResponseDto {
|
||||
///
|
||||
String? thirdPartySourceUrl;
|
||||
|
||||
/// Third-party support URL
|
||||
///
|
||||
/// 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
|
||||
@@ -182,8 +201,10 @@ class ServerAboutResponseDto {
|
||||
///
|
||||
String? thirdPartySupportUrl;
|
||||
|
||||
/// Server version
|
||||
String version;
|
||||
|
||||
/// URL to version information
|
||||
String versionUrl;
|
||||
|
||||
@override
|
||||
|
||||
Reference in New Issue
Block a user