fix(parameters): Support int numerals

Signed-off-by: Joas Schilling <[email protected]>
nextcloud · Nov 10, 2023 · d2c2487 · d2c2487
1 parent 0358899
commit d2c2487
Show file tree

Hide file tree

Showing 4 changed files with 130 additions and 0 deletions.
diff --git a/src/OpenApiType.php b/src/OpenApiType.php
@@ -161,6 +161,27 @@ static function resolve(string $context, array $definitions, ParamTagValueNode|N
 
 			return new OpenApiType(type: "string", enum: $values);
 		}
+		if ($isUnion && count($node->types) == count(array_filter($node->types, fn($type) => $type instanceof ConstTypeNode && $type->constExpr instanceof ConstExprIntegerNode))) {
+			$values = [];
+			/** @var ConstTypeNode $type */
+			foreach ($node->types as $type) {
+				$values[] = (int) $type->constExpr->value;
+			}
+
+			if (count(array_filter($values, fn(string $value) => $value == '')) > 0) {
+				// Not a valid enum
+				return new OpenApiType(
+					type: "integer",
+					format: "int64",
+				);
+			}
+
+			return new OpenApiType(
+				type: "integer",
+				format: "int64",
+				enum: $values,
+			);
+		}
 
 		if ($isUnion || $isIntersection) {
 			$nullable = false;
@@ -205,6 +226,7 @@ enum: [$node->constExpr->value],
 			return new OpenApiType(
 				type: "integer",
 				format: "int64",
+				enum: [(int) $node->constExpr->value],
 			);
 		}
 

diff --git a/tests/appinfo/routes.php b/tests/appinfo/routes.php
@@ -31,6 +31,7 @@
 		['name' => 'Settings#defaultScope', 'url' => '/api/{apiVersion}/settings', 'verb' => 'POST', 'requirements' => ['apiVersion' => '(v2)']],
 		['name' => 'Settings#adminScope', 'url' => '/api/{apiVersion}/admin', 'verb' => 'POST', 'requirements' => ['apiVersion' => '(v2)']],
 		['name' => 'Settings#doubleScope', 'url' => '/api/{apiVersion}/double', 'verb' => 'POST', 'requirements' => ['apiVersion' => '(v2)']],
+		['name' => 'Settings#listOfIntParameters', 'url' => '/api/{apiVersion}/list-of-int', 'verb' => 'POST', 'requirements' => ['apiVersion' => '(v2)']],
 
 		['name' => 'Settings2#defaultAdminScopeOverwritten', 'url' => '/api/{apiVersion}/default-admin-overwritten', 'verb' => 'POST', 'requirements' => ['apiVersion' => '(v2)']],
 		['name' => 'Settings2#defaultAdminScope', 'url' => '/api/{apiVersion}/default-admin', 'verb' => 'POST', 'requirements' => ['apiVersion' => '(v2)']],

diff --git a/tests/lib/Controller/SettingsController.php b/tests/lib/Controller/SettingsController.php
@@ -118,4 +118,17 @@ protected function createNotificationsPushDevice(): array {
 	public function doubleScope(): DataResponse {
 		return new DataResponse();
 	}
+
+	/**
+	 * A route with a limited set of possible integers
+	 *
+	 * @param 1|2|3|4|5|6|7|8|9|10 $limit Maximum number of objects
+	 * @psalm-param int<1, 10> $limit
+	 * @return DataResponse<Http::STATUS_OK, array<empty>, array{}>
+	 *
+	 * 200: Admin settings updated
+	 */
+	public function listOfIntParameters(int $limit): DataResponse {
+		return new DataResponse();
+	}
 }
diff --git a/tests/openapi-federation.json b/tests/openapi-federation.json
@@ -117,6 +117,100 @@
                     }
                 }
             }
+        },
+        "/ocs/v2.php/apps/notifications/api/{apiVersion}/list-of-int": {
+            "post": {
+                "operationId": "settings-list-of-int-parameters",
+                "summary": "A route with a limited set of possible integers",
+                "description": "This endpoint requires admin access",
+                "tags": [
+                    "settings"
+                ],
+                "security": [
+                    {
+                        "bearer_auth": []
+                    },
+                    {
+                        "basic_auth": []
+                    }
+                ],
+                "parameters": [
+                    {
+                        "name": "limit",
+                        "in": "query",
+                        "description": "Maximum number of objects",
+                        "required": true,
+                        "schema": {
+                            "type": "integer",
+                            "format": "int64",
+                            "enum": [
+                                1,
+                                2,
+                                3,
+                                4,
+                                5,
+                                6,
+                                7,
+                                8,
+                                9,
+                                10
+                            ]
+                        }
+                    },
+                    {
+                        "name": "apiVersion",
+                        "in": "path",
+                        "required": true,
+                        "schema": {
+                            "type": "string",
+                            "enum": [
+                                "v2"
+                            ],
+                            "default": "v2"
+                        }
+                    },
+                    {
+                        "name": "OCS-APIRequest",
+                        "in": "header",
+                        "description": "Required to be true for the API request to pass",
+                        "required": true,
+                        "schema": {
+                            "type": "boolean",
+                            "default": true
+                        }
+                    }
+                ],
+                "responses": {
+                    "200": {
+                        "description": "Admin settings updated",
+                        "content": {
+                            "application/json": {
+                                "schema": {
+                                    "type": "object",
+                                    "required": [
+                                        "ocs"
+                                    ],
+                                    "properties": {
+                                        "ocs": {
+                                            "type": "object",
+                                            "required": [
+                                                "meta",
+                                                "data"
+                                            ],
+                                            "properties": {
+                                                "meta": {
+                                                    "$ref": "#/components/schemas/OCSMeta"
+                                                },
+                                                "data": {}
+                                            }
+                                        }
+                                    }
+                                }
+                            }
+                        }
+                    }
+                }
+            }
         }
     },
     "tags": []