In Document list customer files endpoint we added details about our new customer file endpoint which includes an optional path parameter. Hapi is fine with this and in our opinion, it looks much cleaner. However, Swagger doesn't support optional path parameters
In OpenAPI, a path parameter is defined using in: path. The parameter name must be the same as specified in the path. Also remember to add required: true, because path parameters are always required.
So, required: false is an invalid attribute for a path param in Swagger and SwaggerHub highlights it as an error. The only workaround is to drop the required and document the fact it's optional ☹️
In Document list customer files endpoint we added details about our new customer file endpoint which includes an optional path parameter. Hapi is fine with this and in our opinion, it looks much cleaner. However, Swagger doesn't support optional path parameters
So,
required: falseis an invalid attribute for a path param in Swagger and SwaggerHub highlights it as an error. The only workaround is to drop the required and document the fact it's optional ☹️