diff options
| author | Christoph Blecker <admin@toph.ca> | 2017-06-15 16:58:11 -0700 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2017-06-15 16:58:11 -0700 |
| commit | 1e6ce587703d3ccfce149d084783af4c3c666fbd (patch) | |
| tree | a61bf6c090f29b90cfd88e070b64e266081cfc19 | |
| parent | aa01b5fc9a078eb0c0b536d84c0ed8e193845d65 (diff) | |
| parent | afa2293065c8289844f12097b69a99546b78c991 (diff) | |
Merge pull request #714 from CaoShuFeng/api-conventions
Fix doc for api-conventions
| -rw-r--r-- | contributors/devel/api-conventions.md | 6 |
1 files changed, 3 insertions, 3 deletions
diff --git a/contributors/devel/api-conventions.md b/contributors/devel/api-conventions.md index ca721706..fd20bdd7 100644 --- a/contributors/devel/api-conventions.md +++ b/contributors/devel/api-conventions.md @@ -69,7 +69,7 @@ kinds would have different attributes and properties) via HTTP to the server. Resources are exposed via: * Collections - a list of resources of the same type, which may be queryable * Elements - an individual resource, addressable via a URL -* **API Group** a set of resources that are exposed together at the same. Along +* **API Group** a set of resources that are exposed together. Along with the version is exposed in the "apiVersion" field as "GROUP/VERSION", e.g. "policy.k8s.io/v1". @@ -232,7 +232,7 @@ the resource may be deleted prior to this time. categorize objects (see [the labels docs](https://kubernetes.io/docs/user-guide/labels/)) * annotations: a map of string keys and values that can be used by external tooling to store and retrieve arbitrary metadata about this object (see -[the annotations docs](https://kubernetes.io/docs/user-guide/annotations/) +[the annotations docs](https://kubernetes.io/docs/user-guide/annotations/)) Labels are intended for organizational purposes by end users (select the pods that match this label query). Annotations enable third-party automation and @@ -531,7 +531,7 @@ overrides a default grace period, including the zero grace period ("now"). * PUT /<resourceNamePlural>/<name> - Update or create the resource with the given name with the JSON object provided by the client. * PATCH /<resourceNamePlural>/<name> - Selectively modify the -specified fields of the resource. See more information [below](#patch). +specified fields of the resource. See more information [below](#patch-operations). * GET /<resourceNamePlural>&watch=true - Receive a stream of JSON objects corresponding to changes made to any resource of the given kind over time. |