kubernetes
/
community
mirror of https://github.com/kubernetes/community.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Add note to api conventions about kind: List (#5903) 

* Add note to api conventions about kind: List

* Wording change

* Fixed small typo
This commit is contained in:
Chris Negus 2021-10-12 14:32:33 -04:00 committed by GitHub
parent 0681aa90be
commit 4f95b92105
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 5 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
contributors/devel/sig-architecture/api-conventions.md
View File

@ -128,6 +128,11 @@ lists should support filtering by fields (see
Examples: `PodList`, `ServiceList`, `NodeList`.
Note that`kubectl` and other tools sometimes output collections of resources
as `kind: List`. Keep in mind that `kind: List` is not part of the Kubernetes API; it is
exposing an implementation detail from client-side code in those tools, used to
handle groups of mixed resources.
3. **Simple** kinds are used for specific actions on objects and for
non-persistent entities.