Skip to content

Commit 952b06b

Browse files
authored
Merge pull request #5356 from pweil-/fix-list-examples
Correct list api examples and add link to field selector documentation
2 parents 7e31e74 + 05334d4 commit 952b06b

File tree

1 file changed

+3
-4
lines changed

1 file changed

+3
-4
lines changed

contributors/devel/sig-architecture/api-conventions.md

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -123,11 +123,10 @@ defaults) and may not have lists.
123123

124124
In addition, all lists that return objects with labels should support label
125125
filtering (see [the labels documentation](https://kubernetes.io/docs/user-guide/labels/)), and most
126-
lists should support filtering by fields.
126+
lists should support filtering by fields (see
127+
[the fields documentation](https://kubernetes.io/docs/concepts/overview/working-with-objects/field-selectors/)).
127128

128-
Examples: `PodLists`, `ServiceLists`, `NodeLists`.
129-
130-
TODO: Describe field filtering below or in a separate doc.
129+
Examples: `PodList`, `ServiceList`, `NodeList`.
131130

132131
3. **Simple** kinds are used for specific actions on objects and for
133132
non-persistent entities.

0 commit comments

Comments
 (0)