opentargets / issues

Issue tracker for Open Targets Platform and Open Targets Genetics Portal
https://platform.opentargets.org https://genetics.opentargets.org
Apache License 2.0
12 stars 2 forks source link

In the Platform documenation graphql examples are not consistent with the provided playground links #3294

Closed DSuveges closed 2 months ago

DSuveges commented 2 months ago

The Platform documentation (link) contains numerous examples how to extract data from a number of graphql API endpoints. Besides the examples, there are direct links to the API playground area, so users can immediately experiment with the queries.

Unfortunately, in the tractability example there's a bug. This is the correct query on the UI:

query targetInfo {
  target(ensemblId: "ENSG00000169083") {
    id
    approvedSymbol
    biotype
    geneticConstraint{
      constraintType
      exp
      obs
      score
      oe
      oeLower
      oeUpper
    }
    tractability{
      label
      modality
      value
    }
  }
}

However the link to the playground has this query:

query targetInfo {
  target(ensemblId: "ENSG00000169083") {
    id
    approvedSymbol
    biotype
    geneticConstraint {
      constraintType
      exp
      obs
      score
      oe
      oeLower
      oeUpper
    }
    tractability {
      id
      modality
      value
    }
  }
}

This query is not correct, because tractability object has no id field, so the API throws a server error.

Expected behaviour

All query examples on the documentation should be correct and be consistent with the linked playground page.