Allow setting a description on a derived CRD

kube-rs · Nov 30, 2023 · 82d0f8f · 82d0f8f
1 parent 2fc37a2
commit 82d0f8f
Show file tree

Hide file tree

Showing 3 changed files with 8 additions and 3 deletions.
diff --git a/examples/crd_derive.rs b/examples/crd_derive.rs
@@ -17,6 +17,7 @@ use serde::{Deserialize, Serialize};
     plural = "fooz",
     root = "FooCrd",
     namespaced,
+    description = "Custom resource representing a Foo",
     status = "FooStatus",
     derive = "PartialEq",
     derive = "Default",
@@ -119,7 +120,7 @@ fn verify_crd() {
             ],
             "schema": {
               "openAPIV3Schema": {
-                "description": "Auto-generated derived type for MyFoo via `CustomResource`",
+                "description": "Custom resource representing a Foo",
                 "properties": {
                   "spec": {
                     "description": "Our spec for Foo\n\nA struct with our chosen Kind will be created for us, using the following kube attrs",

diff --git a/kube-derive/src/custom_resource.rs b/kube-derive/src/custom_resource.rs
@@ -10,6 +10,7 @@ struct KubeAttrs {
     group: String,
     version: String,
     kind: String,
+    description: Option<String>,
     #[darling(rename = "root")]
     kind_struct: Option<String>,
     /// lowercase plural of kind (inferred if omitted)
@@ -145,6 +146,7 @@ pub(crate) fn derive(input: proc_macro2::TokenStream) -> proc_macro2::TokenStrea
         kind,
         kind_struct,
         version,
+        description,
         namespaced,
         derives,
         schema: schema_mode,
@@ -239,7 +241,8 @@ pub(crate) fn derive(input: proc_macro2::TokenStream) -> proc_macro2::TokenStrea
         derive_paths.push(syn::parse_quote! { #schemars::JsonSchema });
     }
 
-    let docstr = format!(" Auto-generated derived type for {ident} via `CustomResource`");
+    let docstr = description
+        .unwrap_or_else(|| format!(" Auto-generated derived type for {ident} via `CustomResource`"));
     let quoted_serde = Literal::string(&serde.to_token_stream().to_string());
     let root_obj = quote! {
         #[doc = #docstr]

diff --git a/kube-derive/tests/crd_schema_test.rs b/kube-derive/tests/crd_schema_test.rs
@@ -15,6 +15,7 @@ use std::collections::HashMap;
     kind = "Foo",
     category = "clux",
     namespaced,
+    description = "Custom resource representing a Foo",
     derive = "PartialEq",
     shortname = "fo",
     shortname = "f"
@@ -195,7 +196,7 @@ fn test_crd_schema_matches_expected() {
                         "additionalPrinterColumns": [],
                         "schema": {
                             "openAPIV3Schema": {
-                                "description": "Auto-generated derived type for FooSpec via `CustomResource`",
+                                "description": "Custom resource representing a Foo",
                                 "properties": {
                                     "spec": {
                                         "properties": {