arduino/arduino-app-cliPublic

NotificationsYou must be signed in to change notification settings
Fork2
Star5

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

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to ourterms of service andprivacy statement. We’ll occasionally send you account related emails.

Already on GitHub?Sign in to your account

Jump to bottom

Merged

mirkoCrobu merged 12 commits intomainfromissue_809

Nov 6, 2025

Merged

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

mirkoCrobu merged 12 commits intomainfromissue_809

Nov 6, 2025

Conversation

Copy link

Contributor

mirkoCrobu commentedOct 23, 2025•
edited by dido18
Loading

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}/bricksto 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 theconfig_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 inmain.
Changes are covered by tests.
Logging is meaningful in case of troubleshooting.

per1234 added the enhancementNew feature or request label

Oct 24, 2025

mirkoCrobu self-assigned this

Oct 24, 2025

mirkoCrobu requested a review froma team

October 24, 2025 07:25

dido18 reviewed

Oct 27, 2025

View reviewed changes

Copy link

Contributor

dido18 left a comment•
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others.Learn more.

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    }  ],

Copy link

ContributorAuthor

mirkoCrobu commentedOct 27, 2025

@dido18 I kept the same structure asBrickInstance.Variables for consistency. The only difference is the fielddefault_valuebecomingvalue.
But yes, we can use the array that you suggested.
What do you think?

lucarin91 reviewed

Oct 27, 2025

View reviewed changes

internal/orchestrator/bricks/types.go OutdatedShow resolvedHide resolved

internal/orchestrator/bricks/bricks.go OutdatedShow resolvedHide resolved

lucarin91 force-pushed themain branch froma8cfdb5 tof61b73fCompare

October 28, 2025 11:45

lucarin91 force-pushed theissue_809 branch from9510b5a to419e257Compare

October 28, 2025 12:15

mirkoCrobu force-pushed theissue_809 branch from419e257 to87d8f44Compare

October 29, 2025 15:13

mirkoCrobu requested review fromdido18 andlucarin91

October 30, 2025 08:20

lucarin91 reviewed

Oct 30, 2025

View reviewed changes

internal/orchestrator/bricks/bricks.go OutdatedShow resolvedHide resolved

Copy link

CLAassistant commentedNov 3, 2025•
edited
Loading

All committers have signed the CLA.

mirkoCrobu force-pushed theissue_809 branch fromcbeab24 tod43f0e5Compare

November 3, 2025 15:54

lucarin91 requested changes

Nov 3, 2025

View reviewed changes

internal/orchestrator/bricks/types.go OutdatedShow resolvedHide resolved

mirkoCrobu force-pushed theissue_809 branch 3 times, most recently fromd43f0e5 to1c1fc7eCompare

November 4, 2025 11:31

mirkoCrobu requested review froma team andlucarin91

November 4, 2025 13:13

dido18 requested changes

Nov 6, 2025

View reviewed changes

Copy link

Contributor

dido18 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others.Learn more.

LGTM.

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

Thanks

Copy link

ContributorAuthor

mirkoCrobu commentedNov 6, 2025•
edited
Loading

GEThttp://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                }            ]        }    ]}

Copy link

ContributorAuthor

mirkoCrobu commentedNov 6, 2025•
edited
Loading

GEThttp://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"}

lucarin91 approved these changes

Nov 6, 2025

View reviewed changes

mirkoCrobu requested a review fromdido18

November 6, 2025 09:07

dido18 reviewed

Nov 6, 2025

View reviewed changes

internal/orchestrator/bricks/bricks_test.goShow resolvedHide resolved

dido18 reviewed

Nov 6, 2025

View reviewed changes

internal/e2e/daemon/const.go OutdatedShow resolvedHide resolved

mirkoCrobu added3 commits

November 6, 2025 11:15

add variables_details

c8dfbff

add unit test

d48a635

update openapi

8a86d29

mirkoCrobu added4 commits

November 6, 2025 11:19

add test e2e

25879bd

fix bug

6fc6b46

add deprecated field description for openapi

1eb0707

refactoring test constants

fe436bd

mirkoCrobu force-pushed theissue_809 branch from3e9efdf tofe436bdCompare

November 6, 2025 10:20

mirkoCrobu requested a review fromdido18

November 6, 2025 10:21

dido18 reviewed

Nov 6, 2025

View reviewed changes

internal/orchestrator/bricks/bricks_test.goShow resolvedHide resolved

restore license header

e7eeb7b

mirkoCrobu requested a review fromdido18

November 6, 2025 10:33

dido18 reviewed

Nov 6, 2025

View reviewed changes

internal/orchestrator/bricks/types.go OutdatedShow resolvedHide resolved

rename variables_details to config_variables

7456335

mirkoCrobu requested a review fromdido18

November 6, 2025 13:43

dido18 reviewed

Nov 6, 2025

View reviewed changes

internal/orchestrator/bricks/types.go OutdatedShow resolvedHide resolved

rename variable name

0fecf63

mirkoCrobu requested a review fromdido18

November 6, 2025 14:06

dido18 reviewed

Nov 6, 2025

View reviewed changes

internal/api/docs/openapi.yaml OutdatedShow resolvedHide resolved

udate docs and tests e2e

e8cae58

mirkoCrobu requested a review fromdido18

November 6, 2025 14:22

dido18 changed the title~~Integrate bricks details endpoint with variables information~~feat(api): return variable configurations in/apps/:id/bricks andapps/{appID}/bricks/:id

Nov 6, 2025

dido18 changed the title~~feat(api): return variable configurations in/apps/:id/bricks andapps/{appID}/bricks/:id~~feat(api): return variable configurations in/apps/:id/bricks andapps/:id/bricks/:id

Nov 6, 2025

dido18 reviewed

Nov 6, 2025

View reviewed changes

internal/orchestrator/bricks/bricks.go OutdatedShow resolvedHide resolved