Skip to content

Playbook support #70

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

Merged
merged 11 commits into from
Feb 13, 2025
Merged

Conversation

pranjalg1331
Copy link

@pranjalg1331 pranjalg1331 commented Jan 28, 2025

Description

Closes #60
Methods Added

  • GetPlaybookByName
  • ListPlaybooks
  • CreateObservablePlaybookAnalysis
  • CreateFilePlaybookAnalysis

Issues

add the related issue(s) your change tackles

Type of change

list down the type of change

  • Bug fix
  • [x ] New feature (added a new endpoint or created)
  • Breaking fix (a bug fix or new feature that would cause exisiting functionality not to work as expected)

Checklist

  • [ x] if a new feature was added it passed all its (if made) test cases
  • if a bug fix was added it passed all its existing test cases

Important Rules

  • If your changes decrease the overall tests coverage (you will know after the Codecov CI job is done), you should add the required tests to fix the problem
  • Everytime you make changes to the PR and you think the work is done, you should explicitly ask for a review

Please delete if the PR is for bug fixing.

@pranjalg1331
Copy link
Author

@drosetti Please review

@mlodic
Copy link
Member

mlodic commented Jan 28, 2025

thanks for the PR. Can you provide an example of a successful run of the new APIs against a local IntelOwl instance?

@mlodic
Copy link
Member

mlodic commented Jan 28, 2025

also, there are linter errors to be fixed

@pranjalg1331
Copy link
Author

pranjalg1331 commented Jan 29, 2025

CreateFilePlaybookAnalysis- Response
image
CreateObservablePlaybookAnalysis- Response
image
GetPlaybookByName- Response
image

@pranjalg1331
Copy link
Author

@mlodic, I have solved the golangci-lint errors.
Should I also include somewhere the usage of playbook methods, possibly creating more sample example files or in docs?

@mlodic
Copy link
Member

mlodic commented Jan 29, 2025

I have solved the golangci-lint errors.

Great!

Should I also include somewhere the usage of playbook methods, possibly creating more sample example files or in docs?

Any documentation or tutorial is always appreciated, that's really the best benefit you can do to the community. Feel free to do that.

@pranjalg1331
Copy link
Author

@mlodic I have added an example for analyzing files with a playbook. It should give an overview on usage of rest of the functions. Please review.

@pranjalg1331
Copy link
Author

@mlodic Please review

@pranjalg1331 pranjalg1331 mentioned this pull request Feb 11, 2025
3 tasks
@pranjalg1331
Copy link
Author

@mlodic Please review

@mlodic
Copy link
Member

mlodic commented Feb 12, 2025

please do not tag us repetitively. Be respectful and use tags only when strictly needed. We have a life and we help here in our free time.

Plus, please ask reviews by using the builtin way in Github (click and select on the top right of the PR). No need to ask it more than once. Patience.

@pranjalg1331
Copy link
Author

Apologies if I overstepped. I really appreciate the time you and others put into reviewing contributions. I'll make sure to follow the guidelines and be patient moving forward.

@mlodic
Copy link
Member

mlodic commented Feb 13, 2025

Thank you for your understanding. Can you pull the changes that I have just merged from your other PR #71 here? So we can re-run the CI with those additional checks and then merge it.

Signed-off-by: pranjalg1331 <[email protected]>
Signed-off-by: pranjalg1331 <[email protected]>
Signed-off-by: pranjalg1331 <[email protected]>
Signed-off-by: pranjalg1331 <[email protected]>
Signed-off-by: pranjalg1331 <[email protected]>
Signed-off-by: pranjalg1331 <[email protected]>
Signed-off-by: pranjalg1331 <[email protected]>
Signed-off-by: pranjalg1331 <[email protected]>
Signed-off-by: pranjalg1331 <[email protected]>
Signed-off-by: pranjalg1331 <[email protected]>
@pranjalg1331
Copy link
Author

I have updated the branch to run all the ci tests.

@mlodic
Copy link
Member

mlodic commented Feb 13, 2025

great

@mlodic mlodic merged commit 57c68de into intelowlproject:develop Feb 13, 2025
4 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants