Update schemas per feedback

dotnet · Jul 30, 2024 · e868532 · e868532
1 parent 7f92191
commit e868532
Show file tree

Hide file tree

Showing 6 changed files with 85 additions and 40 deletions.
diff --git a/release-notes/schemas/dotnet-os-packages.json b/release-notes/schemas/dotnet-os-packages.json
@@ -69,7 +69,8 @@
           "id",
           "name",
           "required-scenarios"
-        ]
+        ],
+        "additionalProperties": false
       }
     },
     "distributions": {
@@ -122,7 +123,8 @@
               "required": [
                 "run-under-sudo",
                 "command-root"
-              ]
+              ],
+              "additionalProperties": false
             }
           },
           "releases": {
@@ -144,6 +146,7 @@
                   "type": "string"
                 },
                 "packages": {
+                  "description": "The packages required by the distro release.",
                   "type": "array",
                   "items": {
                     "description": "A distro archive package to install, with a reference to a logical package with more information.",
@@ -164,29 +167,33 @@
                     "required": [
                       "id",
                       "name"
-                    ]
+                    ],
+                    "additionalProperties": false
                   }
                 }
               },
               "required": [
                 "name",
                 "release",
                 "packages"
-              ]
+              ],
+              "additionalProperties": false
             }
           }
         },
         "required": [
           "name",
           "install-commands",
           "releases"
-        ]
+        ],
+        "additionalProperties": false
       }
     }
   },
   "required": [
     "channel-version",
     "packages",
     "distributions"
-  ]
+  ],
+  "additionalProperties": false
 }
diff --git a/release-notes/schemas/dotnet-patch-release.json b/release-notes/schemas/dotnet-patch-release.json
@@ -1,4 +1,5 @@
 {
+  "description": "A patch release for a major product version.",
   "type": [
     "object",
     "null"
@@ -60,7 +61,8 @@
             "required": [
               "cve-id",
               "cve-url"
-            ]
+            ],
+            "additionalProperties": false
           }
         },
         "release-notes": {
@@ -123,7 +125,8 @@
                   "rid",
                   "url",
                   "hash"
-                ]
+                ],
+                "additionalProperties": false
               }
             },
             "vs-support": {
@@ -140,7 +143,8 @@
             "version-display",
             "vs-version",
             "files"
-          ]
+          ],
+          "additionalProperties": false
         },
         "sdk": {
           "description": "SDK component of the release (primary SDK release).",
@@ -218,7 +222,8 @@
                   "rid",
                   "url",
                   "hash"
-                ]
+                ],
+                "additionalProperties": false
               }
             }
           },
@@ -232,7 +237,8 @@
             "fsharp-version",
             "vb-version",
             "files"
-          ]
+          ],
+          "additionalProperties": false
         },
         "sdks": {
           "description": "SDK components of the release (often multiple, otherwise a repeat of \u0060Sdk\u0060 value within an array).",
@@ -316,7 +322,8 @@
                     "rid",
                     "url",
                     "hash"
-                  ]
+                  ],
+                  "additionalProperties": false
                 }
               }
             },
@@ -330,7 +337,8 @@
               "fsharp-version",
               "vb-version",
               "files"
-            ]
+            ],
+            "additionalProperties": false
           }
         },
         "aspnetcore-runtime": {
@@ -399,7 +407,8 @@
                   "rid",
                   "url",
                   "hash"
-                ]
+                ],
+                "additionalProperties": false
               }
             }
           },
@@ -409,7 +418,8 @@
             "version-aspnetcoremodule",
             "vs-version",
             "files"
-          ]
+          ],
+          "additionalProperties": false
         },
         "windowsdesktop": {
           "description": "Windows Desktop component of the release.",
@@ -466,7 +476,8 @@
                   "rid",
                   "url",
                   "hash"
-                ]
+                ],
+                "additionalProperties": false
               }
             }
           },
@@ -475,6 +486,7 @@
             "version-display",
             "files"
           ],
+          "additionalProperties": false,
           "default": null
         }
       },
@@ -488,7 +500,8 @@
         "sdk",
         "sdks",
         "aspnetcore-runtime"
-      ]
+      ],
+      "additionalProperties": false
     }
   },
   "required": [
@@ -497,5 +510,6 @@
     "release-version",
     "security",
     "release"
-  ]
+  ],
+  "additionalProperties": false
 }
diff --git a/release-notes/schemas/dotnet-patch-releases-index.json b/release-notes/schemas/dotnet-patch-releases-index.json
@@ -40,6 +40,7 @@
       "description": "Set of patch releases.",
       "type": "array",
       "items": {
+        "description": "A patch release, including the version, and whether it included security updates.",
         "type": [
           "object",
           "null"
@@ -68,7 +69,8 @@
           "release-date",
           "security",
           "release-info-uri"
-        ]
+        ],
+        "additionalProperties": false
       }
     }
   },
@@ -80,5 +82,6 @@
     "supported-os-info-uri",
     "os-packages-info-uri",
     "releases"
-  ]
+  ],
+  "additionalProperties": false
 }
diff --git a/release-notes/schemas/dotnet-releases-index.json b/release-notes/schemas/dotnet-releases-index.json
@@ -75,7 +75,7 @@
             "type": "string"
           },
           "patch-releases-index-uri": {
-            "description": "Link to index file of detailed release descriptions  (JSON format), with one file per patch release.",
+            "description": "Link to index file of detailed release descriptions (JSON format), with one file per patch release.",
             "type": [
               "string",
               "null"
@@ -120,11 +120,13 @@
           "release-type",
           "releases.json",
           "patch-releases-info-uri"
-        ]
+        ],
+        "additionalProperties": false
       }
     }
   },
   "required": [
     "releases-index"
-  ]
+  ],
+  "additionalProperties": false
 }