diff options
| author | provokateurin <kate@provokateurin.de> | 2024-05-13 12:47:24 +0200 |
|---|---|---|
| committer | provokateurin <kate@provokateurin.de> | 2024-05-13 12:47:24 +0200 |
| commit | dd997b6ac7738822a52f6ccd94d133dfeb8a82ec (patch) | |
| tree | 11b31862ae0313fe866f18abd66c82b85f4323ab /core/openapi.json | |
| parent | c31d6b1fdc502844ab907355bb553feb451cdda3 (diff) | |
| download | nextcloud-server-dd997b6ac7738822a52f6ccd94d133dfeb8a82ec.tar.gz nextcloud-server-dd997b6ac7738822a52f6ccd94d133dfeb8a82ec.zip | |
docs(preview): Improve API parameter descriptions
Signed-off-by: provokateurin <kate@provokateurin.de>
Diffstat (limited to 'core/openapi.json')
| -rw-r--r-- | core/openapi.json | 24 |
1 files changed, 16 insertions, 8 deletions
diff --git a/core/openapi.json b/core/openapi.json index 37c32cb7404..1c7b2caeeac 100644 --- a/core/openapi.json +++ b/core/openapi.json @@ -6212,7 +6212,7 @@ { "name": "x", "in": "query", - "description": "Width of the preview", + "description": "Width of the preview. A width of -1 will use the original image width.", "schema": { "type": "integer", "format": "int64", @@ -6222,7 +6222,7 @@ { "name": "y", "in": "query", - "description": "Height of the preview", + "description": "Height of the preview. A height of -1 will use the original image height.", "schema": { "type": "integer", "format": "int64", @@ -6232,7 +6232,7 @@ { "name": "a", "in": "query", - "description": "Whether to not crop the preview", + "description": "Preserve the aspect ratio", "schema": { "type": "integer", "default": 0, @@ -6261,7 +6261,11 @@ "description": "How to crop the image", "schema": { "type": "string", - "default": "fill" + "default": "fill", + "enum": [ + "fill", + "cover" + ] } }, { @@ -6356,7 +6360,7 @@ { "name": "x", "in": "query", - "description": "Width of the preview", + "description": "Width of the preview. A width of -1 will use the original image width.", "schema": { "type": "integer", "format": "int64", @@ -6366,7 +6370,7 @@ { "name": "y", "in": "query", - "description": "Height of the preview", + "description": "Height of the preview. A height of -1 will use the original image height.", "schema": { "type": "integer", "format": "int64", @@ -6376,7 +6380,7 @@ { "name": "a", "in": "query", - "description": "Whether to not crop the preview", + "description": "Preserve the aspect ratio", "schema": { "type": "integer", "default": 0, @@ -6405,7 +6409,11 @@ "description": "How to crop the image", "schema": { "type": "string", - "default": "fill" + "default": "fill", + "enum": [ + "fill", + "cover" + ] } }, { |