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

Ancestries Rest API Endpoint to Get All Ancestries for a given gwas study #62

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

Comments

@sprintell
Copy link
Member

As developer I want an api endpoint such that that when I send a GET request to the URL, hateoas compliant, paginated list of all ancestries of a given study in the database is returned in JSON Format

This is a new endpoint, this is required to ensure scalability, it was previously embedded in the studies endpoint, but now a child object to the Studies data, and should still be accessible from within the study endpoint as a link on the URL

{
   "type":"initial",
   "numberOfIndividuals":4390,
   "ancestralGroups":[
  	{
     	"ancestralGroup":"European"
  	}
   ],
   "countryOfOrigin":[
 	 
   ],
   "countryOfRecruitment":[
  	{
     	"majorArea":"Europe",
     	"region":"Northern Europe",
     	"countryName":"U.K."
  	}
   ]
}

Management Rules

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

Acceptance Criteria

  • Given a correct ancestries, when the front end sends a GET request to the endpoint
  • List of corresponding ancestries data is returned in JSON Format
  • Given a wrong accessionId, 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