Add API functionality to update planners #3020
Merged
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
This pull request adds the functionality to Caldera's API to update existing planners.
Type of change
How Has This Been Tested?
The new feature was tested manually using the Swagger UI.
Updating a planner, e.g. its description, results in the Caldera GUI showing the new description of the planner.
Also the corresponding YAML file was reviewed and it was found that it is correctly updated.
New pytest tests were written and executed successfully after applying PR #3013 that fixes the currently broken tests.
Checklist:
More Info / Feature Request Issue
Instead of opening a feature request for this PR as an issue, the respective text can be found below.
What problem are you trying to solve? Please describe.
The new Caldera planners released recently (e.g. the look ahead planner) offer much more configuration than the classic planners. I think it would be really useful to configure them using the API (and thus enabling configuration using the GUI) instead of working with the planners' YAML files.
Also, I have implemented a new planner (#2914) that also offers a lot of configuration possibilities. In the future I intend to make my planner configurable using the Caldera GUI. To do so, I saw the need to update planners using the Caldera API.
The ideal solution: What should the feature should do?
The API should offer a way to update existing planners.
What category of feature is this?
If you have code or pseudo-code please provide:
See PR #3020.
Screenshot of Swagger UI