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

[ DOC ] perform_incident_action includes "comments" in verbose description but not as keyword arguments #776

Closed
seiimonn opened this issue Sep 9, 2022 · 2 comments · Fixed by #777
Assignees
Labels
documentation 📖 Improvements or additions to documentation incidents Incidents issues and questions

Comments

@seiimonn
Copy link

seiimonn commented Sep 9, 2022

Documentation page topic
falconpy/incidents.py -> line 120

Describe the error or typo
In the sourcecode of falconpy/incidents.py the description on line 123 states that the function perform_incident_action can be used to add comments to an incident. In the description of the keyword arguments following there is no reference to any actions possible for comments.

Documentation repository:

  • Source code - docstring
@seiimonn seiimonn added the documentation 📖 Improvements or additions to documentation label Sep 9, 2022
@jshcodes jshcodes added the hosts Hosts or Host Groups issues and questions label Sep 9, 2022
@jshcodes
Copy link
Member

jshcodes commented Sep 9, 2022

Thank you for reporting this! 😄

@jshcodes jshcodes self-assigned this Sep 9, 2022
@jshcodes jshcodes added incidents Incidents issues and questions and removed hosts Hosts or Host Groups issues and questions labels Sep 9, 2022
jshcodes added a commit that referenced this issue Sep 9, 2022
jlangdev pushed a commit that referenced this issue Sep 9, 2022
@morcef
Copy link

morcef commented Jul 5, 2023

@jshcodes , sorry for commenting on a closed issue, but I just passed by as I saw the documentation at falconpy.io still states the same as the documentarion at Swagger;

Perform a set of actions on one or more incidents, such as adding tags or comments or updating the incident name or description

After some digging, I found that it is the documentation at https://falcon.eu-1.crowdstrike.com/documentation/86/detections-monitoring-apis#modify-incidents that is lacking details of the available action paramters. It is in fact possible to add a comment to an incident by using the action parameter name: "add_comment".

I guess it would be a good idea to update the documentations around :) And it would also be nice to have an own keyword argument for add_comment ;)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation 📖 Improvements or additions to documentation incidents Incidents issues and questions
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants