Merge branch 'nada-5.3'

ihsn · Aug 9, 2023 · a2eefb8 · a2eefb8
2 parents e4fcd62 + fd52127
commit a2eefb8
Show file tree

Hide file tree

Showing 270 changed files with 6,072 additions and 3,300 deletions.
diff --git a/api-documentation/catalog-admin/document-schema.json b/api-documentation/catalog-admin/document-schema.json
@@ -566,7 +566,7 @@
 
         "crossref": {
           "type": "string",
-          "title": "Book title",
+          "title": "Cross reference",
           "description":"The database key of the entry being cross referenced"
         },
 
@@ -646,10 +646,6 @@
                 "title": "Affiliation",
                 "type": "string"
               },
-              "role": {
-                "title": "Role",
-                "type": "string"
-              },
               "contribution": {
                 "title": "Contribution",
                 "type": "string"
@@ -910,9 +906,8 @@
         },        
 
         "mandate": {
-          "title": "Audience",
-          "type": "string",
-          "description":"A category of user for whom the resource is intended."
+          "title": "Mandate",
+          "type": "string"          
         },
 
         "pricing": {

diff --git a/api-documentation/catalog-admin/geospatial-schema.json b/api-documentation/catalog-admin/geospatial-schema.json
diff --git a/api-documentation/catalog-admin/script-schema.json b/api-documentation/catalog-admin/script-schema.json
@@ -144,6 +144,23 @@
             "title"
           ]
         },
+        "reproducibility_status": {
+          "type": "object",
+          "title": "Reproducibility status",
+          "description": "Information on the reproducibility status of the project, using a controlled vocabulary",
+          "properties": {
+            "status": {
+              "type": "string",
+              "title": "status",
+              "description": "Status"
+            },
+            "note": {
+              "type": "string",
+              "title": "Note",
+              "description": "Note"
+            }
+          }
+        },
         "abstract": {
           "type": "string",
           "title": "Abstract"
@@ -267,10 +284,7 @@
         "production_date": {
           "title": "Date of production (YYYY-MM-DD)",
           "description": "Date in ISO format when the dissemination-ready version of the research project was produced. It can be a year (YYYY), year-month (YYYY-MM), or year-month-day (YYYY-MM-DD)",
-          "type": "array",
-          "items": {
-            "type": "string"
-          }
+          "type": "string"
         },
         "version_statement": {
           "type": "object",
@@ -456,7 +470,7 @@
                 "title": "Funding Agency/Sponsor",
                 "type": "string"
               },
-              "abbr": {
+              "abbreviation": {
                 "title": "Abbreviation",
                 "type": "string"
               },
@@ -546,7 +560,7 @@
             }
           }
         },
-        "acknowledgements": {
+        "acknowledgments": {
           "type": "array",
           "title": "Other acknowledgments",
           "description": "Acknowledgments of persons or organizations (other than sponsors) who contributed to the project.",
@@ -571,9 +585,9 @@
             "name"
           ]
         },
-        "acknowledgement_statement": {
-          "title": "Acknowledgement statement",
-          "description": "Acknowledgement statement",
+        "acknowledgment_statement": {
+          "title": "Acknowledgment statement",
+          "description": "Acknowledgment statement",
           "type": "string"
         },
         "disclaimer": {
@@ -916,8 +930,8 @@
                       "title": "Person or organization name",
                       "type": "string"
                     },
-                    "abbr": {
-                      "title": "Abbreviation",
+                    "affiliation": {
+                      "title": "Affiliation",
                       "type": "string"
                     },
                     "role": {
@@ -979,6 +993,10 @@
                     "uri": {
                       "title": "License URI",
                       "type": "string"
+                    },
+                    "note": {
+                      "title": "Note",
+                      "type": "string"
                     }
                   }
                 }
@@ -1154,7 +1172,7 @@
             "required": [
               "model_id"
             ]
-          },              
+          },
           "topic_description": {
             "type": "array",
             "title": "Topic information",
@@ -1163,11 +1181,17 @@
               "properties": {
                 "topic_id": {
                   "title": "Topic identifier",
-                  "type": ["integer", "string"]
+                  "type": [
+                    "integer",
+                    "string"
+                  ]
                 },
                 "topic_score": {
                   "title": "Topic score",
-                  "type": ["number", "string"]
+                  "type": [
+                    "number",
+                    "string"
+                  ]
                 },
                 "topic_label": {
                   "title": "Topic label",
@@ -1200,12 +1224,11 @@
               "topic_id"
             ]
           }
-
         },
         "additionalProperties": false
       }
     },
-    "embeddings":{
+    "embeddings": {
       "type": "array",
       "title": "Word embeddings",
       "description": "Word embeddings",
@@ -1230,7 +1253,8 @@
           }
         },
         "required": [
-          "id","vector"
+          "id",
+          "vector"
         ]
       }
     },

diff --git a/api-documentation/catalog-admin/survey-schema.json b/api-documentation/catalog-admin/survey-schema.json
@@ -17,15 +17,7 @@
         "access_policy": {
           "type": "string",
           "title": "Data access policy",
-          "description": "Data access policy for attached microdata resources",
-          "enum": [
-            "direct",
-            "open",
-            "public",
-            "licensed",
-            "remote",
-            "data_na"
-          ],
+          "description": "Data access policy for microdata resources - valid values `direct`, `open`, `public`, `licensed`, `remote`, `data_na` ",          
           "default": "data_na"
         },
         "published": {

diff --git a/api-documentation/catalog-admin/swagger.yaml b/api-documentation/catalog-admin/swagger.yaml
@@ -40,6 +40,7 @@ x-tagGroups:
       - Scripts
       - Survey      
       - Timeseries
+      - Timeseries database
       - Geospatial
       - Images
       - Videos
@@ -762,7 +763,7 @@ paths:
   /datasets/create/timeseriesdb:
     post:
       tags:
-        - Timeseries
+        - Timeseries database
       summary: Create timeseries database
       description: Create a new timeseries database
       operationId: createTimeseriesDB
@@ -782,7 +783,37 @@ paths:
           schema:
             $ref: 'timeseries-db-schema.json'
       security:
-        - ApiKeyAuth: [] 
+        - ApiKeyAuth: []
+  /datasets/update/timeseriesdb/{IDNo}:
+    post:
+      tags:
+        - Timeseries database
+      summary: Update timeseries database
+      description: Update timeseries database
+      operationId: updateTimeseriesDB
+      consumes:
+        - application/json
+      produces:
+        - application/json
+      parameters:
+        - in: "path"
+          name: "IDNo"
+          description: Unique IDNo
+          type: string
+          format: string
+          required: true
+        - in: "body"
+          name: "body"
+          required: true
+          schema:
+            $ref: 'timeseries-db-schema.json'
+      responses:
+        '200':
+          description: successful operation
+          schema:
+            $ref: 'timeseries-db-schema.json'
+      security:
+        - ApiKeyAuth: []
   /datasets/create/timeseries:
       post:
         tags:

diff --git a/api-documentation/catalog-admin/timeseries-db-schema.json b/api-documentation/catalog-admin/timeseries-db-schema.json
@@ -187,11 +187,6 @@
 					"title": "Dataset type",
 					"description": "Dataset type"
 				},
-				"doi": {
-					"type": "string",
-					"title": "DOI",
-					"description": "DOI handle"
-				},
 				"date_created": {
 					"type": "string",
 					"title": "Date of creation",
@@ -386,6 +381,26 @@
 						]
 					}
 				},
+				"dimensions": {
+					"type": "array",
+					"description": "Dimensions",
+					"items": {
+						"type": "object",
+						"properties": {
+							"name": {
+								"title": "Name",
+								"type": "string"
+							},
+							"label": {
+								"title": "Label",
+								"type": "string"
+							}
+						},
+						"required": [
+							"name"
+						]
+					}
+				},
 				"ref_country": {
 					"type": "array",
 					"title": "Reference country",
@@ -649,6 +664,26 @@
 						]
 					}
 				},
+				"errata": {
+					"type": "array",
+					"title": "Errata",
+					"description": "List of corrected errors in data or metadata",
+					"items": {
+					  "type": "object",
+					  "properties": {
+						"date": {
+						  "title": "Date of erratum",
+						  "description": "Date when the erratum was reported or published",
+						  "type": "string"
+						},
+						"description": {
+						  "title": "Description of the erratum",
+						  "description": "A description of the erratum, with information on which data or metadata were impacted",
+						  "type": "string"
+						}
+					  }
+					}
+				  },
 				"license": {
 					"type": "array",
 					"title": "License",

diff --git a/api-documentation/catalog-admin/timeseries-schema.json b/api-documentation/catalog-admin/timeseries-schema.json
@@ -202,6 +202,10 @@
 					"items": {
 						"type": "object",
 						"properties": {
+							"name": {
+								"title": "Name",
+								"type": "string"
+							},
 							"label": {
 								"title": "Label",
 								"type": "string"
@@ -294,6 +298,10 @@
 					"type": "string",
 					"title": "Methodology"
 				},
+				"derivation": {
+					"type": "string",
+					"title": "Derivation"
+				},
 				"imputation": {
 					"type": "string",
 					"title": "Imputations"
@@ -399,10 +407,18 @@
 					"items": {
 						"type": "object",
 						"properties": {
+							"id": {
+								"title": "Unique Identifier",
+								"type": "string"
+							},
 							"name": {
 								"title": "Discipline title or name",
 								"type": "string"
 							},
+							"parent_id": {
+								"title": "Parent Identifier",
+								"type": "string"
+							},
 							"vocabulary": {
 								"title": "Vocabulary",
 								"description": "Vocabulary",
@@ -436,6 +452,10 @@
 							"end": {
 								"type": "string",
 								"title": "End"
+							},
+							"notes": {
+								"type": "string",
+								"title": "Notes"
 							}
 						}
 					}
@@ -718,6 +738,26 @@
 						]
 					}
 				},
+				"errata": {
+					"type": "array",
+					"title": "Errata",
+					"description": "List of corrected errors in data or metadata",
+					"items": {
+					  "type": "object",
+					  "properties": {
+						"date": {
+						  "title": "Date of erratum",
+						  "description": "Date when the erratum was reported or published",
+						  "type": "string"
+						},
+						"description": {
+						  "title": "Description of the erratum",
+						  "description": "A description of the erratum, with information on which data or metadata were impacted",
+						  "type": "string"
+						}
+					  }
+					}
+				  },
 				"notes": {
 					"title": "Notes",
 					"description": "Notes",