QID 570028

QID 570028: Invalid operationId Definition

Swagger files can define multiple operations on each end point. Operations include get, post, put, patch, delete, head, options, and trace. Operation uniqueness is defined based on a combination of path and the http method. operationId is not mandatory. When operationId is defined in the swagger definition, it should be unique across an operation. operationId is used by code generators to refer to the operation and links refer to linked operations. Given these two use cases it is important that the operationId follows the rules of characters in url. Based on analysis of the swagger file it has been determined that the operationId is not valid to be used in an URL.

The operationId defined in the swagger file can result in invalid code if code generators are used. And links cannot use the operationId to reference the operation.

Solution

Please fix the operationId so it has valid characters and can be part of a URL. For example:

/accounts/savings: get: operationId: getExistingUsers summary: Gets all users who have savings accounts ... post: operationId: addNewUser summary: Adds a new user who will have a savings account ...

Vendor References

CVEs related to QID 570028

Software Advisories

Advisory ID	Software	Component	Link

By selecting these links, you may be leaving CVEreport webspace. We have provided these links to other websites because they may have information that would be of interest to you. No inferences should be drawn on account of other sites being referenced, or not, from this page. There may be other websites that are more appropriate for your purpose. CVEreport does not necessarily endorse the views expressed, or concur with the facts presented on these sites. Further, CVEreport does not endorse any commercial products that may be mentioned on these sites. Please address comments about any linked pages to [email protected].