docusaurus-openapi-docs icon indicating copy to clipboard operation
docusaurus-openapi-docs copied to clipboard

Parameters that are defined as an array and read-only shouldn't be displayed in the body

Open JaimeOVasconcelos opened this issue 1 year ago • 0 comments

Describe the bug

The parameters that go in the body of endpoints should not be present if they are read-only. Currently, this is not true when the parameter is defined as type: array and readOnly: true.

Expected behavior

When the parameter is defined with type: array and readOnly: true should not be in the body.

Current behavior

The parameters defined as type: array and readOnly: true are in the body. For example: Screenshot 2024-04-20 at 16 27 18

The result is: image

Possible solution

In the endpoints, if a parameter is defined as an type: array and readOnly: true, they should not be in the body.

Steps to reproduce

  1. Define and endpoint with a parameter that goes in the body and is defined as type: array and readOnly: true Screenshot 2024-04-20 at 16 31 56

  2. Render the documentation with the plugin

  3. The parameter appears in the body.

Your Environment

Version used: Plugin version is 2.1.3 Environment name and version: Chrome 123.0.6312.124, node.js 20.12.2 Operating System and version: Mac

JaimeOVasconcelos avatar Apr 20 '24 15:04 JaimeOVasconcelos