-
Notifications
You must be signed in to change notification settings - Fork 135
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Request to remove 'careOf' field from the PaymentAddress interface #244
Comments
I'm sympathetic to the issues you describe regarding interfacing with existing libraries. The fact remains that users must make use of c/o in certain circumstances (I sent Zach a reference to USPS guidelines referring to some of these circumstances, but can't find them at the moment). We can either push the complexity of shoehorning the c/o value into some appropriate place to the user (which is confusing and frustrating for the user), or we can require applications to perform this mapping (e.g., by appending "c/o Name" to the name fields, or prepending it to the company fields). So, we're really discussing whether to push this complexity on to users, or to push it onto app developers. At which point I would turn to https://www.w3.org/TR/html-design-principles/#priority-of-constituencies to break the tie. |
I found the references I provided Zach earlier. To establish as fact that certain users must make use of "care of" for proper mail handling: Section 2.8 bullet "b" here lays out a requirement (using the term "must") to use a "care of" format: Section 1.1.8 bullet "h" gives "care of" legal force here: So the need for such a field really isn't in question: it only comes down to whether users need to wedge c/o in somewhere, or whether software does. |
Perhaps "care of" could fit into something like "alternateName": https://schema.org/PostalAddress |
Thanks for your responses, @adamroach and @dlongley! I think the above comparison of postal address schemas / APIs has shown that the consensus in the industry is that there is no need for a careOf field. This strongly supports a different reading / conclusion than the interpretation that there must be a careOf field.
Why try to innovate in address schemas here by adding a the careOf field?
|
It seems to me that both sides are making good points: 1.) @adamroach is saying that if users want to use the careOf field, they shouldn't have to figure out how to shoehorn it into one of the other fields (e.g. recipient). But this is mostly on a user level, not a spec level. 2.) @andyst is saying that careOf doesn't belong in the spec itself and it seems that there is strong support for that being true. I think that both use cases can be accommodated. It's already true that the form fields that users see do not necessarily reflect what is in the underlying spec (e.g. most residents of the US would not know what to fill in on a region field, they would expect to see "State"). So I think we can remove "careOf" from the actual specification, and let it be an example of localizing a form. So as an implementation decision, the browser could show a form that looked like:
But when the address gets normalized to the underlying spec format, it would look like:
Or something like that anyway. :) |
I think @zkoch's proposal is a reasonable compromise, assuming we have language in the spec that mentions this treatment of recipient name. Specifically: if we decide this is the solution for "care of" handling, then we need mention that the recipient name field may, under certain circumstances, contain multiline information. |
Thank you very much, @zkoch & @adamroach. That's a good compromise. Thanks a lot for the discussion! |
Though we did not record a formal decision, I believe there was consensus on today's WPWG call [1] to handle this through user interface. Zach took an action to update the spec with a note on handling multi-line data, with careOf as an example. Ian |
Summary: The PaymentAddress interface has a
careOf
field which is non-standard (no well-known address standards support it, see below). ThecareOf
field is unnecessary, therecipient
andorganization
fields sufficiently support all necessary use cases. AddingcareOf
poses significant issues in terms of interoperability with existing postal address schemas and APIs.I’m with the internationalization group at Google who support all aspects of address input, validation, conversion between schemas, and formatting for all countries, including the open source libaddressinput.
careOf
was added in #198 without much discussion. Every new field has potential benefit but may also have a non-trivial maintenance and interoperability cost. As such we think it's important that the value of any new fields is examined carefully and weighed against the cost. The other fields inPaymentAddress
are there for very solid, defensible reasons. E.g. name & organization are there because depending on the purpose, these are used differently and many major APIs / address schemas have these two fields (or equivalents thereof).careOf
is problematic because it requires everyone handling addresses to retain the field type, decide where in input/editing forms and formatting it goes, offer UI for it and internationalize all of this for hundreds of countries and decide what to do with it when converting to & from all the other schemas / APIs which don’t have this field.This would be fine if it provided enough value to outweigh the cost. But the value is unclear and the interoperability & handling cost is very significant. Companies / existing solutions can handle
recipient
andorganization
fields. Which service / library can format / validate addresses in 200+ countries with such acareOf
field?List of major postal address / shipping schemas & APIs none of which have a careOf field (or similar) as a separate field but do have a name/contact and a organization/company/firm field:
We don't know of any standard / API which has these 3 fields (
careOf
,recipient
,organization
), irrespective of the exact field name (e.g.recipient
vs.name
vs.contact
). We are aware of schemas / APIs which only have a single name/contact field rather than also having a separate field fororganization
, yetorganization
is there in the above mentioned APIs / schemas for good reasons.We think there’s overwhelming evidence against a
careOf
field. If that’s not the case, please present the case to have acareOf
field.To summarize: The
recipient
field is good enough (together with theorganization
field). Therecipient
field is and can be used instead of thecareOf
field.Thanks for your consideration,
Andy on behalf of the team behind libaddressinput, address formatting in Google Maps, etc.
The text was updated successfully, but these errors were encountered: