docs(exfil): document watch rule schema and pre-push validate#238
Draft
maximelb wants to merge 1 commit into
Draft
docs(exfil): document watch rule schema and pre-push validate#238maximelb wants to merge 1 commit into
maximelb wants to merge 1 commit into
Conversation
A recent support case stemmed from a Watch Rule config that mixed scalar
and list types for required fields. The current docs only describe the
fields conceptually and the CLI's pre-push validate workflow isn't
documented anywhere, so customers can't self-serve when the underlying
schema rejects their config.
- Add a Watch Rule Fields reference table showing the expected type
(string vs list) and which fields are required.
- Add a "Configuration via Hive" section with a complete, valid YAML
example using the list form for path/filters.platforms/filters.tags.
- Add a "Validate Before Pushing" section documenting
limacharlie hive validate as the read-only pre-flight check that
returns '{}' on success and a description of the failure otherwise.
Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
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
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.
Summary
A recent support case followed the pattern: customer pushed an Exfil config containing a malformed Watch Rule, the push timed out without surfacing the actual schema error, and they had to wait for a human to diagnose it. The customer's own feedback was "work on the docs and the error handling" — this PR is the docs half.
Changes
In
docs/5-integrations/extensions/limacharlie/exfil.md:Watch Rule Fields reference table (under Using the Exfil Extension): per-field type and required/optional flag, with a "common gotcha" callout that
path,filters.platforms, andfilters.tagsmust be YAML lists even when they only have one value.Configuration via Hive section: a complete, valid Watch Rule YAML example using the
extension_confighive, demonstrating the list form forpathand the nestedfiltersblock. Matches the pattern already established in the feedback and usage-alerts docs.Validate Before Pushing subsection: documents the
limacharlie hive validate --hive-name extension_config --key ext-exfilworkflow as the read-only pre-flight check, including what an empty{}response means and the fact thatvalidatenever modifies stored config.No customer-supplied data or identifiers are included; all examples use generic field values.
Test plan
mkdocs serveand confirm the new sections appear in the expected order in the left navlimacharlie hive validateagainst a current ext-exfil schema🤖 Generated with Claude Code