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 ] ids parameter should be composite_ids in https://falconpy.io/Service-Collections/Alerts.html#patchentitiesalertsv3 #1166

Closed
2 of 3 tasks
morcef opened this issue May 24, 2024 · 1 comment
Assignees
Labels
documentation 📖 Improvements or additions to documentation

Comments

@morcef
Copy link

morcef commented May 24, 2024

Documentation page topic
patchentitiesalertsv3

Describe the error or typo
patchentitiesalertsv3 instructs to use ids as a parameter, when the correct parameter is composite_ids.

Documentation repository:

  • GitHub Wiki
  • falconpy.io
  • Source code - docstring

Additional context
I also find the error message from the backend to be quite useless and misleading:
'errors': [{'code': 400, 'message': 'invalid element in the request'}]

@morcef morcef added the documentation 📖 Improvements or additions to documentation label May 24, 2024
@jshcodes jshcodes self-assigned this May 28, 2024
@jshcodes
Copy link
Member

Wiki content updated and replicated to falconpy.io.

Thank you for reporting this issue! 🙇

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
Projects
None yet
Development

No branches or pull requests

2 participants