cern-sis / issues-scoap3

0 stars 0 forks source link

Required Fields #289

Open ErnestaP opened 5 months ago

ErnestaP commented 5 months ago

Our schema, for scoap3 records (for the records which don't have added new fields yet), is not working as well as we would like. For example, the "license" field is required, but what is inside of it, according to the schema, is not. So, we can just have a record that would have an empty license value ({"license": []}) and it will be a valid record. However, we know that a value like this ("license": []) is not valid. @agentilb , could you please replace X in the following JSON, with values :"Required" or "Not Required", that we would be sure how to handle missing data

{
   "dois":[
      {
         "value":"Required"
      }
   ],
   "page_nr":[
      Not required
   ],
   "arxiv_eprints":[    **NOTE: This field is required for partial journals (from publishers: IOP, OUP, Hindawi, Jagellonian, APS), not required for the the other publishers (Elsevier, Springer)**
      {
         "value":"Required",
         "categories":[
            "Required",
         ]
      }
   ],
   "authors":[
      {
         "full_name":"Required",
         "given_names":"Not required",
         "surname":"Not required",
         "affiliations":[  **NOTE: This subfield is required but there are some rare cases where the author has genuinely no affiliation**
            {
               "value":"Required",
               "organization":"Not required",
               "country":"Required"
            }
         ]
      },
      {
         "full_name":"X",
         "given_names":"X",
         "surname":"X",
         "affiliations":[
            {
               "value":"X",
               "organization":"X",
               "country":"X"
            }
         ]
      },
      {
         "full_name":"X",
         "given_names":"X",
         "surname":"X",
         "affiliations":[
            {
               "value":"X",
               "organization":"X",
               "country":"X"
            }
         ]
      }
   ],
   "license":[
      {
         "url":"Required",
         "license":"Required"
      }
   ],
   "collections":[
      {
         "primary":"Not required"
      },
   ],
   "publication_info":[
      {
         "journal_title":"Required",
         "journal_volume":"Not required",
         "year":Required,
         "journal_issue":"Not required",
         "material":"Not required"
      }
   ],
   "abstracts":[
      {
         "value":"Required",
         "source":"Not required"
      }
   ],
   "acquisition_source":{
      "source":"Required?",
      "method":"Required?",
      "date":"Required?"
   },
   "copyright":[
      {
         "year":Required,
         "statement":"Required"
      }
   ],
   "imprints":[
      {
         "date":"Required",
         "publisher":"Required"
      }
   ],
   "record_creation_date":"Required",
   "titles":[
      {
         "title":"Required",
         "source":"Not required"
      }
   ],
   "$schema":"Required"
}
ErnestaP commented 5 months ago

collaborations is not req!!!