Add examples for TX_PLAN_* transaction types
#66
Conversation
| "security_law_exemptions": [ | ||
| { | ||
| "description": "Exemption", | ||
| "jurisdiction": "CA" |
There was a problem hiding this comment.
Oh, this reminded me of a question for the group. The spec says ISO-3166 but doesn't specify which format. There's 3166-1 alpha-2, 3166-1 alpha-3, 3166-1 numeric, and 3166-2.
3166-2 is just a longer version of 3166-1 alpha-2 so I think that's unnecessary.
alpha-3 "may allow a better visual association between the codes and the country names" so is for human readability, probably don't need to support it but if we don't we should specify (and possibly enforce in the schema with string length)
We use 3-letter codes in our system so from our perspective it would be easiest to use 3166-1 alpha-3; at a minimum I think we need to support that. If folks are using other formats we should discuss how flexible we want to be for this field.
There was a problem hiding this comment.
ISO 3166-2 is separate from ISO 3166-1, although it relies on it. ISO 3166-2 defines the principal subdivisions of all countries listed in ISO 3166-1.
I like going with one of ISO 3166 alpha-2 or alpha-3, but not both. Supporting both would offload additional work to the consumers of OCF data.
My preference would be for ISO 3166 alpha-2 since it's the most widely used format (sorry @pjohnmeyer). I don't think human readability is a strong reason to go with alpha-3 since the data is going to exist in a complicated JSON structure that isn't intended for manual consumption.
There was a problem hiding this comment.
Totally agree that human readability is not the goal. I think your argument for settling on alpha-2 is sound but let's bring this up on the call today.
There was a problem hiding this comment.
Agreed in meeting to go with ISO 3166 alpha-2 and to set max length to 2 for fields dealing with country codes. @tmccnnll to create issue.
tmccnnll
force-pushed
the
tmccnnll/add-tx-plan-examples
branch
from
f68b54b
to
7c40726
Compare
…warrant-examples Add examples for `TX_WARRANT_*` transaction types
…stock-examples Add examples for `TX_STOCK_*` transaction types
Summary
Part 2/4 of #55, focused on transactions dealing with security plans
Other parts:
Part 1: #63
Part 3: #73
Part 4: #74