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.

Sign up for GitHub

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

Jump to bottom

updated the swagger page's endpoints' names to more meaningful names #77

Merged
merged 3 commits into from
Jan 29, 2024
Merged

updated the swagger page's endpoints' names to more meaningful names #77

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
c2a130c
updated the endpoints's names to more meaningful names
waterflow80 Jan 22, 2024
470c68c
group the related endpoints together under the same section
waterflow80 Jan 23, 2024
eef729a
fixed a typo and grouped related endpoints together
waterflow80 Jan 29, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions src/main/java/uk/ac/ebi/eva/evaseqcol/controller/admin/AdminController.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@
import io.swagger.v3.oas.annotations.Parameter;
import io.swagger.v3.oas.annotations.responses.ApiResponse;
import io.swagger.v3.oas.annotations.responses.ApiResponses;
import io.swagger.v3.oas.annotations.tags.Tag;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.http.HttpStatus;
import org.springframework.http.ResponseEntity;
Expand All @@ -24,6 +25,7 @@

@RequestMapping("/admin")
@RestController
@Tag(name = "Admin endpoints")
public class AdminController {

private SeqColService seqColService;
Expand Down
2 changes: 2 additions & 0 deletions src/main/java/uk/ac/ebi/eva/evaseqcol/controller/seqcol/SeqColComparisonController.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@
import io.swagger.v3.oas.annotations.Parameter;
import io.swagger.v3.oas.annotations.responses.ApiResponse;
import io.swagger.v3.oas.annotations.responses.ApiResponses;
import io.swagger.v3.oas.annotations.tags.Tag;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.http.HttpStatus;
import org.springframework.http.ResponseEntity;
Expand All @@ -23,6 +24,7 @@

@RestController
@RequestMapping("/comparison")
@Tag(name = "Comparison endpoints")
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Technically, these are also under the seqcol specification so they should be called Seqcol as well.
I would actually prefer if they are in the same section.

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Technically, these are also under the seqcol specification so they should be called Seqcol as well. I would actually prefer if they are in the same section.

Yeah that makes sense, I've made the update in commit 470c68c. Now it looks like this:
Screenshot from 2024-01-23 16-14-30

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This looks good, my nitpicks:

  • I wonder if we can at least get the two comparison endpoints to sit next to each other in the same section?
  • There's a typo in the tag name, should be Seqcol!

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Done !
Thanks April

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Now it looks like this:
Screenshot from 2024-01-29 17-24-46

public class SeqColComparisonController {

private SeqColService seqColService;
Expand Down
2 changes: 2 additions & 0 deletions src/main/java/uk/ac/ebi/eva/evaseqcol/controller/seqcol/SeqColController.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@
import io.swagger.v3.oas.annotations.Parameter;
import io.swagger.v3.oas.annotations.responses.ApiResponse;
import io.swagger.v3.oas.annotations.responses.ApiResponses;
import io.swagger.v3.oas.annotations.tags.Tag;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.http.HttpStatus;
import org.springframework.http.ResponseEntity;
Expand All @@ -25,6 +26,7 @@

@RestController
@RequestMapping("/")
@Tag(name = "Secqol endpoint")
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
@Tag(name = "Secqol endpoint")
@Tag(name = "Secqol endpoints")

public class SeqColController {

private SeqColService seqColService;
Expand Down
Loading