fix(schemas): Sort schemas to avoid reordering while developing

Signed-off-by: Joas Schilling <[email protected]>
nextcloud · Jan 18, 2024 · edc241f · edc241f
1 parent ee8e8c3
commit edc241f
Show file tree

Hide file tree

Showing 2 changed files with 29 additions and 27 deletions.
diff --git a/generate-spec b/generate-spec
@@ -851,6 +851,8 @@ foreach ($scopePaths as $scope => $paths) {
 
 		if (count($scopedSchemas) === 0) {
 			$scopedSchemas = new \stdClass();
+		} else {
+			ksort($scopedSchemas);
 		}
 
 		$openapiScope['components']['schemas'] = $scopedSchemas;

diff --git a/tests/openapi.json b/tests/openapi.json
@@ -20,27 +20,32 @@
             }
         },
         "schemas": {
-            "OCSMeta": {
+            "Collection": {
+                "type": "array",
+                "items": {
+                    "$ref": "#/components/schemas/Item"
+                }
+            },
+            "Item": {
                 "type": "object",
                 "required": [
-                    "status",
-                    "statuscode"
+                    "label",
+                    "link",
+                    "type",
+                    "primary"
                 ],
                 "properties": {
-                    "status": {
+                    "label": {
                         "type": "string"
                     },
-                    "statuscode": {
-                        "type": "integer"
-                    },
-                    "message": {
+                    "link": {
                         "type": "string"
                     },
-                    "totalitems": {
+                    "type": {
                         "type": "string"
                     },
-                    "itemsperpage": {
-                        "type": "string"
+                    "primary": {
+                        "type": "boolean"
                     }
                 }
             },
@@ -119,12 +124,6 @@
                     }
                 }
             },
-            "Collection": {
-                "type": "array",
-                "items": {
-                    "$ref": "#/components/schemas/Item"
-                }
-            },
             "NotificationAction": {
                 "type": "object",
                 "required": [
@@ -148,26 +147,27 @@
                     }
                 }
             },
-            "Item": {
+            "OCSMeta": {
                 "type": "object",
                 "required": [
-                    "label",
-                    "link",
-                    "type",
-                    "primary"
+                    "status",
+                    "statuscode"
                 ],
                 "properties": {
-                    "label": {
+                    "status": {
                         "type": "string"
                     },
-                    "link": {
+                    "statuscode": {
+                        "type": "integer"
+                    },
+                    "message": {
                         "type": "string"
                     },
-                    "type": {
+                    "totalitems": {
                         "type": "string"
                     },
-                    "primary": {
-                        "type": "boolean"
+                    "itemsperpage": {
+                        "type": "string"
                     }
                 }
             }