def trace():
tax_benefit_system = data['tax_benefit_system']
request.on_json_loading_failed = handle_invalid_json
input_data = request.get_json()
try:
result = handlers.trace(tax_benefit_system, input_data)
except (SituationParsingError, PeriodMismatchError) as e:
abort(make_response(jsonify(e.error), e.code or 400))
return jsonify(result)
def build_openAPI_specification(api_data):
tax_benefit_system = api_data['tax_benefit_system']
file = open(OPEN_API_CONFIG_FILE, 'r')
spec = yaml.safe_load(file)
country_package_name = api_data['country_package_metadata']['name'].title()
dpath.new(spec, 'info/title', spec['info']['title'].replace("{COUNTRY_PACKAGE_NAME}", country_package_name))
dpath.new(spec, 'info/description', spec['info']['description'].replace("{COUNTRY_PACKAGE_NAME}", country_package_name))
dpath.new(spec, 'info/version', api_data['country_package_metadata']['version'])
for entity in tax_benefit_system.entities:
name = entity.key.title()
spec['definitions'][name] = get_entity_json_schema(entity, tax_benefit_system)
situation_schema = get_situation_json_schema(tax_benefit_system)
dpath.new(spec, 'definitions/SituationInput', situation_schema)
dpath.new(spec, 'definitions/SituationOutput', situation_schema.copy())
dpath.new(spec, 'definitions/Trace/properties/entitiesDescription/properties', {
entity.plural: {'type': 'array', 'items': {"type": "string"}}
for entity in tax_benefit_system.entities
})
# Get example from the served tax benefist system
if tax_benefit_system.open_api_config.get('parameter_example'):
parameter_id = tax_benefit_system.open_api_config['parameter_example']
parameter_path = parameter_id.replace('.', '/')
parameter_example = api_data['parameters'][parameter_path]
else:
parameter_example = next(iter(api_data['parameters'].values()))
dpath.new(spec, 'definitions/Parameter/example', parameter_example)
if tax_benefit_system.open_api_config.get('variable_example'):
variable_example = api_data['variables'][tax_benefit_system.open_api_config['variable_example']]
else:
variable_example = next(iter(api_data['variables'].values()))
dpath.new(spec, 'definitions/Variable/example', variable_example)
if tax_benefit_system.open_api_config.get('simulation_example'):
simulation_example = tax_benefit_system.open_api_config['simulation_example']
dpath.new(spec, 'definitions/SituationInput/example', simulation_example)
dpath.new(spec, 'definitions/SituationOutput/example', handlers.calculate(tax_benefit_system, deepcopy(simulation_example))) # calculate has side-effects
dpath.new(spec, 'definitions/Trace/example', handlers.trace(tax_benefit_system, simulation_example))
else:
message = "No simulation example has been defined for this tax and benefit system. If you are the maintainer of {}, you can define an example by following this documentation: https://openfisca.org/doc/openfisca-web-api/config-openapi.html".format(country_package_name)
dpath.new(spec, 'definitions/SituationInput/example', message)
dpath.new(spec, 'definitions/SituationOutput/example', message)
dpath.new(spec, 'definitions/Trace/example', message)
return spec
def build_openAPI_specification(api_data):
tax_benefit_system = api_data['tax_benefit_system']
file = open(OPEN_API_CONFIG_FILE, 'r')
spec = yaml.load(file)
country_package_name = api_data['country_package_metadata']['name'].title()
dpath.new(
spec, 'info/title',
spec['info']['title'].replace("{COUNTRY_PACKAGE_NAME}",
country_package_name))
dpath.new(
spec, 'info/description',
spec['info']['description'].replace("{COUNTRY_PACKAGE_NAME}",
country_package_name))
dpath.new(spec, 'info/version',
api_data['country_package_metadata']['version'])
for entity in tax_benefit_system.entities:
name = entity.key.title()
spec['definitions'][name] = get_entity_json_schema(
entity, tax_benefit_system)
situation_schema = get_situation_json_schema(tax_benefit_system)
dpath.new(spec, 'definitions/SituationInput', situation_schema)
dpath.new(spec, 'definitions/SituationOutput', situation_schema.copy())
dpath.new(
spec, 'definitions/Trace/properties/entitiesDescription/properties', {
entity.plural: {
'type': 'array',
'items': {
"type": "string"
}
}
for entity in tax_benefit_system.entities
})
# Get example from the served tax benefist system
if tax_benefit_system.open_api_config.get('parameter_example'):
parameter_id = tax_benefit_system.open_api_config['parameter_example']
parameter_path = parameter_id.replace('.', '/')
parameter_example = api_data['parameters'][parameter_path]
else:
parameter_example = next(iter(api_data['parameters'].values()))
dpath.new(spec, 'definitions/Parameter/example', parameter_example)
if tax_benefit_system.open_api_config.get('variable_example'):
variable_example = api_data['variables'][
tax_benefit_system.open_api_config['variable_example']]
else:
variable_example = next(iter(api_data['variables'].values()))
dpath.new(spec, 'definitions/Variable/example', variable_example)
if tax_benefit_system.open_api_config.get('simulation_example'):
simulation_example = tax_benefit_system.open_api_config[
'simulation_example']
dpath.new(spec, 'definitions/SituationInput/example',
simulation_example)
dpath.new(
spec, 'definitions/SituationOutput/example',
handlers.calculate(
tax_benefit_system,
deepcopy(simulation_example))) # calculate has side-effects
dpath.new(spec, 'definitions/Trace/example',
handlers.trace(tax_benefit_system, simulation_example))
else:
message = "No simulation example has been defined for this tax and benefit system. If you are the maintainer of {}, you can define an example by following this documentation: https://openfisca.org/doc/openfisca-web-api/config-openapi.html".format(
country_package_name)
dpath.new(spec, 'definitions/SituationInput/example', message)
dpath.new(spec, 'definitions/SituationOutput/example', message)
dpath.new(spec, 'definitions/Trace/example', message)
return spec