Merge 24ebdb7 into 3806981

.gitignore

@@ -9,3 +9,5 @@ test.db
 test.py
 out.txt
 docs/*.json
+.eggs
+.pytest_cache

honeybee_schema/_openapi.py

@@ -81,6 +81,25 @@ def get_openapi(
         }
         tags.append(tag)
 
+        # sort properties order: put required parameters at begining of the list
+        s = schemas[name]
+        if 'required' in s:
+            props = s['properties']
+            required = s['required']
+
+            propKeys = props.keys()
+            sortedProps = {}
+            optional = {}
+            for r in propKeys:
+                if r in required:
+                    sortedProps[r] = props[r]
+                else:
+                    optional[r] = props[r]
+
+            sortedProps.update(optional)
+
+            s['properties'] = sortedProps
+
     tag_names.sort()
     open_api['tags'] = tags
     open_api['x-tagGroups'][0]['tags'] = tag_names

tests/test_sortProps.py

@@ -0,0 +1,37 @@
+
+from honeybee_schema.model import Model
+from pydantic.schema import schema
+import pytest
+
+
+def test_sort_required_params():
+    definitions = schema([Model], ref_prefix='#/components/schemas/')
+
+    schemas = definitions['definitions']
+    schema_names = list(schemas.keys())
+    schema_names.sort()
+
+    for name in schema_names:
+        s = schemas[name]
+
+        if 'required' in s:
+            props = s['properties']
+            required = s['required']
+
+            propKeys = props.keys()
+
+            sortedProps = {}
+            optional = {}
+            for r in propKeys:
+                if r in required:
+                    sortedProps[r] = props[r]
+                else:
+                    optional[r] = props[r]
+
+            sortedProps.update(optional)
+
+            s['properties'] = sortedProps
+
+    return schemas
+
+