Skip to content

Commit 672ef03

Browse files
committed
Document KEP-5116
1 parent 8255f3f commit 672ef03

File tree

1 file changed

+9
-1
lines changed

1 file changed

+9
-1
lines changed

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

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -127,7 +127,7 @@ virtual resource type would be used if that becomes necessary.
127127

128128
## HTTP media types {#alternate-representations-of-resources}
129129

130-
Over HTTP, Kubernetes supports JSON and Protobuf wire encodings.
130+
Over HTTP, Kubernetes supports JSON, YAML, CBOR and Protobuf wire encodings.
131131

132132
By default, Kubernetes returns objects in [JSON serialization](#json-encoding), using the
133133
`application/json` media type. Although JSON is the default, clients may request a response in
@@ -144,6 +144,14 @@ If you request an available media type, the API server returns a response with a
144144
a `406 Not acceptable` error message.
145145
All built-in resource types support the `application/json` media type.
146146

147+
#### Streamed response writing
148+
149+
For JSON and Protobuf encoding Kubernetes supports streaming while writing response.
150+
The feature doesn't impact the output of the response,
151+
but allows API server to avoid loading whole responses into memory.
152+
Using other types of encoding (including pretty representation of JSON)
153+
should be avoided for large resouces (>100MB) as it can have hugly negative performance impact.
154+
147155
### JSON resource encoding {#json-encoding}
148156

149157
The Kubernetes API defaults to using [JSON](https://www.json.org/json-en.html) for encoding

0 commit comments

Comments
 (0)