ePages-de / ePages-de/restdocs-api-spec

ResourceSnippet does not support PayloadSubsectionExtractor

Open
#229 1 comment 0 reactions 0 assignees View on GitHub
bug
Dominant language
Kotlin
Stars
427
Forks
116
Avg merge
23h 54m
Merged PRs (30d)
1

Description

Hello,

When migrating from vanilla Spring REST Doc to this plugin, we encountered a problem with PayloadSubsectionExtractor.
It is not used at all.
Here is our exemple:

```
document("example",
RequestDocumentation.pathParameters(
DocumentationHelper.tokenIdPathParameterDescriptor()
),
PayloadDocumentation.requestFields(
DocumentationHelper.keyAttributesFieldDescriptor()
),
PayloadDocumentation.relaxedResponseFields(
PayloadDocumentation.beneathPath("[]"),
DocumentationHelper.keyTypeFieldDescriptor(),
DocumentationHelper.keyIdFieldDescriptor(),
DocumentationHelper.keySizeFieldDescriptor("size"),
DocumentationHelper.curveOIDFieldDescriptor().type(String.class).optional(),
DocumentationHelper.publicKeyFieldDescriptor(),
DocumentationHelper.privateKeyFieldDescriptor()
),
PayloadDocumentation.responseFields(
PayloadDocumentation.beneathPath("[].privateKey"),
DocumentationHelper.keyUsagesFieldDescriptor(),
DocumentationHelper.keyAttributesFieldDescriptor()
),
PayloadDocumentation.responseFields(
PayloadDocumentation.beneathPath("[].publicKey"),
DocumentationHelper.rsaPublicKeyDetailsFieldDescriptors()
)
)
```
The `PayloadDocumentation.beneathPath("[]")` is not used at all, which result in multiple errors with fields not found.
We have seen in the documentation that it would be possible to use `subsectionWithPath` or `fieldWithPath` but since `MockMvcRestDocumentationWrapper` is described to be a drop-in replacement, we do not want to go this route.

Contributor guide

No contributing guide indexed for this repository

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.