Kubernetes API Conventions
Official docs outline
12 sections- Types (kinds)
Resources, objects, lists and simple kinds.
- Verbs on resources
GET, LIST, POST, PUT, PATCH, DELETE and WATCH semantics.
- Patch operations
JSON Patch, merge patch, strategic merge patch and apply.
- Idempotency
Idempotent operations and generateName.
- Optional vs required
Field optionality and omitempty rules.
- Defaulting
Static, admission and controller-assigned defaults.
- Concurrency control and consistency
resourceVersion and optimistic concurrency.
- Object references
Naming and shape of reference fields.
- HTTP status codes
Status codes used by the API server.
- Events
Event objects and reasons.
- Spec and status
Declarative desired state vs observed status.
- API concepts
Watch, chunking, server-side apply and resource versions.
Each section links to the official page. Titles and summaries by Extra Credit; the docs belong to their authors.
More in Observability and operations
All 18- C4 Model
- Container Network Interface (CNI) Specification
- Container Storage Interface (CSI) Specification
- Google SRE Book
- OCI Distribution Specification
- OCI Image Format Specification
- OCI Runtime Specification
- OpenMetrics Specification
- OpenTelemetry Protocol (OTLP)
- OpenTelemetry Semantic Conventions
- OpenTelemetry Specification
- Prometheus Exposition Format