Skip to content

Commit

Permalink
Improved docs
Browse files Browse the repository at this point in the history
  • Loading branch information
mattclarke committed Mar 8, 2022
1 parent 80b0f25 commit c153592
Showing 1 changed file with 54 additions and 0 deletions.
54 changes: 54 additions & 0 deletions README-DEV.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,3 +23,57 @@ Now it is possible to run queries against the system, for example:
}
```
Which will return a list of proposals for the instrument with the ID of 4.

# Updating the example data

The file `ymir_data_example.json` can be updated by running the following query and copying the data over:
```
query {
proposals(filter: { instrumentId: 4 }) {
totalCount
proposals {
primaryKey
title
proposalId
users {
firstname
lastname
organisation
}
proposer {
firstname
lastname
organisation
}
samples {
title
id
questionary {
steps {
fields {
value
dependencies {
dependencyNaturalKey
questionId
}
question {
question
naturalKey
}
}
}
}
}
}
}
}
```

The data has a leading `data` tag which needs to be removed along with the corresponding brackets.
```
{
"data": { <--- this needs removing
"proposals": {
"totalCount": 19,
"proposals": [
```

0 comments on commit c153592

Please sign in to comment.