chore: Sorting OpenAPI output (#2854)

tolgee · Jan 17, 2025 · 9f67ac8 · 9f67ac8
1 parent f26d092
commit 9f67ac8
Show file tree

Hide file tree

Showing 2 changed files with 6,141 additions and 6,598 deletions.
diff --git a/backend/app/src/main/kotlin/io/tolgee/configuration/openApi/OpenApiGroupBuilder.kt b/backend/app/src/main/kotlin/io/tolgee/configuration/openApi/OpenApiGroupBuilder.kt
@@ -39,9 +39,27 @@ class OpenApiGroupBuilder(
 
     cleanUnusedModels()
 
+    sortOutput()
+
     return@lazy builder.build()
   }
 
+  private fun sortOutput() {
+    builder.addOpenApiCustomizer { openAPI ->
+      openAPI.paths =
+        Paths().apply {
+          openAPI.paths.toSortedMap().forEach { (key, value) ->
+            addPathItem(key, value)
+            value.parameters?.sortBy { it.name }
+          }
+        }
+      openAPI.components.schemas = openAPI.components.schemas.toSortedMap()
+      openAPI.components.schemas.forEach { (_, value) ->
+        value.properties = value.properties?.toSortedMap()
+      }
+    }
+  }
+
   private fun cleanUnusedModels() {
     builder.addOpenApiCustomizer {
       OpenApiUnusedSchemaCleaner(it).clean()