Merge pull request #328 from nextcloud/feat/response-list-no-limit

Author: provokateurin

generate-spec.php

@@ -545,11 +545,14 @@
 			continue;
 		}
 
+		$hasLimitParameter = false;
 		foreach ($controllerMethod->parameters as $parameter) {
 			if ($parameter->name !== 'limit') {
 				continue;
 			}
 
+			$hasLimitParameter = true;
+
 			if ($parameter->type->type !== 'integer') {
 				Logger::debug($routeName . ': @param: ' . $parameter->name, 'Type was not an integer: ' . $parameter->type->type);
 				continue;
@@ -560,6 +563,19 @@
 			}
 		}
 
+		foreach ($controllerMethod->responses as $response) {
+			if ($response->type === null) {
+				continue;
+			}
+
+			// maxItems=0 is list<empty> which is just for the legacy [] empty response.
+			if ($response->type->type === 'array' && $response->type->maxItems !== 0 && !$hasLimitParameter) {
+				Logger::warning($routeName, 'The endpoint returns a list, but has no parameter to limit the number of items.');
+				// Only show the warning once, even if multiple responses contain lists.
+				break;
+			}
+		}
+
 		$operationId = [
 			$tagName,
 			...Helpers::splitOnUppercaseFollowedByNonUppercase($methodName)