You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
- add field to Country type: region_required
- add field to Country type: postcode_required
- add field to Country type: name
- add field to Country type: eu
- deprecate full_name_locale in favor of name
- deprecate full_name_english in favor of name
- add field to StoreConfig: default_country
- add field to StoreConfig: allow_optional_state
- adds field docs with sorting information
Copy file name to clipboardExpand all lines: design-documents/graph-ql/coverage/directory.graphqls
+17-8Lines changed: 17 additions & 8 deletions
Original file line number
Diff line number
Diff line change
@@ -3,7 +3,7 @@
3
3
4
4
typeQuery {
5
5
currency: Currency@resolver(class: "Magento\\DirectoryGraphQl\\Model\\Resolver\\Currency") @doc(description: "The currency query returns information about store currency.") @cache(cacheable: false)
6
-
countries: [Country] @resolver(class: "Magento\\DirectoryGraphQl\\Model\\Resolver\\Countries") @doc(description: "The countries query provides information for all countries.") @cache(cacheable: false)
6
+
countries: [Country] @resolver(class: "Magento\\DirectoryGraphQl\\Model\\Resolver\\Countries") @doc(description: "The countries query provides information for all countries. Sorted by Top Destination and locale specific country name.") @cache(cacheable: false)
7
7
country (id: String): Country@resolver(class: "Magento\\DirectoryGraphQl\\Model\\Resolver\\Country") @doc(description: "The countries query provides information for a single country.") @cache(cacheable: false)
8
8
}
9
9
@@ -25,15 +25,24 @@ type ExchangeRate {
25
25
26
26
typeCountry {
27
27
id: String
28
-
two_letter_abbreviation: String
29
-
three_letter_abbreviation: String
30
-
full_name_locale: String
31
-
full_name_english: String
32
-
available_regions: [Region]
28
+
two_letter_abbreviation: String@doc(description: "Country code according to ISO 3166-1 alpha-2")
29
+
three_letter_abbreviation: String@doc(description: "Country code according to ISO 3166-1 alpha-3")
30
+
name: String@doc(description: "Name of the country in the locale of the current store")
region_required: Boolean@doc(description: "Is a the region for this country")
34
+
postcode_required: Boolean@doc(description: "Is a postcode required for this country")
35
+
eu: Boolean@doc(description: "Country is a member of the European Union")
36
+
available_regions: [Region] @doc(description: "Only returns regions if region_required StoreConfig.allow_optional_state is set. Sorted by localized name.")
33
37
}
34
38
35
39
typeRegion {
36
40
id: Int
37
-
code: String
38
-
name: String
41
+
code: String@doc(description: "Retuns the region code if a region has a code, else returns the non localized name")
42
+
name: String@doc(description: "Locale specific region name.")
43
+
}
44
+
45
+
typeStoreConfig {
46
+
default_country: String@doc(description: "Default country used for country fields")
47
+
allow_optional_state: String@doc(description: "Allow a customer to enter a state when it isn't required for a country")
0 commit comments