Skip to content

Commit 923c723

Browse files
committed
Update schema description
1 parent 5f7ad0e commit 923c723

File tree

1 file changed

+21
-21
lines changed

1 file changed

+21
-21
lines changed

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

Lines changed: 21 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -2,60 +2,60 @@
22
# See COPYING.txt for license details.
33

44
type ComparableItem {
5-
uid: ID!
5+
uid: ID! @doc(description: "The unique ID of an item in a compare list")
66
product: ProductInterface!
7-
attributes: [ProductAttribute]! @doc(description: "Product comparable attributes")
7+
attributes: [ProductAttribute]! @doc(description: "An array of product attributes that can be used to compare products")
88
}
99

1010
type ProductAttribute {
11-
code: String! @doc(description:"Attribute code")
12-
value: String! @doc(description:"Attribute display value")
11+
code: String! @doc(description: "The unique identifier for a product attribute code.")
12+
value: String! @doc(description:"The display value of the attribute")
1313
}
1414

1515
type ComparableAttribute {
16-
code: String! @doc(description: "Attribute code")
17-
label: String! @doc(description: "Attribute label")
16+
code: String! @doc(description: "An attribute code that is enabled for product comparisons")
17+
label: String! @doc(description: "The label of the attribute code")
1818
}
1919

2020
type CompareList {
21-
uid: ID! @doc(description: "Compare list id")
22-
items: [ComparableItem] @doc(description: "Comparable products")
23-
attributes: [ComparableAttribute] @doc(description: "Comparable attributes, provides codes and titles for the attributes")
21+
uid: ID! @doc(description: "The unique ID assigned to the compare list")
22+
items: [ComparableItem] @doc(description: "An array of products to compare")
23+
attributes: [ComparableAttribute] @doc(description: "An array of attributes that can be used for comparing products")
2424
item_count: Int!
2525
}
2626

2727
type Customer {
28-
compare_list: CompareList @resolver(class: "\\Magento\\CompareListGraphQl\\Model\\Resolver\\CustomerCompareList") @doc(description: "Active customers compare list")
28+
compare_list: CompareList @resolver(class: "\\Magento\\CompareListGraphQl\\Model\\Resolver\\CustomerCompareList") @doc(description: "The contents of the customer's compare list")
2929
}
3030

3131
type Query {
32-
compareList(uid: ID!): CompareList @resolver(class: "\\Magento\\CompareListGraphQl\\Model\\Resolver\\CompareList") @doc(description: "Compare list")
32+
compareList(uid: ID!): CompareList @resolver(class: "\\Magento\\CompareListGraphQl\\Model\\Resolver\\CompareList") @doc(description: "Return products that have been added to the specified compare list")
3333
}
3434

3535
type Mutation {
36-
createCompareList(input: CreateCompareListInput): CompareList @resolver(class: "\\Magento\\CompareListGraphQl\\Model\\Resolver\\CreateCompareList") @doc(description: "Creates a new compare list. For a logged in user, the created list is assigned to the user")
37-
addProductsToCompareList(input: AddProductsToCompareListInput): CompareList @resolver(class: "\\Magento\\CompareListGraphQl\\Model\\Resolver\\AddProductsToCompareList") @doc(description: "Add products to compare list")
38-
removeProductsFromCompareList(input: RemoveProductsFromCompareListInput): CompareList @resolver(class: "\\Magento\\CompareListGraphQl\\Model\\Resolver\\RemoveProductsFromCompareList") @doc(description: "Remove products from compare list")
36+
createCompareList(input: CreateCompareListInput): CompareList @resolver(class: "\\Magento\\CompareListGraphQl\\Model\\Resolver\\CreateCompareList") @doc(description: "Creates a new compare list. The compare list is saved for logged in customers")
37+
addProductsToCompareList(input: AddProductsToCompareListInput): CompareList @resolver(class: "\\Magento\\CompareListGraphQl\\Model\\Resolver\\AddProductsToCompareList") @doc(description: "Add products to the specified compare list")
38+
removeProductsFromCompareList(input: RemoveProductsFromCompareListInput): CompareList @resolver(class: "\\Magento\\CompareListGraphQl\\Model\\Resolver\\RemoveProductsFromCompareList") @doc(description: "Remove products from the specified compare list")
3939
assignCompareListToCustomer(uid: ID!): AssignCompareListToCustomerOutput @resolver(class: "\\Magento\\CompareListGraphQl\\Model\\Resolver\\AssignCompareListToCustomer") @doc(description: "Assign compare list to customer")
40-
deleteCompareList(uid: ID!): DeleteCompareListOutput @resolver(class: "\\Magento\\CompareListGraphQl\\Model\\Resolver\\DeleteCompareList") @doc(description: "Delete compare list")
40+
deleteCompareList(uid: ID!): DeleteCompareListOutput @resolver(class: "\\Magento\\CompareListGraphQl\\Model\\Resolver\\DeleteCompareList") @doc(description: "Delete the specified compare list")
4141
}
4242

4343
input CreateCompareListInput {
44-
products: [ID!]
44+
products: [ID!] @doc(description: "An array of product IDs to add to the compare list")
4545
}
4646

4747
input AddProductsToCompareListInput {
48-
uid: ID!,
49-
products: [ID!]!
48+
uid: ID!, @doc(description: "The unique identifier of the compare list to modify")
49+
products: [ID!]! @doc(description: "An array of product IDs to add to the compare list")
5050
}
5151

5252
input RemoveProductsFromCompareListInput {
53-
uid: ID!,
54-
products: [ID!]!
53+
uid: ID!, @doc(description: "The unique identifier of the compare list to modify")
54+
products: [ID!]! @doc(description: "An array of product IDs to remove from the compare list")
5555
}
5656

5757
type DeleteCompareListOutput {
58-
result: Boolean!
58+
result: Boolean! @doc(description: "Indicates whether the compare list was successfully deleted")
5959
}
6060

6161
type AssignCompareListToCustomerOutput {

0 commit comments

Comments
 (0)