Skip to content

Add default implementation to OpenAPI's new Description property to prevent a breaking change #60937

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Mar 17, 2025
+2 −2
Merged

Add default implementation to OpenAPI's new Description property to prevent a breaking change #60937

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
fa0ffa8
Add default implementation to Description to prevent a breaking chang…
sander1095 Mar 14, 2025
3ca5e52
Apply suggestions from code review
sander1095 Mar 14, 2025
5e2505c
Set default implementation on Description in IApiResponseMetadataProv…
sander1095 Mar 16, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion src/Http/Http.Abstractions/src/Metadata/IProducesResponseTypeMetadata.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ public interface IProducesResponseTypeMetadata
/// <summary>
/// Gets the description of the response.
/// </summary>
string? Description { get; }
string? Description => null;

/// <summary>
/// Gets the content types supported by the metadata.
Expand Down
2 changes: 1 addition & 1 deletion src/Mvc/Mvc.Core/src/ApiExplorer/IApiResponseMetadataProvider.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ public interface IApiResponseMetadataProvider : IFilterMetadata
/// <summary>
/// Gets the description of the response.
/// </summary>
string? Description { get; }
string? Description => null;

/// <summary>
/// Gets the HTTP status code of the response.
Expand Down
Loading