search

oasis-tcs / csaf

OASIS CSAF TC: Supporting version control for Work Product artifacts developed by members of TC, including prose specifications and secondary artifacts like meeting minutes and productivity code
https://github.com/oasis-tcs/csaf
Other
140 stars 38 forks source link

Specify recursion depth for `branches` #625

Open tschmidtb51 opened 1 year ago

tschmidtb51 commented 1 year ago

I remember that we discussed a recursion depth of 25 nested branches within a /product_tree. However, I didn't see it in the standard (or I overlooked it). I think that might be a valuable addition to the guidance - especially for a future API.

tschmidtb51 commented 5 months ago

The TC should decide whether this should be a formal (section 5) or informal requirement (Appendix C) as well as whether it is a "SHOULD" or a "MUST" requirement.

tschmidtb51 commented 5 months ago

Checklist:

tschmidtb51 commented 3 months ago

As we have currently 13 branch categories, I suggest 30 as limit and the following wording in the formal part:

5.4 Branch recursion

The /product_tree uses a nested structure for branches. Along a single path to a leaf, the recursion of branches is limited to 30 repetitions. Therefore, the longest path to a leaf is:

/product_tree/branches[]/branches[]/branches[]/branches[]/branches[]/branches[]/branches[]/branches[]/branches[]/branches[]/branches[]/branches[]/branches[]/branches[]/branches[]/branches[]/branches[]/branches[]/branches[]/branches[]/branches[]/branches[]/branches[]/branches[]/branches[]/branches[]/branches[]/branches[]/branches[]/branches[]/product