Implement cluster app schema requirement 5 - "Properties should have descriptions" #16
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
What does this PR do?
This PR adds a new rule to the
cluster-apprule set, which checks whether all properties have a title. The requirement for this rule is defined in this RFC.In addition:
verifycommandWhat is the effect of this change to users?
The command will check if every property has a description. If not the property will be printed out.
The verification will not fail, as this rule is not a requirement (MUST), but only a recommendation (SHOULD).
How does it look like?
Any background context you can provide?
What is needed from the reviewers?
You can test these changes, with the following command.
Do the docs/README need to be updated?
No.
Should this change be mentioned in the release notes?