File level exclusions

.vscode/settings.json

@@ -1,10 +1,16 @@
 {
-    "cSpell.words": [
-        "CSDL",
-        "Edmx",
-        "intune",
-        "Markdig",
-        "Mooncake",
-        "olders"
-    ]
+  "cSpell.words": [
+    "CSDL",
+    "Edmx",
+    "intune",
+    "Markdig",
+    "Mooncake",
+    "olders"
+  ],
+  "json.schemas": [
+    {
+      "fileMatch": ["cloud-exclusions.json"],
+      "url": "./schema/cloud.exclusions.schema.json"
+    }
+  ]
 }

CheckCloudSupport.slnx

@@ -0,0 +1,8 @@
+<Solution>
+  <Folder Name="/src/">
+    <Project Path="src/CheckCloudSupport.csproj" />
+  </Folder>
+  <Folder Name="/test/">
+    <Project Path="test/CheckCloudSupportTests.csproj" />
+  </Folder>
+</Solution>

schema/cloud.exclusions.schema.json

@@ -14,6 +14,10 @@
           "description": "The HTTP method for the API to exclude.",
           "type": "string"
         },
+        "fileName": {
+          "description": "The API doc file name. Setting this property excludes all APIs in the specified file from the specified cloud.",
+          "type": "string"
+        },
         "cloud": {
           "description": "The cloud to exclude this API from. Must be 'Global', 'UsGov', or 'China'.",
           "type": "string",
@@ -22,13 +26,23 @@
             "UsGov",
             "China"
           ]
+        },
+        "description": {
+          "description": "A description of the reason for the exclusion.",
+          "type": "string"
         }
       },
       "required": [
-        "apiPath",
-        "operation",
         "cloud"
       ],
+      "oneOf": [
+        {
+          "required": ["apiPath", "operation"]
+        },
+        {
+          "required": ["fileName"]
+        }
+      ],
       "additionalProperties": false
     }
   },

src/CheckCloudSupport.csproj

@@ -14,7 +14,7 @@
   </ItemGroup>
 
   <ItemGroup>
-    <PackageReference Include="Markdig" Version="0.45.0" />
+    <PackageReference Include="Markdig" Version="1.1.1" />
     <PackageReference Include="Microsoft.Extensions.Logging.Console" Version="10.0.3" />
     <PackageReference Include="Microsoft.OpenApi" Version="3.4.0" />
     <PackageReference Include="Microsoft.OpenApi.OData" Version="3.1.0" />

src/Extensions/OpenApiUrlTreeNodeExtensions.cs

@@ -99,27 +99,35 @@ public static class OpenApiUrlTreeNodeExtensions
     /// </summary>
     /// <param name="node">The API URL node to check.</param>
     /// <param name="method">The HTTP method to check for.</param>
+    /// <param name="filePath">The API document file path.</param>
     /// <returns>The <see cref="CloudSupportStatus"/> indicating the cloud support status of the API.</returns>
-    public static CloudSupportStatus GetCloudSupportStatus(this OpenApiUrlTreeNode node, HttpMethod? method)
+    public static CloudSupportStatus GetCloudSupportStatus(
+        this OpenApiUrlTreeNode node,
+        HttpMethod? method,
+        string filePath)
     {
         if (method == null)
         {
             return CloudSupportStatus.Unknown;
         }
 
+        var fileName = Path.GetFileName(filePath);
+
         if (node.Path.EndsWith("\\bundles\\{driveItem-id}"))
-            {
-                method = HttpMethod.Get;
-            }
+        {
+            method = HttpMethod.Get;
+        }
 
         var supportsGlobal = node.PathItems.ContainsKey("Global") &&
             (node.PathItems["Global"].Operations?.ContainsKey(method) ?? false);
         var supportsUsGov = node.PathItems.ContainsKey("UsGov") &&
             (node.PathItems["UsGov"].Operations?.ContainsKey(method) ?? false) &&
-            !OpenAPIOverrides.CheckIfCloudExcluded(node.Path, method, "UsGov");
+            !OpenAPIOverrides.CheckIfCloudExcluded(node.Path, method, "UsGov") &&
+            !OpenAPIOverrides.CheckIfCloudExcludedForFile(fileName, "UsGov");
         var supportsChina = node.PathItems.ContainsKey("China") &&
             (node.PathItems["China"].Operations?.ContainsKey(method) ?? false) &&
-            !OpenAPIOverrides.CheckIfCloudExcluded(node.Path, method, "China");
+            !OpenAPIOverrides.CheckIfCloudExcluded(node.Path, method, "China") &&
+            !OpenAPIOverrides.CheckIfCloudExcludedForFile(fileName, "China");
 
         if (!supportsGlobal)
         {

src/OpenAPI/CloudExclusion.cs

@@ -24,6 +24,13 @@ public class CloudExclusion
     [JsonPropertyName("operation")]
     public string? Operation { get;  set; }
 
+    /// <summary>
+    /// Gets or sets the API doc file name. Setting this property excludes
+    /// all APIs in the specified file from the specified cloud.
+    /// </summary>
+    [JsonPropertyName("fileName")]
+    public string? FileName { get; set; }
+
     /// <summary>
     /// Gets or sets the cloud to exclude.
     /// </summary>

src/OpenAPI/OpenAPIOverrides.cs

@@ -58,6 +58,19 @@ public static bool CheckIfCloudExcluded(string apiPath, HttpMethod? method, stri
             string.Compare(e.Cloud, cloud, StringComparison.InvariantCultureIgnoreCase) == 0) ?? false;
     }
 
+    /// <summary>
+    /// Checks if a cloud is excluded for a given API doc file. This is used to exclude entire
+    /// files of APIs that don't function in certain clouds, even if the individual API paths aren't known.
+    /// </summary>
+    /// <param name="fileName">The name of the API doc file to check for an exclusion for.</param>
+    /// <param name="cloud">The cloud to check.</param>
+    /// <returns>True if the given cloud is excluded for the specified file.</returns>
+    public static bool CheckIfCloudExcludedForFile(string fileName, string cloud)
+    {
+        return cloudExclusions?.Any(e => string.Compare(e.FileName, fileName, StringComparison.InvariantCultureIgnoreCase) == 0 &&
+            string.Compare(e.Cloud, cloud, StringComparison.InvariantCultureIgnoreCase) == 0) ?? false;
+    }
+
     private static void LoadOverridesFromJson(string? jsonFile)
     {
         if (!string.IsNullOrEmpty(jsonFile))

src/Program.cs

@@ -148,7 +148,7 @@
                 continue;
             }
 
-            var supportStatus = operationNode.GetCloudSupportStatus(operation.Method);
+            var supportStatus = operationNode.GetCloudSupportStatus(operation.Method, apiDoc.FilePath);
             OutputLogger.Logger?.LogInformation("{path} support status: {status}", operation.Path, supportStatus);
             if (supportStatus != CloudSupportStatus.Unknown &&
                 apiDoc.CloudSupportStatus != CloudSupportStatus.Unknown &&
@@ -327,7 +327,7 @@
                 continue;
             }
 
-            var supportStatus = operationNode.GetCloudSupportStatus(operation.Method);
+            var supportStatus = operationNode.GetCloudSupportStatus(operation.Method, apiDoc.FilePath);
             OutputLogger.Logger?.LogInformation("{version} {path} support status: {status}", "v1", operation.Path, supportStatus);
             if (supportStatus != CloudSupportStatus.Unknown &&
                 v1CloudSupportStatus != CloudSupportStatus.Unknown &&
@@ -364,7 +364,7 @@
                 continue;
             }
 
-            var supportStatus = operationNode.GetCloudSupportStatus(operation.Method);
+            var supportStatus = operationNode.GetCloudSupportStatus(operation.Method, apiDoc.FilePath);
             OutputLogger.Logger?.LogInformation("{version} {path} support status: {status}", "beta", operation.Path, supportStatus);
             if (supportStatus != CloudSupportStatus.Unknown &&
                 betaCloudSupportStatus != CloudSupportStatus.Unknown &&

test/CheckCloudSupportTests.csproj

@@ -16,7 +16,7 @@
       <IncludeAssets>runtime; build; native; contentfiles; analyzers; buildtransitive</IncludeAssets>
       <PrivateAssets>all</PrivateAssets>
     </PackageReference>
-    <PackageReference Include="coverlet.collector" Version="6.0.4">
+    <PackageReference Include="coverlet.collector" Version="8.0.0">
       <IncludeAssets>runtime; build; native; contentfiles; analyzers; buildtransitive</IncludeAssets>
       <PrivateAssets>all</PrivateAssets>
     </PackageReference>