Add more information about nested type to Page type title, for example Page[NestedType] -> PageOfNestedType (#221)

Author: Iurii Sevastianov

CHANGELOG.md

@@ -4,6 +4,11 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [9.6.2] - 2022-07-08
+
+winter_openapi: add more information about nested type to Page type title,
+for example Page[NestedType] -> PageOfNestedType
+
 ## [9.6.1] - 2022-07-04
 
 Return 400 Bad Request instead of 500 if UUID request parameter has a newline character in the end

pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "winter"
-version = "9.6.1"
+version = "9.6.2"
 homepage = "https://github.com/WinterFramework/winter"
 description = "Web Framework inspired by Spring Framework"
 authors = ["Alexander Egorov <[email protected]>"]

tests/winter_openapi/test_type_inspection.py

@@ -102,7 +102,7 @@ class CustomPage(Page, Generic[CustomPageItem]):
             'nested_number': TypeInfo(openapi.TYPE_INTEGER),
         }),
     })),
-    (Page[NestedDataclass], TypeInfo(openapi.TYPE_OBJECT, title='Page', properties={
+    (Page[NestedDataclass], TypeInfo(openapi.TYPE_OBJECT, title='PageOfNestedDataclass', properties={
         'meta': TypeInfo(openapi.TYPE_OBJECT, title='PageMeta', properties={
             'total_count': TypeInfo(openapi.TYPE_INTEGER),
             'limit': TypeInfo(openapi.TYPE_INTEGER, nullable=True),
@@ -114,7 +114,7 @@ class CustomPage(Page, Generic[CustomPageItem]):
             'nested_number': TypeInfo(openapi.TYPE_INTEGER),
         })),
     })),
-    (CustomPage[int], TypeInfo(openapi.TYPE_OBJECT, title='Page', properties={
+    (CustomPage[int], TypeInfo(openapi.TYPE_OBJECT, title='PageOfInteger', properties={
         'meta': TypeInfo(openapi.TYPE_OBJECT, title='PageMeta', properties={
             'total_count': TypeInfo(openapi.TYPE_INTEGER),
             'limit': TypeInfo(openapi.TYPE_INTEGER, nullable=True),

winter_openapi/page_inspector.py

@@ -12,18 +12,24 @@ def inspect_page(hint_class) -> TypeInfo:
     args = getattr(hint_class, '__args__', None)
     child_class = args[0] if args else str
     extra_fields = set(dataclasses.fields(hint_class.__origin__)) - set(dataclasses.fields(Page))
+    child_type_info = inspect_type(child_class)
 
-    return TypeInfo(openapi.TYPE_OBJECT, title='Page', properties={
-        'meta': TypeInfo(openapi.TYPE_OBJECT, title='PageMeta', properties={
-            'total_count': TypeInfo(openapi.TYPE_INTEGER),
-            'limit': TypeInfo(openapi.TYPE_INTEGER, nullable=True),
-            'offset': TypeInfo(openapi.TYPE_INTEGER, nullable=True),
-            'previous': TypeInfo(openapi.TYPE_STRING, openapi.FORMAT_URI, nullable=True),
-            'next': TypeInfo(openapi.TYPE_STRING, openapi.FORMAT_URI, nullable=True),
-            **{
-                extra_field.name: inspect_type(extra_field.type)
-                for extra_field in extra_fields
-            },
-        }),
-        'objects': inspect_type(List[child_class]),
-    })
+    return TypeInfo(
+        openapi.TYPE_OBJECT,
+        title=f'PageOf{child_type_info.title or child_type_info.type_.capitalize()}',
+        properties={
+            'meta': TypeInfo(
+                openapi.TYPE_OBJECT,
+                title='PageMeta',
+                properties={
+                    'total_count': TypeInfo(openapi.TYPE_INTEGER),
+                    'limit': TypeInfo(openapi.TYPE_INTEGER, nullable=True),
+                    'offset': TypeInfo(openapi.TYPE_INTEGER, nullable=True),
+                    'previous': TypeInfo(openapi.TYPE_STRING, openapi.FORMAT_URI, nullable=True),
+                    'next': TypeInfo(openapi.TYPE_STRING, openapi.FORMAT_URI, nullable=True),
+                    **{extra_field.name: inspect_type(extra_field.type) for extra_field in extra_fields},
+                },
+            ),
+            'objects': inspect_type(List[child_class]),
+        },
+    )