Skip to content

Commit 78d8ae6

Browse files
committed
DOC-475: Fix typos and make tweaks
1 parent 8d72ba3 commit 78d8ae6

File tree

9 files changed

+27
-27
lines changed

9 files changed

+27
-27
lines changed

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ type CheckoutAgreement @doc(description: "Contains details about an individual c
1212
content_height: String @doc(description: "The height of the text box where the Terms and Conditions statement appears during checkout.")
1313
checkbox_text: String! @doc(description: "The checkbox text for the checkout agreement.")
1414
is_html: Boolean! @doc(description: "Indicates whether the `content` text is in HTML format.")
15-
mode: CheckoutAgreementMode! @doc(description: "Whether agreements are accepted automatically or manually.")
15+
mode: CheckoutAgreementMode! @doc(description: "Indicates whether agreements are accepted automatically or manually.")
1616
}
1717

1818
enum CheckoutAgreementMode @doc(description: "Indicates how agreements are accepted.") {

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,9 +10,9 @@ type Query {
1010
type Currency {
1111
base_currency_code: String @doc(description: "The base currency set for the store, such as USD.")
1212
base_currency_symbol: String @doc(description: "The symbol for the specified base currency, such as $.")
13-
default_display_currecy_code: String @deprecated(reason: "Field name is misspelled. Use `default_display_currency_code` instead.")
13+
default_display_currecy_code: String @deprecated(reason: "The ield name is misspelled. Use `default_display_currency_code` instead.")
1414
default_display_currency_code: String @doc(description: "The currency that is displayed by default, such as USD.")
15-
default_display_currecy_symbol: String @deprecated(reason: "Field name is misspelled. Use `default_display_currency_symbol` instead.")
15+
default_display_currecy_symbol: String @deprecated(reason: "The field name is misspelled. Use `default_display_currency_symbol` instead.")
1616
default_display_currency_symbol: String @doc(description: "The currency symbol that is displayed by default, such as $.")
1717
available_currency_codes: [String] @doc(description: "An array of three-letter currency codes accepted by the store, such as USD and EUR.")
1818
exchange_rates: [ExchangeRate] @doc(description: "An array of exchange rates for currencies defined in the store.")

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ type Attribute @doc(description: "Contains details about the attribute, includin
1515
attribute_type: String @doc(description: "The data type of the attribute.")
1616
input_type: String @doc(description: "The frontend input type of the attribute.")
1717
attribute_options: [AttributeOption] @resolver(class: "Magento\\EavGraphQl\\Model\\Resolver\\AttributeOptions") @doc(description: "Attribute options list.")
18-
storefront_properties: StorefrontProperties @doc(description: "Contains details about the storefront properties configured for the attribute.")
18+
storefront_properties: StorefrontProperties @doc(description: "Details about the storefront properties configured for the attribute.")
1919
}
2020

2121
type StorefrontProperties @doc(description: "Indicates where an attribute can be displayed.") {
@@ -26,7 +26,7 @@ type StorefrontProperties @doc(description: "Indicates where an attribute can be
2626
use_in_search_results_layered_navigation: Boolean @doc(description: "Indicates whether the attribute can be used in layered navigation on search results pages.")
2727
}
2828

29-
enum UseInLayeredNavigationOptions @doc(description: "Defines whether the attribute filterable in layered navigation.") {
29+
enum UseInLayeredNavigationOptions @doc(description: "Defines whether the attribute is filterable in layered navigation.") {
3030
NO
3131
FILTERABLE_WITH_RESULTS
3232
FILTERABLE_NO_RESULT

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
# See COPYING.txt for license details.
33

44
type Mutation {
5-
subscribeEmailToNewsletter(email: String! @doc(description: "The email address to subscribe.")): SubscribeEmailToNewsletterOutput @doc(description:"Subscribe the specified email to a newsletter") @resolver(class: "Magento\\NewsletterGraphQl\\Model\\Resolver\\SubscribeEmailToNewsletter")
5+
subscribeEmailToNewsletter(email: String! @doc(description: "The email address to subscribe.")): SubscribeEmailToNewsletterOutput @doc(description:"Subscribe the specified email to the store's newsletter.") @resolver(class: "Magento\\NewsletterGraphQl\\Model\\Resolver\\SubscribeEmailToNewsletter")
66
}
77

88
type SubscribeEmailToNewsletterOutput @doc(description: "Contains the status of the request.") {

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

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -7,20 +7,20 @@ type Query {
77
}
88

99
type Mutation {
10-
createPaypalExpressToken(input: PaypalExpressTokenInput! @doc(description: "An input object that defines the requirements to receive a payment token.")): PaypalExpressTokenOutput @resolver(class: "\\Magento\\PaypalGraphQl\\Model\\Resolver\\PaypalExpressToken") @doc(description:"Initiate an Express Checkout transaction and receives a token. Use this mutation for Express Checkout and Payments Standard payment methods.")
11-
createPayflowProToken(input: PayflowProTokenInput! @doc(description: "An input object that defines the requirements to fetch payment token information.")): CreatePayflowProTokenOutput @resolver(class: "\\Magento\\PaypalGraphQl\\Model\\Resolver\\PayflowProToken") @doc(description: "Initiate a transaction and receives a token. Use this mutation for Payflow Pro and Payments Pro payment methods")
10+
createPaypalExpressToken(input: PaypalExpressTokenInput! @doc(description: "An input object that defines the requirements to receive a payment token.")): PaypalExpressTokenOutput @resolver(class: "\\Magento\\PaypalGraphQl\\Model\\Resolver\\PaypalExpressToken") @doc(description:"Initiate an Express Checkout transaction and receive a token. Use this mutation for Express Checkout and Payments Standard payment methods.")
11+
createPayflowProToken(input: PayflowProTokenInput! @doc(description: "An input object that defines the requirements to fetch payment token information.")): CreatePayflowProTokenOutput @resolver(class: "\\Magento\\PaypalGraphQl\\Model\\Resolver\\PayflowProToken") @doc(description: "Initiate a transaction and receive a token. Use this mutation for Payflow Pro and Payments Pro payment methods")
1212
handlePayflowProResponse(input: PayflowProResponseInput! @doc(description: "An input object that includes the payload returned by PayPal and the cart ID.")): PayflowProResponseOutput @resolver(class: "\\Magento\\PaypalGraphQl\\Model\\Resolver\\PayflowProResponse") @doc(description: "Handle a payment response and save the payment in Quote. Use this mutation for Payflow Pro and Payments Pro payment methods.")
1313
}
1414

1515
input PaypalExpressTokenInput @doc(description: "Defines the attributes required to receive a payment token for Express Checkout and Payments Standard payment methods.") {
1616
cart_id: String! @doc(description:"The unique ID that identifies the customer's cart.")
1717
code: String! @doc(description:"The payment method code.")
18-
urls: PaypalExpressUrlsInput! @doc(description:"A set of relative URLs that PayPal uses in response to various actions during the authorization process")
18+
urls: PaypalExpressUrlsInput! @doc(description:"A set of relative URLs that PayPal uses in response to various actions during the authorization process.")
1919
use_paypal_credit: Boolean @doc(description: "Indicates whether the buyer clicked the PayPal credit button. The default value is false.")
2020
express_button: Boolean @doc(description: "Indicates whether the buyer selected the quick checkout button. The default value is false.")
2121
}
2222

23-
type PaypalExpressToken @doc(description: "Deprecated: use `PaypalExpressTokenOutput` instead.") {
23+
type PaypalExpressToken @doc(description: "Deprecated. Use `PaypalExpressTokenOutput` instead.") {
2424
token: String @deprecated(reason: "Use `PaypalExpressTokenOutput.token` instead.") @doc(description:"The token returned by PayPal.")
2525
paypal_urls: PaypalExpressUrlList @deprecated(reason: "Use `PaypalExpressTokenOutput.paypal_urls` instead.") @doc(description:"A set of URLs that allow the buyer to authorize payment and adjust checkout details.")
2626
}
@@ -49,9 +49,9 @@ input PaymentMethodInput {
4949
paypal_express: PaypalExpressInput @doc(description:"Required input for Express Checkout and Payments Standard payments.")
5050
payflow_express: PayflowExpressInput @doc(description:"Required input for Payflow Express Checkout payments.")
5151
payflow_link: PayflowLinkInput @doc(description:"Required input for PayPal Payflow Link and Payments Advanced payments.")
52-
payflowpro: PayflowProInput @doc(description: "Required input type for PayPal Payflow Pro and Payment Pro payments.")
52+
payflowpro: PayflowProInput @doc(description: "Required input for PayPal Payflow Pro and Payment Pro payments.")
5353
hosted_pro: HostedProInput @doc(description:"Required input for PayPal Hosted pro payments.")
54-
payflowpro_cc_vault: VaultTokenInput @doc(description:"Required input type for PayPal Payflow Pro vault payments.")
54+
payflowpro_cc_vault: VaultTokenInput @doc(description:"Required input for PayPal Payflow Pro vault payments.")
5555
}
5656

5757
input HostedProInput @doc(description:"Contains a set of relative URLs that PayPal uses in response to various actions during the authorization process. Magento prepends the base URL to this value to create a full URL. For example, if the full URL is https://www.example.com/path/to/page.html, the relative URL is path/to/page.html. Use this input for Payments Pro Hosted Solution payment method.") {
@@ -73,7 +73,7 @@ input PaypalExpressUrlsInput @doc(description:"Contains a set of relative URLs t
7373
return_url: String! @doc(description:"The relative URL of the final confirmation page that PayPal redirects to upon payment success. If the full URL to this page is https://www.example.com/paypal/action/return.html, the relative URL is paypal/action/return.html.")
7474
cancel_url: String! @doc(description:"The relative URL of the page that PayPal redirects to when the buyer cancels the transaction in order to choose a different payment method. If the full URL to this page is https://www.example.com/paypal/action/cancel.html, the relative URL is paypal/action/cancel.html.")
7575
success_url: String @doc(description:"The relative URL of the order confirmation page that PayPal redirects to when the payment is successful and additional confirmation is not needed. Not applicable to most PayPal solutions. If the full URL to this page is https://www.example.com/paypal/action/success.html, the relative URL is paypal/action/success.html.")
76-
pending_url: String @doc(description:"The relative URL of the page that PayPal redirects to when the payment has been put on hold for additional review. This condition mostly applies to ACH transactions, and is not applicable to most PayPal solutions. If the full URL to this page is https://www.example.com/paypal/action/success_pending.html, the relative URL is paypal/action/success_pending.html. ")
76+
pending_url: String @doc(description:"The relative URL of the page that PayPal redirects to when the payment has been put on hold for additional review. This condition mostly applies to ACH transactions, and is not applicable to most PayPal solutions. If the full URL to this page is https://www.example.com/paypal/action/success_pending.html, the relative URL is paypal/action/success_pending.html.")
7777
}
7878

7979
type PaypalExpressUrlList @doc(description:"Contains a set of URLs that allow the buyer to authorize payment and adjust checkout details for Express Checkout and Payments Standard transactions.") {
@@ -91,7 +91,7 @@ input PayflowLinkTokenInput @doc(description:"Contains information required to f
9191
cart_id: String! @doc(description:"The unique ID that identifies the customer's cart.")
9292
}
9393

94-
enum PayflowLinkMode @doc(description:"Mode for payment: TEST or LIVE. Applies to the Payflow Link and Payments Advanced payment methods.") {
94+
enum PayflowLinkMode @doc(description:"Indicates the mode for payment. Applies to the Payflow Link and Payments Advanced payment methods.") {
9595
TEST
9696
LIVE
9797
}

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

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -35,18 +35,18 @@ type Query {
3535
}
3636

3737
type ProductReviewRatingsMetadata @doc(description: "Contains an array of metadata about each aspect of a product review.") {
38-
items: [ProductReviewRatingMetadata!]! @doc(description: "List of product reviews sorted by position")
38+
items: [ProductReviewRatingMetadata!]! @doc(description: "An array of product reviews sorted by position.")
3939
}
4040

4141
type ProductReviewRatingMetadata @doc(description: "Contains details about a single aspect of a product review.") {
4242
id: String! @doc(description: "An 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")
43+
name: String! @doc(description: "The label assigned to an aspect of a product that is being rated, such as quality or price.")
4444
values: [ProductReviewRatingValueMetadata!]! @doc(description: "List of product review ratings sorted by position.") @resolver(class: "Magento\\ReviewGraphQl\\Model\\Resolver\\ProductReviewRatingValueMetadata")
4545
}
4646

4747
type ProductReviewRatingValueMetadata @doc(description: "Contails details about a single value in a product review.") {
48-
value_id: String! @doc(description: "An encoded rating value id.")
49-
value: String! @doc(description: "A ratings scale, such as the number of stars awarded")
48+
value_id: String! @doc(description: "An encoded rating value ID.")
49+
value: String! @doc(description: "A ratings scale, such as the number of stars awarded.")
5050
}
5151

5252
type Customer {

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

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,13 @@
11
# Copyright © Magento, Inc. All rights reserved.
22
# See COPYING.txt for license details.
33
type Query {
4-
storeConfig : StoreConfig @resolver(class: "Magento\\StoreGraphQl\\Model\\Resolver\\StoreConfigResolver") @doc(description: "Returns details about the store's configuration.") @cache(cacheable: false)
4+
storeConfig : StoreConfig @resolver(class: "Magento\\StoreGraphQl\\Model\\Resolver\\StoreConfigResolver") @doc(description: "Return details about the store's configuration.") @cache(cacheable: false)
55
availableStores(
66
useCurrentGroup: Boolean @doc(description: "Filter store views by the current store group.")
77
): [StoreConfig] @resolver(class: "Magento\\StoreGraphQl\\Model\\Resolver\\AvailableStoresResolver") @doc(description: "Get a list of available store views and their config information.")
88
}
99

10-
type Website @doc(description: "Deprecated. It because should not be used on storefront. Contains information about a website.") {
10+
type Website @doc(description: "Deprecated. It should not be used on the storefront. Contains information about a website.") {
1111
id : Int @deprecated(reason: "The field should not be used on the storefront.") @doc(description: "The ID number assigned to the website.")
1212
name : String @deprecated(reason: "The field should not be used on the storefront.") @doc(description: "The website name. Websites use this name to identify it easier.")
1313
code : String @deprecated(reason: "The field should not be used on the storefront.") @doc(description: "A code assigned to the website to identify it.")
@@ -18,7 +18,7 @@ type Website @doc(description: "Deprecated. It because should not be used on sto
1818

1919
type StoreConfig @doc(description: "Contains information about a store's configuration.") {
2020
id : Int @deprecated(reason: "Use `store_code` instead.") @doc(description: "The ID number assigned to the store.")
21-
code : String @deprecated(reason: "Use `store_code` instead.") @doc(description: "A code assigned to the store to identify it")
21+
code : String @deprecated(reason: "Use `store_code` instead.") @doc(description: "A code assigned to the store to identify it.")
2222
store_code: ID @doc(description: "The unique ID of the store view. In the Admin, this is called the Store View Code. When making a GraphQL call, assign this value to the `Store` header to provide the scope.")
2323
store_name : String @doc(description: "The label assigned to the store view.")
2424
store_sort_order : Int @doc(description: "The store view sort order.")
@@ -37,10 +37,10 @@ type StoreConfig @doc(description: "Contains information about a store's configu
3737
base_url : String @doc(description: "The store’s fully-qualified base URL.")
3838
base_link_url : String @doc(description: "A fully-qualified URL that is used to create relative links to the `base_url`.")
3939
base_static_url : String @doc(description: "The fully-qualified URL that specifies the location of static view files.")
40-
base_media_url : String @doc(description: "The fully-qualified URL that specifies the location of user media files.")
40+
base_media_url : String @doc(description: "The fully-qualified URL that specifies the location of media files.")
4141
secure_base_url : String @doc(description: "The store’s fully-qualified secure base URL.")
4242
secure_base_link_url : String @doc(description: "A secure fully-qualified URL that is used to create relative links to the `base_url`.")
4343
secure_base_static_url : String @doc(description: "The secure fully-qualified URL that specifies the location of static view files.")
44-
secure_base_media_url : String @doc(description: "The secure fully-qualified URL that specifies the location of user media files.")
44+
secure_base_media_url : String @doc(description: "The secure fully-qualified URL that specifies the location of media files.")
4545
use_store_in_url: Boolean @doc(description: "Indicates whether the store code should be used in the URL.")
4646
}

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Copyright © Magento, Inc. All rights reserved.
22
# See COPYING.txt for license details.
3-
type StoreConfig @doc(description: "The type contains information about a store config") {
3+
type StoreConfig {
44
head_shortcut_icon : String @doc(description: "The small graphic image (favicon) that appears in the address bar and tab of the browser.")
55
default_title : String @doc(description: "The title that appears at the title bar of each page when viewed in a browser.")
66
title_prefix : String @doc(description: "A prefix that appears before the title to create a two- or three-part title.")

0 commit comments

Comments
 (0)