Skip to content

Ignore ApiParam. #167

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

Closed
wants to merge 1 commit into from
+12 −2
Closed

Ignore ApiParam. #167

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions modules/swagger-annotations/src/main/java/com/wordnik/swagger/annotations/ApiParam.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,9 @@
@Target(ElementType.PARAMETER)
@Retention(RetentionPolicy.RUNTIME)
public @interface ApiParam {
/** Ignores parameter in documentation. */
boolean ignore() default false;

/** Name of the parameter */
String name() default "";

Expand Down
5 changes: 4 additions & 1 deletion modules/swagger-jaxrs/src/main/scala/com/wordnik/swagger/jaxrs/JaxrsApiReader.scala
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -85,7 +85,10 @@ class JaxrsApiSpecParser(val _hostClass: Class[_], _apiVersion: String, _swagger
var ignoreParam = false
for (pa <- paramAnnotations) {
pa match {
case apiParam: ApiParam => parseApiParam(docParam, apiParam, method)
case apiParam: ApiParam => {
ignoreParam = apiParam.ignore()
parseApiParam(docParam, apiParam, method)
}
case wsParam: QueryParam => {
docParam.name = readString(wsParam.value, docParam.name)
docParam.paramType = readString(TYPE_QUERY, docParam.paramType)
Expand Down
1 change: 1 addition & 0 deletions modules/swagger-jersey-jaxrs/src/main/scala/com/wordnik/swagger/jersey/JerseyApiReader.scala
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -90,6 +90,7 @@ class JerseyApiSpecParser(val _hostClass: Class[_], _apiVersion: String, _swagge
for (pa <- paramAnnotations) {
pa match {
case param: ApiParam => {
ignoreParam = param.ignore()
parseApiParam(docParam, param, method)
}
case param: QueryParam => {
Expand Down
5 changes: 4 additions & 1 deletion modules/swagger-play2/app/play/modules/swagger/PlayApiReader.scala
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -178,7 +178,10 @@ private class PlayApiSpecParser(_hostClass: Class[_], _apiVersion: String, _swag
var ignoreParam = false
for (pa <- paramAnnotations) {
pa match {
case apiParam: ApiParam => parseApiParam(docParam, apiParam, method)
case apiParam: ApiParam => {
ignoreParam = apiParam.ignore()
parseApiParam(docParam, apiParam, method)
}
case wsParam: QueryParam => {
docParam.name = readString(wsParam.value, docParam.name)
docParam.paramType = readString(TYPE_QUERY, docParam.paramType)
Expand Down