belgif / fedvoc

Federal Vocabularies
6 stars 0 forks source link

Align fedvoc descriptions with OpenAPI types #26

Closed pvdbosch closed 1 year ago

pvdbosch commented 1 year ago

Proposed changes; to limit the descriptions so they can remain the same as in OpenAPI

name definition Comments
Currency A currency represented by its ISO 4217 alpha code (current description)
MonetaryAmount A monetary value in a specified currency (current description)
CivilStatusType The type of civil status of a person, represented by a code assigned by the National Register (unchanged)
HouseholdRelationType The type of relation of a household member to the household reference person, represented by a code assigned by the National Register The household relation type is always relative to the reference person of the household. For example, if the father is the reference person and a household member is a son, then if the grandfather were the reference person of the household the same household member would be a grandson. For possible values, see: https://www.ibz.rrn.fgov.be/fileadmin/user_upload/nl/rr/instructies/IT-lijst/IT141_Gezinslid_20171030.pdf
StreetRrnCode : set inSwagger yes
pvdbosch commented 1 year ago

StreetRrnCode can't be a conceptscheme because it isn't globally unique (always relative to postCode)

pvdbosch commented 1 year ago

change havebeen updated in artifact