Azure / Azure/azure-openapi-validator

Warnings "DescriptionAndTitleMissing" and "ParameterDescriptionRequired" should be errors

Open
#140 2 comments 0 reactions 0 assignees View on GitHub
documentation planned Sprint-113
Dominant language
TypeScript
Stars
53
Forks
57
Avg merge
1d 23h
Merged PRs (30d)
2

Description

Porting issue from https://github.com/Azure/autorest/issues/2794

Currently these two are presented as warnings while `DescriptionMustNotBeNodeName` is an error.
IMHO, missing description must be treated as error for better documentation of generated swagger.

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.