Skip to content

Commit 9747d6a

Browse files
Chris Martinezcommonsensesoftware
authored andcommitted
Update response annotations
1 parent 32c3700 commit 9747d6a

File tree

4 files changed

+12
-5
lines changed

4 files changed

+12
-5
lines changed

samples/aspnetcore/SwaggerODataSample/V1/OrdersController.cs

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -39,6 +39,7 @@ public class OrdersController : ODataController
3939
/// <response code="400">The order is invalid.</response>
4040
[ODataRoute]
4141
[MapToApiVersion( "1.0" )]
42+
[Produces( "application/json" )]
4243
[ProducesResponseType( typeof( Order ), Status201Created )]
4344
[ProducesResponseType( Status400BadRequest )]
4445
public IActionResult Post( [FromBody] Order order )

samples/aspnetcore/SwaggerODataSample/V2/OrdersController.cs

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -60,6 +60,7 @@ public IQueryable<Order> Get()
6060
/// <response code="201">The order was successfully placed.</response>
6161
/// <response code="400">The order is invalid.</response>
6262
[ODataRoute]
63+
[Produces( "application/json" )]
6364
[ProducesResponseType( typeof( Order ), Status201Created )]
6465
[ProducesResponseType( Status400BadRequest )]
6566
public IActionResult Post( [FromBody] Order order )
@@ -84,7 +85,9 @@ public IActionResult Post( [FromBody] Order order )
8485
/// <response code="400">The order is invalid.</response>
8586
/// <response code="404">The order does not exist.</response>
8687
[ODataRoute( "({key})" )]
87-
[ProducesResponseType( typeof( Order ), Status204NoContent )]
88+
[Produces( "application/json" )]
89+
[ProducesResponseType( typeof( Order ), Status200OK )]
90+
[ProducesResponseType( Status204NoContent )]
8891
[ProducesResponseType( Status400BadRequest )]
8992
[ProducesResponseType( Status404NotFound )]
9093
public IActionResult Patch( int key, Delta<Order> delta )
@@ -126,7 +129,7 @@ public IActionResult Patch( int key, Delta<Order> delta )
126129
/// <response code="404">The order does not exist.</response>
127130
[HttpPost]
128131
[ODataRoute( "({key})/Rate" )]
129-
[ProducesResponseType( Status200OK )]
132+
[ProducesResponseType( Status204NoContent )]
130133
[ProducesResponseType( Status400BadRequest )]
131134
[ProducesResponseType( Status404NotFound )]
132135
public IActionResult Rate( int key, ODataActionParameters parameters )

samples/aspnetcore/SwaggerODataSample/V3/OrdersController.cs

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -85,7 +85,9 @@ public IActionResult Post( [FromBody] Order order )
8585
/// <response code="400">The order is invalid.</response>
8686
/// <response code="404">The order does not exist.</response>
8787
[ODataRoute( "({key})" )]
88-
[ProducesResponseType( typeof( Order ), Status204NoContent )]
88+
[Produces( "application/json" )]
89+
[ProducesResponseType( typeof( Order), Status200OK )]
90+
[ProducesResponseType( Status204NoContent )]
8991
[ProducesResponseType( Status400BadRequest )]
9092
[ProducesResponseType( Status404NotFound )]
9193
public IActionResult Patch( int key, Delta<Order> delta )
@@ -140,7 +142,7 @@ public IActionResult Patch( int key, Delta<Order> delta )
140142
/// <response code="404">The order does not exist.</response>
141143
[HttpPost]
142144
[ODataRoute( "({key})/Rate" )]
143-
[ProducesResponseType( Status200OK )]
145+
[ProducesResponseType( Status204NoContent )]
144146
[ProducesResponseType( Status400BadRequest )]
145147
[ProducesResponseType( Status404NotFound )]
146148
public IActionResult Rate( int key, ODataActionParameters parameters )

samples/aspnetcore/SwaggerODataSample/V3/PeopleController.cs

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -120,6 +120,7 @@ public IActionResult Get( int key, ODataQueryOptions<Person> options )
120120
/// <returns>The created person.</returns>
121121
/// <response code="201">The person was successfully created.</response>
122122
/// <response code="400">The person was invalid.</response>
123+
[Produces( "application/json" )]
123124
[ProducesResponseType( typeof( Person ), Status201Created )]
124125
[ProducesResponseType( Status400BadRequest )]
125126
public IActionResult Post( [FromBody] Person person )
@@ -156,7 +157,7 @@ public IActionResult Post( [FromBody] Person person )
156157
/// <response code="400">The parameters are invalid.</response>
157158
/// <response code="404">The person does not exist.</response>
158159
[HttpPost]
159-
[ProducesResponseType( Status200OK )]
160+
[ProducesResponseType( Status204NoContent )]
160161
[ProducesResponseType( Status400BadRequest )]
161162
[ProducesResponseType( Status404NotFound )]
162163
public IActionResult Promote( int key, ODataActionParameters parameters )

0 commit comments

Comments
 (0)