You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
||`--skip-reference`| Skip printing the reference docs to the rule that was violated. |
1116
1115
{{< /table >}}
1117
1116
1118
-
#### Rule XRD001 - No boolean fields
1117
+
#### Rules
1118
+
1119
+
##### Rule XRD001 - No boolean fields
1119
1120
1120
1121
Boolean fields are inflexible and cannot be extended. Replace them with enum-based strings so you can introduce additional states later.
1121
1122
See [Kubernetes API conventions](https://github.com/kubernetes/community/blob/master/contributors/devel/sig-architecture/api-conventions.md#primitive-types)
@@ -1140,7 +1141,7 @@ properties:
1140
1141
- Disabled
1141
1142
```
1142
1143
1143
-
#### Rule XRD002 - Check for required fields
1144
+
##### Rule XRD002 - Check for required fields
1144
1145
1145
1146
Marking fields as required up front forces every user to provide them and makes future changes risky - this rule flags any `required:`
1146
1147
list in your XRD so you can decide if each field truly needs to be mandatory.
@@ -1157,7 +1158,7 @@ properties:
1157
1158
- version
1158
1159
```
1159
1160
1160
-
#### Rule XRD003 - Check for missing descriptions
1161
+
##### Rule XRD003 - Check for missing descriptions
1161
1162
1162
1163
Every property in your schema should include a description: so that `kubectl explain` and documentation generators can produce helpful output.
0 commit comments