Skip to content
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 our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Improve the control interface usage examples #280

Open
3 tasks
krucod3 opened this issue Jun 5, 2024 · 1 comment
Open
3 tasks

Improve the control interface usage examples #280

krucod3 opened this issue Jun 5, 2024 · 1 comment
Labels
enhancement New feature or request. Issue will appear in the change log "Features"
Milestone

Comments

@krucod3
Copy link
Contributor

krucod3 commented Jun 5, 2024

Description

The Control Interface usage examples currently do not show how to deal with the response message of an update request.
Additionally one method called "write.. " is updating and reading the current state.

We should update the examples, s.t. it is clear how to use the control interface. Additionally the example in the documentation has to reflect reading the update request response message. It would be also good to show kind of in a sequence that each request has its response and that ids are matching.

Goals

  • Update all Control Interface usage examples:
    ** to reflect the request response model
    ** to show better the reading of the complete state by separating it into its own method.
  • User documentation:
    ** Review the user documentation regarding the control interface usage
    ** Reflect the request-response model there too
    ** Add a sequence diagram showing how an update is performed
    ** add something about the IDs and that they shall be unique in case of parallel calls

Final result

Summary

To be filled when the final solution is sketched.

Tasks

  • Task 1
  • Task 2
  • ...
@krucod3 krucod3 added the enhancement New feature or request. Issue will appear in the change log "Features" label Jun 5, 2024
@krucod3
Copy link
Contributor Author

krucod3 commented Jun 26, 2024

This should be done after the SDKs are available #263 and #304.

@krucod3 krucod3 added this to the v0.6 milestone Jun 26, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request. Issue will appear in the change log "Features"
Projects
None yet
Development

No branches or pull requests

1 participant