Skip to content

Fixed: HTTP 415 error at operations endpoint when using OpenAPI extension #1971

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.

Sign up for GitHub

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
bkoelman merged 1 commit into from
Apr 11, 2026
Merged

Fixed: HTTP 415 error at operations endpoint when using OpenAPI extension #1971

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
50 changes: 41 additions & 9 deletions src/JsonApiDotNetCore.OpenApi.Swashbuckle/JsonApiActionDescriptorCollectionProvider.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,23 @@ internal sealed class JsonApiActionDescriptorCollectionProvider : IActionDescrip
private const int FilterScope = 10;
private static readonly Type ErrorDocumentType = typeof(ErrorResponseDocument);

private static readonly ConsumesMediaTypeCollection RegularMediaTypes = new([
JsonApiMediaType.Default,
OpenApiMediaTypes.OpenApi,
#pragma warning disable CS0618 // Type or member is obsolete
OpenApiMediaTypes.RelaxedOpenApi
#pragma warning restore CS0618 // Type or member is obsolete
]);

private static readonly ConsumesMediaTypeCollection OperationsMediaTypes = new([
JsonApiMediaType.AtomicOperations,
OpenApiMediaTypes.AtomicOperationsWithOpenApi,
#pragma warning disable CS0618 // Type or member is obsolete
JsonApiMediaType.RelaxedAtomicOperations,
OpenApiMediaTypes.RelaxedAtomicOperationsWithRelaxedOpenApi
#pragma warning restore CS0618 // Type or member is obsolete
]);

private readonly IActionDescriptorCollectionProvider _defaultProvider;
private readonly IControllerResourceMapping _controllerResourceMapping;
private readonly JsonApiEndpointMetadataProvider _jsonApiEndpointMetadataProvider;
Expand Down Expand Up @@ -220,14 +237,14 @@ private ActionDescriptor[] SetEndpointMetadata(ActionDescriptor descriptor)
{
case AtomicOperationsRequestMetadata atomicOperationsRequestMetadata:
{
SetConsumes(descriptor, atomicOperationsRequestMetadata.DocumentType, JsonApiMediaType.AtomicOperations);
SetConsumes(descriptor, atomicOperationsRequestMetadata.DocumentType, OperationsMediaTypes);
UpdateRequestBodyParameterDescriptor(descriptor, atomicOperationsRequestMetadata.DocumentType, null);

break;
}
case PrimaryRequestMetadata primaryRequestMetadata:
{
SetConsumes(descriptor, primaryRequestMetadata.DocumentType, JsonApiMediaType.Default);
SetConsumes(descriptor, primaryRequestMetadata.DocumentType, RegularMediaTypes);
UpdateRequestBodyParameterDescriptor(descriptor, primaryRequestMetadata.DocumentType, null);

break;
Expand All @@ -243,7 +260,7 @@ private ActionDescriptor[] SetEndpointMetadata(ActionDescriptor descriptor)

RemovePathParameter(relationshipDescriptor.Parameters, "relationshipName");
ExpandTemplate(relationshipDescriptor.AttributeRouteInfo!, relationship.PublicName);
SetConsumes(descriptor, documentType, JsonApiMediaType.Default);
SetConsumes(descriptor, documentType, RegularMediaTypes);
UpdateRequestBodyParameterDescriptor(relationshipDescriptor, documentType, relationship.PublicName);

descriptorsByRelationship[relationship] = relationshipDescriptor;
Expand Down Expand Up @@ -302,22 +319,23 @@ private ActionDescriptor[] SetEndpointMetadata(ActionDescriptor descriptor)
return isNonPrimaryEndpoint ? descriptorsByRelationship.Values.ToArray() : [descriptor];
}

private static void SetConsumes(ActionDescriptor descriptor, Type requestType, JsonApiMediaType mediaType)
private static void SetConsumes(ActionDescriptor descriptor, Type requestType, ConsumesMediaTypeCollection mediaTypes)
{
RemoveFiltersForRequestBody(descriptor);

// This value doesn't actually appear in the OpenAPI document, but is only used to invoke
// JsonApiRequestFormatMetadataProvider.GetSupportedContentTypes(), which determines the actual request content type.
string contentType = mediaType.ToString();

if (descriptor is ControllerActionDescriptor controllerActionDescriptor &&
controllerActionDescriptor.MethodInfo.GetCustomAttributes<ConsumesAttribute>().Any())
{
// A custom JSON:API action method with [Consumes] on it. Hide the attribute from Swashbuckle, so it uses our data in API Explorer.
controllerActionDescriptor.MethodInfo = new MethodInfoWrapper(controllerActionDescriptor.MethodInfo, [typeof(ConsumesAttribute)]);
}

descriptor.FilterDescriptors.Add(new FilterDescriptor(new ConsumesAttribute(requestType, contentType), FilterScope));
// These media types don't actually appear in the OpenAPI document, but are used to invoke
// JsonApiRequestFormatMetadataProvider.GetSupportedContentTypes(), which determines the actual request content type.
// We need to pass all possible media types, otherwise ASP.NET Core's content negotiation returns HTTP 415.

var consumesAttribute = new ConsumesAttribute(requestType, mediaTypes.ContentType, mediaTypes.OtherContentTypes);
descriptor.FilterDescriptors.Add(new FilterDescriptor(consumesAttribute, FilterScope));
}

private static void RemoveFiltersForRequestBody(ActionDescriptor descriptor)
Expand Down Expand Up @@ -474,4 +492,18 @@ private static void SetNonPrimaryResponseMetadata(ActionDescriptor descriptor,

descriptorsByRelationship[relationship] = relationshipDescriptor;
}

private sealed class ConsumesMediaTypeCollection
{
public string ContentType { get; }
public string[] OtherContentTypes { get; }

public ConsumesMediaTypeCollection(JsonApiMediaType[] mediaTypes)
{
ArgumentGuard.NotNullNorEmpty(mediaTypes);

ContentType = mediaTypes[0].ToString();
OtherContentTypes = mediaTypes.Skip(1).Select(mediaType => mediaType.ToString()).ToArray();
}
}
}
Loading