tobor88 / CybereasonAPI

PowerShell module containing commands to easily interact with the Cybereason API.
https://www.cybereason.com/
GNU General Public License v3.0
15 stars 6 forks source link

Function example is for the wrong function. #3

Closed TheSecondQuaid closed 2 years ago

TheSecondQuaid commented 2 years ago

Is your feature request related to a problem? Please describe. A clear and concise description of what the problem is. Ex. I'm always frustrated when [...] Not related to a problem, necessarily, just missing the proper example for a function in CybereasonAPI.psm1, line 3738. It references the preceding function (Set-CybereasonCustomDetectionRule) rather than the current one being described (Get-CybereasonListAllSensor).

Describe the solution you'd like A clear and concise description of what you want to happen. Should be updated to include an example for the correct function. Perhaps something like: Get-CybereasonListAllSensor -Limit 1000 -Offset 0 -Sort DESC -Filter osType:WINDOWS

Describe alternatives you've considered A clear and concise description of any alternative solutions or features you've considered. N/A

Additional context Add any other context or screenshots about the feature request here. Not functionality-breaking at all, but would be beneficial to anyone who genuinely needs an example to help get them started with the function. I apologize if this was done inccorrectly, as well, as I haven't opened many issues in Github yet :).

tobor88 commented 2 years ago

Thanks! I have updated that in the git repo