Handle all possible cases of other Schemas when importing used schemas

Signed-off-by: Joas Schilling <[email protected]>
nextcloud · Dec 7, 2023 · e0274d7 · e0274d7
1 parent f464078
commit e0274d7
Show file tree

Hide file tree

Showing 6 changed files with 143 additions and 5 deletions.
diff --git a/generate-spec b/generate-spec
@@ -764,7 +764,7 @@ foreach ($scopePaths as $scope => $paths) {
 		}
 
 		// Queue potential sub-refs for exporting as well
-		foreach (['allOf', 'oneOf', 'anyOf', 'properties'] as $group) {
+		foreach (['allOf', 'oneOf', 'anyOf', 'properties', 'additionalProperties'] as $group) {
 			if (isset($schemas[$schemaName][$group])) {
 				foreach ($schemas[$schemaName][$group] as $subType) {
 					$newRefs = Helpers::collectUsedRefs($subType);
@@ -777,6 +777,15 @@ foreach ($scopePaths as $scope => $paths) {
 			}
 		}
 
+		if (isset($schemas[$schemaName]['items'])) {
+			$newRefs = Helpers::collectUsedRefs($schemas[$schemaName]['items']);
+			foreach ($newRefs as $newRef) {
+				if (!isset($scopedSchemas[substr($newRef, strlen('#/components/schemas/'))])) {
+					$usedSchemas[] = $newRef;
+				}
+			}
+		}
+
 		$scopedSchemas[$schemaName] = $schemas[$schemaName];
 	}
 

diff --git a/src/Helpers.php b/src/Helpers.php
@@ -255,10 +255,12 @@ static function collectUsedRefs(array $data): array {
 		if (isset($data['$ref'])) {
 			$refs[] = [$data['$ref']];
 		}
-		if (isset($data['properties'])) {
-			foreach ($data['properties'] as $property) {
-				if (is_array($property)) {
-					$refs[] = self::collectUsedRefs($property);
+		foreach (['allOf', 'oneOf', 'anyOf', 'properties', 'additionalProperties'] as $group) {
+			if (isset($data[$group]) && is_array($data[$group])) {
+				foreach ($data[$group] as $property) {
+					if (is_array($property)) {
+						$refs[] = self::collectUsedRefs($property);
+					}
 				}
 			}
 		}

diff --git a/tests/appinfo/routes.php b/tests/appinfo/routes.php
@@ -33,6 +33,7 @@
 		['name' => 'Settings#doubleScope', 'url' => '/api/{apiVersion}/double', 'verb' => 'POST', 'requirements' => ['apiVersion' => '(v2)']],
 		['name' => 'Settings#throwing', 'url' => '/api/{apiVersion}/throwing', 'verb' => 'POST', 'requirements' => ['apiVersion' => '(v2)']],
 		['name' => 'Settings#nestedSchemas', 'url' => '/api/{apiVersion}/nested-schemas', 'verb' => 'POST', 'requirements' => ['apiVersion' => '(v2)']],
+		['name' => 'Settings#listSchemas', 'url' => '/api/{apiVersion}/list-schemas', '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
@@ -36,6 +36,7 @@
 /**
  * @psalm-import-type NotificationsPushDevice from ResponseDefinitions
  * @psalm-import-type NotificationsNotification from ResponseDefinitions
+ * @psalm-import-type NotificationsCollection from ResponseDefinitions
  */
 #[OpenAPI(scope: OpenAPI::SCOPE_FEDERATION)]
 class SettingsController extends OCSController {
@@ -149,4 +150,18 @@ public function throwing(): DataResponse {
 	public function nestedSchemas(): DataResponse {
 		return new DataResponse();
 	}
+
+	/**
+	 * @NoAdminRequired
+	 *
+	 * Route is ignored because of scope on the controller
+	 *
+	 * @return DataResponse<Http::STATUS_OK, NotificationsCollection, array{}>
+	 *
+	 * 200: OK
+	 */
+	#[OpenAPI]
+	public function listSchemas(): DataResponse {
+		return new DataResponse();
+	}
 }
diff --git a/tests/lib/ResponseDefinitions.php b/tests/lib/ResponseDefinitions.php
@@ -27,6 +27,15 @@
 namespace OCA\Notifications;
 
 /**
+ * @psalm-type NotificationsItem = array{
+ *     label: string,
+ *     link: string,
+ *     type: string,
+ *     primary: bool,
+ * }
+ *
+ * @psalm-type NotificationsCollection = list<NotificationsItem>
+ *
  * @psalm-type NotificationsNotificationAction = array{
  *     label: string,
  *     link: string,

diff --git a/tests/openapi.json b/tests/openapi.json
@@ -119,6 +119,12 @@
                     }
                 }
             },
+            "Collection": {
+                "type": "array",
+                "items": {
+                    "$ref": "#/components/schemas/Item"
+                }
+            },
             "NotificationAction": {
                 "type": "object",
                 "required": [
@@ -141,6 +147,29 @@
                         "type": "boolean"
                     }
                 }
+            },
+            "Item": {
+                "type": "object",
+                "required": [
+                    "label",
+                    "link",
+                    "type",
+                    "primary"
+                ],
+                "properties": {
+                    "label": {
+                        "type": "string"
+                    },
+                    "link": {
+                        "type": "string"
+                    },
+                    "type": {
+                        "type": "string"
+                    },
+                    "primary": {
+                        "type": "boolean"
+                    }
+                }
             }
         }
     },
@@ -363,6 +392,79 @@
                 }
             }
         },
+        "/ocs/v2.php/apps/notifications/api/{apiVersion}/list-schemas": {
+            "post": {
+                "operationId": "settings-list-schemas",
+                "summary": "Route is ignored because of scope on the controller",
+                "tags": [
+                    "settings"
+                ],
+                "security": [
+                    {
+                        "bearer_auth": []
+                    },
+                    {
+                        "basic_auth": []
+                    }
+                ],
+                "parameters": [
+                    {
+                        "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": "OK",
+                        "content": {
+                            "application/json": {
+                                "schema": {
+                                    "type": "object",
+                                    "required": [
+                                        "ocs"
+                                    ],
+                                    "properties": {
+                                        "ocs": {
+                                            "type": "object",
+                                            "required": [
+                                                "meta",
+                                                "data"
+                                            ],
+                                            "properties": {
+                                                "meta": {
+                                                    "$ref": "#/components/schemas/OCSMeta"
+                                                },
+                                                "data": {
+                                                    "$ref": "#/components/schemas/Collection"
+                                                }
+                                            }
+                                        }
+                                    }
+                                }
+                            }
+                        }
+                    }
+                }
+            }
+        },
         "/ocs/v2.php/apps/notifications/api/{apiVersion}/default-admin-overwritten": {
             "post": {
                 "operationId": "settings2-default-admin-scope-overwritten",