List enum member names

[guillett]

Some variables are EnumCol (cf. rsa_non_calculable in legislation explorer and rsa_non_calculable code).

As a user/consumer:

• I would like to have a better understanding of Enum variables in the legislation explorer.

Currently, I would use those details to validate a structure in a client application - MesAides that add metadata to openfisca variables.

[benjello]

Same problem for allegement_fillon_mode_recouvrement

[MattiSG]

Thanks for this suggestion @guillett! However, it is not very clear to me what you're suggesting, since this issue is opened in legislation-explorer but mentions the API. What is the most important for you: machine access of enum members through the API (and in this case, on which endpoint?), or listing these members in the legislation explorer? 🙂

[benjello]

For me it is listing these members in the legislation explorer

[guillett]

@MattiSG, the most important for me is the machine access via the API. That is why I created an new issue in openfisca-web-api.

Having said that once it is available via the API, I would love to see it in the legislation explorer. 🙂

[MattiSG]

• [ ] List all possible names in a table called “Table de correspondance”, along with the associated values. First column is called “Name”, second is called “Code”.
• [ ] Document what is an enum type and its usage: “Elle ne peut prendre qu'une valeur chiffrée parmi la liste ci-dessous.”
• [ ] Translate in English and in French.

[fpagnoux]

To implement this, we'll need to expose the values of the enum elements in the API.

Structure

Suggestion 1

{
  "defaultValue": 0, 
  "description": "Activité", 
  "id": "activite", 
  "valueType": "Enum",
  "possibleValues": {
    "Actif occupé": 0,
    "Autre inactif": 4,
    "Chômeur": 1,
    "Étudiant, élève": 2,
    "Retraité": 3
  }
}

Suggestion 2

{
  "defaultValue": 0, 
  "description": "Activité", 
  "id": "activite", 
  "valueType": "Enum",
  "possibleValues": {
    "0": "Actif occupé",
    "1": "Chômeur",
    "2": "Étudiant, élève",
    "3": "Retraité",
    "4": "Autre inactif"
  }
}

Keyword

Suggestion A: possibleValues Suggestion B: values Suggestion C: elements

@guillett @benjello @MattiSG @Anna-Livia @sandcha @Morendil thoughts ?

EDIT: I forgot @michelbl

[guillett]

Suggestion D: members ?

2 - D

[fpagnoux]

members is already used in another context in OpenFisca (the members of an entity). Plus, is it clear what the members of a variable are ?

[fpagnoux]

Or, following swagger style:

Suggestion 3

{
  "defaultValue": "Actif occupé", 
  "description": "Activité", 
  "id": "activite", 
  "valueType": "String",
  "enum": [
    "Actif occupé",
    "Autre inactif",
    "Chômeur",
    "Étudiant, élève",
    "Retraité"
  ]
}

But that notation totally omits the indexes. We can make sure the API accepts strings as inputs for enums (instead of ints) but inside OpenFisca, enums values are integers 🤔 .

For instance, this code doesn't work as expected:

person('activite', period) == u'Chômeur'  # False, as person('activite', period)  is an integer

[guillett]

Note for suggestion 3: It can contain null for enum like statut_marital that start at 1

[Anna-Livia]

suggestion 3 for the structure, "possibleValues" for the key :)

[Morendil]

3 - B

I favor the array representation over the other ones because it communicates an intention of doing the simplest thing, labeling enum values like array indexes - starting at 0, in order and without skipping any values.

[benjello]

2-B