From 716ad40c7ad7f2ce869a6903d16733c464d6ccfe Mon Sep 17 00:00:00 2001
From: Valentin Deniaud <vdeniaud@entrouvert.com>
Date: Thu, 23 Sep 2021 11:59:59 +0200
Subject: [PATCH] misc: allow pattern description in json schemas (#54663)

---
 passerelle/apps/cmis/models.py             | 10 +++++++---
 passerelle/base/templatetags/passerelle.py |  5 ++++-
 tests/test_templatetags.py                 |  8 ++++++++
 3 files changed, 19 insertions(+), 4 deletions(-)

diff --git a/passerelle/apps/cmis/models.py b/passerelle/apps/cmis/models.py
index 9307e29f..9f23797a 100644
--- a/passerelle/apps/cmis/models.py
+++ b/passerelle/apps/cmis/models.py
@@ -55,9 +55,10 @@ UPLOAD_SCHEMA = {
             'properties': {
                 'filename': {
                     'type': 'string',
-                    'description': _('Filename (numbers, letters and special caracters "%s" are allowed)')
-                    % SPECIAL_CHARS,
+                    'description': _('Filename'),
                     'pattern': FILE_NAME_PATTERN,
+                    'pattern_description': _('Numbers, letters and special caracters "%s" are allowed.')
+                    % SPECIAL_CHARS,
                 },
                 'content': {
                     'type': 'string',
@@ -74,11 +75,14 @@ UPLOAD_SCHEMA = {
             'type': 'string',
             'description': _('Filename (takes precendence over filename in "file" object)'),
             'pattern': FILE_NAME_PATTERN,
+            'pattern_description': _('Numbers, letters and special caracters "%s" are allowed.')
+            % SPECIAL_CHARS,
         },
         'path': {
             'type': 'string',
-            'description': _('File path (with leading but not trailing slash)'),
+            'description': _('File path'),
             'pattern': FILE_PATH_PATTERN,
+            'pattern_description': _('Must include leading but not trailing slash.'),
         },
         'object_type': {
             'type': 'string',
diff --git a/passerelle/base/templatetags/passerelle.py b/passerelle/base/templatetags/passerelle.py
index 87b0d0ee..46215342 100644
--- a/passerelle/base/templatetags/passerelle.py
+++ b/passerelle/base/templatetags/passerelle.py
@@ -158,6 +158,7 @@ def render_json_schema(schema):
         min_length = schema.pop('minLength', '')
         max_length = schema.pop('maxLength', '')
         pattern = schema.pop('pattern', '')
+        pattern_description = schema.pop('pattern_description', '')
         if enum:
             enum = mark_safe(' | '.join([format_html('<tt>{}</tt>', json.dumps(el)) for el in enum]))
         s = 'string'
@@ -166,7 +167,9 @@ def render_json_schema(schema):
         s = html_type(s)
         if enum:
             s += ' %s' % enum
-        if pattern:
+        if pattern_description:
+            s += format_html(' <em>{}</em>', pattern_description)
+        elif pattern:
             s += format_html(' /<tt>{}</tt>/', pattern)
         if schema:
             s += format_html('\n{!r}', schema)
diff --git a/tests/test_templatetags.py b/tests/test_templatetags.py
index 63f5093a..cdb4eaa0 100644
--- a/tests/test_templatetags.py
+++ b/tests/test_templatetags.py
@@ -69,3 +69,11 @@ def test_render_enum_schema():
         str(render_json_schema({'enum': [1, "aaa", [1]]}))
         == '<tt>1</tt> | <tt>&quot;aaa&quot;</tt> | <tt>[1]</tt>'
     )
+
+
+def test_render_pattern_description():
+    schema = {'type': 'object', 'properties': {'filename': {'type': 'string', 'pattern': 'abc'}}}
+    assert 'abc' in render_json_schema(schema)
+
+    schema['properties']['filename']['pattern_description'] = 'efg'
+    assert 'abc' not in render_json_schema(schema) and 'efg' in render_json_schema(schema)
-- 
2.30.2