Skip to content

Commit baecb78

Browse files
authored
Merge pull request #19550 from julianvmodesto/single-resource
Document that the API supports single resources
2 parents 7bd283f + 18260ef commit baecb78

File tree

1 file changed

+11
-0
lines changed

1 file changed

+11
-0
lines changed

content/en/docs/reference/using-api/api-concepts.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -334,6 +334,17 @@ are not vulnerable to ordering changes in the list.
334334
Once the last finalizer is removed, the resource is actually removed from etcd.
335335

336336

337+
## Single resource API
338+
339+
API verbs GET, CREATE, UPDATE, PATCH, DELETE and PROXY support single resources only.
340+
These verbs with single resource support have no support for submitting
341+
multiple resources together in an ordered or unordered list or transaction.
342+
Clients including kubectl will parse a list of resources and make
343+
single-resource API requests.
344+
345+
API verbs LIST and WATCH support getting multiple resources, and
346+
DELETECOLLECTION supports deleting multiple resources.
347+
337348
## Dry-run
338349

339350
{{< feature-state for_k8s_version="v1.18" state="stable" >}}

0 commit comments

Comments
 (0)