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

Locus Rest API Endpoint to Get All Locus fora given association #64

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

Locus Rest API Endpoint to Get All Locus fora given association #64

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 loci of a given Locus 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 Association endpoint, but now a child object accessible from within the Association payload as a link on the URL

{
   "haplotypeSnpCount":null,
   "description":"Single variant",
   "strongestRiskAlleles":[
  	{
     	"riskAlleleName":"rs9497975-?",
     	"riskFrequency":null,
     	"genomeWide":null,
     	"limitedList":null
  	}
   ],
   "authorReportedGenes":[
  	{
     	"geneName":"intergenic",
     	"entrezGeneIds":[
       	 
     	],
     	"ensemblGeneIds":[
       	 
     	]
  	}
   ]
}

Management Rules

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

Acceptance Criteria:

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

@sprintell sprintell changed the title Associations Rest API Endpoint to Get All Associations Locus Rest API Endpoint to Get All Locus fora given association Sep 20, 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

1 participant