API Linting Tracker (Phase 2)

[JoelSpeed]

As a follow up to #11834

This issue tracks upcoming linters from KAL and their current status, so that we can track the new rules as they are implemented and get them enabled within CAPI.

For more detailed information and tracking, follow kubernetes-sigs/kube-api-linter#1

Rule	Description	Implemented	Enabled
nomaps	Maps of objects should not be allowed	True	False
enums	Enums are correctly tagged and use PascalCase	False	False
numericbounds	Numeric fields should have upper and lower bounds	False	False
optionalfields	Optional fields should have omitempty and usually be pointers	False	False
defaults	Default values should use the upstream default marker	False	False
markertypos	Checks for common typos in markers	False	False
nodurations	Durations should be avoided, instead use an integer with a unit in the name	False	False
references	Fields should use Ref(s) instead of Reference(s)	False	False
timestamps	Do not use Timestamp in field names, use only Time	False	False
nameformats	Common name fields (name/namespace) should use CEL format library to validate format	False	False
arrayofstruct	Arrays of structs must have at least one required field	False	False
duplicatemarkers	Checks for duplicate markers (eg enum twice on field and type)	False	False
typeandobjectmeta	Enforces consistent standards for typemeta and objectmeta fields	False	False
statusoptional	Top level status fields should all be optional	False	False
ssatags	All lists must be marked with a listType	False	False

Tasks:

• 🌱 Add nomaps API linter #12083

[sbueringer]

Thank you!

[chrischdi]

/help

Before this one is actionable, work needs to be picked up at:

• Linter Rule Wishlist kube-api-linter#1

[k8s-ci-robot]

@chrischdi:
This request has been marked as needing help from a contributor.

Guidelines

Please ensure that the issue body includes answers to the following questions:

• Why are we solving this issue?
• To address this issue, are there any code changes? If there are code changes, what needs to be done in the code and what places can the assignee treat as reference points?
• Does this issue have zero to low barrier of entry?
• How can the assignee reach out to you for help?

For more details on the requirements of such an issue, please see here and ensure that they are met.

If this request no longer meets these requirements, the label can be removed
by commenting with the /remove-help command.

In response to this:

/help

Before this one is actionable, work needs to be picked up at:

• Linter Rule Wishlist kube-api-linter#1

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository.

[sivchari]

/assign

[sbueringer]

Related to the ssatags linter: #6504