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

Document x-kubernetes-list-map-keys into OpenAPI extensions

Browse source 
This PR adds missing OpenAPI vendor extension documentation for the following:
x-kubernetes-list-map-keys

The provided documentation includes simple additions to api/openapi-spec/README.md with similar format to present documentation.
Fixes issue #131724
This commit is contained in:
Anthony Amador 2025-12-05 23:37:35 -08:00 committed by GitHub
parent c70011cf10
commit 7ce879d16f
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
1 changed files with 28 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

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

@ -54,6 +54,34 @@ For example:
}
```
### `x-kubernetes-list-map-keys`
Operations and Definitions may have `x-kubernetes-list-maps-keys` if they
are associated with a [kubernetes resource](https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources). `x-kubernetes-list-type` = `map` specifies field names inside each list element to serve as unique keys for the list-as-map.
**For example:**
```json
{
"type": "object",
"properties": {
"servers": {
"type": "array",
"x-kubernetes-list-type": "map",
"x-kubernetes-list-map-keys": ["name"],
"items": {
"type": "object",
"properties": {
"name": { "type": "string" },
"address": { "type": "string" }
},
"required": ["name"]
}
}
}
}
```
### `x-kubernetes-patch-strategy` and `x-kubernetes-patch-merge-key`
Some of the definitions may have these extensions. For more information about PatchStrategy and PatchMergeKey see