rapi-doc / RapiDoc

RapiDoc -WebComponent for OpenAPI Spec
https://rapidocweb.com
MIT License
1.65k stars 277 forks source link

Array input examples ignore global fill-request-fields-with-example setting #1003

Open brunchboy opened 6 months ago

brunchboy commented 6 months ago

We have configured fill-request-fields-with-example="false", and this works for most of our properties. However, any that are type array still get the examples filled in. I noticed there was a similar fix already merged for the per-property x-fill-example setting, see #776; hopefully fixing this is as simple as adding the global check to the same place?

brunchboy commented 6 months ago

Actually, this is a deeper problem. Looking at the code for that fix it is already trying to honor the global setting. And in fact, even when we set x-fill-example to "no" on a specific array property, it still gets filled in. So the fix does not work at all. Here is an example of such a property that is getting filled in inappropriately Rapidoc for our spec:

          "areaOfInterestIds": {
            "description": "The `id`s of the Areas of Interest to which notifications based on this template should be sent",
            "example": [
              "8145ebd1-7a8b-11ee-bc97-098b09a637c2"
            ],
            "items": {
              "format": "uuid",
              "type": "string"
            },
            "type": "array",
            "uniqueItems": true,
            "x-fill-example": "no"
          },