github/kubernetes
4
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
c9b79da757
kubernetes/api/openapi-spec
History
Kubernetes Submit Queue 93ae5d2250
Merge pull request #67307 from jlegrone/feature/update-container-resources-ref 
Automatic merge from submit-queue (batch tested with PRs 67347, 67307, 67358, 67364, 67385). If you want to cherry-pick this change to another branch, please follow the instructions <a href="https://github.com/kubernetes/community/blob/master/contributors/devel/cherry-picks.md">here</a>.

Update container resources reference link

**What this PR does / why we need it**:
Users are currently directed to documentation on `PersistentVolumeClaim` resources when looking for information on `Container` resources.  While this field is backed by the same type in both instances, [Managing Compute Resources for Containers](https://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/) is more relevant in the `Container` context.

This is surfaced in at least two places:
- https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.11/#container-v1-core
- `kubectl explain pod.spec.containers.resources`

**Release note**:

```release-note
NONE
```
2018-08-15 04:23:15 -07:00
..
BUILD Enable auto-generating sources rules 2017-01-05 14:14:13 -08:00
README.md fix OpenAPI link 2018-08-09 10:56:08 -05:00
swagger.json Merge pull request #67307 from jlegrone/feature/update-container-resources-ref 2018-08-15 04:23:15 -07: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.