docs: Add adapter configuration validation and parsing test documentation #85
Conversation
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
and testing parsing rules before production deployment: - Document --validate flag for local config validation - Document --test-parsing flag for API-based parsing validation - Add exit codes and error handling behavior - Include example output for successful parsing - Include example error output when no events are parsed - Document Python CLI validation commands (limacharlie usp validate) - Add common validation issues table with troubleshooting guidance - Document SDK validateUSP method for programmatic validation These docs support validation features added to usp-adapters and python-limacharlie that help users catch configuration errors and misconfigured parsing rules before deploying adapters.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Details
--validateand--test-parsingCLI flagsContext
This documents new validation features added to usp-adapters and python-limacharlie:
--validate)--test-parsing)TODO