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

Add API functionality to update planners #3020

Merged
merged 3 commits into from
Aug 16, 2024

Conversation

L015H4CK
Copy link
Contributor

@L015H4CK L015H4CK commented Jul 22, 2024

Description

This pull request adds the functionality to Caldera's API to update existing planners.

Type of change

  • New feature (non-breaking change which adds functionality)

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:

  • My code follows the style guidelines of this project
  • I have performed a self-review of my own code
  • I have made corresponding changes to the documentation
  • I have added tests that prove my fix is effective or that my feature works

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?

  • UI/UX
  • API
  • Other

If you have code or pseudo-code please provide:
See PR #3020.

Screenshot of Swagger UI
Bildschirmfoto vom 2024-07-22 14-24-30

@elegantmoose
Copy link
Contributor

Any qualms with this PR @clenk?

@elegantmoose
Copy link
Contributor

TY @L015H4CK

@elegantmoose elegantmoose merged commit 5521615 into mitre:master Aug 16, 2024
1 of 6 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants