fix: incorrect expectation api docs (#833)

Signed-off-by: Charles-Edouard Brétéché <[email protected]>
kyverno · Feb 9, 2024 · 043a1e4 · 043a1e4
1 parent a06d0eb
commit 043a1e4
Show file tree

Hide file tree

Showing 9 changed files with 27 additions and 20 deletions.
diff --git a/.crds/chainsaw.kyverno.io_tests.yaml b/.crds/chainsaw.kyverno.io_tests.yaml
@@ -371,7 +371,8 @@ spec:
  be considered.
  properties:
  check:
- description: Match defines the matching statement.
+ description: Check defines the verification
+ statement.
  type: object
  x-kubernetes-preserve-unknown-fields: true
  match:
@@ -470,7 +471,8 @@ spec:
  be considered.
  properties:
  check:
- description: Match defines the matching statement.
+ description: Check defines the verification
+ statement.
  type: object
  x-kubernetes-preserve-unknown-fields: true
  match:
@@ -510,7 +512,8 @@ spec:
  be considered.
  properties:
  check:
- description: Match defines the matching statement.
+ description: Check defines the verification
+ statement.
  type: object
  x-kubernetes-preserve-unknown-fields: true
  match:

diff --git a/.crds/chainsaw.kyverno.io_teststeps.yaml b/.crds/chainsaw.kyverno.io_teststeps.yaml
@@ -316,7 +316,7 @@ spec:
  determine if the verification should be considered.
  properties:
  check:
- description: Match defines the matching statement.
+ description: Check defines the verification statement.
  type: object
  x-kubernetes-preserve-unknown-fields: true
  match:
@@ -411,7 +411,7 @@ spec:
  determine if the verification should be considered.
  properties:
  check:
- description: Match defines the matching statement.
+ description: Check defines the verification statement.
  type: object
  x-kubernetes-preserve-unknown-fields: true
  match:
@@ -450,7 +450,7 @@ spec:
  determine if the verification should be considered.
  properties:
  check:
- description: Match defines the matching statement.
+ description: Check defines the verification statement.
  type: object
  x-kubernetes-preserve-unknown-fields: true
  match:

diff --git a/.release-notes/main.md b/.release-notes/main.md
@@ -27,6 +27,7 @@ Release notes for `TODO`.
 
 - Fixed an issue when running `chainsaw migrate kuttl tests` twice on the same folder
 - Fixed an issue with `chainsaw migrate kuttl tests` potentially incorrect when a `TestStep` is present
+- Fixed an incorrect `Expectation` API docs
 
 ## 📚 Docs 📚
 

diff --git a/.schemas/json/test-chainsaw-v1alpha1.json b/.schemas/json/test-chainsaw-v1alpha1.json
@@ -870,7 +870,7 @@
  ],
  "properties": {
  "check": {
- "description": "Match defines the matching statement.",
+ "description": "Check defines the verification statement.",
  "x-kubernetes-preserve-unknown-fields": true
  },
  "match": {
@@ -1013,7 +1013,7 @@
  ],
  "properties": {
  "check": {
- "description": "Match defines the matching statement.",
+ "description": "Check defines the verification statement.",
  "x-kubernetes-preserve-unknown-fields": true
  },
  "match": {
@@ -1071,7 +1071,7 @@
  ],
  "properties": {
  "check": {
- "description": "Match defines the matching statement.",
+ "description": "Check defines the verification statement.",
  "x-kubernetes-preserve-unknown-fields": true
  },
  "match": {

diff --git a/pkg/apis/v1alpha1/expectation.go b/pkg/apis/v1alpha1/expectation.go
@@ -7,6 +7,6 @@ type Expectation struct {
  // +optional
  Match *Check `json:"match,omitempty"`
 
- // Match defines the matching statement.
+ // Check defines the verification statement.
  Check Check `json:"check"`
 }
diff --git a/pkg/data/crds/chainsaw.kyverno.io_tests.yaml b/pkg/data/crds/chainsaw.kyverno.io_tests.yaml
@@ -371,7 +371,8 @@ spec:
  be considered.
  properties:
  check:
- description: Match defines the matching statement.
+ description: Check defines the verification
+ statement.
  type: object
  x-kubernetes-preserve-unknown-fields: true
  match:
@@ -470,7 +471,8 @@ spec:
  be considered.
  properties:
  check:
- description: Match defines the matching statement.
+ description: Check defines the verification
+ statement.
  type: object
  x-kubernetes-preserve-unknown-fields: true
  match:
@@ -510,7 +512,8 @@ spec:
  be considered.
  properties:
  check:
- description: Match defines the matching statement.
+ description: Check defines the verification
+ statement.
  type: object
  x-kubernetes-preserve-unknown-fields: true
  match:

diff --git a/pkg/data/crds/chainsaw.kyverno.io_teststeps.yaml b/pkg/data/crds/chainsaw.kyverno.io_teststeps.yaml
@@ -316,7 +316,7 @@ spec:
  determine if the verification should be considered.
  properties:
  check:
- description: Match defines the matching statement.
+ description: Check defines the verification statement.
  type: object
  x-kubernetes-preserve-unknown-fields: true
  match:
@@ -411,7 +411,7 @@ spec:
  determine if the verification should be considered.
  properties:
  check:
- description: Match defines the matching statement.
+ description: Check defines the verification statement.
  type: object
  x-kubernetes-preserve-unknown-fields: true
  match:
@@ -450,7 +450,7 @@ spec:
  determine if the verification should be considered.
  properties:
  check:
- description: Match defines the matching statement.
+ description: Check defines the verification statement.
  type: object
  x-kubernetes-preserve-unknown-fields: true
  match:

diff --git a/pkg/data/schemas/json/test-chainsaw-v1alpha1.json b/pkg/data/schemas/json/test-chainsaw-v1alpha1.json
@@ -870,7 +870,7 @@
  ],
  "properties": {
  "check": {
- "description": "Match defines the matching statement.",
+ "description": "Check defines the verification statement.",
  "x-kubernetes-preserve-unknown-fields": true
  },
  "match": {
@@ -1013,7 +1013,7 @@
  ],
  "properties": {
  "check": {
- "description": "Match defines the matching statement.",
+ "description": "Check defines the verification statement.",
  "x-kubernetes-preserve-unknown-fields": true
  },
  "match": {
@@ -1071,7 +1071,7 @@
  ],
  "properties": {
  "check": {
- "description": "Match defines the matching statement.",
+ "description": "Check defines the verification statement.",
  "x-kubernetes-preserve-unknown-fields": true
  },
  "match": {

diff --git a/website/docs/apis/chainsaw.v1alpha1.md b/website/docs/apis/chainsaw.v1alpha1.md
@@ -224,7 +224,7 @@ with a match filter to determine if the verification should be considered.</p>
 | Field | Type | Required | Inline | Description |
 |---|---|---|---|---|
 | `match` | `policy/v1alpha1.Any` | | | <p>Match defines the matching statement.</p> |
-| `check` | `policy/v1alpha1.Any` | :white_check_mark: | | <p>Match defines the matching statement.</p> |
+| `check` | `policy/v1alpha1.Any` | :white_check_mark: | | <p>Check defines the verification statement.</p> |
 
 ## `FileRef` {#chainsaw-kyverno-io-v1alpha1-FileRef}