You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Path parameters (remote "accepts" arguments mapped with { http: { source: 'path' } } are optional by default. At the moment, Swagger does not support optional path parameters (see OAI/OpenAPI-Specification#93).
This constraint is not clear to novice users. When they create remote methods with path parameters and don't pay attention to the required flag, they will end up with invalid swagger that's difficult to troubleshoot.
I'd like loopback-swagger to print a helpful warning explaining the users what's wrong and how to fix it when an optional path parameter is encountered.
Another option is to change loopback-swagger to always mark path parameters as required. However, I think it may close our future options for re-introducing optional path parameters again, which is something that was already requested by LoopBack users.
The text was updated successfully, but these errors were encountered:
This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions.
This issue has been closed due to continued inactivity. Thank you for your understanding. If you believe this to be in error, please contact one of the code owners, listed in the CODEOWNERS file at the top-level of this repository.
Path parameters (remote "accepts" arguments mapped with
{ http: { source: 'path' } }
are optional by default. At the moment, Swagger does not support optional path parameters (see OAI/OpenAPI-Specification#93).This constraint is not clear to novice users. When they create remote methods with path parameters and don't pay attention to the required flag, they will end up with invalid swagger that's difficult to troubleshoot.
I'd like loopback-swagger to print a helpful warning explaining the users what's wrong and how to fix it when an optional path parameter is encountered.
Another option is to change loopback-swagger to always mark path parameters as required. However, I think it may close our future options for re-introducing optional path parameters again, which is something that was already requested by LoopBack users.
The text was updated successfully, but these errors were encountered: