summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorPaul Weil <pweil@redhat.com>2020-12-08 13:30:48 -0500
committerPaul Weil <pweil@redhat.com>2020-12-08 13:30:48 -0500
commit05334d450a1841192e5d5473464508ecdbb08cf9 (patch)
tree995f66420540c5d159d7263660377bf11690bb28
parent5ee791860b05691097362d025f5413b9d2f3da62 (diff)
Correct list api examples and add link to field selector documentation
-rw-r--r--contributors/devel/sig-architecture/api-conventions.md7
1 files changed, 3 insertions, 4 deletions
diff --git a/contributors/devel/sig-architecture/api-conventions.md b/contributors/devel/sig-architecture/api-conventions.md
index 3784f78e..eecda00c 100644
--- a/contributors/devel/sig-architecture/api-conventions.md
+++ b/contributors/devel/sig-architecture/api-conventions.md
@@ -123,11 +123,10 @@ defaults) and may not have lists.
In addition, all lists that return objects with labels should support label
filtering (see [the labels documentation](https://kubernetes.io/docs/user-guide/labels/)), and most
-lists should support filtering by fields.
+lists should support filtering by fields (see
+[the fields documentation](https://kubernetes.io/docs/concepts/overview/working-with-objects/field-selectors/)).
- Examples: `PodLists`, `ServiceLists`, `NodeLists`.
-
- TODO: Describe field filtering below or in a separate doc.
+ Examples: `PodList`, `ServiceList`, `NodeList`.
3. **Simple** kinds are used for specific actions on objects and for
non-persistent entities.