Skip to content

Commit 033c246

Browse files
committed
update api and docs
1 parent 2dd2491 commit 033c246

File tree

3 files changed

+10
-8
lines changed

3 files changed

+10
-8
lines changed

apis/v1alpha1/snippetsfilter_types.go

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -80,9 +80,9 @@ const (
8080

8181
// SnippetsFilterStatus defines the state of SnippetsFilter.
8282
type SnippetsFilterStatus struct {
83-
// Controllers describe the state of the SnippetsFilter and controller name.
84-
// +optional
85-
// +listType=map
83+
// Controllers is a list of Gateway API controllers that processed the SnippetsFilter
84+
// and the status of the SnippetsFilter with respect to each controller.
85+
//
8686
// +kubebuilder:validation:MaxItems=16
8787
Controllers []ControllerStatus `json:"controllers,omitempty"`
8888
}
@@ -105,6 +105,7 @@ type ControllerStatus struct {
105105

106106
// Conditions describe the status of the SnippetsFilter.
107107
//
108+
// +optional
108109
// +listType=map
109110
// +listMapKey=type
110111
// +kubebuilder:validation:MinItems=1

config/crd/bases/gateway.nginx.org_snippetsfilters.yaml

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -87,8 +87,9 @@ spec:
8787
description: Status defines the state of the SnippetsFilter.
8888
properties:
8989
controllers:
90-
description: Controllers describe the state of the SnippetsFilter
91-
and controller name.
90+
description: |-
91+
Controllers is a list of Gateway API controllers that processed the SnippetsFilter
92+
and the status of the SnippetsFilter with respect to each controller.
9293
items:
9394
properties:
9495
conditions:
@@ -178,7 +179,6 @@ spec:
178179
type: object
179180
maxItems: 16
180181
type: array
181-
x-kubernetes-list-type: map
182182
type: object
183183
required:
184184
- spec

site/content/reference/api.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -860,6 +860,7 @@ longer necessary.</p>
860860
</em>
861861
</td>
862862
<td>
863+
<em>(Optional)</em>
863864
<p>Conditions describe the status of the SnippetsFilter.</p>
864865
</td>
865866
</tr>
@@ -1364,8 +1365,8 @@ Allowed contexts: main, http, http.server, http.server.location.</p>
13641365
</em>
13651366
</td>
13661367
<td>
1367-
<em>(Optional)</em>
1368-
<p>Controllers describe the state of the SnippetsFilter and controller name.</p>
1368+
<p>Controllers is a list of Gateway API controllers that processed the SnippetsFilter
1369+
and the status of the SnippetsFilter with respect to each controller.</p>
13691370
</td>
13701371
</tr>
13711372
</tbody>

0 commit comments

Comments
 (0)