-
Notifications
You must be signed in to change notification settings - Fork 25
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
c4bd306
commit 9203728
Showing
2 changed files
with
27 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
24 changes: 24 additions & 0 deletions
24
submit/samples/sample_checklist/sample_checklist_errors.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,24 @@ | ||
# Sample validation errors | ||
|
||
When you submit your samples and select to validate them against a checklist, you may get errors in your receipt based | ||
on the validation. As per January 2025, these errors are going to be deprecated, in favour of sample validation via the | ||
[BioSamples Database (BSD)](https://www.ebi.ac.uk/biosamples/). While the validation will be the same, error messages | ||
will differ between the previous XML schema validation and the new JSON schema validation. | ||
|
||
Below is a table, compiling the comparison of all the possible errors related to checklist validation: | ||
|
||
| **XML validation (old)** | **BioSamples validation (New)** | | ||
|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | ||
| Error at {<sample-name>}. Invalid units "{value-of-units}" for field "{<attribute-name>}". Allowed units are "{<list-of-allowed-values>}" | sample:{<sample-name>}; attribute:{<path-to-attribute>}; reason:must be equal to one of the allowed values:{list-of-allowed-values} | | ||
| Missing units for field "{<attribute-name>}". Allowed units are "{<list-of-allowed-values>}" | sample:{<sample-name>}; attribute:{<path-to-attribute>}; reason:must have required property 'unit' | | ||
| Error at {<sample-name>}. The length of field "{<attribute-name>}" value "{<value-provided>}" exceeds the maximum allowed length "{<maximum-length-of-field>}". | sample:{<sample-name>}; attribute:{<path-to-attribute>}; reason:must NOT have more than {<maximum-length-of-field>} characters | | ||
| Error at {<sample-name>}. The value "{<value-provided>}" for field "{<attribute-name>}" does not match regular expression "{<pattern>}" | sample:{<sample-name>}; attribute:{<path-to-attribute>}; reason:must match pattern {<pattern>} | | ||
| Missing mandatory field "{<property-name>}". | sample:{<sample-name>}; attribute:{<path-to-attribute>}; reason:must have required property {<property-name>} | | ||
| Missing recommended field "{<property-name>}". | **DEPRECATED**. Recommended field validation will no longer be supported. | | ||
| Error at {<sample-name>}. Field "{<property-name>}" may only occur once. | Just one of the following properties must be specified: {comma-separated-list-of-property-names} | | ||
| Error at {<sample-name>}. Invalid date "{<value-of-property>}" for field "{attribute-name}". | sample:{<sample-name>}; attribute:{<path-to-attribute>}; reason:must match format "date" OR sample:{<sample-name>}; attribute:{<path-to-attribute>}; reason:must match pattern {<pattern>} | | ||
| Error at {<sample-name>}. Invalid choice. The value "{<value-of-property>}" for field "{<attribute-name>}" must contain one of the following values "{<list-of-allowed-values>}" | sample:{<sample-name>}; attribute:{<path-to-attribute>}; reason:must be equal to one of the allowed values:{list-of-allowed-values} | | ||
| A symonym was used for field "{<property-name>}". Replacing value "{<synonym-property-name>}" with value "{<property-name>}" | **DEPRECATED**. Synonym validation and processing will no longer be supported. | | ||
|
||
|
||
Please note: The new sample validation service may catch more errors that do not have an equivalent on the old service. |