Skip to content

Commit c26af3f

Browse files
authored
Merge pull request #24024 from tengqm/api-version-warning
Clarify what API versions mean
2 parents f59e96d + 3d416c6 commit c26af3f

File tree

1 file changed

+13
-4
lines changed

1 file changed

+13
-4
lines changed

content/en/docs/concepts/overview/kubernetes-api.md

Lines changed: 13 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -41,6 +41,7 @@ The Kubernetes API server serves an OpenAPI spec via the `/openapi/v2` endpoint.
4141
You can request the response format using request headers as follows:
4242

4343
<table>
44+
<caption style="display:none">Valid request header values for OpenAPI v2 queries</caption>
4445
<thead>
4546
<tr>
4647
<th>Header</th>
@@ -68,7 +69,6 @@ You can request the response format using request headers as follows:
6869
<td><em>serves </em><code>application/json</code></td>
6970
</tr>
7071
</tbody>
71-
<caption>Valid request header values for OpenAPI v2 queries</caption>
7272
</table>
7373

7474
Kubernetes implements an alternative Protobuf based serialization format that
@@ -102,13 +102,22 @@ to ensure that the API presents a clear, consistent view of system resources
102102
and behavior, and to enable controlling access to end-of-life and/or
103103
experimental APIs.
104104

105-
Refer to [API versions reference](/docs/reference/using-api/api-overview/#api-versioning)
106-
for more details on the API version level definitions.
107-
108105
To make it easier to evolve and to extend its API, Kubernetes implements
109106
[API groups](/docs/reference/using-api/api-overview/#api-groups) that can be
110107
[enabled or disabled](/docs/reference/using-api/api-overview/#enabling-or-disabling).
111108

109+
API resources are distinguished by their API group, resource type, namespace
110+
(for namespaced resources), and name. The API server may serve the same
111+
underlying data through multiple API version and handle the conversion between
112+
API versions transparently. All these different versions are actually
113+
representations of the same resource. For example, suppose there are two
114+
versions `v1` and `v1beta1` for the same resource. An object created by the
115+
`v1beta1` version can then be read, updated, and deleted by either the
116+
`v1beta1` or the `v1` versions.
117+
118+
Refer to [API versions reference](/docs/reference/using-api/api-overview/#api-versioning)
119+
for more details on the API version level definitions.
120+
112121
## API Extension
113122

114123
The Kubernetes API can be extended in one of two ways:

0 commit comments

Comments
 (0)