Skip to content

Commit a75f4ad

Browse files
martincostellomartincostello
committed
Add public API analysers
- Add public API analysers. - Add public API baselines. Resolves #2801.
1 parent ef0c1d1 commit a75f4ad

35 files changed

+834
-1
lines changed

‎Directory.Packages.props‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,7 @@
1818
<PackageVersion Include="Microsoft.AspNetCore.Routing" Version="2.1.0" />
1919
<PackageVersion Include="Microsoft.AspNetCore.StaticFiles" Version="2.1.0" />
2020
<PackageVersion Include="Microsoft.AspNetCore.TestHost" Version="6.0.29" />
21+
<PackageVersion Include="Microsoft.CodeAnalysis.PublicApiAnalyzers" Version="3.3.4" />
2122
<PackageVersion Include="Microsoft.Extensions.FileProviders.Embedded" Version="2.1.0" />
2223
<PackageVersion Include="Microsoft.OpenApi" Version="1.6.14" />
2324
<PackageVersion Include="Microsoft.OpenApi.Readers" Version="1.6.14" />
@@ -32,4 +33,4 @@
3233
<PackageVersion Include="xunit.core" Version="2.8.0" />
3334
<PackageVersion Include="xunit.runner.visualstudio" Version="2.8.0" />
3435
</ItemGroup>
35-
</Project>
36+
</Project>

‎src/Swashbuckle.AspNetCore.Annotations/PublicAPI/PublicAPI.Shipped.txt‎

Lines changed: 91 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,91 @@
1+
Microsoft.Extensions.DependencyInjection.AnnotationsSwaggerGenOptionsExtensions
2+
static Microsoft.Extensions.DependencyInjection.AnnotationsSwaggerGenOptionsExtensions.EnableAnnotations(this Swashbuckle.AspNetCore.SwaggerGen.SwaggerGenOptions options) -> void
3+
static Microsoft.Extensions.DependencyInjection.AnnotationsSwaggerGenOptionsExtensions.EnableAnnotations(this Swashbuckle.AspNetCore.SwaggerGen.SwaggerGenOptions options, bool enableAnnotationsForInheritance, bool enableAnnotationsForPolymorphism) -> void
4+
static Swashbuckle.AspNetCore.Annotations.AnnotationsOperationFilter.ApplySwaggerOperationFilterAttributes(Microsoft.OpenApi.Models.OpenApiOperation operation, Swashbuckle.AspNetCore.SwaggerGen.OperationFilterContext context, System.Collections.Generic.IEnumerable<object> controllerAndActionAttributes) -> void
5+
Swashbuckle.AspNetCore.Annotations.AnnotationsDocumentFilter
6+
Swashbuckle.AspNetCore.Annotations.AnnotationsDocumentFilter.AnnotationsDocumentFilter() -> void
7+
Swashbuckle.AspNetCore.Annotations.AnnotationsDocumentFilter.Apply(Microsoft.OpenApi.Models.OpenApiDocument swaggerDoc, Swashbuckle.AspNetCore.SwaggerGen.DocumentFilterContext context) -> void
8+
Swashbuckle.AspNetCore.Annotations.AnnotationsOperationFilter
9+
Swashbuckle.AspNetCore.Annotations.AnnotationsOperationFilter.AnnotationsOperationFilter() -> void
10+
Swashbuckle.AspNetCore.Annotations.AnnotationsOperationFilter.Apply(Microsoft.OpenApi.Models.OpenApiOperation operation, Swashbuckle.AspNetCore.SwaggerGen.OperationFilterContext context) -> void
11+
Swashbuckle.AspNetCore.Annotations.AnnotationsParameterFilter
12+
Swashbuckle.AspNetCore.Annotations.AnnotationsParameterFilter.AnnotationsParameterFilter() -> void
13+
Swashbuckle.AspNetCore.Annotations.AnnotationsParameterFilter.Apply(Microsoft.OpenApi.Models.OpenApiParameter parameter, Swashbuckle.AspNetCore.SwaggerGen.ParameterFilterContext context) -> void
14+
Swashbuckle.AspNetCore.Annotations.AnnotationsRequestBodyFilter
15+
Swashbuckle.AspNetCore.Annotations.AnnotationsRequestBodyFilter.AnnotationsRequestBodyFilter() -> void
16+
Swashbuckle.AspNetCore.Annotations.AnnotationsRequestBodyFilter.Apply(Microsoft.OpenApi.Models.OpenApiRequestBody requestBody, Swashbuckle.AspNetCore.SwaggerGen.RequestBodyFilterContext context) -> void
17+
Swashbuckle.AspNetCore.Annotations.AnnotationsSchemaFilter
18+
Swashbuckle.AspNetCore.Annotations.AnnotationsSchemaFilter.AnnotationsSchemaFilter(System.IServiceProvider serviceProvider) -> void
19+
Swashbuckle.AspNetCore.Annotations.AnnotationsSchemaFilter.Apply(Microsoft.OpenApi.Models.OpenApiSchema schema, Swashbuckle.AspNetCore.SwaggerGen.SchemaFilterContext context) -> void
20+
Swashbuckle.AspNetCore.Annotations.SwaggerDiscriminatorAttribute
21+
Swashbuckle.AspNetCore.Annotations.SwaggerDiscriminatorAttribute.PropertyName.get -> string
22+
Swashbuckle.AspNetCore.Annotations.SwaggerDiscriminatorAttribute.PropertyName.set -> void
23+
Swashbuckle.AspNetCore.Annotations.SwaggerDiscriminatorAttribute.SwaggerDiscriminatorAttribute(string propertyName) -> void
24+
Swashbuckle.AspNetCore.Annotations.SwaggerOperationAttribute
25+
Swashbuckle.AspNetCore.Annotations.SwaggerOperationAttribute.Description.get -> string
26+
Swashbuckle.AspNetCore.Annotations.SwaggerOperationAttribute.Description.set -> void
27+
Swashbuckle.AspNetCore.Annotations.SwaggerOperationAttribute.OperationId.get -> string
28+
Swashbuckle.AspNetCore.Annotations.SwaggerOperationAttribute.OperationId.set -> void
29+
Swashbuckle.AspNetCore.Annotations.SwaggerOperationAttribute.Summary.get -> string
30+
Swashbuckle.AspNetCore.Annotations.SwaggerOperationAttribute.Summary.set -> void
31+
Swashbuckle.AspNetCore.Annotations.SwaggerOperationAttribute.SwaggerOperationAttribute(string summary = null, string description = null) -> void
32+
Swashbuckle.AspNetCore.Annotations.SwaggerOperationAttribute.Tags.get -> string[]
33+
Swashbuckle.AspNetCore.Annotations.SwaggerOperationAttribute.Tags.set -> void
34+
Swashbuckle.AspNetCore.Annotations.SwaggerOperationFilterAttribute
35+
Swashbuckle.AspNetCore.Annotations.SwaggerOperationFilterAttribute.FilterType.get -> System.Type
36+
Swashbuckle.AspNetCore.Annotations.SwaggerOperationFilterAttribute.SwaggerOperationFilterAttribute(System.Type filterType) -> void
37+
Swashbuckle.AspNetCore.Annotations.SwaggerParameterAttribute
38+
Swashbuckle.AspNetCore.Annotations.SwaggerParameterAttribute.Description.get -> string
39+
Swashbuckle.AspNetCore.Annotations.SwaggerParameterAttribute.Description.set -> void
40+
Swashbuckle.AspNetCore.Annotations.SwaggerParameterAttribute.Required.get -> bool
41+
Swashbuckle.AspNetCore.Annotations.SwaggerParameterAttribute.Required.set -> void
42+
Swashbuckle.AspNetCore.Annotations.SwaggerParameterAttribute.SwaggerParameterAttribute(string description = null) -> void
43+
Swashbuckle.AspNetCore.Annotations.SwaggerRequestBodyAttribute
44+
Swashbuckle.AspNetCore.Annotations.SwaggerRequestBodyAttribute.Description.get -> string
45+
Swashbuckle.AspNetCore.Annotations.SwaggerRequestBodyAttribute.Description.set -> void
46+
Swashbuckle.AspNetCore.Annotations.SwaggerRequestBodyAttribute.Required.get -> bool
47+
Swashbuckle.AspNetCore.Annotations.SwaggerRequestBodyAttribute.Required.set -> void
48+
Swashbuckle.AspNetCore.Annotations.SwaggerRequestBodyAttribute.SwaggerRequestBodyAttribute(string description = null) -> void
49+
Swashbuckle.AspNetCore.Annotations.SwaggerResponseAttribute
50+
Swashbuckle.AspNetCore.Annotations.SwaggerResponseAttribute.ContentTypes.get -> string[]
51+
Swashbuckle.AspNetCore.Annotations.SwaggerResponseAttribute.ContentTypes.set -> void
52+
Swashbuckle.AspNetCore.Annotations.SwaggerResponseAttribute.Description.get -> string
53+
Swashbuckle.AspNetCore.Annotations.SwaggerResponseAttribute.Description.set -> void
54+
Swashbuckle.AspNetCore.Annotations.SwaggerResponseAttribute.SwaggerResponseAttribute(int statusCode, string description = null, System.Type type = null) -> void
55+
Swashbuckle.AspNetCore.Annotations.SwaggerResponseAttribute.SwaggerResponseAttribute(int statusCode, string description = null, System.Type type = null, params string[] contentTypes) -> void
56+
Swashbuckle.AspNetCore.Annotations.SwaggerSchemaAttribute
57+
Swashbuckle.AspNetCore.Annotations.SwaggerSchemaAttribute.Description.get -> string
58+
Swashbuckle.AspNetCore.Annotations.SwaggerSchemaAttribute.Description.set -> void
59+
Swashbuckle.AspNetCore.Annotations.SwaggerSchemaAttribute.Format.get -> string
60+
Swashbuckle.AspNetCore.Annotations.SwaggerSchemaAttribute.Format.set -> void
61+
Swashbuckle.AspNetCore.Annotations.SwaggerSchemaAttribute.Nullable.get -> bool
62+
Swashbuckle.AspNetCore.Annotations.SwaggerSchemaAttribute.Nullable.set -> void
63+
Swashbuckle.AspNetCore.Annotations.SwaggerSchemaAttribute.ReadOnly.get -> bool
64+
Swashbuckle.AspNetCore.Annotations.SwaggerSchemaAttribute.ReadOnly.set -> void
65+
Swashbuckle.AspNetCore.Annotations.SwaggerSchemaAttribute.Required.get -> string[]
66+
Swashbuckle.AspNetCore.Annotations.SwaggerSchemaAttribute.Required.set -> void
67+
Swashbuckle.AspNetCore.Annotations.SwaggerSchemaAttribute.SwaggerSchemaAttribute(string description = null) -> void
68+
Swashbuckle.AspNetCore.Annotations.SwaggerSchemaAttribute.Title.get -> string
69+
Swashbuckle.AspNetCore.Annotations.SwaggerSchemaAttribute.Title.set -> void
70+
Swashbuckle.AspNetCore.Annotations.SwaggerSchemaAttribute.WriteOnly.get -> bool
71+
Swashbuckle.AspNetCore.Annotations.SwaggerSchemaAttribute.WriteOnly.set -> void
72+
Swashbuckle.AspNetCore.Annotations.SwaggerSchemaFilterAttribute
73+
Swashbuckle.AspNetCore.Annotations.SwaggerSchemaFilterAttribute.Arguments.get -> object[]
74+
Swashbuckle.AspNetCore.Annotations.SwaggerSchemaFilterAttribute.Arguments.set -> void
75+
Swashbuckle.AspNetCore.Annotations.SwaggerSchemaFilterAttribute.SwaggerSchemaFilterAttribute(System.Type type) -> void
76+
Swashbuckle.AspNetCore.Annotations.SwaggerSchemaFilterAttribute.Type.get -> System.Type
77+
Swashbuckle.AspNetCore.Annotations.SwaggerSubTypeAttribute
78+
Swashbuckle.AspNetCore.Annotations.SwaggerSubTypeAttribute.DiscriminatorValue.get -> string
79+
Swashbuckle.AspNetCore.Annotations.SwaggerSubTypeAttribute.DiscriminatorValue.set -> void
80+
Swashbuckle.AspNetCore.Annotations.SwaggerSubTypeAttribute.SubType.get -> System.Type
81+
Swashbuckle.AspNetCore.Annotations.SwaggerSubTypeAttribute.SubType.set -> void
82+
Swashbuckle.AspNetCore.Annotations.SwaggerSubTypeAttribute.SwaggerSubTypeAttribute(System.Type subType) -> void
83+
Swashbuckle.AspNetCore.Annotations.SwaggerSubTypesAttribute
84+
Swashbuckle.AspNetCore.Annotations.SwaggerSubTypesAttribute.Discriminator.get -> string
85+
Swashbuckle.AspNetCore.Annotations.SwaggerSubTypesAttribute.Discriminator.set -> void
86+
Swashbuckle.AspNetCore.Annotations.SwaggerSubTypesAttribute.SubTypes.get -> System.Collections.Generic.IEnumerable<System.Type>
87+
Swashbuckle.AspNetCore.Annotations.SwaggerSubTypesAttribute.SwaggerSubTypesAttribute(params System.Type[] subTypes) -> void
88+
Swashbuckle.AspNetCore.Annotations.SwaggerTagAttribute
89+
Swashbuckle.AspNetCore.Annotations.SwaggerTagAttribute.Description.get -> string
90+
Swashbuckle.AspNetCore.Annotations.SwaggerTagAttribute.ExternalDocsUrl.get -> string
91+
Swashbuckle.AspNetCore.Annotations.SwaggerTagAttribute.SwaggerTagAttribute(string description = null, string externalDocsUrl = null) -> void

‎src/Swashbuckle.AspNetCore.Annotations/PublicAPI/PublicAPI.Unshipped.txt‎

Whitespace-only changes.

‎src/Swashbuckle.AspNetCore.Annotations/Swashbuckle.AspNetCore.Annotations.csproj‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,4 +15,10 @@
1515
<ProjectReference Include="..\Swashbuckle.AspNetCore.SwaggerGen\Swashbuckle.AspNetCore.SwaggerGen.csproj" />
1616
</ItemGroup>
1717

18+
<ItemGroup>
19+
<PackageReference Include="Microsoft.CodeAnalysis.PublicApiAnalyzers" PrivateAssets="All" />
20+
<AdditionalFiles Include="PublicAPI\PublicAPI.Shipped.txt" />
21+
<AdditionalFiles Include="PublicAPI\PublicAPI.Unshipped.txt" />
22+
</ItemGroup>
23+
1824
</Project>

‎src/Swashbuckle.AspNetCore.ApiTesting.Xunit/PublicAPI/PublicAPI.Shipped.txt‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
Swashbuckle.AspNetCore.ApiTesting.Xunit.ApiTestFixture<TEntryPoint>
2+
Swashbuckle.AspNetCore.ApiTesting.Xunit.ApiTestFixture<TEntryPoint>.ApiTestFixture(Swashbuckle.AspNetCore.ApiTesting.ApiTestRunnerBase apiTestRunner, Microsoft.AspNetCore.Mvc.Testing.WebApplicationFactory<TEntryPoint> webAppFactory, string documentName) -> void
3+
Swashbuckle.AspNetCore.ApiTesting.Xunit.ApiTestFixture<TEntryPoint>.Describe(string pathTemplate, Microsoft.OpenApi.Models.OperationType operationType, Microsoft.OpenApi.Models.OpenApiOperation operationSpec) -> void
4+
Swashbuckle.AspNetCore.ApiTesting.Xunit.ApiTestFixture<TEntryPoint>.TestAsync(string operationId, string expectedStatusCode, System.Net.Http.HttpRequestMessage request) -> System.Threading.Tasks.Task

‎src/Swashbuckle.AspNetCore.ApiTesting.Xunit/PublicAPI/PublicAPI.Unshipped.txt‎

Whitespace-only changes.

‎src/Swashbuckle.AspNetCore.ApiTesting.Xunit/Swashbuckle.AspNetCore.ApiTesting.Xunit.csproj‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,4 +22,10 @@
2222
<ProjectCapability Remove="TestContainer" />
2323
</ItemGroup>
2424

25+
<ItemGroup>
26+
<PackageReference Include="Microsoft.CodeAnalysis.PublicApiAnalyzers" PrivateAssets="All" />
27+
<AdditionalFiles Include="PublicAPI\PublicAPI.Shipped.txt" />
28+
<AdditionalFiles Include="PublicAPI\PublicAPI.Unshipped.txt" />
29+
</ItemGroup>
30+
2531
</Project>

0 commit comments

Comments
 (0)