The following tables show the implementation status of all errors and warnings in the OCFL v1.1 specification, with links to the specification and into the code repository.
| Code | Specification text (or suffixed code) | Implementation status and message/links |
|---|---|---|
| E001 | ‘The OCFL Object Root must not contain files or directories other than those specified in the following sections.’ | See multiple cases identified with suffixes below |
| E001a | OCFL Object root contains unexpected file: %s [ocfl/validator.py#L203] | |
| E001b | OCFL Object root contains unexpected directory: %s [ocfl/validator.py#L214] | |
| E001c | OCFL Object root contains unexpected entry that isn’t a file or directory: %s [ocfl/validator.py#L216] | |
| E002 | ‘The version declaration must be formatted according to the NAMASTE specification.’ | NOTE - E002 is redundant to more specific errors E003, E004, E005, E006. [Not implemented] |
| E003 | ‘There must be exactly one version declaration file in the base directory of the OCFL Object Root giving the OCFL version in the filename.’ | See multiple cases identified with suffixes below |
| E003a | OCFL Object version declaration file is missing (assuming version %s) [ocfl/validator.py#L92] | |
| E003b | OCFL Object includes more that one file that looks like an object declaration (got %s), using version %s [ocfl/validator.py#L113] | |
| E003c | OCFL Object includes one or move object declaration files (starting 0=) but no valid version number could be extracted from any of them (assuming version %s) [ocfl/validator.py#L109] | |
| E003d | OCFL Storage Root hierarchy includes directory %s with more that one file that looks like an object declaration, ignoring [ocfl/store.py#L168] | |
| E003e | No OCFL Object to validate at path %s. The root of an OCFL Object must be a directory containing an object declaration [ocfl/validator.py#L86] | |
| E004 | ‘The [version declaration] filename MUST conform to the pattern T=dvalue, where T must be 0, and dvalue must be ocfl_object_, followed by the OCFL specification version number.’ | See multiple cases identified with suffixes below |
| E004a | OCFL Storage Root hierarchy includes directory %s with an object declaration giving unknown version %s, ignoring [ocfl/store.py#L175] | |
| E004b | OCFL Storage Root hierarchy includes directory %s with an unrecognized object declaration %s, ignoring [ocfl/store.py#L177] | |
| E005 | ‘The [version declaration] filename must conform to the pattern T=dvalue, where T MUST be 0, and dvalue must be ocfl_object_, followed by the OCFL specification version number.’ | Not implemented |
| E006 | ‘The [version declaration] filename must conform to the pattern T=dvalue, where T must be 0, and dvalue MUST be ocfl_object_, followed by the OCFL specification version number.’ | The OCFL object conformance declaration filename must be 0=ocfl_object_, followed by the OCFL specification version number, got %s instead [ocfl/validator.py#L103] |
| E007 | ‘The text contents of the [version declaration] file must be the same as dvalue, followed by a newline (\n).’ | OCFL Object declaration file %s contents do not match file name without leading 0= (the ‘dvalue’) [ocfl/validator.py#L107] |
| E008 | ‘OCFL Object content must be stored as a sequence of one or more versions.’ | OCFL Object %s inventory versions block does not contain any versions, there must be at least version 1 [ocfl/inventory_validator.py#L252] |
| E009 | ‘The version number sequence MUST start at 1 and must be continuous without missing integers.’ | OCFL Object %s inventory versions block does not contain v1 or a zero padded equivalent [ocfl/inventory_validator.py#L272] |
| E010 | ‘The version number sequence must start at 1 and MUST be continuous without missing integers.’ | OCFL Object %s inventory versions block includes an out-of-sequence version [ocfl/inventory_validator.py#L283] |
| E011 | ‘If zero-padded version directory numbers are used then they must start with the prefix v and then a zero.’ | Missing description [ocfl/inventory_validator.py#L290] |
| E012 | ‘All version directories of an object must use the same naming convention: either a non-padded version directory number, or a zero-padded version directory number of consistent length.’ | Not implemented |
| E013 | ‘Operations that add a new version to an object must follow the version directory naming convention established by earlier versions.’ | Not implemented |
| E014 | ‘In all cases, references to files inside version directories from inventory files must use the actual version directory names.’ | Not implemented |
| E015 | ‘There must be no other files as children of a version directory, other than an inventory file and a inventory digest.’ | OCFL Object version directory %s includes an illegal file (%s) [ocfl/validator.py#L357] |
| E016 | ‘Version directories must contain a designated content sub-directory if the version contains files to be preserved, and should not contain this sub-directory otherwise.’ | Not implemented |
| E017 | ‘The contentDirectory value MUST NOT contain the forward slash (/) path separator and must not be either one or two periods (. or ..).’ | OCFL Object %s inventory contentDirectory must be a string and must not contain a forward slash (/) [ocfl/inventory_validator.py#L112] |
| E018 | ‘The contentDirectory value must not contain the forward slash (/) path separator and MUST NOT be either one or two periods (. or ..).’ | OCFL Object %s inventory contentDirectory must not be either . or .. [ocfl/inventory_validator.py#L114] |
| E019 | ‘If the key contentDirectory is set, it MUST be set in the first version of the object and must not change between versions of the same object.’ | Not implemented |
| E020 | ‘If the key contentDirectory is set, it must be set in the first version of the object and MUST NOT change between versions of the same object.’ | Not implemented |
| E021 | ‘If the key contentDirectory is not present in the inventory file then the name of the designated content sub-directory must be content.’ | Not implemented |
| E022 | ‘OCFL-compliant tools (including any validators) must ignore all directories in the object version directory except for the designated content directory.’ | Not implemented |
| E023 | ‘Every file within a version's content directory must be referenced in the manifest section of the inventory.’ | See multiple cases identified with suffixes below |
| E023a | OCFL Object includes one or more files that are not mentioned in the %s inventory manifest (%s) [ocfl/validator.py#L395] | |
| E023b | OCFL Object %s manifest does not include files listed in previous version manifests (%s) [ocfl/validator.py#L289] | |
| E024 | ‘There must not be empty directories within a version's content directory.’ | OCFL Object version %s content directory includes empty path %s [ocfl/validator.py#L348] |
| E025 | ‘For content-addressing, OCFL Objects must use either sha512 or sha256, and should use sha512.’ | See multiple cases identified with suffixes below |
| E025a | OCFL Object %s inventory manifest block includes a digest (%s) that doesn’t have the correct form for the %s algorithm [ocfl/inventory_validator.py#L171] | |
| E026 | ‘For storage of additional fixity values, or to support legacy content migration, implementers must choose from the following controlled vocabulary of digest algorithms, or from a list of additional algorithms given in the [Digest-Algorithms-Extension].’ | See multiple cases identified with suffixes below |
| E026a | OCFL Object %s inventory uses unknown digest type %s [ocfl/inventory_validator.py#L413] | |
| E027 | ‘OCFL clients must support all fixity algorithms given in the table below, and may support additional algorithms from the extensions.’ | Not implemented |
| E028 | ‘Optional fixity algorithms that are not supported by a client must be ignored by that client.’ | Not implemented |
| E029 | ‘SHA-1 algorithm defined by [FIPS-180-4] and must be encoded using hex (base16) encoding [RFC4648].’ | Not implemented |
| E030 | ‘SHA-256 algorithm defined by [FIPS-180-4] and must be encoded using hex (base16) encoding [RFC4648].’ | Not implemented |
| E031 | ‘SHA-512 algorithm defined by [FIPS-180-4] and must be encoded using hex (base16) encoding [RFC4648].’ | Not implemented |
| E032 | ‘[blake2b-512] must be encoded using hex (base16) encoding [RFC4648].’ | Not implemented |
| E033 | ‘An OCFL Object Inventory MUST follow the [JSON] structure described in this section and must be named inventory.json.’ | OCFL Object %s inventory is not valid JSON (%s) [ocfl/object.py#L550 ocfl/validator.py#L155] |
| E034 | ‘An OCFL Object Inventory must follow the [JSON] structure described in this section and MUST be named inventory.json.’ | Not implemented |
| E035 | ‘The forward slash (/) path separator must be used in content paths in the manifest and fixity blocks within the inventory.’ | Not implemented |
| E036 | ‘An OCFL Object Inventory must include the following keys: [id, type, digestAlgorithm, head]’ | See multiple cases identified with suffixes below |
| E036a | OCFL Object %s inventory missing id attribute [ocfl/inventory_validator.py#L82] |
|
| E036b | OCFL Object %s inventory missing type attribute [ocfl/inventory_validator.py#L84] |
|
| E036c | OCFL Object %s inventory missing digestAlgorithm attribute [ocfl/inventory_validator.py#L98] |
|
| E036d | OCFL Object %s inventory missing head attribute [ocfl/inventory_validator.py#L129] |
|
| E037 | ‘[id] must be unique in the local context, and should be a URI [RFC3986].’ | See multiple cases identified with suffixes below |
| E037a | OCFL Object %s inventory id attribute is empty or badly formed [ocfl/inventory_validator.py#L74] |
|
| E037b | OCFL Object %s inventory id %s does not match the value in the root inventory %s [ocfl/validator.py#L279] |
|
| E038 | ‘In the object root inventory [the type value] must be the URI of the inventory section of the specification version matching the object conformance declaration.’ | See multiple cases identified with suffixes below |
| E038a | OCFL Object %s inventory type attribute has wrong value (expected %s, got %s) [ocfl/inventory_validator.py#L96] |
|
| E038b | OCFL Object %s inventory type attribute does not look like a valid specification URI (got %s), will proceed as if using version %s [ocfl/inventory_validator.py#L90] |
|
| E038c | OCFL Object %s inventory type attribute has an unsupported specification version number (%s), will proceed as if using version %s [ocfl/inventory_validator.py#L94] |
|
| E039 | ‘[digestAlgorithm] must be the algorithm used in the manifest and state blocks.’ | OCFL Object %s inventory digestAlgorithm attribute not an allowed value (got ‘%s’) [ocfl/inventory_validator.py#L107] |
| E040 | [head] must be the version directory name with the highest version number.’ | OCFL Object %s inventory head attribute doesn’t match versions (got %s, expected %s) [ocfl/inventory_validator.py#L133] |
| E041 | ‘In addition to these keys, there must be two other blocks present, manifest and versions, which are discussed in the next two sections.’ | See multiple cases identified with suffixes below |
| E041a | OCFL Object %s inventory missing manifest attribute [ocfl/inventory_validator.py#L119] |
|
| E041b | OCFL Object %s inventory missing versions attribute [ocfl/inventory_validator.py#L124] |
|
| E041c | OCFL Object %s inventory manifest block is not a JSON object [ocfl/inventory_validator.py#L164] | |
| E042 | ‘Content paths within a manifest block must be relative to the OCFL Object Root.’ | See multiple cases identified with suffixes below |
| E042a | OCFL Object %s inventory manifest includes invalid content path %s [ocfl/inventory_validator.py#L448] | |
| E042b | OCFL Object %s inventory manifest includes content path %s with invalid version directory [ocfl/inventory_validator.py#L394] | |
| E043 | ‘An OCFL Object Inventory must include a block for storing versions.’ | Not implemented |
| E044 | ‘This block MUST have the key of versions within the inventory, and it must be a JSON object.’ | OCFL Object %s inventory versions block is not a JSON object [ocfl/inventory_validator.py#L249] |
| E045 | ‘This block must have the key of versions within the inventory, and it MUST be a JSON object.’ | Not implemented |
| E046 | ‘The keys of [the versions object] must correspond to the names of the version directories used.’ | See multiple cases identified with suffixes below |
| E046a | OCFL Object root inventory describes version %s but no corresponding version directory is present [ocfl/validator.py#L359] | |
| E046b | OCFL Object includes directory %s that looks like a version directory but isn’t a valid version in the inventory [ocfl/validator.py#L211] | |
| E047 | ‘Each value [of the versions object] must be another JSON object that characterizes the version, as described in the 3.5.3.1 Version section.’ | Not implemented |
| E048 | ‘A JSON object to describe one OCFL Version, which must include the following keys: [created, state]’ | OCFL Object %s inventory %s version block does not include a created date or it is malformed [ocfl/inventory_validator.py#L310] |
| E048c | OCFL Object %s inventory %s version block does not include a state block [ocfl/inventory_validator.py#L326] | |
| E049 | ‘[the value of the “created” key] must be expressed in the Internet Date/Time Format defined by [RFC3339].’ | See multiple cases identified with suffixes below |
| E049a | OCFL Object %s inventory %s version block created date SHOULD include a timezone designator [ocfl/inventory_validator.py#L318] | |
| E049b | OCFL Object %s inventory %s version block created date SHOULD be granular to the seconds level [ocfl/inventory_validator.py#L320] | |
| E049c | OCFL Object %s inventory %s version block has bad created date, must be IS8601 (%s) [ocfl/inventory_validator.py#L322] | |
| E049d | OCFL Object %s inventory %s version block created value is not a JSON string [ocfl/inventory_validator.py#L312] | |
| E050 | ‘The keys of [the “state” JSON object] are digest values, each of which must correspond to an entry in the manifest of the inventory.’ | See multiple cases identified with suffixes below |
| E050a | OCFL Object %s inventory state refers to one or more digests that are not in the manifest (%s) [ocfl/inventory_validator.py#L402] | |
| E050c | OCFL Object %s inventory %s version block state block is not a JSON object [ocfl/inventory_validator.py#L359] | |
| E050d | OCFL Object %s inventory %s version state block includes a bad digest (%s) [ocfl/inventory_validator.py#L364] | |
| E050e | OCFL Object %s inventory %s version block state block value for digest %s is not list [ocfl/inventory_validator.py#L366] | |
| E050f | OCFL Object %s inventory version %s state includes digest value %s that is not listed in the manifest block [ocfl/inventory_validator.py#L375] | |
| E051 | ‘The logical path [value of a “state” digest key] must be interpreted as a set of one or more path elements joined by a / path separator.’ | NOTE - E051 is essentially a processing instruction and can’t be tested for. [Not implemented] |
| E052 | ‘[logical] Path elements must not be ., .., or empty (//).’ | OCFL Object %s inventory %s version block state block includes an invalid path %s that starts or ends with / [ocfl/inventory_validator.py#L430] |
| E053 | ‘Additionally, a logical path must not begin or end with a forward slash (/).’ | OCFL Object %s inventory %s version block state block includes an invalid path %s that includes . .. or // [ocfl/inventory_validator.py#L425] |
| E054 | ‘The value of the user key must contain a user name key, “name” and should contain an address key, “address”.’ | See multiple cases identified with suffixes below |
| E054a | OCFL Object %s inventory %s version block has user key with value that isn’t a JSON object [ocfl/inventory_validator.py#L336] | |
| E054b | OCFL Object %s inventory %s version block has user/name key with value that isn’t a string [ocfl/inventory_validator.py#L339] | |
| E054c | OCFL Object %s inventory %s version block has user/address key with value that isn’t a string [ocfl/inventory_validator.py#L343] | |
| E055 | ‘If present, [the fixity] block must have the key of fixity within the inventory.’ | Not implemented |
| E056 | ‘The fixity block must contain keys corresponding to the controlled vocabulary given in the digest algorithms listed in the Digests section, or in a table given in an Extension.’ | See multiple cases identified with suffixes below |
| E056a | OCFL Object %s inventory includes a fixity key with value that isn’t a JSON object [ocfl/inventory_validator.py#L202] | |
| E056b | OCFL Object %s inventory fixity block includes a key that is not a known digest algorithm name: %s [ocfl/inventory_validator.py#L210] | |
| E057 | ‘The value of the fixity block for a particular digest algorithm must follow the structure of the manifest block; that is, a key corresponding to the digest value, and an array of content paths that match that digest.’ | See multiple cases identified with suffixes below |
| E057a | OCFL Object %s inventory fixity block entry for digest algorithm name %s is not a JSON object [ocfl/inventory_validator.py#L217] | |
| E057b | OCFL Object %s inventory fixity block entry for digest algorithm %s includes digest %s which has the wrong form [ocfl/inventory_validator.py#L223] | |
| E057c | OCFL Object %s inventory fixity block entry for digest algorithm %s, digest %s is not a JSON list [ocfl/inventory_validator.py#L225] | |
| E057d | OCFL Object %s inventory fixity block entry for digest algorithm %s, digest %s includes a content path %s that is not in the manifest [ocfl/inventory_validator.py#L238] | |
| E058 | ‘Every occurrence of an inventory file must have an accompanying sidecar file stating its digest.’ | See multiple cases identified with suffixes below |
| E058a | OCFL Object %s inventory is missing sidecar digest file at %s [ocfl/validator.py#L167] | |
| E058b | Cannot extract digest type from inventory digest file name %s [ocfl/validator.py#L190] | |
| E059 | ‘This value must match the value given for the digestAlgorithm key in the inventory.’ | Not implemented |
| E060 | ‘The digest sidecar file must contain the digest of the inventory file.’ | Mismatch between actual and recorded inventory digests for %s (calculated %s but read %s from %s) [ocfl/validator.py#L186] |
| E061 | ‘[The digest sidecar file] must follow the format: DIGEST inventory.json’ | Cannot extract digest from inventory digest file (%s) [ocfl/validator.py#L188] |
| E062 | ‘The digest of the inventory must be computed only after all changes to the inventory have been made, and thus writing the digest sidecar file is the last step in the versioning process.’ | Not implemented |
| E063 | ‘Every OCFL Object must have an inventory file within the OCFL Object Root, corresponding to the state of the OCFL Object at the current version.’ | OCFL Object root inventory is missing [ocfl/validator.py#L117] |
| E064 | ‘Where an OCFL Object contains inventory.json in version directories, the inventory file in the OCFL Object Root must be the same as the file in the most recent version.’ | Object root inventory and copy in last version MUST be identical but are not (%s and %s) [ocfl/validator.py#L261] |
| E066 | ‘Each version block in each prior inventory file must represent the same object state as the corresponding version block in the current inventory file.’ | See multiple cases identified with suffixes below |
| E066a | OCFL Object inventory for %s doesn’t have a subset of version blocks of inventory for %s [ocfl/inventory_validator.py#L472] | |
| E066b | OCFL Object %s inventory %s version state doesn’t have same logical paths as same version in %s inventory (paths %s only in %s inventory) [ocfl/inventory_validator.py#L492 ocfl/inventory_validator.py#L494] | |
| E066c | OCFL Object %s inventory %s version state has logical path %s that maps to content path %s, but in %s inventory it maps to content path %s [ocfl/inventory_validator.py#L499] | |
| E066d | OCFL Object %s inventory %s version state has digest %s (mapping to logical files %s) that does not appear in the %s inventory [ocfl/inventory_validator.py#L528] | |
| E066e | OCFL Object %s inventory %s version state has digest %s (mapping to logical files %s) that does not appear in the %s inventory [ocfl/inventory_validator.py#L531] | |
| E067 | ‘The extensions directory must not contain any files or sub-directories other than extension sub-directories.’ | OCFL Object extensions direct contains an unexpected non-directory entry: %s [ocfl/validator.py#L232] |
| E069 | ‘An OCFL Storage Root MUST contain a Root Conformance Declaration identifying it as such.’ | Not implemented |
| E070 | ‘If present, [the ocfl_layout.json document] MUST include the following two keys in the root JSON object: [extension, description]’ | Not implemented |
| E071 | ‘The value of the [ocfl_layout.json] extension key must be the registered extension name for the extension defining the arrangement under the storage root.’ | Not implemented |
| E072 | ‘The directory hierarchy used to store OCFL Objects MUST NOT contain files that are not part of an OCFL Object.’ | OCFL storage root hierarchy include directory %s with at least one file but no object declaration. Such additional files are not allowed [ocfl/store.py#L179] |
| E073 | ‘Empty directories MUST NOT appear under a storage root.’ | OCFL storage root hierarchy contains an empty directory: %s [ocfl/store.py#L161] |
| E074 | ‘Although implementations may require multiple OCFL Storage Roots - that is, several logical or physical volumes, or multiple “buckets” in an object store - each OCFL Storage Root MUST be independent.’ | Not implemented |
| E075 | ‘The OCFL version declaration MUST be formatted according to the NAMASTE specification.’ | Not implemented |
| E076 | ‘There must be exactly one version declaration file in the base directory of the OCFL Storage Root giving the OCFL version in the filename.’ | Not implemented |
| E077 | ‘[The OCFL version declaration filename] MUST conform to the pattern T=dvalue, where T must be 0, and dvalue must be ocfl_, followed by the OCFL specification version number.’ | Not implemented |
| E078 | ‘[The OCFL version declaration filename] must conform to the pattern T=dvalue, where T MUST be 0, and dvalue must be ocfl_, followed by the OCFL specification version number.’ | Not implemented |
| E079 | ‘[The OCFL version declaration filename] must conform to the pattern T=dvalue, where T must be 0, and dvalue MUST be ocfl_, followed by the OCFL specification version number.’ | Not implemented |
| E080 | ‘The text contents of [the OCFL version declaration file] MUST be the same as dvalue, followed by a newline (\n).’ | Not implemented |
| E081 | ‘OCFL Objects within the OCFL Storage Root also include a conformance declaration which MUST indicate OCFL Object conformance to the same or earlier version of the specification.’ | Not implemented |
| E082 | ‘OCFL Object Roots MUST be stored either as the terminal resource at the end of a directory storage hierarchy or as direct children of a containing OCFL Storage Root.’ | Not implemented |
| E083 | ‘There MUST be a deterministic mapping from an object identifier to a unique storage path.’ | Not implemented |
| E084 | ‘Storage hierarchies MUST NOT include files within intermediate directories.’ | Not implemented |
| E085 | ‘Storage hierarchies MUST be terminated by OCFL Object Roots.’ | Not implemented |
| E086 | Not in specification | OCFL Storage Root extensions direct contains an unexpected non-directory entry: %s [ocfl/store.py#L195] |
| E087 | ‘An OCFL validator MUST ignore any files in the storage root it does not understand.’ | NOTE - E087 is a processing instruction and can’t be tested for [Not implemented] |
| E088 | ‘An OCFL Storage Root MUST NOT contain directories or sub-directories other than as a directory hierarchy used to store OCFL Objects or for storage root extensions.’ | NOTE - E088 is redundant to more specific errors E072 and E073 [Not implemented] |
| E089 | ‘If the preservation of non-OCFL-compliant features is required then the content MUST be wrapped in a suitable disk or filesystem image format which OCFL can treat as a regular file.’ | Not implemented |
| E090 | ‘Hard and soft (symbolic) links are not portable and MUST NOT be used within OCFL Storage hierarchies.’ | NOTE - E090 is a processing instruction and can’t be tested for [Not implemented] |
| E091 | ‘Filesystems MUST preserve the case of OCFL filepaths and filenames.’ | OCFL Object %s inventory manifest file list for digest %s is not a JSON array [Not implemented] |
| E092 | ‘The value for each key in the manifest must be an array containing the content paths of files in the OCFL Object that have content with the given digest.’ | Missing description [ocfl/inventory_validator.py#L173] |
| E092a | OCFL Object %s inventory manifest using digest algorithm %s has digest %s for file %s which doesn’t match calculated digest %s for that file [ocfl/validator.py#L385 ocfl/validator.py#L390] | |
| E092b | OCFL Object %s inventory manifest refers to a file path that is not present in the object (%s) [ocfl/validator.py#L380] | |
| E093 | ‘Where included in the fixity block, the digest values given must match the digests of the files at the corresponding content paths.’ | See multiple cases identified with suffixes below |
| E093a | OCFL Object %s inventory fixity block for digest algorithm %s has digest %s for file %s which doesn’t match calculated digest %s for that file [ocfl/validator.py#L388 ocfl/validator.py#L391] | |
| E093b | OCFL Object %s inventory fixity block for digest algorithm %s has digest %s for a file %s which does not exist in the object [ocfl/validator.py#L374] | |
| E094 | ‘The value of [the message] key is freeform text, used to record the rationale for creating this version. It must be a JSON string.’ | OCFL Object %s inventory %s version block has message key with value that isn’t a string [ocfl/inventory_validator.py#L330] |
| E095 | ‘Within a version, logical paths must be unique and non-conflicting, so the logical path for a file cannot appear as the initial part of another logical path.’ | See multiple cases identified with suffixes below |
| E095a | OCFL Object %s inventory version %s state has logical path %s used more than once [ocfl/inventory_validator.py#L370] | |
| E095b | OCFL Object %s inventory version %s state has logical path %s used as both a directory and a file path. [ocfl/inventory_validator.py#L381] | |
| E096 | ‘As JSON keys are case sensitive, while digests may not be, there is an additional requirement that each digest value must occur only once in the manifest regardless of case.’ | OCFL Object %s inventory manifest block includes digest %s more than once with different normalizations [ocfl/inventory_validator.py#L179] |
| E097 | ‘As JSON keys are case sensitive, while digests may not be, there is an additional requirement that each digest value must occur only once in the fixity block for any digest algorithm, regardless of case.’ | OCFL Object %s inventory fixity block for digest algorithm %s, includes digest %s more than once with different normalizations [ocfl/inventory_validator.py#L233] |
| E098 | ‘The content path must be interpreted as a set of one or more path elements joined by a / path separator.’ | Not implemented |
| E099 | ‘[content] path elements must not be ., .., or empty (//).’ | OCFL Object %s inventory manifest content path %s includes invalid element ., .., or empty (//). [ocfl/inventory_validator.py#L453] |
| E100 | ‘A content path must not begin or end with a forward slash (/).’ | OCFL Object %s inventory manifest content path %s must not begin or end with /. [ocfl/inventory_validator.py#L444] |
| E101 | ‘Within an inventory, content paths must be unique and non-conflicting, so the content path for a file cannot appear as the initial part of another content path.’ | See multiple cases identified with suffixes below |
| E101a | OCFL Object %s inventory manifest content path %s is repeated [ocfl/inventory_validator.py#L457] | |
| E101b | OCFL Object %s inventory manifest content path %s used as both a directory and a file path [ocfl/inventory_validator.py#L189] | |
| E102 | ‘An inventory file must not contain keys that are not specified.’ | Not implemented |
| E103 | ‘Each version directory within an OCFL Object MUST conform to either the same or a later OCFL specification version as the preceding version directory.’ | OCFL Object %s inventory conforms to specification version %s which is an earlier version than the %s inventory which conforms to specification version %s [ocfl/validator.py#L321] |
| E104 | ‘Version directory names MUST be constructed by prepending v to the version number.’ | Not implemented |
| E105 | ‘The version number MUST be taken from the sequence of positive, base-ten integers: 1, 2, 3, etc.’ | Not implemented |
| E106 | ‘The value of the manifest key MUST be a JSON object.’ | Not implemented |
| E107 | ‘The value of the manifest key must be a JSON object, and each key MUST correspond to a digest value key found in one or more state blocks of the current and/or previous version blocks of the OCFL Object.’ | Missing description [ocfl/inventory_validator.py#L405] |
| E108 | ‘The contentDirectory value MUST represent a direct child directory of the version directory in which it is found.’ | Not implemented |
| E110 | ‘A unique identifier for the OCFL Object MUST NOT change between versions of the same object.’ | Not implemented |
| E111 | ‘If present, [the value of the fixity key] MUST be a JSON object, which may be empty.’ | OCFL Object %s inventory includes a fixity key with value that isn’t a JSON object [Not implemented] |
| E112 | ‘The extensions directory must not contain any files or sub-directories other than extension sub-directories.’ | Not implemented |
| E999 | Not in specification | Missing description [ocfl/inventory_validator.py#L86] |
| Code | Specification text (or suffixed code) | Implementation status and message/links |
|---|---|---|
| W001 | ‘Implementations SHOULD use version directory names constructed without zero-padding the version number, ie. v1, v2, v3, etc.’’ | OCFL Object %s inventory version numbers SHOULD NOT be zero-padded [ocfl/inventory_validator.py#L275] |
| W002 | ‘The version directory SHOULD NOT contain any directories other than the designated content sub-directory. Once created, the contents of a version directory are expected to be immutable.’ | OCFL Object version directory %s SHOULD NOT contain any directory except the designated content directory (found %s) [ocfl/validator.py#L355] |
| W003 | ‘Version directories must contain a designated content sub-directory if the version contains files to be preserved, and SHOULD NOT contain this sub-directory otherwise.’ | OCFL Object version directory %s SHOULD NOT contain an empty content directory [ocfl/validator.py#L353] |
| W004 | ‘For content-addressing, OCFL Objects SHOULD use sha512.’ | OCFL Object %s inventory SHOULD use sha512 but uses sha256 as the DigestAlgorithm [ocfl/inventory_validator.py#L104] |
| W005 | ‘The OCFL Object Inventory id SHOULD be a URI.’ | OCFL Object %s inventory id SHOULD be a URI (got %s) [ocfl/inventory_validator.py#L79] |
| W007 | ‘In the OCFL Object Inventory, the JSON object describing an OCFL Version, SHOULD include the message and user keys.’ | See multiple cases identified with suffixes below |
| W007a | OCFL Object %s inventory %s version block SHOULD include a message key [ocfl/inventory_validator.py#L328] | |
| W007b | OCFL Object %s inventory %s version block SHOULD include a user key [ocfl/inventory_validator.py#L332] | |
| W008 | ‘In the OCFL Object Inventory, in the version block, the value of the user key SHOULD contain an address key, address.’ | OCFL Object %s inventory %s version block user description SHOULD have an address [ocfl/inventory_validator.py#L341] |
| W009 | ‘In the OCFL Object Inventory, in the version block, the address value SHOULD be a URI: either a mailto URI [RFC6068] with the e-mail address of the user or a URL to a personal identifier, e.g., an ORCID iD.’ | OCFL Object %s inventory %s version block user description SHOULD be a mailto: or person identifier URI [ocfl/inventory_validator.py#L345] |
| W010 | ‘In addition to the inventory in the OCFL Object Root, every version directory SHOULD include an inventory file that is an Inventory of all content for versions up to and including that particular version.’ | OCFL Object %s SHOULD have an inventory file but does not [ocfl/validator.py#L253] |
| W011 | ‘In the case that prior version directories include an inventory file, the values of the created, message and user keys in each version block in each prior inventory file SHOULD have the same values as the corresponding keys in the corresponding version block in the current inventory file.’ | OCFL Object version metadata ‘%s’ for %s in %s inventory does not match that in %s inventory [ocfl/inventory_validator.py#L507] |
| W012 | ‘Implementers SHOULD use the logs directory, if present, for storing files that contain a record of actions taken on the object.’ | Not implemented |
| W013 | ‘In an OCFL Object, extension sub-directories SHOULD be named according to a registered extension name.’ | OCFL Object includes unregistered extension directory ‘%s’ [ocfl/validator.py#L230] |
| W014 | ‘Storage hierarchies within the same OCFL Storage Root SHOULD use just one layout pattern.’ | Not implemented |
| W015 | ‘Storage hierarchies within the same OCFL Storage Root SHOULD consistently use either a directory hierarchy of OCFL Objects or top-level OCFL Objects.’ | Not implemented |
| W016 | ‘In the Storage Root, extension sub-directories SHOULD be named according to a registered extension name.’ | Not implemented |
| W901 | Not in specification | OCFL Storage Root includes unregistered extension directory ‘%s’ [ocfl/store.py#L193] |
Generated by extract_codes.py at 2023-03-08 13:06:00.465419