Skip to content

Add OpenAPI /swagger-ui/index.html and /api-docs#582

Merged
julesjacobsen merged 2 commits intodevelopmentfrom
rest-prioritiser-open-api
Dec 19, 2024
Merged

Add OpenAPI /swagger-ui/index.html and /api-docs#582
julesjacobsen merged 2 commits intodevelopmentfrom
rest-prioritiser-open-api

Conversation

@julesjacobsen
Copy link
Copy Markdown
Contributor

Adds much-needed OpenAPI documentation on how to interface with the Exomiser prioritiser REST API.

Alter context path to `/exomiser-prioritiser`
Add `swagger-ui` and `api-docs` endpoints
Update PrioritiserController @RequestMapping to `api/v1` with two `prioritise` end points (GET and POST)
Extract new PrioritiserService from PrioritiserController for easier testing.
Update PrioritiserController endpoints from `/api/v1/prioritise` to `/api/v1/prioritise/gene`
Update PrioritiserService.prioritise() method to prioritiseGenes
Set `hiphive` as the default prioritiser and set requirement to not required.
Add a README.md
@julesjacobsen julesjacobsen merged commit d8b8eff into development Dec 19, 2024
@julesjacobsen julesjacobsen deleted the rest-prioritiser-open-api branch December 19, 2024 17:59
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant