Skip to content

Added Swagger support for OData void response type and default parameter values other than strings #718

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 1 commit into from
Feb 8, 2021
Merged

Added Swagger support for OData void response type and default parameter values other than strings #718

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
22 changes: 20 additions & 2 deletions samples/aspnetcore/SwaggerODataSample/SwaggerDefaultValues.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
namespace Microsoft.Examples
{
using Microsoft.AspNetCore.Mvc.ApiExplorer;
using Microsoft.OpenApi.Any;
using Microsoft.OpenApi.Models;
using Swashbuckle.AspNetCore.SwaggerGen;
using System.Linq;
Expand All @@ -24,6 +23,24 @@ public void Apply( OpenApiOperation operation, OperationFilterContext context )

operation.Deprecated |= apiDescription.IsDeprecated();

// https://github.com/domaindrivendev/Swashbuckle.AspNetCore/issues/1752#issue-663991077
foreach ( var responseType in context.ApiDescription.SupportedResponseTypes )
{
// based on internals of SwaggerGenerator
// https://github.com/domaindrivendev/Swashbuckle.AspNetCore/blob/b7cf75e7905050305b115dd96640ddd6e74c7ac9/src/Swashbuckle.AspNetCore.SwaggerGen/SwaggerGenerator/SwaggerGenerator.cs#L383-L387
var responseKey = responseType.IsDefaultResponse ? "default" : responseType.StatusCode.ToString();
var response = operation.Responses[responseKey];

// remove media types not supported by the API
foreach ( var contentType in response.Content.Keys )
{
if ( !responseType.ApiResponseFormats.Any( x => x.MediaType == contentType ) )
{
response.Content.Remove( contentType );
}
}
}

if ( operation.Parameters == null )
{
return;
Expand All @@ -42,7 +59,8 @@ public void Apply( OpenApiOperation operation, OperationFilterContext context )

if ( parameter.Schema.Default == null && description.DefaultValue != null )
{
parameter.Schema.Default = new OpenApiString( description.DefaultValue.ToString() );
// https://github.com/Microsoft/aspnet-api-versioning/issues/429#issuecomment-605402330
parameter.Schema.Default = OpenApiAnyFactory.CreateFor( parameter.Schema, description.DefaultValue );
}

parameter.Required |= description.IsRequired;
Expand Down
22 changes: 20 additions & 2 deletions samples/aspnetcore/SwaggerSample/SwaggerDefaultValues.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
namespace Microsoft.Examples
{
using Microsoft.AspNetCore.Mvc.ApiExplorer;
using Microsoft.OpenApi.Any;
using Microsoft.OpenApi.Models;
using Swashbuckle.AspNetCore.SwaggerGen;
using System.Linq;
Expand All @@ -24,6 +23,24 @@ public void Apply( OpenApiOperation operation, OperationFilterContext context )

operation.Deprecated |= apiDescription.IsDeprecated();

// https://github.com/domaindrivendev/Swashbuckle.AspNetCore/issues/1752#issue-663991077
foreach ( var responseType in context.ApiDescription.SupportedResponseTypes )
{
// based on internals of SwaggerGenerator
// https://github.com/domaindrivendev/Swashbuckle.AspNetCore/blob/b7cf75e7905050305b115dd96640ddd6e74c7ac9/src/Swashbuckle.AspNetCore.SwaggerGen/SwaggerGenerator/SwaggerGenerator.cs#L383-L387
var responseKey = responseType.IsDefaultResponse ? "default" : responseType.StatusCode.ToString();
var response = operation.Responses[responseKey];

// remove media types not supported by the API
foreach ( var contentType in response.Content.Keys )
{
if ( !responseType.ApiResponseFormats.Any( x => x.MediaType == contentType ) )
{
response.Content.Remove( contentType );
}
}
}

if ( operation.Parameters == null )
{
return;
Expand All @@ -42,7 +59,8 @@ public void Apply( OpenApiOperation operation, OperationFilterContext context )

if ( parameter.Schema.Default == null && description.DefaultValue != null )
{
parameter.Schema.Default = new OpenApiString( description.DefaultValue.ToString() );
// https://github.com/Microsoft/aspnet-api-versioning/issues/429#issuecomment-605402330
parameter.Schema.Default = OpenApiAnyFactory.CreateFor( parameter.Schema, description.DefaultValue );
}

parameter.Required |= description.IsRequired;
Expand Down