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.

Sign up for GitHub

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

Jump to bottom

validation issues in spec examples #539

Closed
pwinckles opened this issue Apr 2, 2021 · 3 comments
Closed

validation issues in spec examples #539

pwinckles opened this issue Apr 2, 2021 · 3 comments
Assignees
@julianmorley
Labels
OCFL Object Ready for Review Ready for review by editorial group Validation Validation errors, warnings and other issues
Milestone
1.1

Comments

@pwinckles
Copy link

I noticed a few problems with the spec examples:

  1. All of the examples include an address that is not a URI
  2. This example is missing a user
  3. The Moab example is invalid because the versions in its inventory are not zero-padded; while the version directories on disk are
@pwinckles
Copy link
Author

Additionally, I just glanced at the examples in the implementation notes. The addresses are correct there, but all of the created timestamps are missing their offset.

@zimeon
Copy link
Contributor

zimeon commented Apr 2, 2021

Thanks @pwinckles , sigh re spec errors:

  1. Yes, the address entries should all have a mailto: prefix
  2. I agree that https://ocfl.io/1.0/spec/#example-object-diff-paths would give a warning, probably best that spec examples don't give warnings unless there is a good reason, and maybe then the expected warning and reason should be made explicit
  3. Yikes, yes. Per https://ocfl.io/1.0/spec/#versions the Moab example should generate https://ocfl.io/1.0/spec/#E046 "The keys of [the versions] object MUST correspond to the names of the version directories used."

@zimeon zimeon added OCFL Object Validation Validation errors, warnings and other issues labels Apr 20, 2021
@zimeon zimeon added this to the 1.1 milestone May 4, 2021
awoods pushed a commit that referenced this issue May 23, 2021
Add 'mailto' to example addresses
926b334 
Related to: #539
awoods pushed a commit that referenced this issue May 23, 2021
Add 'user' block to https://ocfl.io/1.0/spec/#example-object-diff-paths
a73ba87 
Related to: #539
@awoods awoods mentioned this issue May 23, 2021
Merged
awoods pushed a commit that referenced this issue May 23, 2021
Add 'user' block to https://ocfl.io/1.0/spec/#example-object-diff-paths
bb4056a 
Related to: #539
@awoods awoods added the Ready for Review Ready for review by editorial group label May 23, 2021
neilsjefferies pushed a commit that referenced this issue Jun 10, 2021
@awoods
Fix examples in spec (#546)
274f9b2 
* Add 'mailto' to example addresses

Related to: #539

* Add 'user' block to https://ocfl.io/1.0/spec/#example-object-diff-paths

Related to: #539

Co-authored-by: anw822 <andrew_woods@harvard.edu>
@rosy1280
Copy link
Contributor

Moab objects still need to be fixed.

julianmorley added a commit that referenced this issue Aug 25, 2021
@julianmorley
Fix versions in Moab example. (#539)
a33d859
@rosy1280 rosy1280 closed this as completed Oct 5, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@julianmorley julianmorley

Labels
OCFL Object Ready for Review Ready for review by editorial group Validation Validation errors, warnings and other issues
Projects
None yet
Milestone
1.1
Development

No branches or pull requests
5 participants
@rosy1280 @awoods @zimeon @pwinckles @julianmorley