upstream/kubernetes
1
0
Fork 0
mirror of https://github.com/kubernetes/kubernetes.git synced 2026-02-03 20:40:26 -05:00
Code Issues Projects Releases Packages Wiki Activity Actions

Enhance README with Kubernetes extension details

Browse source 
Added details about x-kubernetes-list-type, x-kubernetes-list-map-keys, x-kubernetes-map-type, and x-kubernetes-unions extensions in the README.
This commit is contained in:
Jimoh Habeeblahi Adesola 2025-10-14 15:15:17 +01:00 committed by GitHub
parent 9b9cd768a0
commit c19181f606
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
1 changed files with 78 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

78
api/openapi-spec/README.md
View file

@ -58,3 +58,81 @@ For example:
Some of the definitions may have these extensions. For more information about PatchStrategy and PatchMergeKey see
[strategic-merge-patch](https://git.k8s.io/community/contributors/devel/sig-api-machinery/strategic-merge-patch.md).
### `x-kubernetes-list-type`
Some definitions may have `x-kubernetes-list-type`.
This extension specifies how lists are merged when Kubernetes objects are combined (for example, during updates or patches).
Possible values are:
- `"atomic"` – treat the entire list as one unit; replacing the list replaces all elements.
- `"set"` – treat the list as a set; merge items based on equality.
- `"map"` – treat the list as a map; keys come from the field defined in `x-kubernetes-list-map-keys`.
For example:
```json
{
"x-kubernetes-list-type": "map",
"x-kubernetes-list-map-keys": ["name"]
}
```
See [Kubernetes API conventions (lists and maps)](https://github.com/kubernetes/community/blob/master/contributors/devel/sig-architecture/api-conventions.md) for more.
### `x-kubernetes-list-map-keys`
This extension sets which field(s) identify elements uniquely for x-kubernetes-list-type: map.
It allows merging list entries based on those key fields.
For example:
```json
{
"x-kubernetes-list-type": "map",
"x-kubernetes-list-map-keys": ["name"]
}
```
Here, "name" acts as the key for each map entry.
See [API conventions – merge strategy](https://github.com/kubernetes/community/blob/master/contributors/devel/sig-architecture/api-conventions.md#merge-strategy) for details.
### `x-kubernetes-map-type`
Some definitions may have x-kubernetes-map-type.
This extension describes how maps should merge:
• "atomic" – replace entire map
• "granular" – merge map entries individually
For example:
```json
{
"x-kubernetes-map-type": "granular"
}
```
See Kubernetes [API conventions (maps section)](https://github.com/kubernetes/community/blob/master/contributors/devel/sig-architecture/api-conventions.md#maps) for details.
### `x-kubernetes-unions`
Some definitions may have x-kubernetes-unions.
This extension describes mutually exclusive fields (union-like behavior).
Only one field in that union can be set.
For example:
```json
{
"x-kubernetes-unions": [
{
"discriminator": "type",
"fields": ["intValue", "stringValue"]
}
]
}
```
This ensures only one of "intValue" or "stringValue" is specified based on the type discriminator.
See Kubernetes [API conventions (union types)](https://github.com/kubernetes/community/blob/master/contributors/devel/sig-architecture/api-conventions.md#union-types) for more.