History

Anish Ramasekar 796faba4ac Allow multiple node cidr masks in cm update tests add comment amend var name update comment add check for empty slice fix tests fix mask size in test review feedback add ipv4 and ipv6 flag for mask sizes add to violation exception list remove import alias run update-openapi-spec review feedback run update-bazel review feedback review feedback		2019-11-14 20:04:31 -08:00
..
apiextensions_violation_exceptions.list	Regenerate all	2019-08-27 14:52:36 -07:00
codegen_violation_exceptions.list	Update codegen violation rules	2019-09-23 19:31:19 +05:30
README.md	Add UPDATE_API_KNOWN_VIOLATIONS=true to Makefile.generated_files	2018-11-01 17:43:16 -07:00
sample_apiserver_violation_exceptions.list	Regenerate all	2019-08-27 14:52:36 -07:00
violation_exceptions.list	Allow multiple node cidr masks in cm	2019-11-14 20:04:31 -08:00

README.md

Existing API Rule Violations

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

API Rule Violation Format

The report file violation_exceptions.list 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

And the violation list is sorted alphabetically in each of the <RULE>, <PACKAGE>, <TYPE>, <FIELD> levels.

How to resolve API Rule Check Failure

Make rule returns an error when the newly generated violation report differs from this checked-in violation report.

Our goal is that exceptions should never be added to this list, only fixed and removed. For new APIs, this is a hard requirement. For APIs that are e.g. being moved between versions or groups without other changes, it is OK for your API reviewer to make an exception.

If you're removing violations from the exception list, or if you have good reasons to add new violations to this list, please update the file using:

make generated_files UPDATE_API_KNOWN_VIOLATIONS=true

It is up to API reviewers to review the list and make sure new APIs follow our API conventions.

NOTE: please don't hide changes to this file in a "generated changes" commit, treat it as source code instead.

API Rules Being Enforced

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