Merge pull request #81 from unicef/sdgevidence

BLD: added evidenceText, evidenceURL to SDGs in schema -> v0.7.0
DPGAlliance · Oct 8, 2020 · a9c5f40 · a9c5f40
2 parents cb04af6 + 302a5b0
commit a9c5f40
Show file tree

Hide file tree

Showing 473 changed files with 2,133 additions and 2,777 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -4,7 +4,13 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
-## Unreleased
+## [0.7.0] - 2020-10-08
+
+### Added
+- Added `scripts/migrate-v0.7.0.json` to adjust all existing JSON files to the change introduced in the `nominee-schema.json` described below.
+
+### Changed
+- [Breaking changes] Modified the JSON schema to account for SDG evidence. Thus, `SDGs` is not longer an array of enums, but an array of objects, that contains a required `SDGNumber` and an optional `evidenceText` and `evidenceURL`, one of which should be required. This field is not made mandatory retroactively, but will be required in future nominations.
 
 ## [0.6.0] - 2020-09-23
 
@@ -92,6 +98,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - Changed language from `candidates` to `nominees` to match the recent changes in [digitalpublicgoods.net](https://digitalpublicgoods.net)
 - Renamed folder from `candidates/` to `nominees/`, as well as `candidate-schema.json` to `nominee-schema.json`
 
+[0.7.0]: https://github.com/unicef/publicgoods-candidates/compare/v0.6.0...v0.7.0
 [0.6.0]: https://github.com/unicef/publicgoods-candidates/compare/v0.5.0...v0.6.0
 [0.5.0]: https://github.com/unicef/publicgoods-candidates/compare/v0.4.0...v0.5.0
 [0.4.0]: https://github.com/unicef/publicgoods-candidates/compare/v0.3.0...v0.4.0

diff --git a/nominee-schema.json b/nominee-schema.json
@@ -194,83 +194,45 @@
       "minItems": 1,
       "uniqueItems": true,
       "items": {
-        "type": "array",
-        "enum": [
-          [
-            1,
-            "No Poverty"
-          ],
-          [
-            2,
-            "Zero Hunger"
-          ],
-          [
-            3,
-            "Good Health and Well-Being"
-          ],
-          [
-            4,
-            "Quality Education"
-          ],
-          [
-            5,
-            "Gender Equality"
-          ],
-          [
-            6,
-            "Clean Water and Sanitation"
-          ],
-          [
-            7,
-            "Affordable and Clean Energy"
-          ],
-          [
-            8,
-            "Decent Work and Economic Growth"
-          ],
-          [
-            9,
-            "Industry, Innovation and Infrastructure"
-          ],
-          [
-            10,
-            "Reduced Inequalities"
-          ],
-          [
-            11,
-            "Sustainable Cities and Communities"
-          ],
-          [
-            12,
-            "Responsible Consumption and Production"
-          ],
-          [
-            13,
-            "Climate Action"
-          ],
-          [
-            14,
-            "Life Below Water"
-          ],
-          [
-            15,
-            "Life On Land"
-          ],
-          [
-            16,
-            "Peace, Justice and Strong Institutions"
-          ],
-          [
-            17,
-            "Partnerships for the Goals"
-          ]
-        ]
+        "type": "object",
+        "required": [
+          "SDGNumber"
+        ],
+        "properties": {
+          "SDGNumber": {
+            "type": "number",
+            "description": "Number of the Sustainable Development Goal",
+            "enum": [
+              1,
+              2,
+              3,
+              4,
+              5,
+              6,
+              7,
+              8,
+              9,
+              10,
+              11,
+              12,
+              13,
+              14,
+              15,
+              16,
+              17
+            ]
+          },
+          "evidenceText": {
+            "type": "string",
+            "description": "Evidence of SDG relevance in text form."
+          },
+          "evidenceURL": {
+            "type": "string",
+            "description": "Evidence of SDG relevance in the form of a link."
+          }
+        }
       }
     },
-    "SDGevidence": {
-      "type": "string",
-      "description": "Relevant links or information to support the relevance to SDGs."
-    },
     "sectors": {
       "type": "array",
       "description": "List of sectors that this Global Digital Public Good addresses.",

diff --git a/nominees/2019-ncov-data-repository-by-johns-hopkins-csse.json b/nominees/2019-ncov-data-repository-by-johns-hopkins-csse.json
@@ -9,10 +9,9 @@
     }
   ],
   "SDGs": [
-    [
-      3,
-      "Good Health and Well-Being"
-    ]
+    {
+      "SDGNumber": 3
+    }
   ],
   "type": [
     "data"

diff --git a/nominees/5calls-frontend.json b/nominees/5calls-frontend.json
@@ -9,10 +9,9 @@
     }
   ],
   "SDGs": [
-    [
-      16,
-      "Peace, Justice and Strong Institutions"
-    ]
+    {
+      "SDGNumber": 16
+    }
   ],
   "sectors": [],
   "type": [

diff --git a/nominees/5calls-ios.json b/nominees/5calls-ios.json
@@ -9,10 +9,9 @@
     }
   ],
   "SDGs": [
-    [
-      16,
-      "Peace, Justice and Strong Institutions"
-    ]
+    {
+      "SDGNumber": 16
+    }
   ],
   "sectors": [],
   "type": [

diff --git a/nominees/@firma.json b/nominees/@firma.json
@@ -9,14 +9,12 @@
     }
   ],
   "SDGs": [
-    [
-      3,
-      "Good Health and Well-Being"
-    ],
-    [
-      16,
-      "Peace, Justice and Strong Institutions"
-    ]
+    {
+      "SDGNumber": 3
+    },
+    {
+      "SDGNumber": 16
+    }
   ],
   "sectors": [],
   "type": [

diff --git a/nominees/aarogya-setu.json b/nominees/aarogya-setu.json
@@ -9,10 +9,9 @@
     }
   ],
   "SDGs": [
-    [
-      3,
-      "Good Health and Well-Being"
-    ]
+    {
+      "SDGNumber": 3
+    }
   ],
   "type": [
     "software"

diff --git a/nominees/accessibility-cloud.json b/nominees/accessibility-cloud.json
@@ -9,14 +9,12 @@
     }
   ],
   "SDGs": [
-    [
-      3,
-      "Good Health and Well-Being"
-    ],
-    [
-      10,
-      "Reduced Inequalities"
-    ]
+    {
+      "SDGNumber": 3
+    },
+    {
+      "SDGNumber": 10
+    }
   ],
   "sectors": [],
   "type": [

diff --git a/nominees/adopt-a-drain.json b/nominees/adopt-a-drain.json
@@ -9,10 +9,9 @@
     }
   ],
   "SDGs": [
-    [
-      11,
-      "Sustainable Cities and Communities"
-    ]
+    {
+      "SDGNumber": 11
+    }
   ],
   "sectors": [],
   "type": [

diff --git a/nominees/afinidata.json b/nominees/afinidata.json
@@ -9,10 +9,9 @@
     }
   ],
   "SDGs": [
-    [
-      4,
-      "Quality Education"
-    ]
+    {
+      "SDGNumber": 4
+    }
   ],
   "sectors": [],
   "type": [

diff --git a/nominees/african-storybook.json b/nominees/african-storybook.json
@@ -9,10 +9,9 @@
     }
   ],
   "SDGs": [
-    [
-      4,
-      "Quality Education"
-    ]
+    {
+      "SDGNumber": 4
+    }
   ],
   "sectors": [],
   "type": [

diff --git a/nominees/agrosense.json b/nominees/agrosense.json
@@ -9,14 +9,12 @@
     }
   ],
   "SDGs": [
-    [
-      2,
-      "Zero Hunger"
-    ],
-    [
-      9,
-      "Industry, Innovation and Infrastructure"
-    ]
+    {
+      "SDGNumber": 2
+    },
+    {
+      "SDGNumber": 9
+    }
   ],
   "sectors": [],
   "type": [

diff --git a/nominees/aid-transparency-tracker.json b/nominees/aid-transparency-tracker.json
@@ -9,10 +9,9 @@
     }
   ],
   "SDGs": [
-    [
-      16,
-      "Peace, Justice and Strong Institutions"
-    ]
+    {
+      "SDGNumber": 16
+    }
   ],
   "sectors": [],
   "type": [

diff --git a/nominees/alaveteli.json b/nominees/alaveteli.json
@@ -9,10 +9,9 @@
     }
   ],
   "SDGs": [
-    [
-      16,
-      "Peace, Justice and Strong Institutions"
-    ]
+    {
+      "SDGNumber": 16
+    }
   ],
   "sectors": [],
   "type": [

diff --git a/nominees/alex-atom-linter.json b/nominees/alex-atom-linter.json
@@ -9,10 +9,9 @@
     }
   ],
   "SDGs": [
-    [
-      11,
-      "Sustainable Cities and Communities"
-    ]
+    {
+      "SDGNumber": 11
+    }
   ],
   "sectors": [],
   "type": [

diff --git a/nominees/alex-sublime-linter.json b/nominees/alex-sublime-linter.json
@@ -9,10 +9,9 @@
     }
   ],
   "SDGs": [
-    [
-      11,
-      "Sustainable Cities and Communities"
-    ]
+    {
+      "SDGNumber": 11
+    }
   ],
   "sectors": [],
   "type": [

diff --git a/nominees/alex.json b/nominees/alex.json
@@ -9,10 +9,9 @@
     }
   ],
   "SDGs": [
-    [
-      11,
-      "Sustainable Cities and Communities"
-    ]
+    {
+      "SDGNumber": 11
+    }
   ],
   "sectors": [],
   "type": [

diff --git a/nominees/all-ready.json b/nominees/all-ready.json
@@ -9,10 +9,9 @@
     }
   ],
   "SDGs": [
-    [
-      16,
-      "Peace, Justice and Strong Institutions"
-    ]
+    {
+      "SDGNumber": 16
+    }
   ],
   "sectors": [],
   "type": [