Skip to content

Commit

Permalink
Add docs for CRD description attribute
Browse files Browse the repository at this point in the history
  • Loading branch information
sbernauer committed Dec 1, 2023
1 parent 6d3a482 commit 7754d4a
Showing 1 changed file with 5 additions and 0 deletions.
5 changes: 5 additions & 0 deletions kube-derive/src/lib.rs
Original file line number Diff line number Diff line change
Expand Up @@ -141,6 +141,10 @@ mod custom_resource;
/// ## `#[kube(category = "apps")]`
/// Add a single category to `crd.spec.names.categories`.
///
/// ## `#[kube(description = "description")]`
/// Sets the description of the schema in the generated CRD. If not specified
/// `Auto-generated derived type for {customResourceName} via CustomResource` will be used instead.
///
/// ## Example with all properties
///
/// ```rust
Expand All @@ -155,6 +159,7 @@ mod custom_resource;
/// kind = "Foo",
/// root = "FooCrd",
/// namespaced,
/// description = "Custom resource representing a Foo",
/// status = "FooStatus",
/// derive = "PartialEq",
/// singular = "foot",
Expand Down

0 comments on commit 7754d4a

Please sign in to comment.