Skip to content

Directive giving invalid vBRIEF files & wrong key names #144

@Adoracorn

Description

@Adoracorn

Directive generated an invalid vBRIEF file. The first issue is what makes it invalid (for vBRIEF-Studio it wouldn't load views and gave errors). The next doesn't make it invalid, but it does effect how it's presented vBRIEF-Studio. I've attached the invalid file & the fixed file!

  1. Invalid narrative value type (plan.narratives.Requirements)
    The Requirements narrative was an object with nested arrays (Functional: [...], NonFunctional: [...]). The vBRIEF schema requires all narrative values to be plain strings. It was split into two separate string keys — FunctionalRequirements and NonFunctionalRequirements — with each requirement on its own line.

  2. Wrong key name for nested items (all 8 subphase/task levels)
    Every level of nesting inside the phase items used "items" as the key, but the vBRIEF schema uses "subItems" for children within a PlanItem. Because PlanItem has additionalProperties: true, this didn't cause a schema validation error — the nested items were simply invisible to vBRIEF tools (they'd never render in the tree, outline, or form editor). All "items" keys inside plan items were renamed to "subItems", which brought the total recognised item count from 4 (just the top-level phases) to 30 (all phases, subphases, and tasks).

specification.vbrief.json

specification.vbrief-fixed.json

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions