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

Missing requirement that non-zero-padded version numbers are prefixed with 'v' #532

Closed
pwinckles opened this issue Mar 18, 2021 · 3 comments · Fixed by #560
Closed

Missing requirement that non-zero-padded version numbers are prefixed with 'v' #532

pwinckles opened this issue Mar 18, 2021 · 3 comments · Fixed by #560
Assignees
Labels
OCFL Object Ready for Review Ready for review by editorial group Validation Validation errors, warnings and other issues
Milestone

Comments

@pwinckles
Copy link

Spec:

The sequence of version numbers is the sequence of positive, base-ten integers: 1, 2, 3, etc., and the version directory name is constructed by adding the prefix v.

Validation codes:

  • E009: ‘The version number sequence MUST start at 1 and must be continuous without missing integers.’
  • E010: ‘The version number sequence must start at 1 and MUST be continuous without missing integers.’
  • E011: ‘If zero-padded version directory numbers are used then they must start with the prefix v and then a zero.’

There is no code requiring non-zero-padded version numbers to begin with v. I assume this is because the spec is missing a MUST in the quoted sentence.

@zimeon
Copy link
Contributor

zimeon commented Mar 19, 2021

I see my validator gives an E009 if I put a version 1 (as opposed to v1) which isn't covered by the description.

I agree that it would be helpful to have a MUST that all version directory names start with v, and that this is separate from the current E009, E010, E011 (which should perhaps be just about zero padding)

@zimeon zimeon added the Validation Validation errors, warnings and other issues label Mar 26, 2021
@zimeon zimeon added this to the 2.0 milestone Mar 26, 2021
@zimeon
Copy link
Contributor

zimeon commented Apr 27, 2021

I propose rewriting the first paragraph of https://ocfl.io/1.0/spec/#version-directories in v1.1 to include an additional MUST, along the lines of @pwinckles' suggest. Change from:

OCFL Object content MUST be stored as a sequence of one or more versions. Each object version is stored in a version directory under the object root. The sequence of version numbers is the sequence of positive, base-ten integers: 1, 2, 3, etc., and the version directory name is constructed by adding the prefix v. The version number sequence MUST start at 1 and MUST be continuous without missing integers.

to

OCFL Object content MUST be stored as a sequence of one or more versions. Each object version is stored in a version directory under the object root. Version directory names MUST be constructed by prepending v to the version number, taken from the sequence of positive, base-ten integers: 1, 2, 3, etc.. The version number sequence MUST start at 1 and MUST be continuous without missing integers.

@zimeon zimeon modified the milestones: 2.0, 1.1 Apr 27, 2021
@awoods
Copy link
Member

awoods commented May 23, 2021

Just word-smithing here:

OCFL Object content MUST be stored as a sequence of one or more versions. Each object version is stored in a version directory under the object root. Version directory names MUST be constructed by prepending v to the version number. The version number MUST be taken from the sequence of positive, base-ten integers: 1, 2, 3, etc.. The version number sequence MUST start at 1 and MUST be continuous without missing integers.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
OCFL Object Ready for Review Ready for review by editorial group Validation Validation errors, warnings and other issues
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants