Clean up examples

Author: commonsensesoftware

Diff for: examples/AspNetCore/WebApi/MinimalApiExample/appsettings.Development.json

@@ -16,7 +16,7 @@
         "ASPNETCORE_ENVIRONMENT": "Development"
       }
     },
-    "SwaggerExample": {
+    "OpenApiExample": {
       "commandName": "Project",
       "launchBrowser": true,
       "launchUrl": "http://localhost:5000/swagger",

Diff for: examples/AspNetCore/WebApi/OpenApiExample/Properties/launchSettings.json

@@ -90,7 +90,9 @@ public void Configure( IApplicationBuilder app, IApiVersionDescriptionProvider p
                 // build a swagger endpoint for each discovered API version
                 foreach ( var description in provider.ApiVersionDescriptions )
                 {
-                    options.SwaggerEndpoint( $"/swagger/{description.GroupName}/swagger.json", description.GroupName.ToUpperInvariant() );
+                    var url = $"/swagger/{description.GroupName}/swagger.json";
+                    var name = description.GroupName.ToUpperInvariant();
+                    options.SwaggerEndpoint( url, name );
                 }
             } );
     }

Diff for: examples/AspNetCore/WebApi/OpenApiExample/Startup.cs

@@ -1,22 +1,19 @@
 namespace ApiVersioning.Examples;
 
 using Microsoft.AspNetCore.Mvc.ApiExplorer;
+using Microsoft.AspNetCore.Mvc.ModelBinding;
 using Microsoft.OpenApi.Models;
 using Swashbuckle.AspNetCore.SwaggerGen;
 using System.Text.Json;
 
 /// <summary>
-/// Represents the OpenAPI/Swashbuckle operation filter used to document the implicit API version parameter.
+/// Represents the OpenAPI/Swashbuckle operation filter used to document information provided, but not used.
 /// </summary>
 /// <remarks>This <see cref="IOperationFilter"/> is only required due to bugs in the <see cref="SwaggerGenerator"/>.
 /// Once they are fixed and published, this class can be removed.</remarks>
 public class SwaggerDefaultValues : IOperationFilter
 {
-    /// <summary>
-    /// Applies the filter to the specified operation using the given context.
-    /// </summary>
-    /// <param name="operation">The operation to apply the filter to.</param>
-    /// <param name="context">The current operation filter context.</param>
+    /// <inheritdoc />
     public void Apply( OpenApiOperation operation, OperationFilterContext context )
     {
         var apiDescription = context.ApiDescription;
@@ -55,10 +52,13 @@ public void Apply( OpenApiOperation operation, OperationFilterContext context )
                 parameter.Description = description.ModelMetadata?.Description;
             }
 
-            if ( parameter.Schema.Default == null && description.DefaultValue != null )
+            if ( parameter.Schema.Default == null &&
+                 description.DefaultValue != null &&
+                 description.DefaultValue is not DBNull &&
+                 description.ModelMetadata is ModelMetadata modelMetadata )
             {
                 // REF: https://github.com/Microsoft/aspnet-api-versioning/issues/429#issuecomment-605402330
-                var json = JsonSerializer.Serialize( description.DefaultValue, description.ModelMetadata.ModelType );
+                var json = JsonSerializer.Serialize( description.DefaultValue, modelMetadata.ModelType );
                 parameter.Schema.Default = OpenApiAnyFactory.CreateFromJson( json );
             }
 

Diff for: examples/AspNetCore/WebApi/OpenApiExample/SwaggerDefaultValues.cs

@@ -34,8 +34,8 @@ public class OrdersController : ControllerBase
     /// <response code="400">The order is invalid.</response>
     [HttpPost]
     [MapToApiVersion( "1.0" )]
-    [Produces( "application/json" )]
     [Consumes( "application/json" )]
+    [Produces( "application/json" )]
     [ProducesResponseType( typeof( Order ), 201 )]
     [ProducesResponseType( 400 )]
     public IActionResult Post( [FromBody] Order order )
@@ -49,13 +49,12 @@ public IActionResult Post( [FromBody] Order order )
     /// </summary>
     /// <param name="id">The requested order identifier.</param>
     /// <param name="order">The order to update.</param>
-    /// <returns>The created order.</returns>
+    /// <returns>None.</returns>
     /// <response code="204">The order was successfully updated.</response>
     /// <response code="400">The order is invalid.</response>
     /// <response code="404">The order does not exist.</response>
     [MapToApiVersion( "1.0" )]
     [HttpPatch( "{id:int}" )]
-    [Produces( "application/json" )]
     [Consumes( "application/json" )]
     [ProducesResponseType( 204 )]
     [ProducesResponseType( 400 )]

Diff for: examples/AspNetCore/WebApi/OpenApiExample/V1/Controllers/OrdersController.cs

@@ -28,6 +28,6 @@ public IActionResult Get( int id ) =>
         {
             Id = id,
             FirstName = "John",
-            LastName = "Doe"
+            LastName = "Doe",
         } );
 }

Diff for: examples/AspNetCore/WebApi/OpenApiExample/V1/Controllers/PeopleController.cs

@@ -42,7 +42,6 @@ public IActionResult Get()
     [HttpGet( "{id:int}" )]
     [Produces( "application/json" )]
     [ProducesResponseType( typeof( Order ), 200 )]
-    [ProducesResponseType( 400 )]
     [ProducesResponseType( 404 )]
     public IActionResult Get( int id ) => Ok( new Order() { Id = id, Customer = "John Doe" } );
 
@@ -54,6 +53,7 @@ public IActionResult Get()
     /// <response code="201">The order was successfully placed.</response>
     /// <response code="400">The order is invalid.</response>
     [HttpPost]
+    [Consumes( "application/json" )]
     [Produces( "application/json" )]
     [ProducesResponseType( typeof( Order ), 201 )]
     [ProducesResponseType( 400 )]
@@ -68,12 +68,11 @@ public IActionResult Post( [FromBody] Order order )
     /// </summary>
     /// <param name="id">The requested order identifier.</param>
     /// <param name="order">The order to update.</param>
-    /// <returns>The created order.</returns>
+    /// <returns>None.</returns>
     /// <response code="204">The order was successfully updated.</response>
     /// <response code="400">The order is invalid.</response>
     /// <response code="404">The order does not exist.</response>
     [HttpPatch( "{id:int}" )]
-    [Produces( "application/json" )]
     [Consumes( "application/json" )]
     [ProducesResponseType( Status204NoContent )]
     [ProducesResponseType( Status400BadRequest )]

Diff for: examples/AspNetCore/WebApi/OpenApiExample/V2/Controllers/OrdersController.cs

@@ -16,17 +16,15 @@ public class OrdersController : ControllerBase
     /// </summary>
     /// <returns>All available orders.</returns>
     /// <response code="200">Orders successfully retrieved.</response>
-    /// <response code="400">The order is invalid.</response>
     [HttpGet]
     [Produces( "application/json" )]
     [ProducesResponseType( typeof( IEnumerable<Order> ), 200 )]
-    [ProducesResponseType( 400 )]
     public IActionResult Get()
     {
         var orders = new Order[]
         {
             new(){ Id = 1, Customer = "John Doe" },
-            new(){ Id = 2, Customer = "John Doe" },
+            new(){ Id = 2, Customer = "Bob Smith" },
             new(){ Id = 3, Customer = "Jane Doe", EffectiveDate = DateTimeOffset.UtcNow.AddDays( 7d ) },
         };
 
@@ -43,7 +41,6 @@ public IActionResult Get()
     [HttpGet( "{id:int}" )]
     [Produces( "application/json" )]
     [ProducesResponseType( typeof( Order ), 200 )]
-    [ProducesResponseType( 400 )]
     [ProducesResponseType( 404 )]
     public IActionResult Get( int id ) => Ok( new Order() { Id = id, Customer = "John Doe" } );
 
@@ -55,6 +52,7 @@ public IActionResult Get()
     /// <response code="201">The order was successfully placed.</response>
     /// <response code="400">The order is invalid.</response>
     [HttpPost]
+    [Consumes( "application/json" )]
     [Produces( "application/json" )]
     [ProducesResponseType( typeof( Order ), 201 )]
     [ProducesResponseType( 400 )]

Diff for: examples/AspNetCore/WebApi/OpenApiExample/V3/Controllers/OrdersController.cs

@@ -82,6 +82,7 @@ public IActionResult Get( int id ) =>
     /// <response code="201">The person was successfully created.</response>
     /// <response code="400">The person was invalid.</response>
     [HttpPost]
+    [Consumes( "application/json" )]
     [Produces( "application/json" )]
     [ProducesResponseType( typeof( Person ), 201 )]
     [ProducesResponseType( 400 )]