Merge pull request #1320 from Sage-Bionetworks/SYNPY-1766-display-names

valid values and properties now use labels at the same time

Author: andrewelamb

docs/tutorials/python/schema_operations.md

@@ -89,6 +89,16 @@ Create a JSON Schema
 
 If you don't set `output` parameter the JSON Schema file will be created in the current working directory.
 
+## 9. Create a JSON Schema using display names
+
+Create a JSON Schema
+
+```python
+{!docs/tutorials/python/tutorial_scripts/schema_operations.py!lines=56-62}
+```
+
+You can have Curator format the property names and valid values in the JSON Schema. This will remove whitespace and special characters.
+
 ## Source Code for this Tutorial
 
 <details class="quote">

docs/tutorials/python/tutorial_scripts/schema_operations.py

@@ -52,3 +52,11 @@
     data_types=DATA_TYPE,
     synapse_client=syn,
 )
+
+# Create JSON Schema in using display names for both properties names and valid values
+schemas, file_paths = generate_jsonschema(
+    data_model_source=DATA_MODEL_SOURCE,
+    data_types=DATA_TYPE,
+    data_model_labels="display_label",
+    synapse_client=syn,
+)

synapseclient/extensions/curator/schema_generation.py

@@ -19,20 +19,20 @@
     "Enum": {
       "description": "TBD",
       "enum": [
-        "ab",
-        "cd",
-        "ef",
-        "gh"
+        "Ab",
+        "Cd",
+        "Ef",
+        "Gh"
       ],
       "title": "Enum"
     },
     "EnumNotRequired": {
       "description": "TBD",
       "enum": [
-        "ab",
-        "cd",
-        "ef",
-        "gh"
+        "Ab",
+        "Cd",
+        "Ef",
+        "Gh"
       ],
       "title": "Enum Not Required"
     },
@@ -67,10 +67,10 @@
       "description": "TBD",
       "items": {
         "enum": [
-          "ab",
-          "cd",
-          "ef",
-          "gh"
+          "Ab",
+          "Cd",
+          "Ef",
+          "Gh"
         ],
         "type": "string"
       },
@@ -81,10 +81,10 @@
       "description": "TBD",
       "items": {
         "enum": [
-          "ab",
-          "cd",
-          "ef",
-          "gh"
+          "Ab",
+          "Cd",
+          "Ef",
+          "Gh"
         ],
         "type": "string"
       },

tests/unit/synapseclient/extensions/schema_files/expected_jsonschemas/expected.JSONSchemaComponent.display_names_schema.json

@@ -37,10 +37,10 @@
       "description": "TBD",
       "items": {
         "enum": [
-          "ab",
-          "cd",
-          "ef",
-          "gh"
+          "Ab",
+          "Cd",
+          "Ef",
+          "Gh"
         ],
         "type": "string"
       },
@@ -51,10 +51,10 @@
       "description": "TBD",
       "items": {
         "enum": [
-          "ab",
-          "cd",
-          "ef",
-          "gh"
+          "Ab",
+          "Cd",
+          "Ef",
+          "Gh"
         ],
         "type": "string"
       },
@@ -70,10 +70,10 @@
       "description": "TBD",
       "items": {
         "enum": [
-          "ab",
-          "cd",
-          "ef",
-          "gh"
+          "Ab",
+          "Cd",
+          "Ef",
+          "Gh"
         ],
         "type": "string"
       },