Skip to content

Move [FromBody] back on base controllers, to prevent a breaking change #1508

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.

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
Mar 18, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
11 changes: 6 additions & 5 deletions src/JsonApiDotNetCore/Controllers/BaseJsonApiController.cs
Original file line number Diff line number Diff line change
Expand Up @@ -185,7 +185,7 @@ public virtual async Task<IActionResult> GetRelationshipAsync(TId id, string rel
/// POST /articles HTTP/1.1
/// ]]></code>
/// </summary>
public virtual async Task<IActionResult> PostAsync(TResource resource, CancellationToken cancellationToken)
public virtual async Task<IActionResult> PostAsync([FromBody] TResource resource, CancellationToken cancellationToken)
{
_traceWriter.LogMethodStart(new
{
Expand Down Expand Up @@ -235,7 +235,7 @@ public virtual async Task<IActionResult> PostAsync(TResource resource, Cancellat
/// <param name="cancellationToken">
/// Propagates notification that request handling should be canceled.
/// </param>
public virtual async Task<IActionResult> PostRelationshipAsync(TId id, string relationshipName, ISet<IIdentifiable> rightResourceIds,
public virtual async Task<IActionResult> PostRelationshipAsync(TId id, string relationshipName, [FromBody] ISet<IIdentifiable> rightResourceIds,
CancellationToken cancellationToken)
{
_traceWriter.LogMethodStart(new
Expand Down Expand Up @@ -264,7 +264,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, TResource resource, CancellationToken cancellationToken)
public virtual async Task<IActionResult> PatchAsync(TId id, [FromBody] TResource resource, CancellationToken cancellationToken)
{
_traceWriter.LogMethodStart(new
{
Expand Down Expand Up @@ -310,7 +310,8 @@ public virtual async Task<IActionResult> PatchAsync(TId id, TResource resource,
/// <param name="cancellationToken">
/// Propagates notification that request handling should be canceled.
/// </param>
public virtual async Task<IActionResult> PatchRelationshipAsync(TId id, string relationshipName, object? rightValue, CancellationToken cancellationToken)
public virtual async Task<IActionResult> PatchRelationshipAsync(TId id, string relationshipName, [FromBody] object? rightValue,
CancellationToken cancellationToken)
{
_traceWriter.LogMethodStart(new
{
Expand Down Expand Up @@ -370,7 +371,7 @@ 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, ISet<IIdentifiable> rightResourceIds,
public virtual async Task<IActionResult> DeleteRelationshipAsync(TId id, string relationshipName, [FromBody] ISet<IIdentifiable> rightResourceIds,
CancellationToken cancellationToken)
{
_traceWriter.LogMethodStart(new
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -102,7 +102,7 @@ protected BaseJsonApiOperationsController(IJsonApiOptions options, IResourceGrap
/// }
/// ]]></code>
/// </example>
public virtual async Task<IActionResult> PostOperationsAsync(IList<OperationContainer> operations, CancellationToken cancellationToken)
public virtual async Task<IActionResult> PostOperationsAsync([FromBody] IList<OperationContainer> operations, CancellationToken cancellationToken)
{
_traceWriter.LogMethodStart(new
{
Expand Down
10 changes: 5 additions & 5 deletions src/JsonApiDotNetCore/Controllers/JsonApiController.cs
Original file line number Diff line number Diff line change
Expand Up @@ -73,30 +73,30 @@ public override Task<IActionResult> GetRelationshipAsync([Required] TId id, [Req

/// <inheritdoc />
[HttpPost]
public override Task<IActionResult> PostAsync([FromBody] [Required] TResource resource, CancellationToken cancellationToken)
public override Task<IActionResult> PostAsync([Required] TResource resource, CancellationToken cancellationToken)
{
return base.PostAsync(resource, cancellationToken);
}

/// <inheritdoc />
[HttpPost("{id}/relationships/{relationshipName}")]
public override Task<IActionResult> PostRelationshipAsync([Required] TId id, [Required] string relationshipName,
[FromBody] [Required] ISet<IIdentifiable> rightResourceIds, CancellationToken cancellationToken)
[Required] ISet<IIdentifiable> rightResourceIds, CancellationToken cancellationToken)
{
return base.PostRelationshipAsync(id, relationshipName, rightResourceIds, cancellationToken);
}

/// <inheritdoc />
[HttpPatch("{id}")]
public override Task<IActionResult> PatchAsync([Required] TId id, [FromBody] [Required] TResource resource, CancellationToken cancellationToken)
public override Task<IActionResult> PatchAsync([Required] TId id, [Required] TResource resource, CancellationToken cancellationToken)
{
return base.PatchAsync(id, resource, cancellationToken);
}

/// <inheritdoc />
[HttpPatch("{id}/relationships/{relationshipName}")]
// Parameter `[Required] object? rightValue` makes Swashbuckle generate the OpenAPI request body as required. We don't actually validate ModelState, so it doesn't hurt.
public override Task<IActionResult> PatchRelationshipAsync([Required] TId id, [Required] string relationshipName, [FromBody] [Required] object? rightValue,
public override Task<IActionResult> PatchRelationshipAsync([Required] TId id, [Required] string relationshipName, [Required] object? rightValue,
CancellationToken cancellationToken)
{
return base.PatchRelationshipAsync(id, relationshipName, rightValue, cancellationToken);
Expand All @@ -112,7 +112,7 @@ public override Task<IActionResult> DeleteAsync([Required] TId id, CancellationT
/// <inheritdoc />
[HttpDelete("{id}/relationships/{relationshipName}")]
public override Task<IActionResult> DeleteRelationshipAsync([Required] TId id, [Required] string relationshipName,
[FromBody] [Required] ISet<IIdentifiable> rightResourceIds, CancellationToken cancellationToken)
[Required] ISet<IIdentifiable> rightResourceIds, CancellationToken cancellationToken)
{
return base.DeleteRelationshipAsync(id, relationshipName, rightResourceIds, cancellationToken);
}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ public abstract class JsonApiOperationsController(
{
/// <inheritdoc />
[HttpPost]
public override Task<IActionResult> PostOperationsAsync([FromBody] [Required] IList<OperationContainer> operations, CancellationToken cancellationToken)
public override Task<IActionResult> PostOperationsAsync([Required] IList<OperationContainer> operations, CancellationToken cancellationToken)
{
return base.PostOperationsAsync(operations, cancellationToken);
}
Expand Down