github/kubernetes
4
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
04b7977ef6
kubernetes/api/openapi-spec
History
AbdulBasitAlvi 29cfc68911 bug(staging_api_apps_v1): add descriptions to apps/v1/types.go files 
#### What type of PR is this?
/kind bug

#### What this PR does / why we need it:

This PR adds descriptions for the following:
1. Metadata and List of Struct `StatefulSetLists`
2. Metadata of Struct `StatefulSet`

#### Which issue(s) this PR fixes:
Ref #99675
2021-05-16 07:09:40 +05:00
..
README.md Update deprecated links 2019-02-15 09:13:07 -05:00
swagger.json bug(staging_api_apps_v1): add descriptions to apps/v1/types.go files 2021-05-16 07:09:40 +05: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.