ci: switches to public API analyzer

Copilot · baywet · baywet · commit d49ea64e6a31 · 2026-01-27T15:41:44.000-05:00
* Initial plan

* Convert PublicApi.approved.txt to PublicApiAnalyzers format

- Converted test/Microsoft.OpenApi.Tests/PublicApi/PublicApi.approved.txt (2152 lines)
  to src/Microsoft.OpenApi/PublicAPI.Shipped.txt (1844 entries)
- Generated PublicAPI.Shipped.txt and PublicAPI.Unshipped.txt files for both
  Microsoft.OpenApi and Microsoft.OpenApi.YamlReader projects
- Added Microsoft.CodeAnalysis.PublicApiAnalyzers package reference in Directory.Build.props

The conversion extracted 1843 public API declarations from the PublicApiGenerator
format and converted them to the Microsoft.CodeAnalysis.PublicApiAnalyzers format:
- Types (classes, interfaces, structs, enums, delegates)
- Constructors
- Methods
- Properties (with get/set accessors)
- Fields (including const fields)
- Events
- Enum values with their numeric assignments

Note: Build validation and potential missing API entries will need to be addressed
in follow-up work as the PublicApiAnalyzers may identify additional public APIs
not captured in the original PublicApiGenerator output.

* Populate PublicAPI.Shipped.txt for Microsoft.OpenApi project

Co-authored-by: baywet &lt;7905502+baywet@users.noreply.github.com&gt;

* Remove backup files

* Fix PublicAPI.Unshipped.txt for Microsoft.OpenApi.YamlReader

- Generated public API using PublicApiGenerator for Microsoft.OpenApi.YamlReader assembly
- Converted to PublicApiAnalyzers format and added to PublicAPI.Unshipped.txt
- Made static ReadFragment&lt;T&gt;(JsonNode...) method internal to resolve RS0016 and RS0026 analyzer errors
- Resolved RS0016/RS0017 analyzer errors for YamlReader project
- Note: RS0036 nullability annotation warnings remain but are separate from PublicAPI format issues

Co-authored-by: baywet &lt;7905502+baywet@users.noreply.github.com&gt;

* chore: removes old unit test based public API validation

Signed-off-by: Vincent Biret &lt;vibiret@microsoft.com&gt;

* chore: reverts copilot hallucination

Signed-off-by: Vincent Biret &lt;vibiret@microsoft.com&gt;

* chore: moves the analyzer to library projects only

* chore: refreshes API export

Signed-off-by: Vincent Biret &lt;vibiret@microsoft.com&gt;

---------

Signed-off-by: Vincent Biret &lt;vibiret@microsoft.com&gt;
Co-authored-by: copilot-swe-agent[bot] &lt;198982749+Copilot@users.noreply.github.com&gt;
Co-authored-by: baywet &lt;7905502+baywet@users.noreply.github.com&gt;
Co-authored-by: Vincent Biret &lt;vibiret@microsoft.com&gt;
diff --git a/src/Microsoft.OpenApi.YamlReader/Microsoft.OpenApi.YamlReader.csproj b/src/Microsoft.OpenApi.YamlReader/Microsoft.OpenApi.YamlReader.csproj
@@ -28,6 +28,11 @@
 
     <ItemGroup>
 
+        <PackageReference Include="Microsoft.CodeAnalysis.PublicApiAnalyzers" Version="3.3.4">
+          <IncludeAssets>runtime; build; native; contentfiles; analyzers; buildtransitive</IncludeAssets>
+          <PrivateAssets>all</PrivateAssets>
+        </PackageReference>
+
         <PackageReference Include="Microsoft.VisualStudio.Threading.Analyzers" Version="17.14.15">
           <IncludeAssets>runtime; build; native; contentfiles; analyzers; buildtransitive</IncludeAssets>
           <PrivateAssets>all</PrivateAssets>
diff --git a/src/Microsoft.OpenApi.YamlReader/PublicAPI.Shipped.txt b/src/Microsoft.OpenApi.YamlReader/PublicAPI.Shipped.txt
@@ -0,0 +1,17 @@
+#nullable enable
+Microsoft.OpenApi.Reader.OpenApiReaderSettingsExtensions
+Microsoft.OpenApi.YamlReader.OpenApiYamlReader
+Microsoft.OpenApi.YamlReader.OpenApiYamlReader.OpenApiYamlReader() -> void
+Microsoft.OpenApi.YamlReader.OpenApiYamlReader.Read(System.IO.MemoryStream! input, System.Uri! location, Microsoft.OpenApi.Reader.OpenApiReaderSettings! settings) -> Microsoft.OpenApi.Reader.ReadResult!
+Microsoft.OpenApi.YamlReader.OpenApiYamlReader.ReadAsync(System.IO.Stream! input, System.Uri! location, Microsoft.OpenApi.Reader.OpenApiReaderSettings! settings, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task<Microsoft.OpenApi.Reader.ReadResult!>!
+Microsoft.OpenApi.YamlReader.OpenApiYamlReader.ReadFragment<T>(System.IO.MemoryStream! input, Microsoft.OpenApi.OpenApiSpecVersion version, Microsoft.OpenApi.OpenApiDocument! openApiDocument, out Microsoft.OpenApi.Reader.OpenApiDiagnostic! diagnostic, Microsoft.OpenApi.Reader.OpenApiReaderSettings? settings = null) -> T?
+Microsoft.OpenApi.YamlReader.YamlConverter
+static Microsoft.OpenApi.Reader.OpenApiReaderSettingsExtensions.AddYamlReader(this Microsoft.OpenApi.Reader.OpenApiReaderSettings! settings) -> void
+static Microsoft.OpenApi.YamlReader.OpenApiYamlReader.Read(System.Text.Json.Nodes.JsonNode! jsonNode, System.Uri! location, Microsoft.OpenApi.Reader.OpenApiReaderSettings! settings) -> Microsoft.OpenApi.Reader.ReadResult!
+static Microsoft.OpenApi.YamlReader.OpenApiYamlReader.ReadFragment<T>(System.Text.Json.Nodes.JsonNode! input, Microsoft.OpenApi.OpenApiSpecVersion version, Microsoft.OpenApi.OpenApiDocument! openApiDocument, out Microsoft.OpenApi.Reader.OpenApiDiagnostic! diagnostic, Microsoft.OpenApi.Reader.OpenApiReaderSettings? settings = null) -> T?
+static Microsoft.OpenApi.YamlReader.YamlConverter.ToJsonArray(this SharpYaml.Serialization.YamlSequenceNode! yaml) -> System.Text.Json.Nodes.JsonArray!
+static Microsoft.OpenApi.YamlReader.YamlConverter.ToJsonNode(this SharpYaml.Serialization.YamlDocument! yaml) -> System.Text.Json.Nodes.JsonNode!
+static Microsoft.OpenApi.YamlReader.YamlConverter.ToJsonNode(this SharpYaml.Serialization.YamlNode! yaml) -> System.Text.Json.Nodes.JsonNode!
+static Microsoft.OpenApi.YamlReader.YamlConverter.ToJsonNode(this SharpYaml.Serialization.YamlStream! yaml) -> System.Collections.Generic.IEnumerable<System.Text.Json.Nodes.JsonNode!>!
+static Microsoft.OpenApi.YamlReader.YamlConverter.ToJsonObject(this SharpYaml.Serialization.YamlMappingNode! yaml) -> System.Text.Json.Nodes.JsonObject!
+static Microsoft.OpenApi.YamlReader.YamlConverter.ToYamlNode(this System.Text.Json.Nodes.JsonNode! json) -> SharpYaml.Serialization.YamlNode!
diff --git a/src/Microsoft.OpenApi.YamlReader/PublicAPI.Unshipped.txt b/src/Microsoft.OpenApi.YamlReader/PublicAPI.Unshipped.txt
@@ -0,0 +1 @@
+#nullable enable
diff --git a/src/Microsoft.OpenApi/Microsoft.OpenApi.csproj b/src/Microsoft.OpenApi/Microsoft.OpenApi.csproj
@@ -24,6 +24,10 @@
         <ContinuousIntegrationBuild>true</ContinuousIntegrationBuild>
     </PropertyGroup>
     <ItemGroup>        
+        <PackageReference Include="Microsoft.CodeAnalysis.PublicApiAnalyzers" Version="3.3.4">
+          <IncludeAssets>runtime; build; native; contentfiles; analyzers; buildtransitive</IncludeAssets>
+          <PrivateAssets>all</PrivateAssets>
+        </PackageReference>        
         <PackageReference Include="System.Text.Json" Version="[8.0.5,)" />
         <NuGetAuditSuppress Include="https://github.com/advisories/GHSA-hh2w-p6rv-4g7w" />
         <NuGetAuditSuppress Include="https://github.com/advisories/GHSA-8g4q-xg66-9fp4" />
diff --git a/src/Microsoft.OpenApi/PublicAPI.Shipped.txt b/src/Microsoft.OpenApi/PublicAPI.Shipped.txt
diff --git a/src/Microsoft.OpenApi/PublicAPI.Unshipped.txt b/src/Microsoft.OpenApi/PublicAPI.Unshipped.txt
@@ -0,0 +1 @@
+#nullable enable
diff --git a/test/Microsoft.OpenApi.Tests/Microsoft.OpenApi.Tests.csproj b/test/Microsoft.OpenApi.Tests/Microsoft.OpenApi.Tests.csproj
@@ -18,7 +18,6 @@
     <PackageReference Include="xunit" Version="2.9.3" />
     <PackageReference Include="xunit.runner.visualstudio" Version="3.1.5" PrivateAssets="all" />
     <PackageReference Include="Microsoft.CSharp" Version="4.7.0" />
-    <PackageReference Include="PublicApiGenerator" Version="11.5.0" />
   </ItemGroup>
 
   <ItemGroup>
diff --git a/test/Microsoft.OpenApi.Tests/PublicApi/PublicApi.approved.txt b/test/Microsoft.OpenApi.Tests/PublicApi/PublicApi.approved.txt
diff --git a/test/Microsoft.OpenApi.Tests/PublicApi/PublicApiTests.cs b/test/Microsoft.OpenApi.Tests/PublicApi/PublicApiTests.cs
