mirror of
https://github.com/zulip/zulip.git
synced 2025-11-04 22:13:26 +00:00
Previously, our OpenAPI documentation validation was failing for some endpoints because it didn't account for the `in: path` type of parameter, resulting in a mismatch between what was declared via REQ and what was declared in the OpenAPI docs. We fix this by excluding the path type parameters in both places from what's considered by documentation using the `path_only` flag. I doubt this is the correct long-term fix; in particular, I don't think we're actually running the validators for these path-only parameters. The examples that exist today are all IDs with validators for being non-negative numbers, but longer-term I think we'll want to do something different (possibly at the REQ layer, see the TODO).
5.0 KiB
5.0 KiB