Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

Open
bact opened this issue Jun 30, 2024 · 2 comments
Open

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

bact opened this issue Jun 30, 2024 · 2 comments

Comments

@bact
Copy link
Contributor

bact commented Jun 30, 2024

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
Copy link
Contributor Author

bact commented Jul 1, 2024

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 spdx/spdx-spec#975

@bact bact changed the title Generate seralize name (with prefix) in the document Generate serialized name (a name with profile prefix) in the document Jul 1, 2024
@zvr
Copy link
Member

zvr commented Jul 2, 2024

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants