Skip to content

Commit 225e522

Browse files
committed
Support @JsonIgnore in @ParameterObject. Fixes #1375
1 parent 44eefd5 commit 225e522

File tree

3 files changed

+5
-10
lines changed

3 files changed

+5
-10
lines changed

springdoc-openapi-common/src/main/java/org/springdoc/core/SpringDocAnnotationsUtils.java

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -30,6 +30,7 @@
3030
import java.util.Map;
3131
import java.util.Optional;
3232

33+
import com.fasterxml.jackson.annotation.JsonIgnore;
3334
import com.fasterxml.jackson.annotation.JsonView;
3435
import io.swagger.v3.core.converter.AnnotatedType;
3536
import io.swagger.v3.core.converter.ModelConverters;
@@ -74,6 +75,7 @@ public class SpringDocAnnotationsUtils extends AnnotationsUtils {
7475

7576
static {
7677
ANNOTATIONS_TO_IGNORE.add(Hidden.class);
78+
ANNOTATIONS_TO_IGNORE.add(JsonIgnore.class);
7779
ANNOTATIONS_TO_IGNORE.add(RequestAttribute.class);
7880
}
7981

springdoc-openapi-webmvc-core/src/test/java/test/org/springdoc/api/app102/RequestParams.java

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,13 +4,15 @@
44
import java.util.List;
55
import java.util.Optional;
66

7+
import com.fasterxml.jackson.annotation.JsonIgnore;
78
import io.swagger.v3.oas.annotations.Parameter;
89

910
import org.springframework.lang.Nullable;
1011

1112
public class RequestParams {
1213

1314
@Parameter(description = "string parameter")
15+
@JsonIgnore
1416
private String stringParam;
1517

1618
@Deprecated

springdoc-openapi-webmvc-core/src/test/resources/results/app102.json

Lines changed: 1 addition & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -35,15 +35,6 @@
3535
"type": "string"
3636
}
3737
},
38-
{
39-
"name": "stringParam",
40-
"in": "query",
41-
"description": "string parameter",
42-
"required": false,
43-
"schema": {
44-
"type": "string"
45-
}
46-
},
4738
{
4839
"name": "stringParam1",
4940
"in": "query",
@@ -139,4 +130,4 @@
139130
}
140131
}
141132
}
142-
}
133+
}

0 commit comments

Comments
 (0)