API Style Guides

Kubernetes API Conventions

The Kubernetes API conventions document, maintained by SIG Architecture. Defines the "kind / apiVersion" object envelope, spec/status separation, resourceVersion-based optimistic concurrency, list semantics, label and selector validation, and the patterns used by every Kubernetes-native API (and by extension every CRD).

GitHub

Other Resources

🔗
StyleGuide
https://github.com/kubernetes/community/blob/master/contributors/devel/sig-architecture/api-conventions.md
🔗
License
https://github.com/kubernetes/community/blob/master/LICENSE
🔗
Scope

API entry from apis.yml

apis.yml Raw ↑ 
aid: style-guides:kubernetes
name: Kubernetes API Conventions
description: The Kubernetes API conventions document, maintained by SIG Architecture. Defines the "kind
  / apiVersion" object envelope, spec/status separation, resourceVersion-based optimistic concurrency,
  list semantics, label and selector validation, and the patterns used by every Kubernetes-native API
  (and by extension every CRD).
humanURL: https://github.com/kubernetes/community/blob/master/contributors/devel/sig-architecture/api-conventions.md
baseURL: https://github.com/kubernetes/community/
tags:
- REST
- Kubernetes
- SIG Architecture
- CRD
properties:
- type: StyleGuide
  url: https://github.com/kubernetes/community/blob/master/contributors/devel/sig-architecture/api-conventions.md
- type: License
  url: https://github.com/kubernetes/community/blob/master/LICENSE
- type: Scope
  data:
    surfaces:
    - REST
    publisher: Kubernetes / CNCF
    license: Apache-2.0 (repo)
    status: living