Avoid generating documentation of an optional body parameters

[nnbai]

Scribe version

4.32.0

Your question

One of the APIs has a parameter (body parameter) in a form request that is only used for internal purposes. However, it is part of form validation and is an optional parameter. Scribe is used for generating the documentation for external parties.

How do I avoid generating documentation for this parameter?

Docs

• I've checked the docs, the troubleshooting guide, and existing issues, but I didn't find a solution

[shalvah]

Hmm, you don't want it to show at all in the docs? We could maybe add support for a hidden comment. But, in the meantime, your best bet would be to create a custom strategy. Make sure it runs last, and I think you should be able to unset the parameter from the ExtractedEndpointData object.