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

Studies Rest API Endpoint to Get One Study Detailed Data #55

Open
sprintell opened this issue Sep 19, 2024 · 1 comment
Open

Studies Rest API Endpoint to Get One Study Detailed Data #55

sprintell opened this issue Sep 19, 2024 · 1 comment

Comments

@sprintell
Copy link
Member

sprintell commented Sep 19, 2024

As developer I want a study details API endpoint such that when I send a GET request to the URL I can get full details of a single study in JSON Format

This will be a replacement to the old endpoint https://www.ebi.ac.uk/gwas/rest/api/studies

{
  "initialSampleSize": "...",  
  "replicationSampleSize": "2,698 European ancestry Bipolar disorder cases, 1,649 …",
  "gxe": false,
  "gxg": false,
  "snpCount": 1922309,
  "qualifier": null,
  "imputed": true,
  "pooled": false,
  "studyDesignComment": null,
  "accessionId": "GCST000854",
  "fullPvalueSet": false,
  "userRequested": false,
  "pubmedId": "20971583",
  "platforms": [{}],
  "diseaseTrait": "Suicide risk",
  "genotypingTechnologies": [{}],
  “efo_uri”: "EFO_0004229",
  “efoTrait”: "Dupuytren Contracture",
  "_links": {
	"self": {
  	"href": "{base_url}/v1/studies/GCST000841"
	},
	"ancestries": {
  	"href": "{base_url}/v1/studies/GCST000841/ancestries"
	},
	"search": {
  	"href": "{base_url}/v1/studies?pubmed_id"
	}
  }
}

Must Have Additional Payload Attributes - These are displayed on the catalog UI:

  • discovery_ancestry (country of recruitment): "4390 European (U.K.)"
  • Traits: ["mental or behavioural disorder", "attempted suicide"]
  • Platform [SNPs passing QC]: "Affymetrix [1922309] (imputed)"
  • Replication ancestry (country of recruitment): "1649 NR (NR), 2698 European (Germany)"
  • Full Summary Statistics: "NA"
  • Terms/Licence: "https://www.ebi.ac.uk/about/terms-of-use/"
  • backgroundEfoTraits: ["",""]

Management Rules

  • Rule 1: Endpoint - /v1/studies/{accessionId}
  • Rule 2: HTTP Request Method - GET
  • Rule 3: Endpoint should accept studies id
  • Rule 4: Endpoint should return full attributes of the studies
  • Rule 5: Endpoint should be accessible to all

Acceptance Criteria

  • Given a correct accession Id
  • When the front end sends a GET request to the endpoint
  • A single corresponding study is returned in JSON Format
  • Given a wrong study id
  • When a GET request is sent to the endpoint
  • Properly described Resource not found exception error should be returned as JSON payload

Additional details here

@sajo-ebi
Copy link
Contributor

Local Code changes completed

@sajo-ebi sajo-ebi self-assigned this Oct 30, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants