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

[Change Request] Rename result table #436

Closed
bartvanb opened this issue Dec 13, 2022 · 2 comments · Fixed by #527
Closed

[Change Request] Rename result table #436

bartvanb opened this issue Dec 13, 2022 · 2 comments · Fixed by #527
Assignees
Labels
change Internal change

Comments

@bartvanb
Copy link
Member

Description
There is a table result which is a bit of a misnomer. It describes some parameters related to a run of an algorithm container, such as its input, started and finished times, and ...its results!
The idea is that for the next major version release, we rename this table to something like algorithm_run

@bartvanb bartvanb added the change Internal change label Dec 13, 2022
@bartvanb
Copy link
Member Author

bartvanb commented Feb 1, 2023

  • Rename table to run
  • Also rename the result endpoint to run but only include ref to result
  • Rename the task.run_id field to avoid confusion
  • Keep client.result.get() but that should only return result
  • Check if there are other places where this needs to be replaced to be consistent
  • Have 2 endpoints: /result and /run
  • The endpoint /result should give ONLY the result, not the other fields
  • The /run endpoint should give the other fields but with only a link to obtain the result field
    Create endpoint to patch result (?). Note that doing so would require changes in the nodes
  • Take into account in all other places that result is no longer a field in the /run endpoint -> update client and node (and CLI?)
  • Rename / change return values of get_results(), patch_result(), proxy_task_result() and proxy_result()
  • Check output for /task?include=result -> should only include result. Also add include=run?
  • Adapt UI to the changes
  • The endpoint /task/<id>/run is used by nodes to collect algorithm results and other run data. Should we refactor into two endpoints?

Latest relevant branch: change/rename-result-to-run2

@bartvanb
Copy link
Member Author

bartvanb commented May 3, 2023

Tests to do:

  • Check if in node proxy server the proxy_result() function can be accessed from the AlgorithmClient

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
change Internal change
Projects
Status: Done
Development

Successfully merging a pull request may close this issue.

2 participants