JsonApiErrors¶
class in JsonApiToolkit.Models.Errors
Factory methods for creating consistent, well-structured JSON:API errors.
Methods¶
NotFound(resourceType: string, id: object)¶
: JsonApiNotFoundException
Creates a 404 error for a missing resource.
Parameters
- resourceType
- id
RelatedNotFound(resourceType: string, id: object, relationship: string, relatedId: object)¶
: JsonApiNotFoundException
Creates a 404 error for a missing related resource.
Parameters
- resourceType
- id
- relationship
- relatedId
InvalidFilterValue(field: string, actualValue: string, expectedType: Type)¶
: JsonApiBadRequestException
Creates a 400 error for an invalid filter value type.
Parameters
- field
- actualValue
- expectedType
InvalidFilterField(field: string, entityType: Type, availableFields: IEnumerable)¶
: JsonApiBadRequestException
InvalidFilterOperator(op: string, validOperators: IEnumerable)¶
: JsonApiBadRequestException
InvalidSortField(field: string, entityType: Type, availableFields: IEnumerable)¶
: JsonApiBadRequestException
QueryTooComplex(limitName: string, limit: int, actual: int, configKey: string)¶
: JsonApiBadRequestException
Creates a 400 error when query exceeds complexity limits.
Parameters
- limitName
- limit
- actual
- configKey
IncludeNotAllowed(include: string, allowedIncludes: IEnumerable)¶
: JsonApiForbiddenException
FilterNotAllowed(relationshipPath: string)¶
: JsonApiForbiddenException
Creates a 403 error for filtering on a disallowed relationship.
Parameters
- relationshipPath
AlreadyExists(resourceType: string, field: string, value: object)¶
: JsonApiConflictException
Creates a 409 error for duplicate resource.
Parameters
- resourceType
- field
- value
ValidationFailed(field: string, message: string)¶
: JsonApiBadRequestException
Creates a 400 error for a validation failure.
Parameters
- field
- message
RequiredFieldMissing(field: string)¶
: JsonApiBadRequestException
Creates a 400 error for a missing required field.
Parameters
- field