Skip to content

[plan] Update documentation for JSON Schema validation approach #6405

@github-actions

Description

@github-actions

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:

  1. Consistent validation approach across workflow and campaign specs
  2. Schema caching pattern using sync.Once
  3. Removal of the unmaintained dependency

Implementation Steps

  1. Check for documentation references:

    grep -r "gojsonschema\|JSON Schema" docs/ README.md DEVGUIDE.md --include="*.md"
  2. 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
  3. Update code comments in validation files:

    • Add package-level documentation explaining the validation approach
    • Document the schema caching pattern
  4. 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.md
  • README.md
  • AGENTS.md (optional)
  • pkg/campaign/validation.go (code comments)
  • pkg/workflow/schema_validation.go (code comments)

Acceptance Criteria

AI generated by Plan Command for discussion #6400

Metadata

Metadata

Assignees

Labels

Type

No type
No fields configured for issues without a type.

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions