Enhance OTXv2 usability with improved .getall() docstring and API key…#78
Open
marky224 wants to merge 1 commit intoAlienVault-OTX:masterfrom
Open
Enhance OTXv2 usability with improved .getall() docstring and API key…#78marky224 wants to merge 1 commit intoAlienVault-OTX:masterfrom
marky224 wants to merge 1 commit intoAlienVault-OTX:masterfrom
Conversation
… validation This commit improves the OTXv2.py SDK by: 1. Adding a detailed schema to the .getall() docstring, clarifying the structure of returned pulse and indicator data to reduce transformation errors. 2. Implementing proactive API key validation in __init__ to catch format errors (non-64-char hex strings) before API calls, preventing runtime 403 errors. These changes enhance developer experience by providing better documentation and early error detection, inspired by real-world usage in an ETL pipeline.
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
… validation
This commit improves the OTXv2.py SDK by:
These changes enhance developer experience by providing better documentation and early error detection, inspired by real-world usage in an ETL pipeline.