Skip to main content

Review miscellaneous validation rules for feature compatibility and configuration requirements

Date Added

DateAddedMustBePresent

DefinitionSeverityAPISampleMode
Validate that dateAdded is present
VIOLATION
POST_AND_PUT
S
Example Validation Report
{
"code": "VALIDATION__DateAddedMustBePresent",
"severity": "VIOLATION",
"message": "Field '{{field}}' must be present",
"context": {
"field": "dateAdded"
}
}

DateAddedMustNotBeEmpty

DefinitionSeverityAPISampleMode
Validate that dateAdded is not an empty string
VIOLATION
POST_AND_PUT
S

ReviewsFromSameAuthorHaveSameDateAdded

Preconditions
Author imageUrl is present
DefinitionSeverityAPISampleMode
Validate that dateAdded among reviews referencing the same author imageUrl are distinct
WARNING
POST_AND_PUT
A

DateAddedMustHaveValidFormat

DefinitionSeverityAPISampleMode
Validate that dateAdded formatting is valid
VIOLATION
POST_AND_PUT
S

MustNotBeFutureDate

DefinitionSeverityAPISampleMode
Validate that dateAdded is not a future date
VIOLATION
POST_AND_PUT
S

Image URL

AspectRatioMustBeOneToOne

DefinitionSeverityAPISampleMode
Validate that the longest dimension's whole numbers are equal to the shortest dimension's whole numbers
VIOLATION
POST_AND_PUT
Link
A

ReferencedImageMustHaveRequiredSize

DefinitionSeverityAPISampleMode
Validate that the dimensions of an image, referenced via imageUrl, are within permitted range
VIOLATION
POST_AND_PUT
Link
A

Partners Review ID

PartnersReviewIdMustBePresent

DefinitionSeverityAPISampleMode
Validate that partnersReviewId is present
VIOLATION
POST_AND_PUT
S

PartnersReviewIdMustNotBeEmpty

DefinitionSeverityAPISampleMode
Validate that partnersReviewId is not an empty string
VIOLATION
POST_AND_PUT
S

Resource State

ReviewStateDoesNotAllowUndelete

DefinitionSeverityAPISampleMode
Validate that resource state is not FAILED or REJECTED
VIOLATION
UNDELETE
A

Review

UndeleteTimePeriodHasElapsed

DefinitionSeverityAPISampleMode
Validate that the quantity of days that a resource's state was DELETED is ninety (90) days or less
VIOLATION
UNDELETE
S
Example Validation Report
{
"code": "VALIDATION__UndeleteTimePeriodHasElapsed",
"message": "Undelete operation no longer available after 90 days",
"severity": "VIOLATION"
}

Review Details

UpdatedReviewShouldNotMatchExistingReview

DefinitionSeverityAPISampleMode
Validate that the review does not exactly match the previous existing record
VIOLATION
PUT
A

Configuration

Match Constraints
Exclude internal fields
Exclude reviewDetails/partnerReviewId
Limit matching to all other properties of reviewDetails