smif.http_api package

HTTP API endpoint

Submodules:

• smif.http_api.app module

Classes:

NarrativeAPI	Implement CRUD operations for narratives configuration data
NarrativeSetAPI	Implement CRUD operations for narrative_sets configuration data
ScenarioAPI	Implement CRUD operations for scenarios configuration data
ScenarioSetAPI	Implement CRUD operations for scenario_sets configuration data
SectorModelAPI	Implement CRUD operations for sector_model configuration data
SmifAPI	Implement operations for Smif
SosModelAPI	Implement CRUD operations for sos_model configuration data
SosModelRunAPI	Implement CRUD operations for sos_model_run configuration data

Functions:

check_timestamp	Check for timestamp and parse to datetime object
create_app	Create Flask app object
register_api	Register a MethodView as an endpoint with CRUD operations at a URL
register_api_endpoints	Register API calls (using pluggable views)
register_error_handlers	Handle expected errors
register_routes	Register plain routing

Reference

class smif.http_api.NarrativeAPI

Bases: flask.views.MethodView

Implement CRUD operations for narratives configuration data

delete(narrative_name)

Delete a narrative: DELETE /api/v1/narratives

get(narrative_name)

Get narratives all: GET /api/v1/narratives/ one: GET /api/vi/narratives/name

methods = ['DELETE', 'GET', 'POST', 'PUT']

post()

Create a narrative: POST /api/v1/narratives

put(narrative_name)

Update a narrative: PUT /api/v1/narratives

class smif.http_api.NarrativeSetAPI

Bases: flask.views.MethodView

Implement CRUD operations for narrative_sets configuration data

delete(narrative_set_name)

Delete a narrative_set: DELETE /api/v1/narrative_sets

get(narrative_set_name)

Get narrative_sets all: GET /api/v1/narrative_sets/ one: GET /api/vi/narrative_sets/name

methods = ['DELETE', 'GET', 'POST', 'PUT']

post()

Create a narrative_set: POST /api/v1/narrative_sets

put(narrative_set_name)

Update a narrative_set: PUT /api/v1/narrative_sets

class smif.http_api.ScenarioAPI

Bases: flask.views.MethodView

Implement CRUD operations for scenarios configuration data

delete(scenario_name)

Delete a scenario: DELETE /api/v1/scenarios

get(scenario_name)

Get scenarios all: GET /api/v1/scenarios/ one: GET /api/vi/scenarios/name

methods = ['DELETE', 'GET', 'POST', 'PUT']

post()

Create a scenario: POST /api/v1/scenarios

put(scenario_name)

Update a scenario: PUT /api/v1/scenarios

class smif.http_api.ScenarioSetAPI

Bases: flask.views.MethodView

Implement CRUD operations for scenario_sets configuration data

delete(scenario_set_name)

Delete a scenario_set: DELETE /api/v1/scenario_sets

get(scenario_set_name)

Get scenario_sets all: GET /api/v1/scenario_sets/ one: GET /api/vi/scenario_sets/name

methods = ['DELETE', 'GET', 'POST', 'PUT']

post()

Create a scenario_set: POST /api/v1/scenario_sets

put(scenario_set_name)

Update a scenario_set: PUT /api/v1/scenario_sets

class smif.http_api.SectorModelAPI

Bases: flask.views.MethodView

Implement CRUD operations for sector_model configuration data

delete(sector_model_name)

Delete a sector_model: DELETE /api/v1/sector_models

get(sector_model_name)

Get sector_models all: GET /api/v1/sector_models/ one: GET /api/vi/sector_models/name

methods = ['DELETE', 'GET', 'POST', 'PUT']

post()

Create a sector_model: POST /api/v1/sector_models

put(sector_model_name)

Update a sector_model: PUT /api/v1/sector_models

class smif.http_api.SmifAPI

Bases: flask.views.MethodView

Implement operations for Smif

get(key)

Get smif details version: GET /api/v1/smif/version

methods = ['GET']

class smif.http_api.SosModelAPI

Bases: flask.views.MethodView

Implement CRUD operations for sos_model configuration data

delete(sos_model_name)

Delete a sos_model: DELETE /api/v1/sos_model

get(sos_model_name)

Get sos_model all: GET /api/v1/sos_model/ one: GET /api/vi/sos_model/name

methods = ['DELETE', 'GET', 'POST', 'PUT']

post()

Create a sos_model: POST /api/v1/sos_model

put(sos_model_name)

Update a sos_model: PUT /api/v1/sos_model

class smif.http_api.SosModelRunAPI

Bases: flask.views.MethodView

Implement CRUD operations for sos_model_run configuration data

delete(sos_model_run_name)

Delete a sos_model_run: DELETE /api/v1/sos_model_runs

get(sos_model_run_name)

Get sos_model_runs all: GET /api/v1/sos_model_runs/ one: GET /api/vi/sos_model_runs/name

methods = ['DELETE', 'GET', 'POST', 'PUT']

post()

Create a sos_model_run: POST /api/v1/sos_model_runs

put(sos_model_run_name)

Update a sos_model_run: PUT /api/v1/sos_model_runs

smif.http_api.check_timestamp(data)

Check for timestamp and parse to datetime object

smif.http_api.create_app(static_folder='static', template_folder='templates', get_data_interface=None)

Create Flask app object

smif.http_api.register_api(app, view, endpoint, url, key='id', key_type='int')

Register a MethodView as an endpoint with CRUD operations at a URL

smif.http_api.register_api_endpoints(app)

Register API calls (using pluggable views)

smif.http_api.register_error_handlers(app)

Handle expected errors

smif.http_api.register_routes(app)

Register plain routing