spdx / spec-parser

automagically process the specification
Apache License 2.0
6 stars 14 forks source link

Generate serialized name (a name with profile prefix) in the document #132

Open bact opened 4 months ago

bact commented 4 months ago

When writing objects, pay attention to which profile the property is defined in, as that sets the prefix (the documentation should make it clear what the serialized name of a property is if you are unsure TODO: It does not yet).

From a TODO in Getting started writing SPDX 3 document.

bact commented 4 months ago

Not sure what is a preferable approach in making this, I come up with two to choose from:

1st approach:

2nd approach:

I can open a PR, once the decision about coding approach is made here and the decision about the design (where to put the serialized name in the page) is made in https://github.com/spdx/spdx-spec/issues/975

zvr commented 4 months ago

This is only relevant for JSON-LD serialization. I doubt we want to have each and every serialization format present in the model cards.