Skip to content

Rewrite bundled examples to exercise newer schema features (structured architecture, structured steps, etc.) #53

Description

@JohnASRG

Motivation

Several v0.1.0 schema features (structured architecture, structured attackSteps, structured dataFlows, AFR inputFactors, impact categories, CAL/TAF objects) exist in the schema but are not demonstrated in examples/rdx-xml-comprehensive.xml or the JSON comprehensive example, which still lean on legacy string forms. Adopters following the examples will skip the newer capabilities entirely. The XSD/JSON parity work is partly invisible because no test vector currently exercises it end-to-end.

Proposed change

  1. Rewrite examples/rdx-xml-comprehensive.xml and the JSON counterpart so every supported object/field type is exercised at least once — including:
  2. Add an XSD coverage report to tools/validate.sh that lists which complexType / element / attribute names are exercised by the comprehensive example and flags any unused ones in CI output.
  3. Document the comprehensive example in CLAUDE.md and README.md as the canonical "what does a fully populated RDX document look like" reference.

References

  • AI peer review, section 4 closing note ("the comprehensive example still uses a simple architecture string, even though the schema supports structured architecture")
  • CLAUDE.md — schema parity note ("XML coverage example is the XSD coverage/test vector")

Acceptance criteria


Surfaced by external AI peer review; see chat transcript for full review text.

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    ai-proposalProposed by the AI idea scout; needs human reviewenhancementNew feature or requestpeer-reviewSurfaced by external AI/peer review of the repopriority/P1High priority — V1.0 foundation

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions