ENH: JsonSchemaExporter accepts do_not_create parameter.

Summary

For #116 (closed) Insert a meaningful description for this merge request here: What is the new/changed behavior? Which bug has been fixed? Are there related issues?

Focus

Point the reviewer to the core of the code change. Where should they start reading? What should they focus on (e.g. security, performance, maintainability, user-friendliness, compliance with the specs, finding more corner cases, concrete questions)?

Test Environment

How to set up a test environment for manual testing?

Check List for the Author

Please, prepare your MR for a review. Be sure to write a summary and a focus and create gitlab comments for the reviewer. They should guide the reviewer through the changes, explain your changes and also point out open questions. For further good practices have a look at our review guidelines

• All automated tests pass
• Reference related issues
• Up-to-date CHANGELOG.md (or not necessary)
• Up-to-date JSON schema (or not necessary)
• Appropriate user and developer documentation (or not necessary)
  • How do I use the software? Assume "stupid" users.
  • How do I develop or debug the software? Assume novice developers.
• Annotations in code (Gitlab comments)
  • Intent of new code
  • Problems with old code
  • Why this implementation?

Check List for the Reviewer

• I understand the intent of this MR
• All automated tests pass
• Up-to-date CHANGELOG.md (or not necessary)
• Appropriate user and developer documentation (or not necessary)
• The test environment setup works and the intended behavior is reproducible in the test environment
• In-code documentation and comments are up-to-date.
• Check: Are there specifications? Are they satisfied?

For further good practices have a look at our review guidelines.

src/caosadvancedtools/json_schema_exporter.py

@@ -300,7 +300,8 @@ class JsonSchemaExporter:
 
         return schema, ui_schema
 
-    def recordtype_to_json_schema(self, rt: db.RecordType, rjsf_uischema: Optional[dict] = None):
+    def recordtype_to_json_schema(self, rt: db.RecordType, rjsf: bool = False) -> Union[
+            dict, Tuple[dict, dict]]:
         """Create a jsonschema from a given RecordType that can be used, e.g., to
         validate a json specifying a record of the given type.
 
@@ -308,28 +309,31 @@ class JsonSchemaExporter:
         ----------
         rt : RecordType
             The RecordType from which a json schema will be created.
-        rjsf_uischema : dict, optional
-            If given, uiSchema definitions for react-jsonschema-forms will be appended to this dict
-            at ``[rt.name]``.
+        rjsf : bool, optional
+            If True, uiSchema definitions for react-jsonschema-forms will be output as the second
+            return value.  Default is False
 
         Returns
         -------
         schema : dict
             A dict containing the json schema created from the given RecordType's properties.
+
+        ui_schema : dict, optional
+            A ui schema.  Only if a parameter asks for it (e.g. ``rjsf``).
         """
         if rt is None:
             raise ValueError(
                 "recordtype_to_json_schema(...) cannot be called with a `None` RecordType.")
-        if rjsf_uischema is None:
-            rjsf_uischema = {}
-
         schema, inner_uischema = self._make_segment_from_recordtype(rt)
-        if inner_uischema:
-            rjsf_uischema[rt.name] = inner_uischema
         schema["$schema"] = "https://json-schema.org/draft/2020-12/schema"
         if rt.description:
             schema["description"] = rt.description
 
+        if rjsf:
+            uischema = {}
+            if inner_uischema:
+                uischema = inner_uischema
+            return schema, uischema
         return schema
 
 
@@ -342,8 +346,8 @@ def recordtype_to_json_schema(rt: db.RecordType, additional_properties: bool = T
                               do_not_retrieve: List[str] = None,
                               no_remote: bool = False,
                               multiple_choice: List[str] = None,
-                              rjsf_uischema: Optional[dict] = None,
-                              ):
+                              rjsf: bool = False,
+                              ) -> Union[dict, Tuple[dict, dict]]:
     """Create a jsonschema from a given RecordType that can be used, e.g., to
     validate a json specifying a record of the given type.
 
@@ -385,14 +389,17 @@ def recordtype_to_json_schema(rt: db.RecordType, additional_properties: bool = T
         A list of reference Property names which shall be denoted as multiple choice properties.
         This means that each option in this property may be selected at most once.  This is not
         implemented yet if the Property is not in ``do_not_create`` as well.
-    rjsf_uischema : dict, optional
-        If given, uiSchema definitions for react-jsonschema-forms will be appended to this dict.
+    rjsf : bool, optional
+        If True, uiSchema definitions for react-jsonschema-forms will be output as the second return
+        value.  Default is False.
 
     Returns
     -------
     schema : dict
         A dict containing the json schema created from the given RecordType's properties.
 
+    ui_schema : dict, optional
+        A ui schema.  Only if a parameter asks for it (e.g. ``rjsf``).
     """
 
     exporter = JsonSchemaExporter(
@@ -406,10 +413,10 @@ def recordtype_to_json_schema(rt: db.RecordType, additional_properties: bool = T
         no_remote=no_remote,
         multiple_choice=multiple_choice,
     )
-    return exporter.recordtype_to_json_schema(rt, rjsf_uischema=rjsf_uischema)
+    return exporter.recordtype_to_json_schema(rt, rjsf=rjsf)
 
 
-def make_array(schema: dict, rjsf_uischema: dict = None) -> Union[dict, tuple[dict, dict]]:
+def make_array(schema: dict, rjsf_uischema: dict = None) -> Union[dict, Tuple[dict, dict]]:
     """Create an array of the given schema.
 
 The result will look like this: