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

Software: Add sizeInBytes in field #966

Open
wants to merge 1 commit into
base: develop
Choose a base branch
from

Conversation

JPEWdev
Copy link
Contributor

@JPEWdev JPEWdev commented Jan 30, 2025

Adds a property to software Artifact that indicates the size, in bytes

@bact bact added the Profile:Core Core Profile and related matters label Jan 30, 2025
@bact
Copy link
Collaborator

bact commented Jan 30, 2025

Two things:

  1. Does it possible for a SoftwareArtifact to have a size of 0 ?

    • If yes, then we may need to have this as a xsd:nonNegativeInteger type to allows zero
  2. If we eventually have this, we may like to deprecate Dataset/datasetSize and let Dataset/DatasetPackage use this Core/sizeInBytes instead.

    • Good news: DatasetPackage is a SoftwareArtifact, and the datasetSize is in bytes
    • @rgopikrishnan91 @bennetkl what do you think?

@JPEWdev
Copy link
Contributor Author

JPEWdev commented Jan 30, 2025

Ya, 0 bytes makes sense, so we should change that.

@zvr
Copy link
Member

zvr commented Jan 30, 2025

Why not simply call it size, or at most artifactSize ? We can have the description say that the number is in bytes.

Adds a property to software Artifact that indicates the size, in bytes

Signed-off-by: Joshua Watt <[email protected]>
Copy link
Contributor

@kestewart kestewart left a comment

Choose a reason for hiding this comment

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

LGTM

Copy link
Contributor

@bennetkl bennetkl left a comment

Choose a reason for hiding this comment

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

I'm in agreement to add this field in software profile and remove from datasets. I like the new name of field, better than with bytes in the field name. You might want to put in examples of how to fill in this field. I approve the change and for 3.1 we add a PR to remove similar field from dataset profile.

@bact
Copy link
Collaborator

bact commented Jan 31, 2025

I'm in agreement to add this field in software profile and remove from datasets. I like the new name of field, better than with bytes in the field name. You might want to put in examples of how to fill in this field. I approve the change and for 3.1 we add a PR to remove similar field from dataset profile.

@bennetkl for backward compatibility with 3.0.x, I don't think we can remove datasetSize from the spec.

We can however deprecate it, put some description encouraging people to use the new artifactSize, also maybe considering putting a owl:sameAs to tell that the two are similar.

A 3.0 to 3.1 migration tool can also help users convert this.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Profile:Core Core Profile and related matters
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants