Skip to content

Commit 017da27

Browse files
committed
Updating schema description
1 parent 7089708 commit 017da27

File tree

1 file changed

+17
-17
lines changed

1 file changed

+17
-17
lines changed

app/code/Magento/ReviewGraphQl/etc/schema.graphqls

Lines changed: 17 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -17,31 +17,31 @@ type ProductReviews {
1717

1818
type ProductReview @doc(description: "Details of a product review") {
1919
product: ProductInterface! @doc(description: "Contains details about the reviewed product") @resolver(class: "Magento\\CatalogGraphQl\\Model\\Resolver\\Product")
20-
summary: String! @doc(description: "The review summary (a.k.a title")
20+
summary: String! @doc(description: "The summary (title) of the review")
2121
text: String! @doc(description: "The review text.")
22-
nickname: String! @doc(description: "The customer's nickname. Defaults to customer name if logged in.")
22+
nickname: String! @doc(description: "The customer's nickname. Defaults to the customer name, if logged in")
2323
created_at: String! @doc(description: "Date indicating when the review was created.")
2424
average_rating: Float! @doc(description: "The average rating for product review.") @resolver(class: "Magento\\ReviewGraphQl\\Model\\Resolver\\Product\\Review\\AverageRating")
25-
ratings_breakdown: [ProductReviewRating!]! @doc(description: "An array of ratings by rating category. For example quality, price.") @resolver(class: "Magento\\ReviewGraphQl\\Model\\Resolver\\Product\\Review\\RatingBreakdown")
25+
ratings_breakdown: [ProductReviewRating!]! @doc(description: "An array of ratings by rating category, such as quality, price, and value") @resolver(class: "Magento\\ReviewGraphQl\\Model\\Resolver\\Product\\Review\\RatingBreakdown")
2626
}
2727

2828
type ProductReviewRating {
29-
name: String! @doc(description: "The review rating name for example quality, price.")
30-
value: String! @doc(description: "The rating value given by customer. Possible values by default: 1 to 5.")
29+
name: String! @doc(description: "The label assigned to an aspect of a product that is being rated, such as quality or price")
30+
value: String! @doc(description: "The rating value given by customer. By default, possible values range from 1 to 5.")
3131
}
3232

3333
type Query {
34-
productReviewRatingsMetadata: ProductReviewRatingsMetadata! @doc(description: "Metadata required by clients to render ratings & reviews section.") @resolver(class: "Magento\\ReviewGraphQl\\Model\\Resolver\\ProductReviewRatingsMetadata")
34+
productReviewRatingsMetadata: ProductReviewRatingsMetadata! @doc(description: "Retrieves metadata required by clients to render the Reviews section.") @resolver(class: "Magento\\ReviewGraphQl\\Model\\Resolver\\ProductReviewRatingsMetadata")
3535
}
3636

3737
type ProductReviewRatingsMetadata {
38-
items: [ProductReviewRatingMetadata!]! @doc(description: "List of product reviews sorted based on position")
38+
items: [ProductReviewRatingMetadata!]! @doc(description: "List of product reviews sorted by position")
3939
}
4040

4141
type ProductReviewRatingMetadata {
42-
id: String! @doc(description: "Base 64 encoded rating id.")
43-
name: String! @doc(description: "The review rating name for example quality, price")
44-
values: [ProductReviewRatingValueMetadata!]! @doc(description: "List of product review ratings sorted based on position.") @resolver(class: "Magento\\ReviewGraphQl\\Model\\Resolver\\ProductReviewRatingValueMetadata")
42+
id: String! @doc(description: "Base64 encoded rating ID.")
43+
name: String! @doc(description: "The label assigned to an aspect of a product that is being rated, such as quality or price")
44+
values: [ProductReviewRatingValueMetadata!]! @doc(description: "List of product review ratings sorted by position.") @resolver(class: "Magento\\ReviewGraphQl\\Model\\Resolver\\ProductReviewRatingValueMetadata")
4545
}
4646

4747
type ProductReviewRatingValueMetadata {
@@ -53,26 +53,26 @@ type Customer {
5353
reviews(
5454
pageSize: Int = 20 @doc(description: "Specifies the maximum number of results to return at once."),
5555
currentPage: Int = 1 @doc(description: "Specifies which page of results to return."),
56-
): ProductReviews! @resolver(class: "Magento\\ReviewGraphQl\\Model\\Resolver\\Customer\\Reviews")
56+
): ProductReviews! @doc(description: "Contains the customer's product reviews") @resolver(class: "Magento\\ReviewGraphQl\\Model\\Resolver\\Customer\\Reviews")
5757
}
5858

5959
type Mutation {
60-
createProductReview(input: CreateProductReviewInput!): CreateProductReviewOutput! @resolver(class: "Magento\\ReviewGraphQl\\Model\\Resolver\\CreateProductReview")
60+
createProductReview(input: CreateProductReviewInput!): CreateProductReviewOutput! @doc(description: "Creates a product review for the specified SKU") @resolver(class: "Magento\\ReviewGraphQl\\Model\\Resolver\\CreateProductReview")
6161
}
6262

6363
type CreateProductReviewOutput {
64-
review: ProductReview!
64+
review: ProductReview! @doc(description: "Contains the completed product review")
6565
}
6666

6767
input CreateProductReviewInput {
68-
sku: String! @doc(description: "The SKU of the product that the review is assigned")
69-
nickname: String! @doc(description: "The customer's nickname. Defaults to customer name if logged in.")
70-
summary: String! @doc(description: "The review summary (a.k.a title")
68+
sku: String! @doc(description: "The SKU of the reviewed product")
69+
nickname: String! @doc(description: "The customer's nickname. Defaults to the customer name, if logged in")
70+
summary: String! @doc(description: "The summary (title) of the review")
7171
text: String! @doc(description: "The review text.")
7272
ratings: [ProductReviewRatingInput!]! @doc(description: "Ratings details by category. e.g price: 5, quality: 4 etc")
7373
}
7474

7575
input ProductReviewRatingInput {
76-
id: String! @doc(description: "Base 64 encoded rating id.")
76+
id: String! @doc(description: "Base64 encoded rating ID.")
7777
value_id: String! @doc(description: "Base 64 encoded rating value id.")
7878
}

0 commit comments

Comments
 (0)