Repository navigation
[release/8.0] Drop Microsoft.AspNetCore.Grpc.Swagger - #67955
Conversation
Co-authored-by: Youssef1313 <31348972+Youssef1313@users.noreply.github.com>
There was a problem hiding this comment.
Pull request overview
Removes the Microsoft.AspNetCore.Grpc.Swagger package (and its associated tests/assets) from release/8.0, along with build/solution plumbing and Sandbox usage, to reduce shipped surface area and eliminate stale dependencies.
Changes:
- Deletes the
Microsoft.AspNetCore.Grpc.Swaggersource project and its PublicAPI baselines. - Deletes the
Microsoft.AspNetCore.Grpc.Swagger.Testsproject plus supporting test services/protos. - Removes remaining wiring/references from build metadata (eng props),
src/Grpc/Grpc.slnf, and the JsonTranscoding Sandbox testasset.
Reviewed changes
Copilot reviewed 39 out of 39 changed files in this pull request and generated 1 comment.
Show a summary per file
| File | Description |
|---|---|
| src/Grpc/JsonTranscoding/test/testassets/Sandbox/Startup.cs | Removes Swagger/OpenAPI middleware and service registration from the Sandbox test asset. |
| src/Grpc/JsonTranscoding/test/testassets/Sandbox/Sandbox.csproj | Drops the Microsoft.AspNetCore.Grpc.Swagger reference from the Sandbox test asset. |
| src/Grpc/JsonTranscoding/test/Microsoft.AspNetCore.Grpc.Swagger.Tests/XmlComments/XmlDocumentationIntegrationTests.cs | Deletes Grpc.Swagger XML-docs integration tests (project removal). |
| src/Grpc/JsonTranscoding/test/Microsoft.AspNetCore.Grpc.Swagger.Tests/XmlComments/XmlCommentsDocumentFilterTests.cs | Deletes Grpc.Swagger XML-docs document-filter tests (project removal). |
| src/Grpc/JsonTranscoding/test/Microsoft.AspNetCore.Grpc.Swagger.Tests/Services/XmlDocServiceWithComments.cs | Deletes test service used by Grpc.Swagger XML comment coverage. |
| src/Grpc/JsonTranscoding/test/Microsoft.AspNetCore.Grpc.Swagger.Tests/Services/XmlDocService.cs | Deletes test service used by Grpc.Swagger XML/proto-doc coverage. |
| src/Grpc/JsonTranscoding/test/Microsoft.AspNetCore.Grpc.Swagger.Tests/Services/ParametersService.cs | Deletes test service used by parameter binding tests for Grpc.Swagger. |
| src/Grpc/JsonTranscoding/test/Microsoft.AspNetCore.Grpc.Swagger.Tests/Services/GreeterService.cs | Deletes test service used by basic OpenAPI generation tests for Grpc.Swagger. |
| src/Grpc/JsonTranscoding/test/Microsoft.AspNetCore.Grpc.Swagger.Tests/Services/BodyService.cs | Deletes test service used by body binding tests for Grpc.Swagger. |
| src/Grpc/JsonTranscoding/test/Microsoft.AspNetCore.Grpc.Swagger.Tests/SchemaGeneratorIntegrationTests.cs | Deletes schema generation integration tests (project removal). |
| src/Grpc/JsonTranscoding/test/Microsoft.AspNetCore.Grpc.Swagger.Tests/Proto/xmldoc.proto | Deletes proto used by XML documentation tests (project removal). |
| src/Grpc/JsonTranscoding/test/Microsoft.AspNetCore.Grpc.Swagger.Tests/Proto/parameters.proto | Deletes proto used by parameter binding tests (project removal). |
| src/Grpc/JsonTranscoding/test/Microsoft.AspNetCore.Grpc.Swagger.Tests/Proto/messages.proto | Deletes proto used by schema generation tests (project removal). |
| src/Grpc/JsonTranscoding/test/Microsoft.AspNetCore.Grpc.Swagger.Tests/Proto/greeter.proto | Deletes proto used by basic operation generation tests (project removal). |
| src/Grpc/JsonTranscoding/test/Microsoft.AspNetCore.Grpc.Swagger.Tests/Proto/counter.proto | Deletes proto used by grouped swagger doc tests (project removal). |
| src/Grpc/JsonTranscoding/test/Microsoft.AspNetCore.Grpc.Swagger.Tests/Proto/body.proto | Deletes proto used by body binding tests (project removal). |
| src/Grpc/JsonTranscoding/test/Microsoft.AspNetCore.Grpc.Swagger.Tests/Microsoft.AspNetCore.Grpc.Swagger.Tests.csproj | Deletes the Grpc.Swagger test project definition. |
| src/Grpc/JsonTranscoding/test/Microsoft.AspNetCore.Grpc.Swagger.Tests/Infrastructure/TestWebHostEnvironment.cs | Deletes test infrastructure type (project removal). |
| src/Grpc/JsonTranscoding/test/Microsoft.AspNetCore.Grpc.Swagger.Tests/Infrastructure/OpenApiTestHelpers.cs | Deletes OpenAPI test helper infrastructure (project removal). |
| src/Grpc/JsonTranscoding/test/Microsoft.AspNetCore.Grpc.Swagger.Tests/GrpcSwaggerServiceExtensionsTests.cs | Deletes extension-method behavior tests (project removal). |
| src/Grpc/JsonTranscoding/test/Microsoft.AspNetCore.Grpc.Swagger.Tests/google/api/http.proto | Deletes vendored google.api.http proto used by tests (project removal). |
| src/Grpc/JsonTranscoding/test/Microsoft.AspNetCore.Grpc.Swagger.Tests/google/api/annotations.proto | Deletes vendored google.api.annotations proto used by tests (project removal). |
| src/Grpc/JsonTranscoding/test/Microsoft.AspNetCore.Grpc.Swagger.Tests/Binding/ParametersTests.cs | Deletes parameter binding tests (project removal). |
| src/Grpc/JsonTranscoding/test/Microsoft.AspNetCore.Grpc.Swagger.Tests/Binding/BodyTests.cs | Deletes body binding tests (project removal). |
| src/Grpc/JsonTranscoding/src/Microsoft.AspNetCore.Grpc.Swagger/PublicAPI.Unshipped.txt | Deletes PublicAPI baseline file (package removal). |
| src/Grpc/JsonTranscoding/src/Microsoft.AspNetCore.Grpc.Swagger/PublicAPI.Shipped.txt | Deletes shipped API baseline file (package removal). |
| src/Grpc/JsonTranscoding/src/Microsoft.AspNetCore.Grpc.Swagger/Microsoft.AspNetCore.Grpc.Swagger.csproj | Deletes the Grpc.Swagger package project. |
| src/Grpc/JsonTranscoding/src/Microsoft.AspNetCore.Grpc.Swagger/Internal/XmlComments/GrpcXmlCommentsOperationFilter.cs | Deletes internal XML comment operation filter implementation (package removal). |
| src/Grpc/JsonTranscoding/src/Microsoft.AspNetCore.Grpc.Swagger/Internal/XmlComments/GrpcXmlCommentsDocumentFilter.cs | Deletes internal XML comment document filter implementation (package removal). |
| src/Grpc/JsonTranscoding/src/Microsoft.AspNetCore.Grpc.Swagger/Internal/MessageDescriptorHelpers.cs | Deletes internal protobuf descriptor helper code (package removal). |
| src/Grpc/JsonTranscoding/src/Microsoft.AspNetCore.Grpc.Swagger/Internal/GrpcModelMetadata.cs | Deletes internal ModelMetadata implementation (package removal). |
| src/Grpc/JsonTranscoding/src/Microsoft.AspNetCore.Grpc.Swagger/Internal/GrpcJsonTranscodingDescriptionProvider.cs | Deletes internal ApiExplorer description provider used for OpenAPI generation (package removal). |
| src/Grpc/JsonTranscoding/src/Microsoft.AspNetCore.Grpc.Swagger/Internal/GrpcDataContractResolver.cs | Deletes internal Swashbuckle data contract resolver (package removal). |
| src/Grpc/JsonTranscoding/src/Microsoft.AspNetCore.Grpc.Swagger/GrpcSwaggerServiceExtensions.cs | Deletes public DI extensions (AddGrpcSwagger) (package removal). |
| src/Grpc/JsonTranscoding/src/Microsoft.AspNetCore.Grpc.Swagger/GrpcSwaggerGenOptionsExtensions.cs | Deletes public SwaggerGen extensions (IncludeGrpcXmlComments) (package removal). |
| src/Grpc/Grpc.slnf | Removes Grpc.Swagger projects from the gRPC solution filter. |
| eng/ShippingAssemblies.props | Stops shipping Microsoft.AspNetCore.Grpc.Swagger as part of the shared framework assembly list. |
| eng/RequiresDelayedBuildProjects.props | Removes Grpc.Swagger projects from the delayed-build project list. |
| eng/ProjectReferences.props | Removes Grpc.Swagger from centralized project reference providers. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Co-authored-by: Youssef1313 <31348972+Youssef1313@users.noreply.github.com>
|
/ba-g Build check is expected to fail here. Quarantined timeout isn't related and not important. |
|
Hi @copilot. This PR was just approved to be included in the upcoming servicing release. Somebody from the @dotnet/aspnet-build team will get it merged when the branches are open. Until then, please make sure all the CI checks pass and the PR is reviewed. |
Drop Microsoft.AspNetCore.Grpc.Swagger
This is a backport of #67919 which removes the experimental Microsoft.AspNetCore.Grpc.Swagger.
Description
See #67134
This package has been experimental with relatively low usage.
https://www.nuget.org/packages/Microsoft.AspNetCore.Grpc.Swagger -> Current version (released 23 days ago) 36K downloads.
In contrast, https://www.nuget.org/packages/Swashbuckle.AspNetCore.Swagger has 7.6M downloads for current version (released only a month ago), and https://www.nuget.org/packages/Microsoft.AspNetCore.OpenApi has 2M downloads for current version (released 23 days ago).
The package adds maintenance cost that's not worth it.
Customer Impact
No new experimental versions of this package will be published.
Regression?
N/A
Risk
Low - intentional package deprecation.
Verification
N/A