Merge pull request #35 from cloudblue/enh/LITE-21771

LITE-21771 More readable generated OpenAPI specification

Author: maxipavlovic

dj_rql/openapi.py

@@ -1,5 +1,5 @@
 #
-#  Copyright © 2021 Ingram Micro Inc. All rights reserved.
+#  Copyright © 2022 Ingram Micro Inc. All rights reserved.
 #
 
 from copy import copy
@@ -11,7 +11,7 @@
 
 
 class RQLFilterDescriptionTemplate:
-    BASE_TEMPLATE = '**{description}**\n\nlookups: {lookups}'
+    BASE_TEMPLATE = '{description}\n\n**lookups:** {lookups}'
     DEFAULT_DESCRIPTION = 'Filter for: {description}'
     IN_PLACE_RENDERERS = (
         '_render_search_inplace',
@@ -89,13 +89,13 @@ def _render_null_inplace(cls, base, filter_item, filter_instance):
     @classmethod
     def _render_default_inplace(cls, base, filter_item, filter_instance):
         if filter_item.get('hidden', False):
-            return cls._render_common_key_inplace(base, 'default', '**hidden**')
+            return cls._render_common_key_inplace(base, 'default', '*hidden*')
 
         return base
 
     @classmethod
     def _render_common_key_inplace(cls, base, key, value):
-        return '{base}\n{key}: {value}'.format(base=base, key=key, value=value)
+        return '{base}\n\n**{key}:** {value}'.format(base=base, key=key, value=value)
 
 
 class RQLFilterClassSpecification:

tests/test_openapi.py

@@ -1,5 +1,5 @@
 #
-#  Copyright © 2021 Ingram Micro Inc. All rights reserved.
+#  Copyright © 2022 Ingram Micro Inc. All rights reserved.
 #
 
 from copy import copy
@@ -35,39 +35,39 @@ def filter_data(f_name):
 
 def test_description_common_render():
     result = RQLFilterDescriptionTemplate.render(*filter_data('id'))
-    assert result == '**Filter for: id**\n\nlookups: eq, ne, ge, gt, le, lt, null, in, out'
+    assert result == 'Filter for: id\n\n**lookups:** eq, ne, ge, gt, le, lt, null, in, out'
 
 
 def test_description_search_render():
     result = RQLFilterDescriptionTemplate.render(*filter_data('str_choice_field'))
     assert result == (
-        '**Filter for: str_choice_field**\n\nlookups: '
-        'eq, ne, like, ilike, in, out\nsearch: true'
+        'Filter for: str_choice_field\n\n**lookups:** '
+        'eq, ne, like, ilike, in, out\n\n**search:** true'
     )
 
 
 def test_description_ordering_render():
     result = RQLFilterDescriptionTemplate.render(*filter_data('int_choice_field'))
     assert result == (
-        '**Filter for: int_choice_field**\n\nlookups: '
-        'eq, ne, ge, gt, le, lt, in, out\nordering: true'
+        'Filter for: int_choice_field\n\n**lookups:** '
+        'eq, ne, ge, gt, le, lt, in, out\n\n**ordering:** true'
     )
 
 
 def test_description_null_overridden_render():
     result = RQLFilterDescriptionTemplate.render(*filter_data('title'))
     assert result == (
-        '**Filter for: title**\n\n'
-        'lookups: eq, ne, like, ilike, null, in, out\nsearch: true\n'
-        'null: NULL_ID, null()'
+        'Filter for: title\n\n'
+        '**lookups:** eq, ne, like, ilike, null, in, out\n\n**search:** true\n\n'
+        '**null:** NULL_ID, null()'
     )
 
 
 def test_description_hidden_render():
     result = RQLFilterDescriptionTemplate.render(*filter_data('select_author'))
     assert result == (
-        '**Filter for: select_author**\n\n'
-        'lookups: eq, ne, like, ilike, in, out\ndefault: **hidden**'
+        'Filter for: select_author\n\n'
+        '**lookups:** eq, ne, like, ilike, in, out\n\n**default:** *hidden*'
     )