Remove unneeded [FromBody] from overridden controller methods, add [Required] so OpenAPI can determine whether parameters are required

bkoelman · bkoelman · commit 17db8889e5d9 · 2024-03-16T14:05:23.000+01:00
diff --git a/src/JsonApiDotNetCore/Controllers/BaseJsonApiController.cs b/src/JsonApiDotNetCore/Controllers/BaseJsonApiController.cs
@@ -1,3 +1,4 @@
+using System.ComponentModel.DataAnnotations;
 using JsonApiDotNetCore.Configuration;
 using JsonApiDotNetCore.Errors;
 using JsonApiDotNetCore.Middleware;
@@ -185,7 +186,7 @@ public virtual async Task<IActionResult> GetRelationshipAsync(TId id, string rel
     /// POST /articles HTTP/1.1
     /// ]]></code>
     /// </summary>
-    public virtual async Task<IActionResult> PostAsync([FromBody] TResource resource, CancellationToken cancellationToken)
+    public virtual async Task<IActionResult> PostAsync([FromBody] [Required] TResource resource, CancellationToken cancellationToken)
     {
         _traceWriter.LogMethodStart(new
         {
@@ -235,7 +236,7 @@ public virtual async Task<IActionResult> PostAsync([FromBody] TResource resource
     /// <param name="cancellationToken">
     /// Propagates notification that request handling should be canceled.
     /// </param>
-    public virtual async Task<IActionResult> PostRelationshipAsync(TId id, string relationshipName, [FromBody] ISet<IIdentifiable> rightResourceIds,
+    public virtual async Task<IActionResult> PostRelationshipAsync(TId id, string relationshipName, [FromBody] [Required] ISet<IIdentifiable> rightResourceIds,
         CancellationToken cancellationToken)
     {
         _traceWriter.LogMethodStart(new
@@ -264,7 +265,7 @@ public virtual async Task<IActionResult> PostRelationshipAsync(TId id, string re
     /// PATCH /articles/1 HTTP/1.1
     /// ]]></code>
     /// </summary>
-    public virtual async Task<IActionResult> PatchAsync(TId id, [FromBody] TResource resource, CancellationToken cancellationToken)
+    public virtual async Task<IActionResult> PatchAsync(TId id, [FromBody] [Required] TResource resource, CancellationToken cancellationToken)
     {
         _traceWriter.LogMethodStart(new
         {
@@ -371,8 +372,8 @@ public virtual async Task<IActionResult> DeleteAsync(TId id, CancellationToken c
     /// <param name="cancellationToken">
     /// Propagates notification that request handling should be canceled.
     /// </param>
-    public virtual async Task<IActionResult> DeleteRelationshipAsync(TId id, string relationshipName, [FromBody] ISet<IIdentifiable> rightResourceIds,
-        CancellationToken cancellationToken)
+    public virtual async Task<IActionResult> DeleteRelationshipAsync(TId id, string relationshipName,
+        [FromBody] [Required] ISet<IIdentifiable> rightResourceIds, CancellationToken cancellationToken)
     {
         _traceWriter.LogMethodStart(new
         {
diff --git a/src/JsonApiDotNetCore/Controllers/BaseJsonApiOperationsController.cs b/src/JsonApiDotNetCore/Controllers/BaseJsonApiOperationsController.cs
@@ -1,3 +1,4 @@
+using System.ComponentModel.DataAnnotations;
 using JetBrains.Annotations;
 using JsonApiDotNetCore.AtomicOperations;
 using JsonApiDotNetCore.Configuration;
@@ -102,7 +103,8 @@ protected BaseJsonApiOperationsController(IJsonApiOptions options, IResourceGrap
     /// }
     /// ]]></code>
     /// </example>
-    public virtual async Task<IActionResult> PostOperationsAsync([FromBody] IList<OperationContainer> operations, CancellationToken cancellationToken)
+    public virtual async Task<IActionResult> PostOperationsAsync([FromBody] [Required] IList<OperationContainer> operations,
+        CancellationToken cancellationToken)
     {
         _traceWriter.LogMethodStart(new
         {
diff --git a/src/JsonApiDotNetCore/Controllers/JsonApiController.cs b/src/JsonApiDotNetCore/Controllers/JsonApiController.cs
@@ -72,22 +72,22 @@ public override Task<IActionResult> GetRelationshipAsync(TId id, string relation
 
     /// <inheritdoc />
     [HttpPost]
-    public override Task<IActionResult> PostAsync([FromBody] TResource resource, CancellationToken cancellationToken)
+    public override Task<IActionResult> PostAsync(TResource resource, CancellationToken cancellationToken)
     {
         return base.PostAsync(resource, cancellationToken);
     }
 
     /// <inheritdoc />
     [HttpPost("{id}/relationships/{relationshipName}")]
-    public override Task<IActionResult> PostRelationshipAsync(TId id, string relationshipName, [FromBody] ISet<IIdentifiable> rightResourceIds,
+    public override Task<IActionResult> PostRelationshipAsync(TId id, string relationshipName, ISet<IIdentifiable> rightResourceIds,
         CancellationToken cancellationToken)
     {
         return base.PostRelationshipAsync(id, relationshipName, rightResourceIds, cancellationToken);
     }
 
     /// <inheritdoc />
     [HttpPatch("{id}")]
-    public override Task<IActionResult> PatchAsync(TId id, [FromBody] TResource resource, CancellationToken cancellationToken)
+    public override Task<IActionResult> PatchAsync(TId id, TResource resource, CancellationToken cancellationToken)
     {
         return base.PatchAsync(id, resource, cancellationToken);
     }
@@ -109,7 +109,7 @@ public override Task<IActionResult> DeleteAsync(TId id, CancellationToken cancel
 
     /// <inheritdoc />
     [HttpDelete("{id}/relationships/{relationshipName}")]
-    public override Task<IActionResult> DeleteRelationshipAsync(TId id, string relationshipName, [FromBody] ISet<IIdentifiable> rightResourceIds,
+    public override Task<IActionResult> DeleteRelationshipAsync(TId id, string relationshipName, ISet<IIdentifiable> rightResourceIds,
         CancellationToken cancellationToken)
     {
         return base.DeleteRelationshipAsync(id, relationshipName, rightResourceIds, cancellationToken);
diff --git a/src/JsonApiDotNetCore/Controllers/JsonApiOperationsController.cs b/src/JsonApiDotNetCore/Controllers/JsonApiOperationsController.cs
@@ -17,7 +17,7 @@ public abstract class JsonApiOperationsController(
 {
     /// <inheritdoc />
     [HttpPost]
-    public override Task<IActionResult> PostOperationsAsync([FromBody] IList<OperationContainer> operations, CancellationToken cancellationToken)
+    public override Task<IActionResult> PostOperationsAsync(IList<OperationContainer> operations, CancellationToken cancellationToken)
     {
         return base.PostOperationsAsync(operations, cancellationToken);
     }
diff --git a/test/JsonApiDotNetCoreTests/IntegrationTests/IdObfuscation/ObfuscatedIdentifiableController.cs b/test/JsonApiDotNetCoreTests/IntegrationTests/IdObfuscation/ObfuscatedIdentifiableController.cs
@@ -1,3 +1,4 @@
+using System.ComponentModel.DataAnnotations;
 using JsonApiDotNetCore.Configuration;
 using JsonApiDotNetCore.Controllers;
 using JsonApiDotNetCore.Resources;
@@ -42,28 +43,28 @@ public Task<IActionResult> GetRelationshipAsync(string id, string relationshipNa
     }
 
     [HttpPost]
-    public override Task<IActionResult> PostAsync([FromBody] TResource resource, CancellationToken cancellationToken)
+    public override Task<IActionResult> PostAsync([FromBody] [Required] TResource resource, CancellationToken cancellationToken)
     {
         return base.PostAsync(resource, cancellationToken);
     }
 
     [HttpPost("{id}/relationships/{relationshipName}")]
-    public Task<IActionResult> PostRelationshipAsync(string id, string relationshipName, [FromBody] ISet<IIdentifiable> rightResourceIds,
+    public Task<IActionResult> PostRelationshipAsync(string id, string relationshipName, [FromBody] [Required] ISet<IIdentifiable> rightResourceIds,
         CancellationToken cancellationToken)
     {
         int idValue = _codec.Decode(id);
         return base.PostRelationshipAsync(idValue, relationshipName, rightResourceIds, cancellationToken);
     }
 
     [HttpPatch("{id}")]
-    public Task<IActionResult> PatchAsync(string id, [FromBody] TResource resource, CancellationToken cancellationToken)
+    public Task<IActionResult> PatchAsync(string id, [FromBody] [Required] TResource resource, CancellationToken cancellationToken)
     {
         int idValue = _codec.Decode(id);
         return base.PatchAsync(idValue, resource, cancellationToken);
     }
 
     [HttpPatch("{id}/relationships/{relationshipName}")]
-    public Task<IActionResult> PatchRelationshipAsync(string id, string relationshipName, [FromBody] object rightValue, CancellationToken cancellationToken)
+    public Task<IActionResult> PatchRelationshipAsync(string id, string relationshipName, [FromBody] object? rightValue, CancellationToken cancellationToken)
     {
         int idValue = _codec.Decode(id);
         return base.PatchRelationshipAsync(idValue, relationshipName, rightValue, cancellationToken);
@@ -77,7 +78,7 @@ public Task<IActionResult> DeleteAsync(string id, CancellationToken cancellation
     }
 
     [HttpDelete("{id}/relationships/{relationshipName}")]
-    public Task<IActionResult> DeleteRelationshipAsync(string id, string relationshipName, [FromBody] ISet<IIdentifiable> rightResourceIds,
+    public Task<IActionResult> DeleteRelationshipAsync(string id, string relationshipName, [FromBody] [Required] ISet<IIdentifiable> rightResourceIds,
         CancellationToken cancellationToken)
     {
         int idValue = _codec.Decode(id);

Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,4 @@`
	`1`	`+using System.ComponentModel.DataAnnotations;`
`1`	`2`	`using JsonApiDotNetCore.Configuration;`
`2`	`3`	`using JsonApiDotNetCore.Errors;`
`3`	`4`	`using JsonApiDotNetCore.Middleware;`
`@@ -185,7 +186,7 @@ public virtual async Task<IActionResult> GetRelationshipAsync(TId id, string rel`
`185`	`186`	`/// POST /articles HTTP/1.1`
`186`	`187`	`/// ]]></code>`
`187`	`188`	`/// </summary>`
`188`		`- public virtual async Task<IActionResult> PostAsync([FromBody] TResource resource, CancellationToken cancellationToken)`
	`189`	`+ public virtual async Task<IActionResult> PostAsync([FromBody] [Required] TResource resource, CancellationToken cancellationToken)`
`189`	`190`	`{`
`190`	`191`	`_traceWriter.LogMethodStart(new`
`191`	`192`	`{`
`@@ -235,7 +236,7 @@ public virtual async Task<IActionResult> PostAsync([FromBody] TResource resource`
`235`	`236`	`/// <param name="cancellationToken">`
`236`	`237`	`/// Propagates notification that request handling should be canceled.`
`237`	`238`	`/// </param>`
`238`		`- public virtual async Task<IActionResult> PostRelationshipAsync(TId id, string relationshipName, [FromBody] ISet<IIdentifiable> rightResourceIds,`
	`239`	`+ public virtual async Task<IActionResult> PostRelationshipAsync(TId id, string relationshipName, [FromBody] [Required] ISet<IIdentifiable> rightResourceIds,`
`239`	`240`	`CancellationToken cancellationToken)`
`240`	`241`	`{`
`241`	`242`	`_traceWriter.LogMethodStart(new`
`@@ -264,7 +265,7 @@ public virtual async Task<IActionResult> PostRelationshipAsync(TId id, string re`
`264`	`265`	`/// PATCH /articles/1 HTTP/1.1`
`265`	`266`	`/// ]]></code>`
`266`	`267`	`/// </summary>`
`267`		`- public virtual async Task<IActionResult> PatchAsync(TId id, [FromBody] TResource resource, CancellationToken cancellationToken)`
	`268`	`+ public virtual async Task<IActionResult> PatchAsync(TId id, [FromBody] [Required] TResource resource, CancellationToken cancellationToken)`
`268`	`269`	`{`
`269`	`270`	`_traceWriter.LogMethodStart(new`
`270`	`271`	`{`
`@@ -371,8 +372,8 @@ public virtual async Task<IActionResult> DeleteAsync(TId id, CancellationToken c`
`371`	`372`	`/// <param name="cancellationToken">`
`372`	`373`	`/// Propagates notification that request handling should be canceled.`
`373`	`374`	`/// </param>`
`374`		`- public virtual async Task<IActionResult> DeleteRelationshipAsync(TId id, string relationshipName, [FromBody] ISet<IIdentifiable> rightResourceIds,`
`375`		`- CancellationToken cancellationToken)`
	`375`	`+ public virtual async Task<IActionResult> DeleteRelationshipAsync(TId id, string relationshipName,`
	`376`	`+ [FromBody] [Required] ISet<IIdentifiable> rightResourceIds, CancellationToken cancellationToken)`
`376`	`377`	`{`
`377`	`378`	`_traceWriter.LogMethodStart(new`
`378`	`379`	`{`
Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,4 @@`
	`1`	`+using System.ComponentModel.DataAnnotations;`
`1`	`2`	`using JetBrains.Annotations;`
`2`	`3`	`using JsonApiDotNetCore.AtomicOperations;`
`3`	`4`	`using JsonApiDotNetCore.Configuration;`
`@@ -102,7 +103,8 @@ protected BaseJsonApiOperationsController(IJsonApiOptions options, IResourceGrap`
`102`	`103`	`/// }`
`103`	`104`	`/// ]]></code>`
`104`	`105`	`/// </example>`
`105`		`- public virtual async Task<IActionResult> PostOperationsAsync([FromBody] IList<OperationContainer> operations, CancellationToken cancellationToken)`
	`106`	`+ public virtual async Task<IActionResult> PostOperationsAsync([FromBody] [Required] IList<OperationContainer> operations,`
	`107`	`+ CancellationToken cancellationToken)`
`106`	`108`	`{`
`107`	`109`	`_traceWriter.LogMethodStart(new`
`108`	`110`	`{`
Original file line number	Diff line number	Diff line change
`@@ -72,22 +72,22 @@ public override Task<IActionResult> GetRelationshipAsync(TId id, string relation`
`72`	`72`
`73`	`73`	`/// <inheritdoc />`
`74`	`74`	`[HttpPost]`
`75`		`- public override Task<IActionResult> PostAsync([FromBody] TResource resource, CancellationToken cancellationToken)`
	`75`	`+ public override Task<IActionResult> PostAsync(TResource resource, CancellationToken cancellationToken)`
`76`	`76`	`{`
`77`	`77`	`return base.PostAsync(resource, cancellationToken);`
`78`	`78`	`}`
`79`	`79`
`80`	`80`	`/// <inheritdoc />`
`81`	`81`	`[HttpPost("{id}/relationships/{relationshipName}")]`
`82`		`- public override Task<IActionResult> PostRelationshipAsync(TId id, string relationshipName, [FromBody] ISet<IIdentifiable> rightResourceIds,`
	`82`	`+ public override Task<IActionResult> PostRelationshipAsync(TId id, string relationshipName, ISet<IIdentifiable> rightResourceIds,`
`83`	`83`	`CancellationToken cancellationToken)`
`84`	`84`	`{`
`85`	`85`	`return base.PostRelationshipAsync(id, relationshipName, rightResourceIds, cancellationToken);`
`86`	`86`	`}`
`87`	`87`
`88`	`88`	`/// <inheritdoc />`
`89`	`89`	`[HttpPatch("{id}")]`
`90`		`- public override Task<IActionResult> PatchAsync(TId id, [FromBody] TResource resource, CancellationToken cancellationToken)`
	`90`	`+ public override Task<IActionResult> PatchAsync(TId id, TResource resource, CancellationToken cancellationToken)`
`91`	`91`	`{`
`92`	`92`	`return base.PatchAsync(id, resource, cancellationToken);`
`93`	`93`	`}`
`@@ -109,7 +109,7 @@ public override Task<IActionResult> DeleteAsync(TId id, CancellationToken cancel`
`109`	`109`
`110`	`110`	`/// <inheritdoc />`
`111`	`111`	`[HttpDelete("{id}/relationships/{relationshipName}")]`
`112`		`- public override Task<IActionResult> DeleteRelationshipAsync(TId id, string relationshipName, [FromBody] ISet<IIdentifiable> rightResourceIds,`
	`112`	`+ public override Task<IActionResult> DeleteRelationshipAsync(TId id, string relationshipName, ISet<IIdentifiable> rightResourceIds,`
`113`	`113`	`CancellationToken cancellationToken)`
`114`	`114`	`{`
`115`	`115`	`return base.DeleteRelationshipAsync(id, relationshipName, rightResourceIds, cancellationToken);`
Original file line number	Diff line number	Diff line change
`@@ -17,7 +17,7 @@ public abstract class JsonApiOperationsController(`
`17`	`17`	`{`
`18`	`18`	`/// <inheritdoc />`
`19`	`19`	`[HttpPost]`
`20`		`- public override Task<IActionResult> PostOperationsAsync([FromBody] IList<OperationContainer> operations, CancellationToken cancellationToken)`
	`20`	`+ public override Task<IActionResult> PostOperationsAsync(IList<OperationContainer> operations, CancellationToken cancellationToken)`
`21`	`21`	`{`
`22`	`22`	`return base.PostOperationsAsync(operations, cancellationToken);`
`23`	`23`	`}`