kubernetes/api/openapi-spec
Kimon N. 6691ecaf2f
Fix v1.VolumeMount.MountPath doc to match validator (allow ':')
The v1.VolumeMount.MountPath doc claims the path must not contain
':', but the validator does not enforce this. The internal type in
pkg/apis/core/types.go carries no such constraint, and existing
TestValidateVolumeMounts success cases use mountPath values like "d:",
"F:", and "G:\mount".

This is a doc-only change. The validator is unchanged; the public doc
now matches what the validator actually accepts. Regenerated proto and
openapi snapshots to propagate the doc update.

Signed-off-by: Kimon N. <nkimon00@gmail.com>
2026-04-30 22:51:30 +02:00
..
v3 Fix v1.VolumeMount.MountPath doc to match validator (allow ':') 2026-04-30 22:51:30 +02:00
README.md Document x-kubernetes-list-map-keys into OpenAPI extensions 2025-12-05 23:37:35 -08:00
swagger.json Fix v1.VolumeMount.MountPath doc to match validator (allow ':') 2026-04-30 22:51:30 +02:00

Kubernetes's OpenAPI Specification

This folder contains an OpenAPI specification for Kubernetes API.

Vendor Extensions

Kubernetes extends OpenAPI using these extensions. Note the version that extensions have been added.

x-kubernetes-group-version-kind

Operations and Definitions may have x-kubernetes-group-version-kind if they are associated with a kubernetes resource.

For example:

"paths": {
    ...
    "/api/v1/namespaces/{namespace}/pods/{name}": {
        ...
        "get": {
        ...
            "x-kubernetes-group-version-kind": {
            "group": "",
            "version": "v1",
            "kind": "Pod"
            }
        }
    }
}

x-kubernetes-action

Operations and Definitions may have x-kubernetes-action if they are associated with a kubernetes resource. Action can be one of get, list, put, patch, post, delete, deletecollection, watch, watchlist, proxy, or connect.

For example:

"paths": {
    ...
    "/api/v1/namespaces/{namespace}/pods/{name}": {
        ...
        "get": {
        ...
            "x-kubernetes-action": "list"
        }
    }
}

x-kubernetes-list-map-keys

Operations and Definitions may have x-kubernetes-list-maps-keys if they are associated with a kubernetes resource. x-kubernetes-list-type = map specifies field names inside each list element to serve as unique keys for the list-as-map.

For example:

{
  "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 strategic-merge-patch.