QID 570027

QID 570027: Missing Component Description

Swagger specification suggests that all components should have a description. While descriptions are optional they are very important and helpful. Components hold reusable definitons related to schemas, parameters etc. Data in components are not useful unless they are referenced out of the component. In order to use the definitions as intended the descriptions are very important. Swagger file was analyzed and determined that component description was missing.

The purpose of the component is not clear to the API user.

Solution

Ensure that all components have clear descriptions.

components: schemas: AccountName: type: string description :

Vendor References

CVEs related to QID 570027

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