feat(api): return variable configurations in /apps/:id/bricks and apps/:id/bricks/:id

[mirkoCrobu]

Motivation

To complete the new flow “RUN an app with mandatory configuration”, the mandatory bricks variables should be set before running the app.

Currently, the App Lab to retrieve a mandatory app from an app must do the following:

• call /v1/apps/{appID}/bricks to list all the instance bricks for the current app(it doesn’t return the bricks variables information)
• For each brickInstance, it has to call the /v1/apps/{appID}/bricks/{brickID} to check brickInstance variables current value(the response does not contain information about the mandatory requirement of a variable, but just the value).
• For each brick instance, it has to call the /v1/bricks/{brickID} to check which variable is mandatory.

This set of calls is tedious and inefficient.

Change description

Integrate the /v1/apps/{appID}/bricks/{brickID} and /v1/apps/{appID}/bricks , adding for each brickInstance the config_variables array with the list of variables with their complete information.

Additional Notes

Reviewer checklist

• PR addresses a single concern.
• PR title and description are properly filled.
• Changes will be merged in main.
• Changes are covered by tests.
• Logging is meaningful in case of troubleshooting.

[dido18]

Why not using a list of variables like this instead of the object with the name of the variable as key?

"variables":[
    {
     "name: "CUSTOM_MODEL_PATH",
      "default_value": "/home/arduino/.arduino-bricks/ei-models",
      "description": "path to the custom model directory",
      "required": false
    },
    {
    "name" "EI_CLASSIFICATION_MODEL",
     "default_value": "/models/ootb/ei/mobilenet-v2-224px.eim",
      "description": "path to the model file",
      "required": false
    }
  ],

[mirkoCrobu]

@dido18 I kept the same structure as BrickInstance.Variables for consistency. The only difference is the field default_value becoming value.
But yes, we can use the array that you suggested.
What do you think?

[CLAassistant]

All committers have signed the CLA.

[dido18]

LGTM.

Could you add an example of the new json respone in the PR description ?

Thanks

[mirkoCrobu]

GET http://localhost:8080/v1/apps/ZXhhbXBsZXM6aW1hZ2UtY2xhc3NpZmljYXRpb24/bricks

{
    "bricks": [
        {
            "id": "arduino:web_ui",
            "name": "WebUI - HTML",
            "author": "Arduino",
            "category": "ui",
            "status": "installed"
        },
        {
            "id": "arduino:image_classification",
            "name": "Image Classification",
            "author": "Arduino",
            "category": "video",
            "status": "installed",
            "variables": {
                "CUSTOM_MODEL_PATH": "overidden",
                "EI_CLASSIFICATION_MODEL": "/models/ootb/ei/mobilenet-v2-224px.eim"
            },
            "config_variables": [
                {
                    "name": "CUSTOM_MODEL_PATH",
                    "value": "overidden",
                    "description": "path to the custom model directory",
                    "required": false
                },
                {
                    "name": "EI_CLASSIFICATION_MODEL",
                    "value": "/models/ootb/ei/mobilenet-v2-224px.eim",
                    "description": "path to the model file",
                    "required": false
                }
            ]
        }
    ]
}

[mirkoCrobu]

GET http://localhost:8080/v1/apps/ZXhhbXBsZXM6aW1hZ2UtY2xhc3NpZmljYXRpb24/bricks/arduino:image_classification

{
    "id": "arduino:image_classification",
    "name": "Image Classification",
    "author": "Arduino",
    "category": "video",
    "status": "installed",
    "variables": {
        "CUSTOM_MODEL_PATH": "overidden",
        "EI_CLASSIFICATION_MODEL": "/models/ootb/ei/mobilenet-v2-224px.eim"
    },
    "config_variables": [
        {
            "name": "CUSTOM_MODEL_PATH",
            "value": "overidden",
            "description": "path to the custom model directory",
            "required": false
        },
        {
            "name": "EI_CLASSIFICATION_MODEL",
            "value": "/models/ootb/ei/mobilenet-v2-224px.eim",
            "description": "path to the model file",
            "required": false
        }
    ],
    "model": "mobilenet-image-classification"
}

[dido18]

LGTM