Add schema validation example

[jacobtomlinson]

As discussed in #225 (comment) kr8s will probably never add automatic client-side schema validation for objects.

However, given that kubernetes-validate exists and is easy to use this PR adds an example to the documentation showing how to use it with kr8s.

import kubernetes_validate
from kr8s.objects import Pod

pod = Pod({
        "apiVersion": "v1",
        "kind": "Pod",
        "metadata": {
            "name": "my-pod",
        },
        "spec": {
            "containers": [{"name": "pause", "image": "gcr.io/google_containers/pause",}]
        },
    })

kubernetes_validate.validate(pod.raw, "1.28")
pod.create()

Note

I've also opened willthames/kubernetes-validate#23 which would enable passing objects directly to kubernetes_validate.validate() and means we could drop the .raw from the example (not just kr8s objects but kubernetes, kubernetes_asyncio and lightkube work with that change too).

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Comparison is base (416860a) 94.78% compared to head (110b37c) 94.80%.

Additional details and impacted files

@@            Coverage Diff             @@
##             main     #228      +/-   ##
==========================================
+ Coverage   94.78%   94.80%   +0.01%     
==========================================
  Files          27       27              
  Lines        2645     2654       +9     
==========================================
+ Hits         2507     2516       +9     
  Misses        138      138              

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.