clarity-h2020/table-state-rest-api

CLARITY Table Component State REST API

Table Component REST API

Data has to be obtained and processed before displaying it on the Table Component (https://github.com/clarity-h2020/table-components). This REST API is meant to provide a simple way of retrieving the data stored on the geoserver instance and returning the appropriate information to the Table Component.

For more information check the discussion on issues: clarity-h2020/table-components#1 clarity-h2020/table-components#3

Dependencies:

• Python 3.5 or higher
• numpy 1.13.3 or higher
• OWSLib 0.17.1 or higher
• GDAL 2.1.3 or higher
• Flask 0.12.2 or higher

Samples

Sample JSON request and response files can be found on the examples folder.

table-state-rest-api's Issues

Test the current version of the API

@therter I have just finished configuring the service. It can be found here:

https://clarity.meteogrid.com/api/request_exposure
https://clarity.meteogrid.com/api/request_hazard

There are only two options for now. To make it work you need to do a POST request with a certain request.json file depending on the request. You can find the examples in the examples folder: https://github.com/clarity-h2020/table-state-rest-api/tree/master/examples

I've been using the layers already available in geoserver. I'm keeping in mind what @maesbri said about a different source in the future, but I won't implement it until I have some feedback.

Note that the requests are very sensible to the bbox. I'm working on some error handling on that regard and on other possible sources of error now, but it's not yet available in the server.

The responses should look something like what you see in the same folder.

Exposure - Switch to EMIKAT API

Exposure Data (Population) for whole Europe will be served from a new EMIKAT API.
This means, that the table API for aggregating Exposure Data has to be updated accordingly.
Additionally, the respective Exposure Resources in the Data Package have to be updated as well as the Table Component.

@humerh Could you please provide an example request and response? To keep the changes to the table-state-rest-api minimal, it would be helpful if EMIKAT API could offer the the same API as currently used by the table-state-rest-api to access the underlying exposure data. @ghilbrae Is it WCS, WFS, ...?

It may be necessary to parametrise the URL as described here. Likewise the parameters have to be supported by the table-state-rest-api. This is somehow related to #3.

Update server with new version

@therter I have a newer version of the API ready but I did not want to update anything on our server just before the review.

This new version has some exception control and logging capabilities, which should not be a problem from your side. But also, I've added an EPSG field to the requests, which you'll need to consider. I'd rather you let me know when it is best for you to do this change so it does not mess up anything you might be working on.

Submit layer URLs within the request

It may be needed to add a URL field to the request to determine the source of the layer.

There are a few considerations:

• All the layers of one request are stored in the same source (geoserver or whatever) => one global field in the request.
• Each layer is retrieved from a different source => a field per layer.
• The layers will always come from the same source => no need for field, handle this via API configuration.

Additional information on HC response

@therter do you want to me to add the values obtained from the threshold comparison to the response so they can be added to the table?

Add other options for thresholds definitions

Check comment:
clarity-h2020/table-components#1 (comment)
Where it is detailed that it may be needed to account for more complex definitions of the thresholds for the HC table.

Units for Hazard table

It may be needed to add unit information to the responses for the HC layers.

The existing layers do not have that information as of now. This should be taken into account in the future to add this when generating the layers.