Using Spring RestDocs bracket notation for documenting array objects
I'm using spring restdocs to document my spring boot api with junit/webmvc and am running into an issue for documenting a certain portion of a request-body.
An example json request body:
{
"thisFieldHas.aDot": {
"a": "b"
}
...
"thisFieldHas.someDots.andAnArray" : [
"key" : "someValue"
]
...
}
Now, I have successfully been able to document the thisFieldHas.aDot object using Spring Rest Doc's bracket notation like this:
fieldWithPath("['thisFieldHas.aDot'].a").description("this is the letter a");
however, I have not had success with the thisFieldHas.someDots.andAnArray object. I've tried the below permutations and am out of ideas - does spring restdocs even support this?
fieldWithPath("['thisFieldHas.someDots.andAnArray'].key").description("this is a key");
fieldWithPath("['thisFieldHas.someDots.andAnArray']..key").description("this is a key");
fieldWithPath("['thisFieldHas.someDots.andAnArray'].key").description("this is a key");
fieldWithPath("['thisFieldHas.someDots.andAnArray'.].key").description("this is a key");
fieldWithPath("['thisFieldHas.someDots.andAnArray']['key']").description("this is a key");
spring-restdocs
asked Nov 13 '18 at 21:56
TonyRedYellowTonyRedYellow
61
add a comment |
I'm using spring restdocs to document my spring boot api with junit/webmvc and am running into an issue for documenting a certain portion of a request-body.
An example json request body:
{
"thisFieldHas.aDot": {
"a": "b"
}
...
"thisFieldHas.someDots.andAnArray" : [
"key" : "someValue"
]
...
}
Now, I have successfully been able to document the thisFieldHas.aDot object using Spring Rest Doc's bracket notation like this:
fieldWithPath("['thisFieldHas.aDot'].a").description("this is the letter a");
however, I have not had success with the thisFieldHas.someDots.andAnArray object. I've tried the below permutations and am out of ideas - does spring restdocs even support this?
fieldWithPath("['thisFieldHas.someDots.andAnArray'].key").description("this is a key");
fieldWithPath("['thisFieldHas.someDots.andAnArray']..key").description("this is a key");
fieldWithPath("['thisFieldHas.someDots.andAnArray'].key").description("this is a key");
fieldWithPath("['thisFieldHas.someDots.andAnArray'.].key").description("this is a key");
fieldWithPath("['thisFieldHas.someDots.andAnArray']['key']").description("this is a key");
spring-restdocs
asked Nov 13 '18 at 21:56
TonyRedYellowTonyRedYellow
61
As far as I can tell['thisFieldHas.someDots.andAnArray']..keyworks correctly. Can you provide a minimal, complete, and verifiable example that shows that it does not?
– Andy Wilkinson
Nov 14 '18 at 21:09
add a comment |
I'm using spring restdocs to document my spring boot api with junit/webmvc and am running into an issue for documenting a certain portion of a request-body.
An example json request body:
{
"thisFieldHas.aDot": {
"a": "b"
}
...
"thisFieldHas.someDots.andAnArray" : [
"key" : "someValue"
]
...
}
Now, I have successfully been able to document the thisFieldHas.aDot object using Spring Rest Doc's bracket notation like this:
fieldWithPath("['thisFieldHas.aDot'].a").description("this is the letter a");
however, I have not had success with the thisFieldHas.someDots.andAnArray object. I've tried the below permutations and am out of ideas - does spring restdocs even support this?
fieldWithPath("['thisFieldHas.someDots.andAnArray'].key").description("this is a key");
fieldWithPath("['thisFieldHas.someDots.andAnArray']..key").description("this is a key");
fieldWithPath("['thisFieldHas.someDots.andAnArray'].key").description("this is a key");
fieldWithPath("['thisFieldHas.someDots.andAnArray'.].key").description("this is a key");
fieldWithPath("['thisFieldHas.someDots.andAnArray']['key']").description("this is a key");
spring-restdocs
asked Nov 13 '18 at 21:56
TonyRedYellowTonyRedYellow
61
I'm using spring restdocs to document my spring boot api with junit/webmvc and am running into an issue for documenting a certain portion of a request-body.
An example json request body:
{
"thisFieldHas.aDot": {
"a": "b"
}
...
"thisFieldHas.someDots.andAnArray" : [
"key" : "someValue"
]
...
}
Now, I have successfully been able to document the thisFieldHas.aDot object using Spring Rest Doc's bracket notation like this:
fieldWithPath("['thisFieldHas.aDot'].a").description("this is the letter a");
however, I have not had success with the thisFieldHas.someDots.andAnArray object. I've tried the below permutations and am out of ideas - does spring restdocs even support this?
fieldWithPath("['thisFieldHas.someDots.andAnArray'].key").description("this is a key");
fieldWithPath("['thisFieldHas.someDots.andAnArray']..key").description("this is a key");
fieldWithPath("['thisFieldHas.someDots.andAnArray'].key").description("this is a key");
fieldWithPath("['thisFieldHas.someDots.andAnArray'.].key").description("this is a key");
fieldWithPath("['thisFieldHas.someDots.andAnArray']['key']").description("this is a key");
spring-restdocs
spring-restdocs
asked Nov 13 '18 at 21:56
TonyRedYellowTonyRedYellow
61
asked Nov 13 '18 at 21:56
TonyRedYellowTonyRedYellow
61
asked Nov 13 '18 at 21:56
TonyRedYellowTonyRedYellow
61
asked Nov 13 '18 at 21:56
TonyRedYellowTonyRedYellow
61
asked Nov 13 '18 at 21:56
TonyRedYellowTonyRedYellow
61
61
As far as I can tell['thisFieldHas.someDots.andAnArray']..keyworks correctly. Can you provide a minimal, complete, and verifiable example that shows that it does not?
– Andy Wilkinson
Nov 14 '18 at 21:09
add a comment |
As far as I can tell['thisFieldHas.someDots.andAnArray']..keyworks correctly. Can you provide a minimal, complete, and verifiable example that shows that it does not?
– Andy Wilkinson
Nov 14 '18 at 21:09
As far as I can tell
['thisFieldHas.someDots.andAnArray']..key works correctly. Can you provide a minimal, complete, and verifiable example that shows that it does not?– Andy Wilkinson
Nov 14 '18 at 21:09
As far as I can tell
['thisFieldHas.someDots.andAnArray']..key works correctly. Can you provide a minimal, complete, and verifiable example that shows that it does not?– Andy Wilkinson
Nov 14 '18 at 21:09
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%2f53290120%2fusing-spring-restdocs-bracket-notation-for-documenting-array-objects%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%2f53290120%2fusing-spring-restdocs-bracket-notation-for-documenting-array-objects%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
As far as I can tell
['thisFieldHas.someDots.andAnArray']..keyworks correctly. Can you provide a minimal, complete, and verifiable example that shows that it does not?– Andy Wilkinson
Nov 14 '18 at 21:09