-
Notifications
You must be signed in to change notification settings - Fork 0
Open
Description
Goal
Make QuantityKindTag metadata queryable and exportable for tooling and documentation.
Purpose
Enable external tools, code generators, and documentation systems to discover and validate quantity kind metadata. Provide programmatic access to tag hierarchies and enable deterministic exports for versioning and validation.
Scope
- Prefix/tag query APIs (e.g.,
GetByPrefix("Domain.")) - Deterministic JSON manifest output for tooling and docs
- Test coverage for tag rules and manifest stability
Deliverables
- Public query APIs for tags by prefix, name, or pattern
- JSON manifest generator with deterministic output
- Tag validation rules enforcement (reserved roots, naming conventions)
- Comprehensive tests for query APIs and manifest stability
- Documentation with usage examples for tooling integration
Acceptance Criteria
- Public API enables querying tags by prefix/name with clear semantics
- Manifest is deterministic across runs and properly versioned
- Tests ensure reserved root enforcement (Core, Domain, Application, Custom)
- Manifest output is stable and suitable for version control
- Query performance is acceptable for common use cases
- Documentation includes integration examples for common tooling scenarios
Technical Notes
- See
docs/quantity-kind-governance.mdfor tag hierarchy rules - Manifest format should be machine-readable and human-reviewable
- Query APIs must be deterministic and thread-safe
- Consider caching for performance if needed (with appropriate invalidation)
Risk & Mitigation
Risk: Tag queries may have performance issues with large tag sets
Mitigation: Implement efficient lookup structures; add performance tests; consider caching
Risk: Manifest format changes could break external tooling
Mitigation: Version the manifest format; provide migration guidance; maintain backward compatibility where possible
Reactions are currently unavailable