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

Update dataset schema #848

Closed
jameshadfield opened this issue Feb 14, 2022 · 1 comment · Fixed by #851
Closed

Update dataset schema #848

jameshadfield opened this issue Feb 14, 2022 · 1 comment · Fixed by #851
Labels
good first issue A relatively isolated issue appropriate for first-time contributors

Comments

@jameshadfield
Copy link
Member

As part of the multi-tree / exploded-tree functionality introduced in nextstrain/auspice#1442 the next auspice release will allow an array of trees and the schema needs to be updated accordingly.

Current schema (abridged):

"tree": {
    "type" : "object",
    "$comment": "The phylogeny in a nested JSON structure",
    "properties": {
        "children": {
            "type": "array",
            "minItems": 1,
            "items": {"$ref": "#/properties/tree"}
        }
    }
}

The new schema is similar, except that the tree property can now be an object (as currently) or an array of objects. In the latter, each object is the same as the current "$ref": "#/properties/tree".

It is fully backwards compatible and doesn't need a version bump.

An example dataset is included (which currently fails validation)

tree-array-example.json.gz

@tsibley
Copy link
Member

tsibley commented Feb 14, 2022

I was already looking at the schemas this morning when I saw this issue, so I drafted a change for this in #851.

Repository owner moved this from New to Done in Nextstrain planning (archived) Feb 14, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
good first issue A relatively isolated issue appropriate for first-time contributors
Projects
No open projects
Development

Successfully merging a pull request may close this issue.

2 participants