Skip to content

Enhance OTXv2 usability with improved .getall() docstring and API key… #78

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

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

marky224
Copy link

@marky224 marky224 commented Mar 9, 2025

… 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.

… 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.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant