Develop file structure and way to organize Fields,Field groups,Checklist groups

[snathanvj]

Currently, ENA creates fields ,field group, field unit , field values, checklist group everything in database table. Since , we are going to store everything in github we have to come up with the file structure to organize them.

Things to consider:

• Add new field/field group with unit and restricted values
  • update existing field/field group.

[snathanvj]

Features (related to Field and Field group):

• CreateField(Field fieldJson)
• CreateFieldsToFieldGroup(Field fieldJson) - creates/amends existing field group

Tentative field json format:

{
    "$schema": "http://json-schema.org/draft-04/schema#",
    "type": "object",
    "properties": {
        "fields": {
            "type": "array",
            "items": [
                {
                    "type": "object",
                    "properties": {
                        "name": {
                            "type": "string"
                        },
                        "type": {
                            "type": "string"
                        },
                        "maxValue": {
                            "type": "string"
                        },
                        "minValue": {
                            "type": "string"
                        },
                        "maxOccurrance": {
                            "type": "string"
                        },
                        "regexPattern": {
                            "type": "string"
                        }
                    },
                    "required": [
                        "name",
                        "type",
                        "maxValue",
                        "maxOccurrance"
                    ]
                }
            ]
        }
    },
    "required": [
        "fields"
    ]
}

• FieldGroup

  {
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
  "FieldGroup": {
    "type": "object",
    "properties": {
      "name": {
        "type": "string"
      },
      "fields": {
        "type": "array",
        "items": [
          {
            "type": "string"
          },
          {
            "type": "string"
          },
          {
            "type": "string"
          }
        ]
      }
    },
    "required": [
      "name",
      "fields"
    ]
  }
  },
  "required": [
  "FieldGroup"
  ]
  }

versioning

• we don't versioning of field/field group
• Suggestion is to use github API call to trigger the versioning API call immediately rather than gitlab

implementation

• Use github API call from our application(could be python based or anything it does not matter) to apply changes to related json file and push changes to github , so that the changes will be seen in the UI immediately.
• Github has lot of providers to support event triggering using the webhooks but has to explore bit more to understand it serves our purpose

[snathanvj]

Libraries I am planning to use for github file update : https://github.com/octokit/octokit.js?tab=readme-ov-file

@amnonkhen @theisuru please check previous two comments for the idea to go ahead.Thanks.

[snathanvj]

Suggestion for field versioning

 -field(directory)
    -filed_name(directory )     
        - latest (directory)
            -3.0.0(directory)
                - filed_definition_json (file) 
        -v1 (directory)
            -1.0.0 (directory)
                - filed_definition_json (file) 
            -1.0.1..
                - filed_definition_json (file) 
            -1.1.0...
                - filed_definition_json (file) 
        -v2
            -2.0.0
                - filed_definition_json (file) 
            -2.0.1..
                - filed_definition_json (file) 
            -2.1.0...   
                - filed_definition_json (file) 

[snathanvj]

Tentative checklist schema:

  {
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "checklist": {
      "type": "object",
      "properties": {
        "name": {
          "type": "string"
        },
        "fields": {
          "type": "array",
          "items": [ // array of fields for the checklist
            {
              "type": "object",
              "properties": {
                "field": {
                  "type": "field json" 
                },
                "version": {
                  "type": "string"
                }
              },
              "required": [
                "field",
                "version"
              ]
            }
          ]
        }
      },
      "required": [
        "name",
        "fields"
      ]
    }
  },
  "required": [
    "checklist"
  ]
}

[snathanvj]

Directory structure:

- checklist (directory)
    -checklist_name(directory)
        -live (directory)
            -checklist_1 (file)
            -checklist_2 (file)
            -checklist_3 (file)
            .
            .
            .
            -checklist_N(file)
        -v1 //can have sub directories for minor and batch versions
            -checklist_1 (file)
            -checklist_2 (file)
            -checklist_3 (file)
            .
            .
            .
            -checklist_N(file)
        -v2 //can have sub directories for minor and batch versions
            -checklist_1 (file)
            -checklist_2 (file)
            -checklist_3 (file)
            .
            .
            .
            -checklist_N(file)

 - field(directory)
    - filed_name(directory )     
        - latest (directory)
            -3.0.0(directory)
                - field_definition_json (file with all fields and it's status like disabled,deprecated...) 
        -v1 (directory)
            -1.0.0 (directory)
                - field_definition_json (file) 
            -1.0.1..
                - field_definition_json (file) 
            -1.1.0...
                - field_definition_json (file) 
        -v2
            -2.0.0
                - field_definition_json (file) 
            -2.0.1..
                - field_definition_json (file) 
            -2.1.0...   
                - field_definition_json (file) 

- field_group (directory)
    -field_group_1 (file with list of fields)
    -field_group_2 (file with list of fields)
    -field_group_3 (file with list of fields)
    .
    .
    .
    -field_group_N (file with list of fields)

- checklist_group (directory)
    -checklist_group_1 (file with list of checklists)
    -checklist_group_2 (file with list of checklists)
    .
    .
    .
    -checklist_group_N (file with list of checklists)