From 8133e812058c7dde9cfadc774e0150056e3220fb Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Niccol=C3=B2=20Fei?= <niccolo.fei@enterprisedb.com>
Date: Mon, 24 Mar 2025 17:19:14 +0100
Subject: [PATCH] chore: add some missing descriptions
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

Signed-off-by: Niccolò Fei <niccolo.fei@enterprisedb.com>
---
 api/v1/objectstore_types.go        |  6 ++++++
 docs/src/plugin-barman-cloud.v1.md | 12 +++++++++---
 2 files changed, 15 insertions(+), 3 deletions(-)

diff --git a/api/v1/objectstore_types.go b/api/v1/objectstore_types.go
index 786d92d..a028adf 100644
--- a/api/v1/objectstore_types.go
+++ b/api/v1/objectstore_types.go
@@ -48,6 +48,7 @@ type ObjectStoreSpec struct {
 	// +optional
 	RetentionPolicy string `json:"retentionPolicy,omitempty"`
 
+	// The configuration for the sidecar that runs in the instance pods
 	// +optional
 	InstanceSidecarConfiguration InstanceSidecarConfiguration `json:"instanceSidecarConfiguration,omitempty"`
 }
@@ -81,7 +82,12 @@ type ObjectStore struct {
 	metav1.TypeMeta   `json:",inline"`
 	metav1.ObjectMeta `json:"metadata"`
 
+	// Specification of the desired behavior of the ObjectStore.
+	// More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status
 	Spec ObjectStoreSpec `json:"spec"`
+	// Most recently observed status of the ObjectStore. This data may not be up to
+	// date. Populated by the system. Read-only.
+	// More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status
 	// +optional
 	Status ObjectStoreStatus `json:"status,omitempty"`
 }
diff --git a/docs/src/plugin-barman-cloud.v1.md b/docs/src/plugin-barman-cloud.v1.md
index 58b1fc3..0573d8f 100644
--- a/docs/src/plugin-barman-cloud.v1.md
+++ b/docs/src/plugin-barman-cloud.v1.md
@@ -30,13 +30,18 @@
 <a href="#barmancloud-cnpg-io-v1-ObjectStoreSpec"><i>ObjectStoreSpec</i></a>
 </td>
 <td>
-   <span class="text-muted">No description provided.</span></td>
+   <p>Specification of the desired behavior of the ObjectStore.
+More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status</p>
+</td>
 </tr>
 <tr><td><code>status</code><br/>
 <a href="#barmancloud-cnpg-io-v1-ObjectStoreStatus"><i>ObjectStoreStatus</i></a>
 </td>
 <td>
-   <span class="text-muted">No description provided.</span></td>
+   <p>Most recently observed status of the ObjectStore. This data may not be up to
+date. Populated by the system. Read-only.
+More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status</p>
+</td>
 </tr>
 </tbody>
 </table>
@@ -108,7 +113,8 @@ days, weeks, months.</p>
 <a href="#barmancloud-cnpg-io-v1-InstanceSidecarConfiguration"><i>InstanceSidecarConfiguration</i></a>
 </td>
 <td>
-   <span class="text-muted">No description provided.</span></td>
+   <p>The configuration for the sidecar that runs in the instance pods</p>
+</td>
 </tr>
 </tbody>
 </table>