[rest] add commissioner api

[OmegaRelay]

Added endpoints to the REST server to expose commissioner functionality over the REST API

These changes intend to implement commissioner functionality in the same style as the current rest API offering.

• The /node/commissioner/state endpoint allows the user to get/set the commissioner state using GET and PUT requests respectively.
• The /node/commissioner/joiner allows the user to manage joiners accepted by the commissioner, supporting POST, GET and DELETE request methods to add, get and remove a joiner respectively.

All added endpoints and their usage have been documented in the openapi.yaml

Example usage:

Please give me feedback and let me know of any required changes 😄

[marijnacht]

Will this PR be picked up as we kind of need this functionality. I also see another PR #2514 but that is really large change.

[codecov]

Codecov Report

Attention: Patch coverage is 0.72993% with 272 lines in your changes missing coverage. Please review.

Project coverage is 45.13%. Comparing base (2b41187) to head (8d7051a).
Report is 862 commits behind head on main.

Files with missing lines	Patch %	Lines
src/rest/resource.cpp	1.21%	162 Missing ⚠️
src/rest/json.cpp	0.00%	95 Missing ⚠️
src/common/api_strings.cpp	0.00%	13 Missing ⚠️
src/utils/hex.cpp	0.00%	2 Missing ⚠️

Additional details and impacted files

@@             Coverage Diff             @@
##             main    #2515       +/-   ##
===========================================
- Coverage   55.77%   45.13%   -10.65%     
===========================================
  Files          87      104       +17     
  Lines        6890    12773     +5883     
  Branches        0      928      +928     
===========================================
+ Hits         3843     5765     +1922     
- Misses       3047     6695     +3648     
- Partials        0      313      +313     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

[wgtdkp]

Thanks for the contribution! Overall loooks good to me, a few suggestions below:

[OmegaRelay]

Hey @wgtdkp, I've made the requested changes, do you want me to resolve the comments?

[wgtdkp]

Hey @wgtdkp, I've made the requested changes, do you want me to resolve the comments?

@OmegaRelay It's typically the PR author to resolve the comments if the suggests in the comments are followed. If you have different thoughts, please reply to the comment and leave it open, the reviewers will take a look again and close it when a consensus is reached.

I did take a glance and it seems my comments are not resolved. Could you check the comments again? thank you!

[wgtdkp]

Overall LGTM, thank you! 👍

[martinzi]

@OmegaRelay A Joiner drops from the joiner table after timeout, but also after successfully joining the network. Could your API differentiate between these two scenarios?

[OmegaRelay]

@OmegaRelay A Joiner drops from the joiner table after timeout, but also after successfully joining the network. Could your API differentiate between these two scenarios?

Hi @martinzi, this PR is intended to be a simple extension of the current stateless API and as such implementing this joiner status feature feels outside the scope of this PR.

On a side note, I am currently looking at implementing server-sent events which can also cover this use case and keep the API itself stateless, I do have an open feature request to discuss this but it hasn't had much interaction.