Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

TagAllOperationsRule #1010

Closed
roxspring opened this issue Jun 25, 2019 · 0 comments · Fixed by #1013 or #1014
Closed

TagAllOperationsRule #1010

roxspring opened this issue Jun 25, 2019 · 0 comments · Fixed by #1013 or #1014

Comments

@roxspring
Copy link
Collaborator

In-house we're about to have a push on making sure APIs are properly tagged so that Swagger UI docs look good, and are neatly divided up using tags as headings. Consequently, I'm considering contributing a TagAllOperationsRule with checks for:

  • Operations have at least one tag
  • Tag names are Title Case (configurable like CaseChecker)
  • All tags appear in top level tags: section (defining heading order)
  • All tags have a description

I'm leaning towards a MUST severity in each case but am happy to be argued down. Also happy if folks want it disabled in the default configuration.

I'm hoping that this might be accepted into the ZallyRuleSet.
roxspring added a commit that referenced this issue Jun 26, 2019
@roxspring
feat(server): TagAllOperationsRule.checkOperationsAreTagged() #1010
dc4c188
roxspring added a commit that referenced this issue Jun 26, 2019
@roxspring
feat(server): TagAllOperationsRule.checkOperationTagsAreDefined() #1010
60b3037
roxspring added a commit that referenced this issue Jun 26, 2019
@roxspring
feat(server): TagAllOperationsRule.checkDefinedTagsAreDescribed() #1010
061389a
roxspring added a commit that referenced this issue Jun 26, 2019
@roxspring
feat(server): TagAllOperationsRule.checkDefinedTagsAreUsed() #1010
5605886
roxspring added a commit that referenced this issue Jun 26, 2019
@roxspring
feat(server): CaseCheckerRule.checkTagNames() #1010
f852b30
roxspring added a commit that referenced this issue Jun 26, 2019
@roxspring
docs(server): Documented TagAllOperationsRule #1010
1621892
@roxspring roxspring mentioned this issue Jun 26, 2019
Merged
roxspring added a commit that referenced this issue Jun 26, 2019
@roxspring
test(server): no_must_violations.yaml passes new rules #1010
1c4bc3c
zeitlinger added a commit that referenced this issue Jun 27, 2019
@zeitlinger
Merge pull request #1013 from zalando/feature/gh-1010-tag-checks
bfb0782 
Rules to check tags
roxspring added a commit that referenced this issue Jun 27, 2019
@roxspring
feat(server): TagAllOperationsRule disabled by default #1010
11f1040
@roxspring roxspring mentioned this issue Jun 27, 2019
Merged
tkrop added a commit that referenced this issue Jun 27, 2019
@tkrop
Merge pull request #1014 from zalando/feature/gh-1010-tag-checks-disa…
3c8d2b6 
…bled-by-default

feat(server): TagAllOperationsRule disabled by default
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
1 participant
@roxspring