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 ] Indicator Update Missing Required Field #634

Closed
1 of 3 tasks
mtobias-getty opened this issue Apr 29, 2022 · 2 comments · Fixed by #648
Closed
1 of 3 tasks

[ DOC ] Indicator Update Missing Required Field #634

mtobias-getty opened this issue Apr 29, 2022 · 2 comments · Fixed by #648
Assignees
Labels
documentation 📖 Improvements or additions to documentation iocs IOCs (both) issues and questions

Comments

@mtobias-getty
Copy link

Documentation page topic
https://www.falconpy.io/Service-Collections/IOC.html#indicator_update_v1

Describe the error or typo
The Indicator Update documentation doesn't appear to show that the ID field is required when updating an IOC but according to the API error response if an ID is not included, it sure seems required.
'errors': [{'code': 400, 'message': 'One or more indicators have a warning or invalid input'}], 'resources': [{'row': 1, 'value': None, 'type': None, 'message_type': 'error', 'field_name': 'ID', 'message': 'required string is missing'}]}

Documentation repository:

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

Additional context

@mtobias-getty mtobias-getty added the documentation 📖 Improvements or additions to documentation label Apr 29, 2022
@jshcodes jshcodes self-assigned this Apr 30, 2022
@jshcodes jshcodes added the iocs IOCs (both) issues and questions label Apr 30, 2022
@jshcodes
Copy link
Member

jshcodes commented May 2, 2022

This is a good catch. That payload attribute isn't listed in the wiki documentation for this method at all! Fortunately, it is present within the body payload handler and the docstring (although the required status is not mentioned).

Thank you for pointing this out, we will get this page (and the docstring) updated!

jshcodes added a commit that referenced this issue May 3, 2022
@jshcodes
Copy link
Member

jshcodes commented May 3, 2022

Wiki content has been updated. Replicated to https://falconpy.io.

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 iocs IOCs (both) issues and questions
Projects
None yet
2 participants