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

SNP Rest API - API endpoint to get one Single Nucleotide Polymorphism data #59

Open
sprintell opened this issue Sep 19, 2024 · 0 comments

Comments

@sprintell
Copy link
Member

sprintell commented Sep 19, 2024

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

{
  "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"
	}
  }
}

Management Rules

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

Acceptance Criteria

  • Given a correct rsId
  • When an API user sends a GET request to the endpoint
  • A single corresponding single-nucleotide-polymorphisms data is returned in JSON Format
  • Given a wrong rsId
  • 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

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

1 participant