-
Notifications
You must be signed in to change notification settings - Fork 327
[plan] Update documentation for JSON Schema validation approach #6405
Copy link
Copy link
Closed as not planned
Labels
ai-generateddocumentationImprovements or additions to documentationImprovements or additions to documentationplan
Description
Objective
Update any relevant documentation to reflect the consolidated JSON Schema validation approach using santhosh-tekuri/jsonschema across the entire codebase.
Context
After migrating from gojsonschema to santhosh-tekuri/jsonschema, documentation should be updated to reflect:
- Consistent validation approach across workflow and campaign specs
- Schema caching pattern using
sync.Once - Removal of the unmaintained dependency
Implementation Steps
-
Check for documentation references:
grep -r "gojsonschema\|JSON Schema" docs/ README.md DEVGUIDE.md --include="*.md"
-
Update DEVGUIDE.md (if needed):
- Document the JSON Schema validation approach
- Mention that we use santhosh-tekuri/jsonschema/v6 for all validation
- Include the schema caching pattern as a best practice
-
Update code comments in validation files:
- Add package-level documentation explaining the validation approach
- Document the schema caching pattern
-
Consider adding to AGENTS.md (if relevant):
- Note about consistent JSON Schema library usage
- Schema caching pattern for future reference
Files to Check/Modify
docs/**/*.md(if exists)DEVGUIDE.mdREADME.mdAGENTS.md(optional)pkg/campaign/validation.go(code comments)pkg/workflow/schema_validation.go(code comments)
Acceptance Criteria
- No outdated references to gojsonschema in documentation
- JSON Schema validation approach is documented (if needed)
- Code comments clearly explain the validation pattern
- Schema caching pattern is documented for future developers
- Documentation builds/renders correctly (if applicable)
Related to [plan] Migrate from unmaintained gojsonschema to santhosh-tekuri/jsonschema #6401
AI generated by Plan Command for discussion #6400
Reactions are currently unavailable
Metadata
Metadata
Assignees
Labels
ai-generateddocumentationImprovements or additions to documentationImprovements or additions to documentationplan
Type
Fields
Give feedbackNo fields configured for issues without a type.