github/kubernetes
1
0
Fork 0
mirror of https://github.com/k3s-io/kubernetes.git synced 2025-11-03 07:11:01 +00:00
Code Issues Projects Releases Wiki Activity
Files
f1101a3318b125a219a9731c39e2c2795f5b954b
kubernetes/api/openapi-spec
History
Patrick Ohly f1101a3318 storage: document csi.storage.k8s.io/ephemeral also for internal type 
This was added to staging/src/k8s.io/api/storage/v1beta1/types.go but
unintentionally left out for the internal type. Both docs should
better match because it is uncertain which one will be looked at by
developers.

The original "iff" for "if and only if" is unnecessary because the
comment about "otherwise false" avoids ambiguity.
2020-06-12 11:34:37 +02:00
..
BUILD
Update generated files
2019-01-15 13:33:06 -05:00
README.md
Update deprecated links
2019-02-15 09:13:07 -05:00
swagger.json
storage: document csi.storage.k8s.io/ephemeral also for internal type
2020-06-12 11:34:37 +02:00

README.md

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 has 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-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.