Merge pull request #169 from nextcloud/fix/openapitype/non-empty-list

fix(OpenApiType): Support non-empty-list
nextcloud · Sep 27, 2024 · cbc89b6 · cbc89b6
2 parents 2acf86d + c711397
commit cbc89b6
Show file tree

Hide file tree

Showing 4 changed files with 22 additions and 4 deletions.
diff --git a/src/OpenApiType.php b/src/OpenApiType.php
@@ -180,8 +180,8 @@ public static function resolve(string $context, array $definitions, ParamTagValu
 				items: self::resolve($context . ': items', $definitions, $node->type),
 			);
 		}
-		if ($node instanceof GenericTypeNode && ($node->type->name == 'array' || $node->type->name == 'list') && count($node->genericTypes) == 1) {
-			if ($node->genericTypes[0] instanceof IdentifierTypeNode && $node->genericTypes[0]->name == 'empty') {
+		if ($node instanceof GenericTypeNode && ($node->type->name === 'array' || $node->type->name === 'list' || $node->type->name === 'non-empty-list') && count($node->genericTypes) === 1) {
+			if ($node->genericTypes[0] instanceof IdentifierTypeNode && $node->genericTypes[0]->name === 'empty') {
 				return new OpenApiType(
 					context: $context,
 					type: 'array',
@@ -192,6 +192,7 @@ public static function resolve(string $context, array $definitions, ParamTagValu
 				context: $context,
 				type: 'array',
 				items: self::resolve($context, $definitions, $node->genericTypes[0]),
+				minItems: $node->type->name === 'non-empty-list' ? 1 : null,
 			);
 		}
 		if ($node instanceof GenericTypeNode && $node->type->name === 'value-of') {

diff --git a/tests/lib/ResponseDefinitions.php b/tests/lib/ResponseDefinitions.php
@@ -43,6 +43,7 @@
  *     messageRichParameters?: array<string, mixed>,
  *     icon?: string,
  *     shouldNotify?: bool,
+ *     nonEmptyList: non-empty-list<string>,
  * }
  *
  * @psalm-type NotificationsPushDeviceBase = array{

diff --git a/tests/openapi-full.json b/tests/openapi-full.json
@@ -61,7 +61,8 @@
                     "subject",
                     "message",
                     "link",
-                    "actions"
+                    "actions",
+                    "nonEmptyList"
                 ],
                 "properties": {
                     "notification_id": {
@@ -121,6 +122,13 @@
                     },
                     "shouldNotify": {
                         "type": "boolean"
+                    },
+                    "nonEmptyList": {
+                        "type": "array",
+                        "items": {
+                            "type": "string"
+                        },
+                        "minItems": 1
                     }
                 }
             },

diff --git a/tests/openapi.json b/tests/openapi.json
@@ -61,7 +61,8 @@
                     "subject",
                     "message",
                     "link",
-                    "actions"
+                    "actions",
+                    "nonEmptyList"
                 ],
                 "properties": {
                     "notification_id": {
@@ -121,6 +122,13 @@
                     },
                     "shouldNotify": {
                         "type": "boolean"
+                    },
+                    "nonEmptyList": {
+                        "type": "array",
+                        "items": {
+                            "type": "string"
+                        },
+                        "minItems": 1
                     }
                 }
             },