OpenCTI-Platform
Placeholder Issue for pycti documentation
Problem to Solve
The documentation for PyCTI is almost entirely lacking, so I'm creating this placeholder issue to track my contributions to it.
Current Workaround
Currently, the only "workaround" is to manually read the PyCTI code or the OpenCTI code to figure out what to do, which isn't great DevX/UX.
Proposed Solution
I'm going to work on documenting the endpoints, functions and classes as I work with them and provide examples. This issue can serve as a reference point for mine (and others) contributions.
Additional Information
I think the biggest problem with the documentation is that type hints are completely absent. This would greatly improve the quality of automatically generated documentation. Since this is effectively just a pythonic interface to the GraphQL API there is also not that much to 'document' on in my opinion. I've read issue #54 but it doesn't actually seem to have been implemented?
Of course this would be a huge undertaking, so I can imagine it not being the most fun thing to implement...
