-
Notifications
You must be signed in to change notification settings - Fork 21
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
Added description for parameters #127
Added description for parameters #127
Conversation
16e693f
to
2511302
Compare
eva-server/src/main/java/uk/ac/ebi/eva/server/ws/RegionWSServerV2.java
Outdated
Show resolved
Hide resolved
eva-server/src/main/java/uk/ac/ebi/eva/server/ws/RegionWSServerV2.java
Outdated
Show resolved
Hide resolved
Co-Authored-By: jmmut <jomutlo@gmail.com>
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I personally find the Swagger annotations more clearly if they are not interleaved with the parameter declarations. You can put them at the top, but I think you may also need to annotate the method; this is not necessarily bad, as adding a description of its purpose is useful.
eva-server/src/main/java/uk/ac/ebi/eva/server/ws/GeneWSServerV2.java
Outdated
Show resolved
Hide resolved
"/v1/meta/species/list/ in the field named 'assemblyCode'.", required = true) | ||
@RequestParam(name = "assembly") String assembly, | ||
@ApiParam(value = "The number of the page that shoulde be displayed. Starts from 0 and is an integer." + | ||
" e.g. 0") |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
No need to add this last part because it will be displayed as default value.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Fixed :)
eva-server/src/main/java/uk/ac/ebi/eva/server/ws/GeneWSServerV2.java
Outdated
Show resolved
Hide resolved
eva-server/src/main/java/uk/ac/ebi/eva/server/ws/RegionWSServerV2.java
Outdated
Show resolved
Hide resolved
@ApiParam(value = "Retrieve only variants with exactly this consequence type (as stated by Ensembl VEP)") | ||
@RequestParam(name = "annot-ct", required = false) List<String> | ||
consequenceType, | ||
@ApiParam(value = "Retrieve only variants with exactly this Minor Allele Frequency") |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Exactly? But we accept ranges using some special characters, don't we?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
oh, right, I saw public VariantRepositoryMafFilter(String maf) { super("st.maf", maf); }
and assumed that was the mongo document. It's true that we have VariantRepositoryDoubleFilter which allows <, >, =, <=, >=.
Co-Authored-By: Cristina Yenyxe Gonzalez Garcia <cyenyxe@ebi.ac.uk>
@ApiParam(value = "Retrieve only variants with exactly this consequence type (as stated by Ensembl VEP)") | ||
@RequestParam(name = "annot-ct", required = false) List<String> | ||
consequenceType, | ||
@ApiParam(value = "Retrieve only variants with exactly this Minor Allele Frequency") |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
ok, junaid, can you change the descriptions for maf, polyphen and sift to explain the relational operators that you can use, for instance "<=0.05"
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Changed :)
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Not critical, but I think these suggestions would make some descriptions quicker/easier to read.
eva-server/src/main/java/uk/ac/ebi/eva/server/ws/RegionWSServerV2.java
Outdated
Show resolved
Hide resolved
eva-server/src/main/java/uk/ac/ebi/eva/server/ws/RegionWSServerV2.java
Outdated
Show resolved
Hide resolved
eva-server/src/main/java/uk/ac/ebi/eva/server/ws/RegionWSServerV2.java
Outdated
Show resolved
Hide resolved
eva-server/src/main/java/uk/ac/ebi/eva/server/ws/VariantWSServerV2.java
Outdated
Show resolved
Hide resolved
eva-server/src/main/java/uk/ac/ebi/eva/server/ws/RegionWSServerV2.java
Outdated
Show resolved
Hide resolved
eva-server/src/main/java/uk/ac/ebi/eva/server/ws/RegionWSServerV2.java
Outdated
Show resolved
Hide resolved
eva-server/src/main/java/uk/ac/ebi/eva/server/ws/VariantWSServerV2.java
Outdated
Show resolved
Hide resolved
eva-server/src/main/java/uk/ac/ebi/eva/server/ws/VariantWSServerV2.java
Outdated
Show resolved
Hide resolved
eva-server/src/main/java/uk/ac/ebi/eva/server/ws/VariantWSServerV2.java
Outdated
Show resolved
Hide resolved
eva-server/src/main/java/uk/ac/ebi/eva/server/ws/RegionWSServerV2.java
Outdated
Show resolved
Hide resolved
Co-Authored-By: Cristina Yenyxe Gonzalez Garcia <cyenyxe@ebi.ac.uk>
@RequestParam(name = "annot-ct", required = false) List<String> | ||
consequenceType, | ||
@ApiParam(value = "Minor Allele Frequency. The value of Minor Allele Frequency with one of the " + | ||
"<, <=, =, >, >= symbols preceding it has to be provided. e.g. >=0.5") |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
hmm, I'm not sure of a good way to explain this concisely. What about
Retrieve only variants whose Minor Allele Frequency is less than (<), less than or equals (<=), greater than (>), greater than or equals (>=) or equals (=) the provided number. e.g. <0.1
applies to polyphen and sift too
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Changed :)
The purpose of this PR is to add parameter description for parameters in the V2 APIs