Skip to content

erp5
erp5
Commit 4d8f03e5 authored by Cédric Le Ninivin's avatar Cédric Le Ninivin Committed by Titouan Soulard
Browse files
Options

erp5_json_form: Add usage of Output Schema

parent 582ddaec
Show whitespace changes
Inline Side-by-side
Showing with 680 additions and 21 deletions
bt5/erp5_json_form/ActionTemplateItem/portal_types/JSON%20Form/view_input_schema.xml 0 → 100644
View file @ 4d8f03e5
<?xml version="1.0"?>
<ZopeData>
<record id="1" aka="AAAAAAAAAAE=">
<pickle>
<global name="ActionInformation" module="Products.CMFCore.ActionInformation"/>
</pickle>
<pickle>
<dictionary>
<item>
<key> <string>action</string> </key>
<value>
<persistent> <string encoding="base64">AAAAAAAAAAI=</string> </persistent>
</value>
</item>
<item>
<key> <string>categories</string> </key>
<value>
<tuple>
<string>action_type/object_view</string>
</tuple>
</value>
</item>
<item>
<key> <string>category</string> </key>
<value> <string>object_view</string> </value>
</item>
<item>
<key> <string>condition</string> </key>
<value> <string></string> </value>
</item>
<item>
<key> <string>description</string> </key>
<value>
<none/>
</value>
</item>
<item>
<key> <string>icon</string> </key>
<value> <string></string> </value>
</item>
<item>
<key> <string>id</string> </key>
<value> <string>view_input_schema</string> </value>
</item>
<item>
<key> <string>permissions</string> </key>
<value>
<tuple>
<string>View</string>
</tuple>
</value>
</item>
<item>
<key> <string>portal_type</string> </key>
<value> <string>Action Information</string> </value>
</item>
<item>
<key> <string>priority</string> </key>
<value> <float>2.0</float> </value>
</item>
<item>
<key> <string>title</string> </key>
<value> <string>Input Schema</string> </value>
</item>
<item>
<key> <string>visible</string> </key>
<value> <int>1</int> </value>
</item>
</dictionary>
</pickle>
</record>
<record id="2" aka="AAAAAAAAAAI=">
<pickle>
<global name="Expression" module="Products.CMFCore.Expression"/>
</pickle>
<pickle>
<dictionary>
<item>
<key> <string>text</string> </key>
<value> <string>string:${object_url}/JSONForm_viewInputSchema</string> </value>
</item>
</dictionary>
</pickle>
</record>
</ZopeData>
bt5/erp5_json_form/ActionTemplateItem/portal_types/JSON%20Form/view_output_schema.xml 0 → 100644
View file @ 4d8f03e5
<?xml version="1.0"?>
<ZopeData>
<record id="1" aka="AAAAAAAAAAE=">
<pickle>
<global name="ActionInformation" module="Products.CMFCore.ActionInformation"/>
</pickle>
<pickle>
<dictionary>
<item>
<key> <string>action</string> </key>
<value>
<persistent> <string encoding="base64">AAAAAAAAAAI=</string> </persistent>
</value>
</item>
<item>
<key> <string>categories</string> </key>
<value>
<tuple>
<string>action_type/object_view</string>
</tuple>
</value>
</item>
<item>
<key> <string>category</string> </key>
<value> <string>object_view</string> </value>
</item>
<item>
<key> <string>condition</string> </key>
<value> <string></string> </value>
</item>
<item>
<key> <string>description</string> </key>
<value>
<none/>
</value>
</item>
<item>
<key> <string>icon</string> </key>
<value> <string></string> </value>
</item>
<item>
<key> <string>id</string> </key>
<value> <string>view_output_schema</string> </value>
</item>
<item>
<key> <string>permissions</string> </key>
<value>
<tuple>
<string>View</string>
</tuple>
</value>
</item>
<item>
<key> <string>portal_type</string> </key>
<value> <string>Action Information</string> </value>
</item>
<item>
<key> <string>priority</string> </key>
<value> <float>3.0</float> </value>
</item>
<item>
<key> <string>title</string> </key>
<value> <string>Output Schema</string> </value>
</item>
<item>
<key> <string>visible</string> </key>
<value> <int>1</int> </value>
</item>
</dictionary>
</pickle>
</record>
<record id="2" aka="AAAAAAAAAAI=">
<pickle>
<global name="Expression" module="Products.CMFCore.Expression"/>
</pickle>
<pickle>
<dictionary>
<item>
<key> <string>text</string> </key>
<value> <string>string:${object_url}/JSONForm_viewOutputSchema</string> </value>
</item>
</dictionary>
</pickle>
</record>
</ZopeData>
bt5/erp5_json_form/ModuleComponentTemplateItem/portal_components/document.erp5.JSONForm.py
View file @ 4d8f03e5
...@@ -34,6 +34,7 @@ import re ...@@ -34,6 +34,7 @@ import re
from AccessControl import ClassSecurityInfo from AccessControl import ClassSecurityInfo
from Products.ERP5Type import Permissions, PropertySheet from Products.ERP5Type import Permissions, PropertySheet
from Products.ERP5Type.Utils import unicode2str from Products.ERP5Type.Utils import unicode2str
from Products.ERP5Type.UnrestrictedMethod import UnrestrictedMethod
class JSONForm(JSONType, TextDocument): class JSONForm(JSONType, TextDocument):
""" """
...@@ -68,7 +69,7 @@ class JSONForm(JSONType, TextDocument): ...@@ -68,7 +69,7 @@ class JSONForm(JSONType, TextDocument):
else: else:
raise ValueError(json.dumps(validation_result)) raise ValueError(json.dumps(validation_result))
if self.getAfterMethodId(): if self.getAfterMethodId():
return getattr(getattr(self, 'aq_parent', None), self.getAfterMethodId())(json_data, self.getResponseSchema()) return getattr(getattr(self, 'aq_parent', None), self.getAfterMethodId())(json_data, self.getOutputJSONSchema())
return "Nothing to do" return "Nothing to do"
def validateJSON(self, json_data, list_error=False): def validateJSON(self, json_data, list_error=False):
...@@ -89,17 +90,10 @@ class JSONForm(JSONType, TextDocument): ...@@ -89,17 +90,10 @@ class JSONForm(JSONType, TextDocument):
return err return err
return True return True
security.declarePublic('getInputJSONSchema') def returnSchema(self, schema, path, REQUEST):
def getInputJSONSchema(self, REQUEST=None):
"""
Clean way to retrive the schema
* Set proper cache headers
* Properly set the $id property
"""
schema = self.getTextContent()
regex = re.compile(r'"\$id": "(([^"])*)"') regex = re.compile(r'"\$id": "(([^"])*)"')
result = regex.search(schema) result = regex.search(schema)
schema_id = self.absolute_url().strip() + "/getInputJSONSchema" schema_id = self.absolute_url().strip() + path
if result: if result:
schema = schema.replace(result.group(1), schema_id, 1) schema = schema.replace(result.group(1), schema_id, 1)
#print data #print data
...@@ -111,3 +105,27 @@ class JSONForm(JSONType, TextDocument): ...@@ -111,3 +105,27 @@ class JSONForm(JSONType, TextDocument):
control.append( 'private' ) control.append( 'private' )
REQUEST.RESPONSE.setHeader('Cache-control', ', '.join( control ) ) REQUEST.RESPONSE.setHeader('Cache-control', ', '.join( control ) )
return schema return schema
security.declarePublic('getOutputJSONSchema')
@UnrestrictedMethod
def getOutputJSONSchema(self, REQUEST=None):
"""
Method to retrieve the expected JSON Schema for JSON input
"""
return self.returnSchema(
self.getOutputSchema(),
"/getOutputJSONSchema",
REQUEST
)
security.declarePublic('getInputJSONSchema')
@UnrestrictedMethod
def getInputJSONSchema(self, REQUEST=None):
"""
Method to retrieve the expected JSON Schema for JSON output
"""
return self.returnSchema(
self.getTextContent(),
"/getInputJSONSchema",
REQUEST
)
bt5/erp5_json_form/PropertySheetTemplateItem/portal_property_sheets/JSONForm/response_schema_property.xml → bt5/erp5_json_form/PropertySheetTemplateItem/portal_property_sheets/JSONForm/output_schema_property.xml
View file @ 4d8f03e5
...@@ -10,7 +10,7 @@ ...@@ -10,7 +10,7 @@
<key> <string>categories</string> </key> <key> <string>categories</string> </key>
<value> <value>
<tuple> <tuple>
<string>elementary_type/string</string> <string>elementary_type/text</string>
</tuple> </tuple>
</value> </value>
</item> </item>
...@@ -20,12 +20,16 @@ ...@@ -20,12 +20,16 @@
</item> </item>
<item> <item>
<key> <string>id</string> </key> <key> <string>id</string> </key>
<value> <string>response_schema_property</string> </value> <value> <string>output_schema_property</string> </value>
</item> </item>
<item> <item>
<key> <string>portal_type</string> </key> <key> <string>portal_type</string> </key>
<value> <string>Standard Property</string> </value> <value> <string>Standard Property</string> </value>
</item> </item>
<item>
<key> <string>read_permission</string> </key>
<value> <string>Access contents information</string> </value>
</item>
</dictionary> </dictionary>
</pickle> </pickle>
</record> </record>
......
bt5/erp5_json_form/SkinTemplateItem/portal_skins/erp5_json_form/JSONForm_view/my_description.xml
View file @ 4d8f03e5
...@@ -9,9 +9,7 @@ ...@@ -9,9 +9,7 @@
<item> <item>
<key> <string>delegated_list</string> </key> <key> <string>delegated_list</string> </key>
<value> <value>
<list> <list/>
<string>editable</string>
</list>
</value> </value>
</item> </item>
<item> <item>
...@@ -63,10 +61,6 @@ ...@@ -63,10 +61,6 @@
<key> <string>values</string> </key> <key> <string>values</string> </key>
<value> <value>
<dictionary> <dictionary>
<item>
<key> <string>editable</string> </key>
<value> <int>0</int> </value>
</item>
<item> <item>
<key> <string>field_id</string> </key> <key> <string>field_id</string> </key>
<value> <string>my_view_mode_description</string> </value> <value> <string>my_view_mode_description</string> </value>
......
bt5/erp5_json_form/SkinTemplateItem/portal_skins/erp5_json_form/JSONForm_view/my_text_content.xml
View file @ 4d8f03e5
...@@ -12,6 +12,7 @@ ...@@ -12,6 +12,7 @@
<list> <list>
<string>editable</string> <string>editable</string>
<string>extra</string> <string>extra</string>
<string>title</string>
</list> </list>
</value> </value>
</item> </item>
...@@ -66,7 +67,7 @@ ...@@ -66,7 +67,7 @@
<dictionary> <dictionary>
<item> <item>
<key> <string>editable</string> </key> <key> <string>editable</string> </key>
<value> <int>1</int> </value> <value> <int>0</int> </value>
</item> </item>
<item> <item>
<key> <string>extra</string> </key> <key> <string>extra</string> </key>
...@@ -80,6 +81,10 @@ ...@@ -80,6 +81,10 @@
<key> <string>form_id</string> </key> <key> <string>form_id</string> </key>
<value> <string>Base_viewJSONFieldLibrary</string> </value> <value> <string>Base_viewJSONFieldLibrary</string> </value>
</item> </item>
<item>
<key> <string>title</string> </key>
<value> <string>Input Schema</string> </value>
</item>
</dictionary> </dictionary>
</value> </value>
</item> </item>
......
bt5/erp5_json_form/SkinTemplateItem/portal_skins/erp5_json_form/JSONForm_viewInputSchema.xml 0 → 100644
View file @ 4d8f03e5
<?xml version="1.0"?>
<ZopeData>
<record id="1" aka="AAAAAAAAAAE=">
<pickle>
<global name="ERP5 Form" module="erp5.portal_type"/>
</pickle>
<pickle>
<dictionary>
<item>
<key> <string>_objects</string> </key>
<value>
<tuple/>
</value>
</item>
<item>
<key> <string>action</string> </key>
<value> <string>Base_edit</string> </value>
</item>
<item>
<key> <string>action_title</string> </key>
<value> <string></string> </value>
</item>
<item>
<key> <string>description</string> </key>
<value> <string></string> </value>
</item>
<item>
<key> <string>edit_order</string> </key>
<value>
<list/>
</value>
</item>
<item>
<key> <string>encoding</string> </key>
<value> <string>UTF-8</string> </value>
</item>
<item>
<key> <string>enctype</string> </key>
<value> <string></string> </value>
</item>
<item>
<key> <string>group_list</string> </key>
<value>
<list>
<string>left</string>
<string>right</string>
<string>center</string>
<string>bottom</string>
<string>hidden</string>
</list>
</value>
</item>
<item>
<key> <string>groups</string> </key>
<value>
<dictionary>
<item>
<key> <string>bottom</string> </key>
<value>
<list>
<string>my_text_content</string>
</list>
</value>
</item>
<item>
<key> <string>center</string> </key>
<value>
<list/>
</value>
</item>
<item>
<key> <string>hidden</string> </key>
<value>
<list/>
</value>
</item>
<item>
<key> <string>left</string> </key>
<value>
<list/>
</value>
</item>
<item>
<key> <string>right</string> </key>
<value>
<list/>
</value>
</item>
</dictionary>
</value>
</item>
<item>
<key> <string>id</string> </key>
<value> <string>JSONForm_viewInputSchema</string> </value>
</item>
<item>
<key> <string>method</string> </key>
<value> <string>POST</string> </value>
</item>
<item>
<key> <string>name</string> </key>
<value> <string>JSONForm_view</string> </value>
</item>
<item>
<key> <string>portal_type</string> </key>
<value> <string>ERP5 Form</string> </value>
</item>
<item>
<key> <string>pt</string> </key>
<value> <string>form_view</string> </value>
</item>
<item>
<key> <string>row_length</string> </key>
<value> <int>4</int> </value>
</item>
<item>
<key> <string>stored_encoding</string> </key>
<value> <string>UTF-8</string> </value>
</item>
<item>
<key> <string>title</string> </key>
<value> <string>JSON Form</string> </value>
</item>
<item>
<key> <string>unicode_mode</string> </key>
<value> <int>0</int> </value>
</item>
<item>
<key> <string>update_action</string> </key>
<value> <string></string> </value>
</item>
<item>
<key> <string>update_action_title</string> </key>
<value> <string></string> </value>
</item>
</dictionary>
</pickle>
</record>
</ZopeData>
bt5/erp5_json_form/SkinTemplateItem/portal_skins/erp5_json_form/JSONForm_viewInputSchema/my_text_content.xml 0 → 100644
View file @ 4d8f03e5
<?xml version="1.0"?>
<ZopeData>
<record id="1" aka="AAAAAAAAAAE=">
<pickle>
<global name="ProxyField" module="Products.ERP5Form.ProxyField"/>
</pickle>
<pickle>
<dictionary>
<item>
<key> <string>delegated_list</string> </key>
<value>
<list>
<string>editable</string>
<string>extra</string>
<string>title</string>
</list>
</value>
</item>
<item>
<key> <string>id</string> </key>
<value> <string>my_text_content</string> </value>
</item>
<item>
<key> <string>message_values</string> </key>
<value>
<dictionary>
<item>
<key> <string>external_validator_failed</string> </key>
<value> <string>The input failed the external validator.</string> </value>
</item>
</dictionary>
</value>
</item>
<item>
<key> <string>overrides</string> </key>
<value>
<dictionary>
<item>
<key> <string>field_id</string> </key>
<value> <string></string> </value>
</item>
<item>
<key> <string>form_id</string> </key>
<value> <string></string> </value>
</item>
</dictionary>
</value>
</item>
<item>
<key> <string>tales</string> </key>
<value>
<dictionary>
<item>
<key> <string>field_id</string> </key>
<value> <string></string> </value>
</item>
<item>
<key> <string>form_id</string> </key>
<value> <string></string> </value>
</item>
</dictionary>
</value>
</item>
<item>
<key> <string>values</string> </key>
<value>
<dictionary>
<item>
<key> <string>editable</string> </key>
<value> <int>1</int> </value>
</item>
<item>
<key> <string>extra</string> </key>
<value> <string></string> </value>
</item>
<item>
<key> <string>field_id</string> </key>
<value> <string>my_text_content</string> </value>
</item>
<item>
<key> <string>form_id</string> </key>
<value> <string>Base_viewJSONFieldLibrary</string> </value>
</item>
<item>
<key> <string>title</string> </key>
<value> <string>Input Schema</string> </value>
</item>
</dictionary>
</value>
</item>
</dictionary>
</pickle>
</record>
</ZopeData>
bt5/erp5_json_form/SkinTemplateItem/portal_skins/erp5_json_form/JSONForm_viewOutputSchema.xml 0 → 100644
View file @ 4d8f03e5
<?xml version="1.0"?>
<ZopeData>
<record id="1" aka="AAAAAAAAAAE=">
<pickle>
<global name="ERP5 Form" module="erp5.portal_type"/>
</pickle>
<pickle>
<dictionary>
<item>
<key> <string>_objects</string> </key>
<value>
<tuple/>
</value>
</item>
<item>
<key> <string>action</string> </key>
<value> <string>Base_edit</string> </value>
</item>
<item>
<key> <string>action_title</string> </key>
<value> <string></string> </value>
</item>
<item>
<key> <string>description</string> </key>
<value> <string></string> </value>
</item>
<item>
<key> <string>edit_order</string> </key>
<value>
<list/>
</value>
</item>
<item>
<key> <string>encoding</string> </key>
<value> <string>UTF-8</string> </value>
</item>
<item>
<key> <string>enctype</string> </key>
<value> <string></string> </value>
</item>
<item>
<key> <string>group_list</string> </key>
<value>
<list>
<string>left</string>
<string>right</string>
<string>center</string>
<string>bottom</string>
<string>hidden</string>
</list>
</value>
</item>
<item>
<key> <string>groups</string> </key>
<value>
<dictionary>
<item>
<key> <string>bottom</string> </key>
<value>
<list>
<string>my_output_schema</string>
</list>
</value>
</item>
<item>
<key> <string>center</string> </key>
<value>
<list/>
</value>
</item>
<item>
<key> <string>hidden</string> </key>
<value>
<list/>
</value>
</item>
<item>
<key> <string>left</string> </key>
<value>
<list/>
</value>
</item>
<item>
<key> <string>right</string> </key>
<value>
<list/>
</value>
</item>
</dictionary>
</value>
</item>
<item>
<key> <string>id</string> </key>
<value> <string>JSONForm_viewOutputSchema</string> </value>
</item>
<item>
<key> <string>method</string> </key>
<value> <string>POST</string> </value>
</item>
<item>
<key> <string>name</string> </key>
<value> <string>JSONForm_view</string> </value>
</item>
<item>
<key> <string>portal_type</string> </key>
<value> <string>ERP5 Form</string> </value>
</item>
<item>
<key> <string>pt</string> </key>
<value> <string>form_view</string> </value>
</item>
<item>
<key> <string>row_length</string> </key>
<value> <int>4</int> </value>
</item>
<item>
<key> <string>stored_encoding</string> </key>
<value> <string>UTF-8</string> </value>
</item>
<item>
<key> <string>title</string> </key>
<value> <string>JSON Form</string> </value>
</item>
<item>
<key> <string>unicode_mode</string> </key>
<value> <int>0</int> </value>
</item>
<item>
<key> <string>update_action</string> </key>
<value> <string></string> </value>
</item>
<item>
<key> <string>update_action_title</string> </key>
<value> <string></string> </value>
</item>
</dictionary>
</pickle>
</record>
</ZopeData>
bt5/erp5_json_form/SkinTemplateItem/portal_skins/erp5_json_form/JSONForm_viewOutputSchema/my_output_schema.xml 0 → 100644
View file @ 4d8f03e5
<?xml version="1.0"?>
<ZopeData>
<record id="1" aka="AAAAAAAAAAE=">
<pickle>
<global name="ProxyField" module="Products.ERP5Form.ProxyField"/>
</pickle>
<pickle>
<dictionary>
<item>
<key> <string>delegated_list</string> </key>
<value>
<list>
<string>editable</string>
<string>extra</string>
<string>title</string>
</list>
</value>
</item>
<item>
<key> <string>id</string> </key>
<value> <string>my_output_schema</string> </value>
</item>
<item>
<key> <string>message_values</string> </key>
<value>
<dictionary>
<item>
<key> <string>external_validator_failed</string> </key>
<value> <string>The input failed the external validator.</string> </value>
</item>
</dictionary>
</value>
</item>
<item>
<key> <string>overrides</string> </key>
<value>
<dictionary>
<item>
<key> <string>field_id</string> </key>
<value> <string></string> </value>
</item>
<item>
<key> <string>form_id</string> </key>
<value> <string></string> </value>
</item>
</dictionary>
</value>
</item>
<item>
<key> <string>tales</string> </key>
<value>
<dictionary>
<item>
<key> <string>field_id</string> </key>
<value> <string></string> </value>
</item>
<item>
<key> <string>form_id</string> </key>
<value> <string></string> </value>
</item>
</dictionary>
</value>
</item>
<item>
<key> <string>values</string> </key>
<value>
<dictionary>
<item>
<key> <string>editable</string> </key>
<value> <int>1</int> </value>
</item>
<item>
<key> <string>extra</string> </key>
<value> <string></string> </value>
</item>
<item>
<key> <string>field_id</string> </key>
<value> <string>my_text_content</string> </value>
</item>
<item>
<key> <string>form_id</string> </key>
<value> <string>Base_viewJSONFieldLibrary</string> </value>
</item>
<item>
<key> <string>title</string> </key>
<value> <string>Input Schema</string> </value>
</item>
</dictionary>
</value>
</item>
</dictionary>
</pickle>
</record>
</ZopeData>
bt5/erp5_json_form/bt/template_action_path_list
View file @ 4d8f03e5
JSON Form | view JSON Form | view
JSON Form | view_input_schema
JSON Form | view_output_schema
\ No newline at end of file
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment
GitLab Nexedi Edition | About GitLab | About Nexedi | 沪ICP备2021021310号-2 | 沪ICP备2021021310号-7