kubernetes

Files

Haowei Cai 3af6061e76 Use kube-openapi cmd in Make rules

check in existing API rule violations;
the Make rule fails if generated violation report differs from the
checked-in violation file and prints error message;
add documentation.

2018-07-10 17:53:24 -07:00

README.md

Use kube-openapi cmd in Make rules

2018-07-10 17:53:24 -07:00

violations.report

Use kube-openapi cmd in Make rules

2018-07-10 17:53:24 -07:00

README.md

Existing API Rule Violations

This folder contains the checked-in report file of known API rule violations. This report file violations.report is used by Make rule during OpenAPI spec generation to make sure that no new API rule violation is introduced into our code base.

The report file violations.report is in format of:

API rule violation: <RULE>,<PACKAGE>,<TYPE>,<FIELD>

e.g.

API rule violation: names_match,k8s.io/api/core/v1,Event,ReportingController

Make rule returns error when new generated violation report differs from this checked-in violation report. If new API rule violation is detected, please fix the API Go source file to pass the API rule check. The entries in the checked-in violation report should only be removed when existing API rule violation is being fixed, but not added.

For more information about the API rules being checked, please refer to https://github.com/kubernetes/kube-openapi/tree/master/pkg/generators/rules