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

Remove Software/contentType (duplicative) #789

Merged
merged 3 commits into from
Jun 28, 2024

Conversation

bact
Copy link
Collaborator

@bact bact commented Jun 16, 2024

  • Update the Core/Properties/contentType.md with wording from Software/Properties/contentType.md, adjusted to accommodate both Element and Property
  • Update Core/Datatypes/MediaType.md to accommodate both Element and Property, also add string examples
  • Remove Software/Properties/contentType.md file
  • Update Software/Classes/File.md to refer to /Core/contentType instead of contentType
  • Update examples: file1.json and spdx_document2.json

This should resolve #781

bact and others added 2 commits June 16, 2024 13:45
- Update the `Core/Properties/contentType.md` with wording from `Software/Properties/contentType.md`, adjusted to accommodate both Element and Property
- Update `Core/Datatypes/MediaType.md` to accommodate both Element and Property, also add string examples
- Remove `Software/Properties/contentType.md` file
- Update `Software/Classes/File.md` to refer to `/Core/contentType` instead of `contentType`
- Update examples: `file1.json` and `spdx_document2.json`

Co-Authored-By: Alexios Zavras (zvr) <136705+zvr@users.noreply.github.com>
Signed-off-by: Arthit Suriyawongkul <arthit@gmail.com>
Add info on the removal of `Software/contentType`

Signed-off-by: Arthit Suriyawongkul <arthit@gmail.com>
Copy link
Member

@goneall goneall left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM - Thanks @bact

@goneall
Copy link
Member

goneall commented Jun 25, 2024

@JPEWdev - This would be a breaking change for existing 3.0.0 users. We're thinking of merging this into 3.0.1 - would this be a problem for your Yocto work?

Update examples to cover media type that:
- contains `+` suffix and `;` parameter - is from `vnd.` vendor tree

Signed-off-by: Arthit Suriyawongkul <arthit@gmail.com>
@JPEWdev
Copy link
Contributor

JPEWdev commented Jun 27, 2024

No, we aren't using that field. Is it possible to "hide" it in the spec, but leave it in the RDF so it's backward compatible maybe?

@goneall
Copy link
Member

goneall commented Jun 28, 2024

No, we aren't using that field. Is it possible to "hide" it in the spec, but leave it in the RDF so it's backward compatible maybe?

@JPEWdev - good to know.

For the RDF, we could keep the Software/contentType and use the owl:sameAs to associate it with the core/contentType. This would imply a bit of a hack to the spec parser to capture this - or a more extensive change to the markdown spec and the spec parser.

My opinion is if we get this changed quickly and release 3.0.1 with the changes, it won't impact many folks since we're in the early phases of 3.0 adoption.

I'm going to go ahead and merge this change.

@zvr if you have time - feel free to update the spec parser.

@goneall goneall merged commit b7a3c95 into spdx:main Jun 28, 2024
1 check passed
@bact bact deleted the remove-software-contenttype branch June 28, 2024 13:41
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

Successfully merging this pull request may close these issues.

Do we want / need to have contentType defined in Software and Core?
3 participants