Docs: Documentation is misleading/incomplete for BodyAsFile #601

Closed
opened 2025-12-29 15:28:01 +01:00 by adam · 1 comment
Owner

Originally created by @dotnetprofessional on GitHub (May 21, 2024).

Originally assigned to: @StefH on GitHub.

Describe the bug

The sample code at:

https://github.com/WireMock-Net/WireMock.Net/wiki/Response-Templating#mapping-json-example-using-handlebarsnet

Is incomplete which leads to a very frustrating experience. Tried for an hour or two to get transformers working until I found the following issue:

https://github.com/WireMock-Net/WireMock.Net/issues/386

The docs need to be updated to include that we also need to have the following property for this to work (btw why introduce another property?):

"UseTransformerForBodyAsFile": true

I did notice (now I know what to look for), a reference at:

UseTransformerForBodyAsFile

However, that should be a little clearer too, as it doesn't call out its to be included in the response.json file.

Expected behavior:

Docs provide clear and working example, which they don't.

Originally created by @dotnetprofessional on GitHub (May 21, 2024). Originally assigned to: @StefH on GitHub. ### Describe the bug The sample code at: https://github.com/WireMock-Net/WireMock.Net/wiki/Response-Templating#mapping-json-example-using-handlebarsnet Is incomplete which leads to a very frustrating experience. Tried for an hour or two to get transformers working until I found the following issue: https://github.com/WireMock-Net/WireMock.Net/issues/386 The docs need to be updated to include that we also need to have the following property for this to work (btw why introduce another property?): "UseTransformerForBodyAsFile": true I did notice (now I know what to look for), a reference at: [UseTransformerForBodyAsFile](https://github.com/WireMock-Net/WireMock.Net/wiki/Response-Templating#transform-the-content-from-a-referenced-file) However, that should be a little clearer too, as it doesn't call out its to be included in the response.json file. ### Expected behavior: Docs provide clear and working example, which they don't.
adam added the doc label 2025-12-29 15:28:01 +01:00
adam closed this issue 2025-12-29 15:28:01 +01:00
Author
Owner

@StefH commented on GitHub (May 21, 2024):

documentation has been updated

@StefH commented on GitHub (May 21, 2024): documentation has been updated
Sign in to join this conversation.
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: starred/WireMock.Net-wiremock#601