Version 1.1 - Expanded binary responses, action_parameter abstraction, docstrings #648
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
github-actions
bot
added
documentation 📖
jshcodes
added
enhancement 🌟
jlangdev
approved these changes
May 9, 2022
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
FalconPy v1.1.0
This update provides new functionality for advanced handling of binary API responses and the abstraction of
action_parameterspayload elements. Several minor developer utilities are added to theutilfolder. Multiple docstring issues are also resolved.Unit test coverage
220 passed in 375.29s (0:06:15)
Bandit analysis
[main] INFO running on Python 3.9.9 Run started:2022-05-09 18:54:22.263100 Test results: No issues identified. Code scanned: Total lines of code: 35059 Total lines skipped (#nosec): 0 Run metrics: Total issues (by severity): Undefined: 0 Low: 0 Medium: 0 High: 0 Total issues (by confidence): Undefined: 0 Low: 0 Medium: 0 High: 0 Files skipped (0):Added features and functionality
Added: Results object expansion - expanded results are returned as a tuple, Ex:
(status_code, headers, content). This allows for headers and status to be checked on binary API returns. Expanded results are supported for all calls to the API and can be requested from any Service Class method or the Uber Class command method using the keywordexpand_result._result.py_util.pyapi_complete.pytest_sample_uploads.pyExample
Added: Specify action_parameters keys for perform operations using keywords instead of a list of dictionaries. Closes [ ENH ] Update all performXYZAction operations to allow for specifying the action parameter payload by name (as a keyword). #647.
group_iddevice_control_policies.py(perform_action method)firewall_policies.py(perform_action method)prevention_policy.py(perform_policies_action method)response_policies.py(perform_policies_action method)sensor_update_policy.py(perform_policies_action method)filterhost_group.py(perform_group_action method)add_tag,delete_tag,unassign,update_name,update_assigned_to_v2,update_description,update_status_payload/__init__.py_payload/_incidents.pyincidents.py(perform_incident_action method)Other
query_accountsandquery_loginsmethods within the Discover Service Class. Closes [ DOC ] Common sort options are incorrectly listed in the query_accounts and query_logins docstrings. #621.discover.pyidrequirements for keyword submissions to theindicator_updatemethod within the IOC Service Class. Closes [ DOC ] Indicator Update Missing Required Field #634.ioc.pyget_downloadoperation within the ReportExecutions Service Class. Closes [ DOC ] ReportExecutionsdownload_getdocumentation lists an incorrect return type. #640.report_executions.pyaction_parameterspayload element.real_time_response.pyutil/babel_fish.pyutil/find-strings.shutil/public-modules.shutil/vcheck.sh