json icon

Submit Review

v1.0.0commands

Command issued by a customer to submit a review and rating for a product.

1{
2  "$schema": "http://json-schema.org/draft-07/schema#",
3  "title": "SubmitReview",
4  "type": "object",
5  "properties": {
6    "reviewId": { "type": "string", "format": "uuid", "description": "Client-generated id for the review." },
7    "productId": { "type": "string", "description": "The product being reviewed." },
8    "customerId": { "type": "string", "description": "The customer submitting the review." },
9    "rating": { "type": "integer", "minimum": 1, "maximum": 5, "description": "Star rating from 1 to 5." },
10    "title": { "type": "string", "maxLength": 120 },
11    "body": { "type": "string", "maxLength": 5000 },
12    "submittedAt": { "type": "string", "format": "date-time" }
13  },
14  "required": ["reviewId", "productId", "customerId", "rating", "body", "submittedAt"]
15}
16

Details

Format
JSON Schema
Resource
commands
Filename
schema.json

Versions