openfisca / openfisca-web-api

[DEPRECATED] Web API for OpenFisca
https://www.openfisca.fr/
GNU Affero General Public License v3.0
13 stars 11 forks source link

Adapt web-api to core#v4 #71

Closed fpagnoux closed 7 years ago

fpagnoux commented 7 years ago

The only breaking change is on route /entities/, but I don't know in which context this route was used.

Before:

{
    "apiVersion": 1,
    "entities": {
        "familles": {
            "labelByRoleKey": {
                "parents": "Parents",
                "enfants": "Enfants"
            },
            "maxCardinalityByRoleKey": {
                "parents": 2
            },
            "roles": ["parents", "enfants"],
            "label": "Famille"
        },
        "foyers_fiscaux": {
            "labelByRoleKey": {
                "personnes_a_charge": "Personnes à charge",
                "declarants": "Déclarants"
            },
            "maxCardinalityByRoleKey": {
                "declarants": 2
            },
            "roles": ["declarants", "personnes_a_charge"],
            "label": "Déclaration d'impôt"
        },
        "individus": {
            "isPersonsEntity": true,
            "label": "Personne"
        },
        "menages": {
            "labelByRoleKey": {
                "conjoint": "Conjoint",
                "autres": "Autres",
                "enfants": "Enfants",
                "personne_de_reference": "Personne de référence"
            },
            "maxCardinalityByRoleKey": {
                "conjoint": 1,
                "personne_de_reference": 1
            },
            "roles": ["personne_de_reference", "conjoint", "enfants", "autres"],
            "label": "Logement principal"
        }
    },
    "method": "/api/1/entities",
    "params": {
        "context": null,
        "reforms": []
    }
}

After:

{
    "apiVersion": 1,
    "entities": {
        "famille": {
            "roles": [{
                "subroles": ["demandeur", "conjoint"],
                "plural": "parents",
                "key": "parent",
                "label": "Parents"
            }, {
                "plural": "enfants",
                "key": "enfant",
                "label": "Enfants"
            }],
            "label": "Famille"
        },
        "foyer_fiscal": {
            "roles": [{
                "subroles": ["declarant_principal", "conjoint"],
                "plural": "declarants",
                "key": "declarant",
                "label": "Déclarants"
            }, {
                "plural": "personnes_a_charge",
                "key": "personne_a_charge",
                "label": "Personnes à charge"
            }],
            "label": "Déclaration d’impôts"
        },
        "individu": {
            "isPersonsEntity": true,
            "label": "Individu"
        },
        "menage": {
            "roles": [{
                "max": 1,
                "key": "personne_de_reference",
                "label": "Personne de référence"
            }, {
                "max": 1,
                "key": "conjoint",
                "label": "Conjoint"
            }, {
                "max": 2,
                "plural": "enfants",
                "key": "enfant",
                "label": "Enfants"
            }, {
                "plural": "autres",
                "key": "autre",
                "label": "Autres"
            }],
            "label": "Logement principal"
        }
    },
    "method": "/api/2/entities",
    "params": {
        "context": null,
        "reforms": []
    }
}
fpagnoux commented 7 years ago

La version installée n'est visiblement pas la bonne en mode push (parce qu'il va chercher la branche refactor-entities plutôt que celle que je lui dis...), mais les tests passent en mode pr.