Class DefaultOperationFilter

Namespace

JsonApiDotNetCore.AtomicOperations

Assembly

JsonApiDotNetCore.dll

Determines whether an operation in an atomic:operations request can be used. For non-operations requests, see IJsonApiEndpointFilter.

public class DefaultOperationFilter : IAtomicOperationFilter

Inheritance

object

DefaultOperationFilter

Implements

IAtomicOperationFilter

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Remarks

The default implementation relies on the usage of GenerateControllerEndpoints. If you're using explicit (non-generated) controllers, register your own implementation to indicate which operations are accessible.

Methods

GetJsonApiEndpoints(ResourceType)

protected virtual JsonApiEndpoints? GetJsonApiEndpoints(ResourceType resourceType)

Parameters

resourceType ResourceType

Returns

JsonApiEndpoints?

IsEnabled(ResourceType, WriteOperationKind)

Determines whether the specified operation can be used in an atomic:operations request.

public virtual bool IsEnabled(ResourceType resourceType, WriteOperationKind writeOperation)

Parameters

resourceType ResourceType

The targeted primary resource type of the operation.

writeOperation WriteOperationKind

The operation kind.

Returns

bool