Skip to content

Commit

Permalink
Update specification.md
Browse files Browse the repository at this point in the history
  • Loading branch information
theosanderson authored Feb 7, 2024
1 parent b64311f commit 2645289
Showing 1 changed file with 9 additions and 3 deletions.
12 changes: 9 additions & 3 deletions preprocessing/specification.md
Original file line number Diff line number Diff line change
Expand Up @@ -104,17 +104,23 @@ The `errors` and `warnings` fields contain an array of objects of the following

```js
{
source: {
source: [{
type: "Metadata" | "NucleotideSequence",
name: string
}[],
affected: {
type: "Metadata" | "NucleotideSequence",
name: string
}[],
message: string
}
```

The `source` field specifies the source of the error. It can be empty if the error is very general or if it is not possible to pinpoint a specific source. If the error is caused by the value in a metadata field, the `name` field should contain the name of a metadata field. If a nucleotide sequence caused the error, the `name` field should contain the (segment) name of the nucleotide sequence.
The `source` field(s) specifies the source of the error. It can be empty if the error is very general or if it is not possible to pinpoint a specific source. If the error is caused by the value in a metadata field, the `name` field should contain the name of a metadata field. If a nucleotide sequence caused the error, the `name` field should contain the (segment) name of the nucleotide sequence.

The `affected` field(s) work similarly but specify which fields in the processed output are affected by the error or warning.

The `message` should contain a human-readable message describing the error.
The `message` should contain a human-readable message describing the error. It may be useful to include the user input in this message.

#### Metadata

Expand Down

0 comments on commit 2645289

Please sign in to comment.