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

Efo Traits Rest API - API endpoint to get one Efo Trait data #61

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

Efo Traits Rest API - API endpoint to get one Efo Trait data #61

sprintell opened this issue Sep 20, 2024 · 0 comments

Comments

@sprintell
Copy link
Member

sprintell commented Sep 20, 2024

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

{
   "trait":"celiac disease",
   "uri":"http://www.ebi.ac.uk/efo/EFO_0001060",
   "shortForm":"MONDO_0016320",
   "_links":{
  	"self":{
     	"href":"http://localhost:8089/api/efo-traits/MONDO_0016320"
  	},
  	"search":{
     	"href":"{base_url}/v1/single-nucleotide-polymorphisms?fullPvalueSet"
  	}
   }
}
  • Management Rules
  • Rule 1: Endpoint - /v1/efo-traits/{rsId}
  • Rule 2: HTTP Request Method - GET
  • Rule 3: Endpoint should accept efoTraitId
  • Rule 4: Endpoint should return full attributes of the efo-traits
  • Rule 5: Endpoint should be accessible to all

Acceptance Criteria

  • Given a correct EfoTraitId
  • When the front end sends a GET request to the endpoint
  • A single corresponding efo-traits data is returned in JSON Format
  • Given a wrong efoTraitId
  • 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 SNP Rest API - API endpoint to get one Single Nucleotide Polymorphism data Efo Traits Rest API - API endpoint to get one Efo Trait data Sep 20, 2024
@sajo-ebi sajo-ebi self-assigned this Nov 19, 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