Skip to content

Commit 4f95b92

Browse files
author
Chris Negus
authored
Add note to api conventions about kind: List (#5903)
* Add note to api conventions about kind: List * Wording change * Fixed small typo
1 parent 0681aa9 commit 4f95b92

File tree

1 file changed

+5
-0
lines changed

1 file changed

+5
-0
lines changed

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

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -128,6 +128,11 @@ lists should support filtering by fields (see
128128

129129
Examples: `PodList`, `ServiceList`, `NodeList`.
130130

131+
Note that`kubectl` and other tools sometimes output collections of resources
132+
as `kind: List`. Keep in mind that `kind: List` is not part of the Kubernetes API; it is
133+
exposing an implementation detail from client-side code in those tools, used to
134+
handle groups of mixed resources.
135+
131136
3. **Simple** kinds are used for specific actions on objects and for
132137
non-persistent entities.
133138

0 commit comments

Comments
 (0)