QID 570044

QID 570044: Parameter Description is Missing in Open API 3.0

In OpenAPI 3.0, parameters are defined in the parameters section of an operation or path. Parameters are defined using few properties: name, location, data type, description etc Descriptions for parameters are really important and help users in using the parameter as expected.

Missing description results in a warning. Not having description on the parameter does not give clarity on the parameter usage.

Solution

Review all your parameters and ensure there is a clear description added for each parameter. For example:

paths: /users/{id}: get: parameters: - in: path name: id # Note the name is the same as in the path required: true schema: type: integer minimum: 1 description: The user ID

Vendor References

CVEs related to QID 570044

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].