Swagger-ui does not hide readOnly nested object from example body
I'm developing spring-boot app with swagger-ui and lombok. Currently I'm trying to hide nested object from request body, but it still shows in example json on swagger-ui page.
I have my class with annotations(simplified to only related stuff):
@Data
@ApiModel(description = "Character model")
public class Character {
@ApiModelProperty(readOnly = true)
private Long id;
@ApiModelProperty(readOnly = true)
private SearchAnnouncement searchAnnouncement;
}
Note: @Data is Lombok annotation that generates getters, setters and few other things
When I access example model on swagger page "id" filed is properly hidden in example json, and visible in response model.
But "searchAnnouncement" is not hidden in example json.
I tried:
- using readOnly = true
- using accessMode = ApiModelProperty.AccessMode.READ_ONLY
- using @Setter(AccessLevel.NONE), which prevents generation of setter for that field, as I read somewhere that something is checking if setter exist and sets readOnly based on that
- different combinations of above
but in all cases example json looks like this (id hidden, and searchAnnouncement visible):
{
"searchAnnouncement": {
"id": 0,
},
}
So in short my question is:
Is it possible to hide from example json nested object?
EDIT:
Forgot to mention I currently have swagger2 & swagger-ui with version 2.9.2 in my dependencies, but I moved up from 2.8.0 hoping to hide this nested object
java swagger-ui swagger-2.0
asked Nov 24 '18 at 1:13
ShirruShirru
13
add a comment |
I'm developing spring-boot app with swagger-ui and lombok. Currently I'm trying to hide nested object from request body, but it still shows in example json on swagger-ui page.
I have my class with annotations(simplified to only related stuff):
@Data
@ApiModel(description = "Character model")
public class Character {
@ApiModelProperty(readOnly = true)
private Long id;
@ApiModelProperty(readOnly = true)
private SearchAnnouncement searchAnnouncement;
}
Note: @Data is Lombok annotation that generates getters, setters and few other things
When I access example model on swagger page "id" filed is properly hidden in example json, and visible in response model.
But "searchAnnouncement" is not hidden in example json.
I tried:
- using readOnly = true
- using accessMode = ApiModelProperty.AccessMode.READ_ONLY
- using @Setter(AccessLevel.NONE), which prevents generation of setter for that field, as I read somewhere that something is checking if setter exist and sets readOnly based on that
- different combinations of above
but in all cases example json looks like this (id hidden, and searchAnnouncement visible):
{
"searchAnnouncement": {
"id": 0,
},
}
So in short my question is:
Is it possible to hide from example json nested object?
EDIT:
Forgot to mention I currently have swagger2 & swagger-ui with version 2.9.2 in my dependencies, but I moved up from 2.8.0 hoping to hide this nested object
java swagger-ui swagger-2.0
asked Nov 24 '18 at 1:13
ShirruShirru
13
add a comment |
I'm developing spring-boot app with swagger-ui and lombok. Currently I'm trying to hide nested object from request body, but it still shows in example json on swagger-ui page.
I have my class with annotations(simplified to only related stuff):
@Data
@ApiModel(description = "Character model")
public class Character {
@ApiModelProperty(readOnly = true)
private Long id;
@ApiModelProperty(readOnly = true)
private SearchAnnouncement searchAnnouncement;
}
Note: @Data is Lombok annotation that generates getters, setters and few other things
When I access example model on swagger page "id" filed is properly hidden in example json, and visible in response model.
But "searchAnnouncement" is not hidden in example json.
I tried:
- using readOnly = true
- using accessMode = ApiModelProperty.AccessMode.READ_ONLY
- using @Setter(AccessLevel.NONE), which prevents generation of setter for that field, as I read somewhere that something is checking if setter exist and sets readOnly based on that
- different combinations of above
but in all cases example json looks like this (id hidden, and searchAnnouncement visible):
{
"searchAnnouncement": {
"id": 0,
},
}
So in short my question is:
Is it possible to hide from example json nested object?
EDIT:
Forgot to mention I currently have swagger2 & swagger-ui with version 2.9.2 in my dependencies, but I moved up from 2.8.0 hoping to hide this nested object
java swagger-ui swagger-2.0
asked Nov 24 '18 at 1:13
ShirruShirru
13
I'm developing spring-boot app with swagger-ui and lombok. Currently I'm trying to hide nested object from request body, but it still shows in example json on swagger-ui page.
I have my class with annotations(simplified to only related stuff):
@Data
@ApiModel(description = "Character model")
public class Character {
@ApiModelProperty(readOnly = true)
private Long id;
@ApiModelProperty(readOnly = true)
private SearchAnnouncement searchAnnouncement;
}
Note: @Data is Lombok annotation that generates getters, setters and few other things
When I access example model on swagger page "id" filed is properly hidden in example json, and visible in response model.
But "searchAnnouncement" is not hidden in example json.
I tried:
- using readOnly = true
- using accessMode = ApiModelProperty.AccessMode.READ_ONLY
- using @Setter(AccessLevel.NONE), which prevents generation of setter for that field, as I read somewhere that something is checking if setter exist and sets readOnly based on that
- different combinations of above
but in all cases example json looks like this (id hidden, and searchAnnouncement visible):
{
"searchAnnouncement": {
"id": 0,
},
}
So in short my question is:
Is it possible to hide from example json nested object?
EDIT:
Forgot to mention I currently have swagger2 & swagger-ui with version 2.9.2 in my dependencies, but I moved up from 2.8.0 hoping to hide this nested object
java swagger-ui swagger-2.0
java swagger-ui swagger-2.0
asked Nov 24 '18 at 1:13
ShirruShirru
13
asked Nov 24 '18 at 1:13
ShirruShirru
13
edited Nov 24 '18 at 1:18
Shirru
asked Nov 24 '18 at 1:13
ShirruShirru
13
asked Nov 24 '18 at 1:13
ShirruShirru
13
asked Nov 24 '18 at 1:13
ShirruShirru
13
13
add a comment |
add a comment |
0
active
oldest
votes
Your Answer
StackExchange.ifUsing("editor", function () {
StackExchange.using("externalEditor", function () {
StackExchange.using("snippets", function () {
StackExchange.snippets.init();
});
});
}, "code-snippets");
StackExchange.ready(function() {
var channelOptions = {
tags: "".split(" "),
id: "1"
};
initTagRenderer("".split(" "), "".split(" "), channelOptions);
StackExchange.using("externalEditor", function() {
// Have to fire editor after snippets, if snippets enabled
if (StackExchange.settings.snippets.snippetsEnabled) {
StackExchange.using("snippets", function() {
createEditor();
});
}
else {
createEditor();
}
});
function createEditor() {
StackExchange.prepareEditor({
heartbeatType: 'answer',
autoActivateHeartbeat: false,
convertImagesToLinks: true,
noModals: true,
showLowRepImageUploadWarning: true,
reputationToPostImages: 10,
bindNavPrevention: true,
postfix: "",
imageUploader: {
brandingHtml: "Powered by u003ca class="icon-imgur-white" href="https://imgur.com/"u003eu003c/au003e",
contentPolicyHtml: "User contributions licensed under u003ca href="https://creativecommons.org/licenses/by-sa/3.0/"u003ecc by-sa 3.0 with attribution requiredu003c/au003e u003ca href="https://stackoverflow.com/legal/content-policy"u003e(content policy)u003c/au003e",
allowUrls: true
},
onDemand: true,
discardSelector: ".discard-answer"
,immediatelyShowMarkdownHelp:true
});
}
});
Sign up or log in
StackExchange.ready(function () {
StackExchange.helpers.onClickDraftSave('#login-link');
});
Sign up using Google
Sign up using Facebook
Sign up using Email and Password
Post as a guest
Required, but never shown
StackExchange.ready(
function () {
StackExchange.openid.initPostLogin('.new-post-login', 'https%3a%2f%2fstackoverflow.com%2fquestions%2f53454357%2fswagger-ui-does-not-hide-readonly-nested-object-from-example-body%23new-answer', 'question_page');
}
);
Post as a guest
Required, but never shown
0
active
oldest
votes
0
active
oldest
votes
active
oldest
votes
active
oldest
votes
Thanks for contributing an answer to Stack Overflow!
- Please be sure to answer the question. Provide details and share your research!
But avoid …
- Asking for help, clarification, or responding to other answers.
- Making statements based on opinion; back them up with references or personal experience.
To learn more, see our tips on writing great answers.
Sign up or log in
StackExchange.ready(function () {
StackExchange.helpers.onClickDraftSave('#login-link');
});
Sign up using Google
Sign up using Facebook
Sign up using Email and Password
Post as a guest
Required, but never shown
StackExchange.ready(
function () {
StackExchange.openid.initPostLogin('.new-post-login', 'https%3a%2f%2fstackoverflow.com%2fquestions%2f53454357%2fswagger-ui-does-not-hide-readonly-nested-object-from-example-body%23new-answer', 'question_page');
}
);
Post as a guest
Required, but never shown
Sign up or log in
StackExchange.ready(function () {
StackExchange.helpers.onClickDraftSave('#login-link');
});
Sign up using Google
Sign up using Facebook
Sign up using Email and Password
Post as a guest
Required, but never shown
Sign up or log in
StackExchange.ready(function () {
StackExchange.helpers.onClickDraftSave('#login-link');
});
Sign up using Google
Sign up using Facebook
Sign up using Email and Password
Post as a guest
Required, but never shown
Sign up or log in
StackExchange.ready(function () {
StackExchange.helpers.onClickDraftSave('#login-link');
});
Sign up using Google
Sign up using Facebook
Sign up using Email and Password
Sign up using Google
Sign up using Facebook
Sign up using Email and Password
Post as a guest
Required, but never shown
Required, but never shown
Required, but never shown
Required, but never shown
Required, but never shown
Required, but never shown
Required, but never shown
Required, but never shown
Required, but never shown
