Improvements to directory.graphqls to include more configation settings #462
Conversation
- 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
| } | ||
|
|
||
| type Currency { | ||
| base_currency_code: String |
There was a problem hiding this comment.
there is a different issue with Currency
https://github.com/magento/architecture/pull/474/files
see what I proposed here
https://github.com/magento/architecture/pull/474/files#r556999960
I am looking at other APIs and Currency object is simple usually name, code and symbol
There was a problem hiding this comment.
Agreed that should be fixed, if there is a conclusion in the other PR I can update this one.
| two_letter_abbreviation: String @doc(description: "Country code according to ISO 3166-1 alpha-2") | ||
| three_letter_abbreviation: String @doc(description: "Country code according to ISO 3166-1 alpha-3") | ||
| name: String @doc(description: "Name of the country in the locale of the current store") | ||
| full_name_locale: String @deprecated(reason: "Use `name`") |
There was a problem hiding this comment.
everywhere else we have fullname used in customers. Of course that's not quite right but would make this an outlier
| full_name_english: String @deprecated(reason: "Use `name`") | ||
| region_required: Boolean @doc(description: "Is a the region for this country") | ||
| postcode_required: Boolean @doc(description: "Is a postcode required for this country") | ||
| eu: Boolean @doc(description: "Country is a member of the European Union") |
There was a problem hiding this comment.
instead of having a specific region for EU, wouldn't it be better to have a "Zone" with value as EU or APAC EMEA, etc
There are other zones besides EU
There was a problem hiding this comment.
In the backend of Magento there is a specific configuration field that allows you to check EU countries. But I agree that zone would be better, but that would require modifications on the other layers as well.
|
|
||
| type StoreConfig { | ||
| default_country: String @doc(description: "Default country used for country fields") | ||
| allow_optional_state: String @doc(description: "Allow a customer to enter a state when it isn't required for a country") |
There was a problem hiding this comment.
what is the path in system config for this?
There was a problem hiding this comment.
Uhh, don't know the exact path, but it's this field:
| name: String @doc(description: "Name of the country in the locale of the current store") | ||
| full_name_locale: String @deprecated(reason: "Use `name`") | ||
| full_name_english: String @deprecated(reason: "Use `name`") |
There was a problem hiding this comment.
@cpartica Something like this?
| name: String @doc(description: "Name of the country in the locale of the current store") | |
| full_name_locale: String @deprecated(reason: "Use `name`") | |
| full_name_english: String @deprecated(reason: "Use `name`") | |
| fullname: String @doc(description: "Name of the country in the locale of the current store") | |
| full_name_locale: String @deprecated(reason: "Use `fullname`") | |
| full_name_english: String @deprecated(reason: "Use `fullname`") |
| full_name_english: String @deprecated(reason: "Use `name`") | ||
| region_required: Boolean @doc(description: "Is a the region for this country") | ||
| postcode_required: Boolean @doc(description: "Is a postcode required for this country") | ||
| eu: Boolean @doc(description: "Country is a member of the European Union") |
There was a problem hiding this comment.
In the backend of Magento there is a specific configuration field that allows you to check EU countries. But I agree that zone would be better, but that would require modifications on the other layers as well.
|
|
||
| type StoreConfig { | ||
| default_country: String @doc(description: "Default country used for country fields") | ||
| allow_optional_state: String @doc(description: "Allow a customer to enter a state when it isn't required for a country") |
There was a problem hiding this comment.
Uhh, don't know the exact path, but it's this field:
| } | ||
|
|
||
| type Currency { | ||
| base_currency_code: String |
There was a problem hiding this comment.
Agreed that should be fixed, if there is a conclusion in the other PR I can update this one.
Problem
To build proper customer address forms, we need to have some additional information.
Solution
I've split this PR in two commits, the first is a copy of the current schema in the magento repository, the second are my modifications on it: 5c8ab13
Introduce additional country fields:
Countrytype:region_requiredCountrytype:postcode_requiredCountrytype:nameCountrytype:eufull_name_localein favor ofnamefull_name_englishin favor ofnameStoreConfigtype:default_countryStoreConfigtype:allow_optional_stateRequested Reviewers
@buskamuza Taggin you because you seem to be responsible for this component
@cpartica Tagging you of the discussion on Slack