oasis-tcs / cti-stix2

OASIS CTI TC: Provides issue tracking and wiki pages for the STIX 2.x Work Products
https://github.com/oasis-tcs/cti-stix2
Other
24 stars 9 forks source link

Link to Open Vocabs in Section 10 from property descriptions #309

Open clenk opened 1 year ago

clenk commented 1 year ago

When reading the description of an object property that uses an open vocabulary or enum, it would be nice to be able to click a link right to the section that defines that vocabulary or enum. Currently I have to either scroll way down to find it, or scroll up to the table of contents to click the link there, or use the search function of my document viewer.

This can be considered low priority and just nice-to-have for a future version of the specification.

rpiazza commented 1 year ago

I have always felt the same way. It could be part of STIX 2.1.1 :-)

jordan2175 commented 1 year ago

I proposed this years ago, but I think we should pull all of the vocabularies out of the document and put them in a registry. Either an OASIS Github or OASIS website, or even IANA. This way vocabs could be added to without updating the spec. The versions of the vocab would be defined by the date the were last updated. You would map which vocab version to the STIX version based on the modified timestamp of the STIX object. So if the SDO had a modified timestamp of "March 2023" then the vocab would be the version that was valid at March 2023". Or something like that.

ejratl commented 1 year ago

We will add the links to 2.1.1.

Removing the vocabs from the specification all together would impact the readability of the specification. However, we can achieve the same result by having open vocab extensions in the STIX common-objects repo that can get updated out of cycle from the document updates. The current OASIS Open STIX validator uses the lists from the spec and would need to be updated to refer to the new extended lists.

jordan2175 commented 1 year ago

I would counter argue that RFCs that point to IANA for their vocabs have been very successful for several decades.