hoetmaaiers

iCapps - JSON request/response specification

Goals

The goal is to specify a consistent api request/repsonse cycle while keeping enough room for project specific implementation.

General rules

• Every property is always returned in the response, even when null.

hoetmaaiers

The context is a long running server side calculation. Because of this long running necessity, we can not use the default request/response, but need to handle it asynchronously.

We have 3 api endpoints available to implement this asynchronous result calculation.

1. Uplaod the data to process
2. Track the caculation process
3. Return the calculation result

Upload

hoetmaaiers

{
  "$defs": {
    "FnameSettings": {
      "properties": {
        "landuse_CORINE": {
          "description": "Path to the CORINE land use file",
          "title": "Landuse Corine",
          "type": "string"
        },
        "landuse_LCZ": {

hoetmaaiers

[project]
authors         = [{ name = "Robin Houdmeyers", email = "[email protected]" }]
dependencies    = []
name            = "climserve-with-climkit"
requires-python = ">= 3.11"
version         = "0.1.0"


[build-system]
build-backend = "hatchling.build"