@gen3/frontend 0.12.4 → 0.12.5

package/schemas/discovery_config_schema.json

@@ -0,0 +1,925 @@
+{
+  "$ref": "#/definitions/DiscoveryConfig",
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "definitions": {
+    "AdvancedSearchFilters": {
+      "additionalProperties": false,
+      "properties": {
+        "displayName": {
+          "type": "string"
+        },
+        "enabled": {
+          "type": "boolean"
+        },
+        "field": {
+          "type": "string"
+        },
+        "filters": {
+          "items": {
+            "$ref": "#/definitions/KeyValueSearchFilter"
+          },
+          "type": "array"
+        }
+      },
+      "required": [
+        "enabled",
+        "field",
+        "displayName",
+        "filters"
+      ],
+      "type": "object"
+    },
+    "AuthorizationValues": {
+      "additionalProperties": false,
+      "properties": {
+        "enabled": {
+          "type": "boolean"
+        },
+        "menuText": {
+          "type": "string"
+        }
+      },
+      "required": [
+        "enabled",
+        "menuText"
+      ],
+      "type": "object"
+    },
+    "ChartsSection": {
+      "additionalProperties": false,
+      "properties": {
+        "charts": {
+          "additionalProperties": {
+            "additionalProperties": false,
+            "properties": {
+              "chartType": {
+                "type": "string"
+              },
+              "dataLabels": {
+                "additionalProperties": {
+                  "type": "string"
+                },
+                "type": "object"
+              },
+              "description": {
+                "type": "string"
+              },
+              "field": {
+                "type": "string"
+              },
+              "label": {
+                "additionalProperties": false,
+                "properties": {
+                  "show": {
+                    "type": "boolean"
+                  }
+                },
+                "type": "object"
+              },
+              "title": {
+                "type": "string"
+              },
+              "valueType": {
+                "enum": [
+                  "count",
+                  "percent"
+                ],
+                "type": "string"
+              }
+            },
+            "required": [
+              "chartType",
+              "field"
+            ],
+            "type": "object"
+          },
+          "type": "object"
+        },
+        "enabled": {
+          "type": "boolean"
+        },
+        "showLegends": {
+          "additionalProperties": false,
+          "properties": {
+            "enabled": {
+              "type": "boolean"
+            },
+            "showSwitch": {
+              "type": "boolean"
+            }
+          },
+          "required": [
+            "enabled"
+          ],
+          "type": "object"
+        },
+        "title": {
+          "type": "string"
+        }
+      },
+      "required": [
+        "enabled"
+      ],
+      "type": "object"
+    },
+    "DataAuthorization": {
+      "additionalProperties": false,
+      "properties": {
+        "columnTooltip": {
+          "type": "string"
+        },
+        "enabled": {
+          "type": "boolean"
+        },
+        "supportedValues": {
+          "additionalProperties": {
+            "$ref": "#/definitions/AuthorizationValues"
+          },
+          "type": "object"
+        }
+      },
+      "type": "object"
+    },
+    "DataDownloadLinks": {
+      "additionalProperties": false,
+      "properties": {
+        "className": {
+          "additionalProperties": {
+            "type": "string"
+          },
+          "type": "object"
+        },
+        "field": {
+          "type": "string"
+        },
+        "name": {
+          "type": "string"
+        }
+      },
+      "required": [
+        "field"
+      ],
+      "type": "object"
+    },
+    "DataLibraryActionButton": {
+      "additionalProperties": false,
+      "properties": {
+        "actionFunction": {
+          "type": "string"
+        },
+        "icon": {
+          "type": "string"
+        },
+        "label": {
+          "type": "string"
+        },
+        "requiresLogin": {
+          "type": "boolean"
+        },
+        "tooltip": {
+          "type": "string"
+        },
+        "type": {
+          "enum": [
+            "manifest",
+            "zip",
+            "download",
+            "link",
+            "externalLink",
+            "add-to-workspace"
+          ],
+          "type": "string"
+        }
+      },
+      "required": [
+        "type",
+        "actionFunction"
+      ],
+      "type": "object"
+    },
+    "DiscoveryConfig": {
+      "additionalProperties": false,
+      "properties": {
+        "metadataConfig": {
+          "items": {
+            "$ref": "#/definitions/DiscoveryIndexConfig"
+          },
+          "type": "array"
+        }
+      },
+      "required": [
+        "metadataConfig"
+      ],
+      "type": "object"
+    },
+    "DiscoveryContentTypes": {
+      "type": "string"
+    },
+    "DiscoveryIndexConfig": {
+      "additionalProperties": false,
+      "properties": {
+        "aggregations": {
+          "items": {
+            "$ref": "#/definitions/SummaryStatisticsConfig"
+          },
+          "type": "array"
+        },
+        "detailView": {
+          "$ref": "#/definitions/StudyDetailView"
+        },
+        "features": {
+          "additionalProperties": false,
+          "properties": {
+            "advSearchFilters": {
+              "$ref": "#/definitions/AdvancedSearchFilters"
+            },
+            "aiSearch": {
+              "type": "boolean"
+            },
+            "authorization": {
+              "$ref": "#/definitions/DataAuthorization"
+            },
+            "chartsSection": {
+              "$ref": "#/definitions/ChartsSection"
+            },
+            "dataLoader": {
+              "additionalProperties": false,
+              "properties": {
+                "dataFetchArgs": {
+                  "additionalProperties": {
+                    "anyOf": [
+                      {
+                        "type": "string"
+                      },
+                      {
+                        "type": "number"
+                      },
+                      {
+                        "type": "boolean"
+                      },
+                      {
+                        "items": {
+                          "$ref": "#/definitions/alias-1192014960-5155-5227-1192014960-0-605053"
+                        },
+                        "type": "array"
+                      },
+                      {
+                        "$ref": "#/definitions/alias-1192014960-5227-5278-1192014960-0-605053"
+                      }
+                    ]
+                  },
+                  "type": "object"
+                },
+                "dataFetchFunction": {
+                  "type": "string"
+                },
+                "sortingAndPagination": {
+                  "enum": [
+                    "client",
+                    "server"
+                  ],
+                  "type": "string"
+                }
+              },
+              "type": "object"
+            },
+            "exportToDataLibrary": {
+              "$ref": "#/definitions/ExportToDataLibrary"
+            },
+            "pageTitle": {
+              "additionalProperties": false,
+              "properties": {
+                "enabled": {
+                  "type": "boolean"
+                },
+                "text": {
+                  "type": "string"
+                }
+              },
+              "required": [
+                "enabled",
+                "text"
+              ],
+              "type": "object"
+            },
+            "search": {
+              "$ref": "#/definitions/SearchConfig"
+            }
+          },
+          "required": [
+            "pageTitle",
+            "authorization"
+          ],
+          "type": "object"
+        },
+        "guidType": {
+          "type": "string"
+        },
+        "label": {
+          "type": "string"
+        },
+        "minimalFieldMapping": {
+          "$ref": "#/definitions/MinimalFieldMapping"
+        },
+        "simpleDetailsView": {
+          "$ref": "#/definitions/StudyPageConfig"
+        },
+        "studyColumns": {
+          "items": {
+            "$ref": "#/definitions/StudyColumn"
+          },
+          "type": "array"
+        },
+        "studyField": {
+          "type": "string"
+        },
+        "studyPreviewField": {
+          "$ref": "#/definitions/StudyDetailsField"
+        },
+        "tableConfig": {
+          "additionalProperties": false,
+          "properties": {
+            "expandableRows": {
+              "type": "boolean"
+            },
+            "expandingRowRenderFunction": {
+              "type": "string"
+            },
+            "selectableRows": {
+              "type": "boolean"
+            }
+          },
+          "type": "object"
+        },
+        "tags": {
+          "$ref": "#/definitions/TagsConfig"
+        }
+      },
+      "required": [
+        "features",
+        "aggregations",
+        "tags",
+        "tableConfig",
+        "studyColumns",
+        "detailView",
+        "minimalFieldMapping"
+      ],
+      "type": "object"
+    },
+    "DownloadLinkFields": {
+      "additionalProperties": false,
+      "properties": {
+        "descriptionField": {
+          "type": "string"
+        },
+        "idField": {
+          "type": "string"
+        },
+        "titleField": {
+          "type": "string"
+        }
+      },
+      "required": [
+        "idField",
+        "titleField",
+        "descriptionField"
+      ],
+      "type": "object"
+    },
+    "ExportToDataLibrary": {
+      "additionalProperties": false,
+      "properties": {
+        "buttons": {
+          "items": {
+            "$ref": "#/definitions/DataLibraryActionButton"
+          },
+          "type": "array"
+        },
+        "enabled": {
+          "type": "boolean"
+        },
+        "loginRequireForAllButtons": {
+          "type": "boolean"
+        },
+        "manifestFieldName": {
+          "type": "string"
+        },
+        "verifyExternalLogins": {
+          "type": "boolean"
+        }
+      },
+      "required": [
+        "buttons"
+      ],
+      "type": "object"
+    },
+    "KeyValueSearchFilter": {
+      "additionalProperties": false,
+      "properties": {
+        "key": {
+          "type": "string"
+        },
+        "keyDisplayName": {
+          "type": "string"
+        },
+        "valueDisplayNames": {
+          "additionalProperties": {
+            "type": "string"
+          },
+          "type": "object"
+        }
+      },
+      "required": [
+        "key"
+      ],
+      "type": "object"
+    },
+    "MinimalFieldMapping": {
+      "additionalProperties": false,
+      "properties": {
+        "authzField": {
+          "type": "string"
+        },
+        "dataAvailabilityField": {
+          "type": "string"
+        },
+        "tagsListFieldName": {
+          "type": "string"
+        },
+        "uid": {
+          "type": "string"
+        }
+      },
+      "required": [
+        "authzField",
+        "tagsListFieldName",
+        "dataAvailabilityField",
+        "uid"
+      ],
+      "type": "object"
+    },
+    "SearchBar": {
+      "additionalProperties": false,
+      "properties": {
+        "enabled": {
+          "type": "boolean"
+        },
+        "inputSubtitle": {
+          "type": "string"
+        },
+        "placeholder": {
+          "type": "string"
+        },
+        "searchableTextFields": {
+          "items": {
+            "type": "string"
+          },
+          "type": "array"
+        }
+      },
+      "required": [
+        "enabled",
+        "inputSubtitle",
+        "searchableTextFields"
+      ],
+      "type": "object"
+    },
+    "SearchConfig": {
+      "additionalProperties": false,
+      "properties": {
+        "searchBar": {
+          "$ref": "#/definitions/SearchBar"
+        },
+        "tagSearchDropdown": {
+          "additionalProperties": false,
+          "properties": {
+            "collapsibleButtonText": {
+              "type": "string"
+            },
+            "enabled": {
+              "type": "boolean"
+            }
+          },
+          "type": "object"
+        }
+      },
+      "type": "object"
+    },
+    "StudyColumn": {
+      "additionalProperties": false,
+      "properties": {
+        "cellRenderFunction": {
+          "type": "string"
+        },
+        "contentType": {
+          "$ref": "#/definitions/DiscoveryContentTypes"
+        },
+        "errorIfNotAvailable": {
+          "type": "boolean"
+        },
+        "field": {
+          "type": "string"
+        },
+        "name": {
+          "type": "string"
+        },
+        "params": {
+          "additionalProperties": {
+            "anyOf": [
+              {
+                "type": "string"
+              },
+              {
+                "type": "number"
+              },
+              {
+                "type": "boolean"
+              },
+              {
+                "items": {
+                  "$ref": "#/definitions/alias-1192014960-5155-5227-1192014960-0-605053"
+                },
+                "type": "array"
+              },
+              {
+                "$ref": "#/definitions/alias-1192014960-5227-5278-1192014960-0-605053"
+              }
+            ]
+          },
+          "type": "object"
+        },
+        "valueIfNotAvailable": {
+          "type": [
+            "string",
+            "number"
+          ]
+        }
+      },
+      "required": [
+        "name",
+        "field"
+      ],
+      "type": "object"
+    },
+    "StudyDetailTab": {
+      "additionalProperties": false,
+      "properties": {
+        "groups": {
+          "items": {
+            "$ref": "#/definitions/StudyTabGroup"
+          },
+          "type": "array"
+        },
+        "tabName": {
+          "type": "string"
+        }
+      },
+      "required": [
+        "tabName",
+        "groups"
+      ],
+      "type": "object"
+    },
+    "StudyDetailView": {
+      "additionalProperties": false,
+      "properties": {
+        "header": {
+          "additionalProperties": false,
+          "properties": {
+            "className": {
+              "type": "string"
+            },
+            "field": {
+              "type": "string"
+            }
+          },
+          "required": [
+            "field"
+          ],
+          "type": "object"
+        },
+        "tabs": {
+          "items": {
+            "$ref": "#/definitions/StudyDetailTab"
+          },
+          "type": "array"
+        }
+      },
+      "required": [
+        "header",
+        "tabs"
+      ],
+      "type": "object"
+    },
+    "StudyDetailsField": {
+      "additionalProperties": false,
+      "properties": {
+        "classNames": {
+          "additionalProperties": {
+            "type": "string"
+          },
+          "type": "object"
+        },
+        "contentType": {
+          "type": "string"
+        },
+        "field": {
+          "type": "string"
+        },
+        "includeIfNotAvailable": {
+          "type": "boolean"
+        },
+        "includeLabel": {
+          "type": "boolean"
+        },
+        "name": {
+          "type": "string"
+        },
+        "params": {
+          "additionalProperties": {},
+          "type": "object"
+        },
+        "renderer": {
+          "type": "string"
+        },
+        "valueIfNotAvailable": {
+          "type": [
+            "string",
+            "number"
+          ]
+        }
+      },
+      "required": [
+        "name",
+        "field"
+      ],
+      "type": "object"
+    },
+    "StudyPageConfig": {
+      "additionalProperties": false,
+      "properties": {
+        "classNames": {
+          "additionalProperties": {
+            "type": "string"
+          },
+          "type": "object"
+        },
+        "downloadLinkFields": {
+          "$ref": "#/definitions/DownloadLinkFields"
+        },
+        "downloadLinks": {
+          "$ref": "#/definitions/DataDownloadLinks"
+        },
+        "fieldsToShow": {
+          "items": {
+            "$ref": "#/definitions/StudyPageGroup"
+          },
+          "type": "array"
+        },
+        "header": {
+          "additionalProperties": false,
+          "properties": {
+            "className": {
+              "type": "string"
+            },
+            "field": {
+              "type": "string"
+            }
+          },
+          "required": [
+            "field"
+          ],
+          "type": "object"
+        },
+        "showAllAvailableFields": {
+          "type": "boolean"
+        }
+      },
+      "required": [
+        "fieldsToShow"
+      ],
+      "type": "object"
+    },
+    "StudyPageGroup": {
+      "additionalProperties": false,
+      "properties": {
+        "fields": {
+          "items": {
+            "$ref": "#/definitions/StudyDetailsField"
+          },
+          "type": "array"
+        },
+        "groupName": {
+          "type": "string"
+        },
+        "groupWidth": {
+          "enum": [
+            "half",
+            "full"
+          ],
+          "type": "string"
+        }
+      },
+      "required": [
+        "fields"
+      ],
+      "type": "object"
+    },
+    "StudyTabGroup": {
+      "additionalProperties": false,
+      "properties": {
+        "fields": {
+          "items": {
+            "anyOf": [
+              {
+                "$ref": "#/definitions/StudyDetailsField"
+              },
+              {
+                "$ref": "#/definitions/StudyTabTagField"
+              }
+            ]
+          },
+          "type": "array"
+        },
+        "header": {
+          "type": "string"
+        }
+      },
+      "required": [
+        "header",
+        "fields"
+      ],
+      "type": "object"
+    },
+    "StudyTabTagField": {
+      "additionalProperties": false,
+      "properties": {
+        "categories": {
+          "items": {
+            "type": "string"
+          },
+          "type": "array"
+        },
+        "classNames": {
+          "additionalProperties": {
+            "type": "string"
+          },
+          "type": "object"
+        },
+        "contentType": {
+          "type": "string"
+        },
+        "field": {
+          "type": "string"
+        },
+        "includeIfNotAvailable": {
+          "type": "boolean"
+        },
+        "includeLabel": {
+          "type": "boolean"
+        },
+        "name": {
+          "type": "string"
+        },
+        "params": {
+          "additionalProperties": {},
+          "type": "object"
+        },
+        "renderer": {
+          "type": "string"
+        },
+        "valueIfNotAvailable": {
+          "type": [
+            "string",
+            "number"
+          ]
+        }
+      },
+      "required": [
+        "field",
+        "name"
+      ],
+      "type": "object"
+    },
+    "SummaryStatisticsConfig": {
+      "additionalProperties": false,
+      "properties": {
+        "displayFunction": {
+          "type": "string"
+        },
+        "field": {
+          "type": "string"
+        },
+        "name": {
+          "type": "string"
+        },
+        "type": {
+          "enum": [
+            "sum",
+            "count"
+          ],
+          "type": "string"
+        }
+      },
+      "required": [
+        "name",
+        "field",
+        "type"
+      ],
+      "type": "object"
+    },
+    "TagCategory": {
+      "additionalProperties": false,
+      "properties": {
+        "category": {
+          "type": "string"
+        },
+        "color": {
+          "type": "string"
+        },
+        "display": {
+          "type": "boolean"
+        },
+        "displayName": {
+          "type": "string"
+        },
+        "name": {
+          "type": "string"
+        }
+      },
+      "required": [
+        "category",
+        "color",
+        "display",
+        "displayName",
+        "name"
+      ],
+      "type": "object"
+    },
+    "TagsConfig": {
+      "additionalProperties": false,
+      "properties": {
+        "showUnknownTags": {
+          "type": "boolean"
+        },
+        "tagCategories": {
+          "items": {
+            "$ref": "#/definitions/TagCategory"
+          },
+          "type": "array"
+        }
+      },
+      "required": [
+        "tagCategories"
+      ],
+      "type": "object"
+    },
+    "alias-1192014960-5155-5227-1192014960-0-605053": {
+      "anyOf": [
+        {
+          "type": "string"
+        },
+        {
+          "type": "number"
+        },
+        {
+          "type": "boolean"
+        },
+        {
+          "items": {
+            "$ref": "#/definitions/alias-1192014960-5155-5227-1192014960-0-605053"
+          },
+          "type": "array"
+        },
+        {
+          "$ref": "#/definitions/alias-1192014960-5227-5278-1192014960-0-605053"
+        }
+      ]
+    },
+    "alias-1192014960-5227-5278-1192014960-0-605053": {
+      "additionalProperties": {
+        "anyOf": [
+          {
+            "type": "string"
+          },
+          {
+            "type": "number"
+          },
+          {
+            "type": "boolean"
+          },
+          {
+            "items": {
+              "$ref": "#/definitions/alias-1192014960-5155-5227-1192014960-0-605053"
+            },
+            "type": "array"
+          },
+          {
+            "$ref": "#/definitions/alias-1192014960-5227-5278-1192014960-0-605053"
+          }
+        ]
+      },
+      "type": "object"
+    }
+  }
+}