camaraproject / EdgeCloud

Repository to describe, develop, document and test the EdgeCloud API family
Apache License 2.0
17 stars 44 forks source link

EAM API: remove appid from appinstance path #302

Closed gainsley closed 2 weeks ago

gainsley commented 1 month ago

What type of PR is this?

What this PR does / why we need it:

Removes appId from the appinstances path. For retrieval, it becomes an optional parameter, allowing a single API call to get appinstances from different Apps. For delete, it is not necessary because appInstanceId is sufficient to identify the instance.

Which issue(s) this PR fixes:

Fixes #299

Special notes for reviewers:

Changelog input

 release-note

Additional documentation

docs
github-actions[bot] commented 1 month ago

🦙 MegaLinter status: ✅ SUCCESS

Descriptor Linter Files Fixed Errors Elapsed time
✅ ACTION actionlint 2 0 0.03s
✅ JSON eslint-plugin-jsonc 1 0 0 1.39s
✅ JSON jsonlint 1 0 0.18s
✅ JSON prettier 1 1 0 0.9s
✅ JSON v8r 1 0 1.72s
✅ OPENAPI spectral 3 0 5.95s
✅ REPOSITORY git_diff yes no 0.54s
✅ REPOSITORY secretlint yes no 4.62s
✅ YAML yamllint 3 0 0.8s

See detailed report in MegaLinter reports

_MegaLinter is graciously provided by OX Security_

JoseMConde commented 1 month ago

Hi @gainsley , one thing about this: for the get and the delete method, looks good to me, but I have doubts about the post method, because if we make appId as optional how do we know which App is going to be instantiate?? If we don't add the appId on the requested body, could we instantiate all the Apps by mistake,??

gainsley commented 1 month ago

Hi @JoseMConde thank you for catching that, indeed my change made the appId and appZone optional which is wrong. I've added the required spec so that they are required. Thanks for reviewing!