-
Notifications
You must be signed in to change notification settings - Fork 35
Closed
Labels
ai-generateddocumentationImprovements or additions to documentationImprovements or additions to documentationplan
Description
Objective
Add a description to the applyTo field in included_file_schema.json, which is currently the only root-level property missing documentation.
Context
This is Issue #2 (Medium) from the schema audit. The applyTo field is the only root-level property without a description, breaking the otherwise perfect 100% documentation coverage.
Approach
In pkg/parser/schemas/included_file_schema.json, locate the applyTo property definition and add a description field.
Files to Modify
pkg/parser/schemas/included_file_schema.json
Implementation
Add description explaining that applyTo is a glob pattern that filters which jobs use this included file:
"applyTo": {
"description": "Glob pattern specifying which jobs should use this included file. Supports wildcards (e.g., '**/*' for all jobs, 'test-*' for jobs starting with 'test'). If omitted, applies to all jobs.",
"type": "string"
}Acceptance Criteria
-
applyTofield has a clear, helpful description - Description explains glob pattern support and filtering behavior
- Description mentions what happens when field is omitted
- Schema validation still passes
- Run
make buildto verify embedded schema compiles
Estimated Effort
5 minutes
AI generated by Plan Command for discussion #8130
Copilot
Metadata
Metadata
Labels
ai-generateddocumentationImprovements or additions to documentationImprovements or additions to documentationplan