Skip to content

Commit 047257a

Browse files
authored
LYNX-155: Update documentation of queries/mutations to include introduces custom_attributes fields (#113)
1 parent b570647 commit 047257a

File tree

2 files changed

+6
-6
lines changed

2 files changed

+6
-6
lines changed

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

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -49,7 +49,7 @@ input CustomerAddressInput @doc(description: "Contains details about a billing o
4949
prefix: String @doc(description: "An honorific, such as Dr., Mr., or Mrs.")
5050
suffix: String @doc(description: "A value such as Sr., Jr., or III.")
5151
vat_id: String @doc(description: "The customer's Tax/VAT number (for corporate customers).")
52-
custom_attributes: [AttributeValueInput] @doc(description: "Deprecated: Custom attributes should not be put into container.")
52+
custom_attributes: [AttributeValueInput] @doc(description: "Custom attributes assigned to the customer address.")
5353
}
5454

5555
input CustomerAddressRegionInput @doc(description: "Defines the customer's state or province.") {
@@ -163,7 +163,7 @@ type CustomerAddress @doc(description: "Contains detailed information about a cu
163163
default_shipping: Boolean @doc(description: "Indicates whether the address is the customer's default shipping address.")
164164
default_billing: Boolean @doc(description: "Indicates whether the address is the customer's default billing address.")
165165
custom_attributes: [CustomerAddressAttribute] @deprecated(reason: "Use custom_attributesV2 instead.")
166-
custom_attributesV2: [AttributeValueInterface!]! @doc(description: "Customer address' custom attributes.")
166+
custom_attributesV2: [AttributeValueInterface!]! @doc(description: "Custom attributes assigned to the customer address.")
167167
extension_attributes: [CustomerAddressAttribute] @doc(description: "Contains any extension attributes for the address.")
168168
}
169169

@@ -175,7 +175,7 @@ type CustomerAddressRegion @doc(description: "Defines the customer's state or pr
175175

176176
type CustomerAddressAttribute @doc(description: "Specifies the attribute code and value of a customer address attribute.") {
177177
attribute_code: String @doc(description: "The name assigned to the customer address attribute.")
178-
value: String @doc(description: "The valuue assigned to the customer address attribute.")
178+
value: String @doc(description: "The value assigned to the customer address attribute.")
179179
}
180180

181181
type IsEmailAvailableOutput @doc(description: "Contains the result of the `isEmailAvailable` query.") {

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

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -36,8 +36,8 @@ type StorefrontProperties @doc(description: "Indicates where an attribute can be
3636

3737
input AttributeValueInput @doc(description: "Specifies the value for attribute.") {
3838
attribute_code: String! @doc(description: "The code of the attribute.")
39-
value: String @doc(description: "The value which should be set for the attribute")
40-
selected_options: [AttributeInputSelectedOption!] @doc(description: "An array with selected option(s) for select or multiselect attribute")
39+
value: String @doc(description: "The value assigned to the attribute.")
40+
selected_options: [AttributeInputSelectedOption!] @doc(description: "An array containing selected options for a select or multiselect attribute.")
4141
}
4242

4343
input AttributeInputSelectedOption @doc(description: "Specifies selected option for dropdown or multiselect attribute value .") {
@@ -153,7 +153,7 @@ type AttributeSelectedOption implements AttributeSelectedOptionInterface {
153153
input AttributeValueInput {
154154
attribute_code: String! @doc(description: "The attribute code.")
155155
value: String @doc(description: "The attribute value.")
156-
selected_options: [AttributeInputSelectedOption!] @doc(description: "An array with selected option(s) for select or multiselect attribute")
156+
selected_options: [AttributeInputSelectedOption!] @doc(description: "An array containing selected options for a select or multiselect attribute.")
157157
}
158158

159159
input AttributeInputSelectedOption @doc(description: "Specifies selected option for dropdown or multiselect attribute value .") {

0 commit comments

Comments
 (0)