Warn on docs.microsoft.com (part 2) (#763)

packages/rulesets/CHANGELOG.md

@@ -1,5 +1,12 @@
 # Change Log - @microsoft.azure/openapi-validator-rulesets
 
+## 2.1.5
+Tue, 14 Feb 2025 19:10:00 GMT
+
+### Patches
+
+- [AvoidMsdnReferences] Fix addition of "docs.microsoft.com" to disallow list
+
 ## 2.1.4
 Tue, 14 Feb 2025 19:10:00 GMT
 

packages/rulesets/generated/spectral/az-arm.js

@@ -28,16 +28,16 @@ const avoidMsdnReferences = (swaggerObj, _opts, paths) => {
     if (swaggerObj === null) {
         return [];
     }
-    if (typeof swaggerObj === "string" && !swaggerObj.includes("https://msdn.microsoft.com"))
+    if (typeof swaggerObj === "string" && !(swaggerObj.includes("https://msdn.microsoft.com") || swaggerObj.includes("https://docs.microsoft.com")))
         return [];
     if (typeof swaggerObj === "object") {
         const docUrl = swaggerObj.url;
-        if (docUrl === undefined || !docUrl.startsWith("https://msdn.microsoft.com"))
+        if (docUrl === undefined || !(docUrl.startsWith("https://msdn.microsoft.com") || docUrl.startsWith("https://docs.microsoft.com")))
             return [];
     }
     const path = paths.path || [];
     return [{
-            message: 'For better generated code quality, remove all references to "msdn.microsoft.com".',
+            message: 'For better generated code quality, remove all references to "msdn.microsoft.com" and "docs.microsoft.com".',
             path,
         }];
 };
@@ -1277,8 +1277,8 @@ const ruleset$1 = {
             },
         },
         AvoidMsdnReferences: {
-            description: 'The documentation is being generated from the OpenAPI(swagger) and published at "docs.microsoft.com". From that perspective, documentation team would like to avoid having links to the "msdn.microsoft.com" in the OpenAPI(swagger) and SDK documentations.',
-            message: 'For better generated code quality, remove all references to "msdn.microsoft.com".',
+            description: 'The documentation is being generated from the OpenAPI(swagger) and published at "learn.microsoft.com". From that perspective, documentation team would like to avoid having links to the "msdn.microsoft.com" or "docs.microsoft.com" in the OpenAPI(swagger) and SDK documentations.',
+            message: 'For better generated code quality, remove all references to "msdn.microsoft.com" and "docs.microsoft.com".',
             severity: "warn",
             resolved: false,
             formats: [oas2],

packages/rulesets/generated/spectral/az-common.js

@@ -1031,8 +1031,8 @@ const ruleset = {
             },
         },
         AvoidMsdnReferences: {
-            description: 'The documentation is being generated from the OpenAPI(swagger) and published at "docs.microsoft.com". From that perspective, documentation team would like to avoid having links to the "msdn.microsoft.com" in the OpenAPI(swagger) and SDK documentations.',
-            message: 'For better generated code quality, remove all references to "msdn.microsoft.com".',
+            description: 'The documentation is being generated from the OpenAPI(swagger) and published at "learn.microsoft.com". From that perspective, documentation team would like to avoid having links to the "msdn.microsoft.com" or "docs.microsoft.com" in the OpenAPI(swagger) and SDK documentations.',
+            message: 'For better generated code quality, remove all references to "msdn.microsoft.com" and "docs.microsoft.com".',
             severity: "warn",
             resolved: false,
             formats: [oas2],

packages/rulesets/generated/spectral/az-dataplane.js

@@ -1061,8 +1061,8 @@ const ruleset$1 = {
             },
         },
         AvoidMsdnReferences: {
-            description: 'The documentation is being generated from the OpenAPI(swagger) and published at "docs.microsoft.com". From that perspective, documentation team would like to avoid having links to the "msdn.microsoft.com" in the OpenAPI(swagger) and SDK documentations.',
-            message: 'For better generated code quality, remove all references to "msdn.microsoft.com".',
+            description: 'The documentation is being generated from the OpenAPI(swagger) and published at "learn.microsoft.com". From that perspective, documentation team would like to avoid having links to the "msdn.microsoft.com" or "docs.microsoft.com" in the OpenAPI(swagger) and SDK documentations.',
+            message: 'For better generated code quality, remove all references to "msdn.microsoft.com" and "docs.microsoft.com".',
             severity: "warn",
             resolved: false,
             formats: [oas2],

packages/rulesets/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@microsoft.azure/openapi-validator-rulesets",
-  "version": "2.1.4",
+  "version": "2.1.5",
   "description": "Azure OpenAPI Validator",
   "main": "dist/index.js",
   "scripts": {

packages/rulesets/src/spectral/az-common.ts

@@ -491,8 +491,8 @@ const ruleset: any = {
     },
     AvoidMsdnReferences: {
       description:
-        'The documentation is being generated from the OpenAPI(swagger) and published at "docs.microsoft.com". From that perspective, documentation team would like to avoid having links to the "msdn.microsoft.com" in the OpenAPI(swagger) and SDK documentations.',
-      message: 'For better generated code quality, remove all references to "msdn.microsoft.com".',
+        'The documentation is being generated from the OpenAPI(swagger) and published at "learn.microsoft.com". From that perspective, documentation team would like to avoid having links to the "msdn.microsoft.com" or "docs.microsoft.com" in the OpenAPI(swagger) and SDK documentations.',
+      message: 'For better generated code quality, remove all references to "msdn.microsoft.com" and "docs.microsoft.com".',
       severity: "warn",
       resolved: false,
       formats: [oas2],