Skip to content

Commit bf14bf4

Browse files
Chris Martinezcommonsensesoftware
authored andcommitted
Update documentation for Swagger
1 parent 4e6f616 commit bf14bf4

File tree

4 files changed

+16
-2
lines changed

4 files changed

+16
-2
lines changed

samples/aspnetcore/SwaggerODataSample/V1/OrdersController.cs

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -60,6 +60,7 @@ public IActionResult Post( [FromBody] Order order )
6060
[MapToApiVersion( "1.0" )]
6161
[Produces( "application/json" )]
6262
[ProducesResponseType( typeof( Order ), Status200OK )]
63+
[ProducesResponseType( Status404NotFound )]
6364
[ODataRoute( "MostExpensive" )]
6465
public IActionResult MostExpensive() => Ok( new Order() { Id = 42, Customer = "Bill Mei" } );
6566
}

samples/aspnetcore/SwaggerODataSample/V2/OrdersController.cs

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -77,6 +77,7 @@ public IActionResult Post( [FromBody] Order order )
7777
/// <param name="delta">The partial order to update.</param>
7878
/// <returns>The created order.</returns>
7979
/// <response code="204">The order was successfully updated.</response>
80+
/// <response code="400">The order is invalid.</response>
8081
/// <response code="404">The order does not exist.</response>
8182
[ProducesResponseType( typeof( Order ), Status204NoContent )]
8283
[ProducesResponseType( Status400BadRequest )]
@@ -105,6 +106,7 @@ public IActionResult Patch( int key, Delta<Order> delta )
105106
[HttpGet]
106107
[Produces( "application/json" )]
107108
[ProducesResponseType( typeof( Order ), Status200OK )]
109+
[ProducesResponseType( Status404NotFound )]
108110
[ODataRoute( nameof( MostExpensive ) )]
109111
public IActionResult MostExpensive() => Ok( new Order() { Id = 42, Customer = "Bill Mei" } );
110112

@@ -115,6 +117,8 @@ public IActionResult Patch( int key, Delta<Order> delta )
115117
/// <param name="parameters">The action parameters.</param>
116118
/// <returns>None</returns>
117119
/// <response code="204">The order was successfully rated.</response>
120+
/// <response code="400">The parameters are invalid.</response>
121+
/// <response code="404">The order does not exist.</response>
118122
[HttpPost]
119123
[ProducesResponseType( Status200OK )]
120124
[ProducesResponseType( Status400BadRequest )]

samples/aspnetcore/SwaggerODataSample/V3/OrdersController.cs

Lines changed: 9 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,6 @@
1212
/// Represents a RESTful service of orders.
1313
/// </summary>
1414
[ApiVersion( "3.0" )]
15-
[Produces( "application/json" )]
1615
[ODataRoutePrefix( "Orders" )]
1716
public class OrdersController : ODataController
1817
{
@@ -57,7 +56,8 @@ public IActionResult Get()
5756
/// <returns>The created order.</returns>
5857
/// <response code="201">The order was successfully placed.</response>
5958
/// <response code="400">The order is invalid.</response>
60-
[Produces( typeof( Order ) )]
59+
[ProducesResponseType( typeof( Order ), Status201Created )]
60+
[ProducesResponseType( Status400BadRequest )]
6161
[ODataRoute]
6262
public IActionResult Post( [FromBody] Order order )
6363
{
@@ -78,9 +78,11 @@ public IActionResult Post( [FromBody] Order order )
7878
/// <param name="delta">The partial order to update.</param>
7979
/// <returns>The created order.</returns>
8080
/// <response code="204">The order was successfully updated.</response>
81+
/// <response code="400">The order is invalid.</response>
8182
/// <response code="404">The order does not exist.</response>
8283
[ProducesResponseType( typeof( Order ), Status204NoContent )]
8384
[ProducesResponseType( Status400BadRequest )]
85+
[ProducesResponseType( Status404NotFound )]
8486
[ODataRoute( "({key})" )]
8587
public IActionResult Patch( int key, Delta<Order> delta )
8688
{
@@ -103,6 +105,7 @@ public IActionResult Patch( int key, Delta<Order> delta )
103105
/// <param name="suspendOnly">Indicates if the order should only be suspended.</param>
104106
/// <returns>None</returns>
105107
/// <response code="204">The order was successfully canceled.</response>
108+
/// <response code="404">The order does not exist.</response>
106109
[ProducesResponseType( Status204NoContent )]
107110
[ProducesResponseType( Status404NotFound )]
108111
[ODataRoute( "({key})" )]
@@ -117,6 +120,7 @@ public IActionResult Patch( int key, Delta<Order> delta )
117120
[HttpGet]
118121
[Produces( "application/json" )]
119122
[ProducesResponseType( typeof( Order ), Status200OK )]
123+
[ProducesResponseType( Status404NotFound )]
120124
[ODataRoute( nameof( MostExpensive ) )]
121125
public IActionResult MostExpensive() => Ok( new Order() { Id = 42, Customer = "Bill Mei" } );
122126

@@ -127,8 +131,11 @@ public IActionResult Patch( int key, Delta<Order> delta )
127131
/// <param name="parameters">The action parameters.</param>
128132
/// <returns>None</returns>
129133
/// <response code="204">The order was successfully rated.</response>
134+
/// <response code="400">The parameters are invalid.</response>
135+
/// <response code="404">The order does not exist.</response>
130136
[HttpPost]
131137
[ProducesResponseType( Status200OK )]
138+
[ProducesResponseType( Status400BadRequest )]
132139
[ProducesResponseType( Status404NotFound )]
133140
[ODataRoute( "({key})/Rate" )]
134141
public IActionResult Rate( int key, ODataActionParameters parameters )

samples/aspnetcore/SwaggerODataSample/V3/PeopleController.cs

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -112,6 +112,8 @@ public IActionResult Post( [FromBody] Person person )
112112
/// <param name="parameters">The action parameters.</param>
113113
/// <returns>None</returns>
114114
/// <response code="204">The person was successfully promoted.</response>
115+
/// <response code="400">The parameters are invalid.</response>
116+
/// <response code="404">The person does not exist.</response>
115117
[HttpPost]
116118
[ProducesResponseType( Status200OK )]
117119
[ProducesResponseType( Status400BadRequest )]

0 commit comments

Comments
 (0)