feat: add descriptions for resource details (#1105)

* feat: add descriptions for resource details

* Apply automatic changes

---------

Co-authored-by: shamsartem <[email protected]>

Author: shamsartem

packages/cli/package/docs/configs/provider.md

@@ -139,12 +139,12 @@ Override or extend RAM details not related to matching but visible to the user f
 
 **Properties**
 
-| Property       | Type    | Required | Description |
-|----------------|---------|----------|-------------|
-| `ecc`          | boolean | No       |             |
-| `manufacturer` | string  | No       |             |
-| `model`        | string  | No       |             |
-| `speed`        | integer | No       |             |
+| Property       | Type    | Required | Description                              |
+|----------------|---------|----------|------------------------------------------|
+| `ecc`          | boolean | No       | Error-Correcting Code (ECC) availability |
+| `manufacturer` | string  | No       |                                          |
+| `model`        | string  | No       |                                          |
+| `speed`        | integer | No       | in MHz                                   |
 
 ##### storage
 
@@ -168,7 +168,7 @@ Override or extend Storage details not related to matching but visible to the us
 |------------------------|---------|----------|-------------|
 | `manufacturer`         | string  | No       |             |
 | `model`                | string  | No       |             |
-| `sequentialWriteSpeed` | integer | No       |             |
+| `sequentialWriteSpeed` | integer | No       | in Mb/s     |
 
 ## offers
 
@@ -301,12 +301,12 @@ RAM details not related to matching but visible to the user for information purp
 
 ##### Properties
 
-| Property       | Type    | Required | Description |
-|----------------|---------|----------|-------------|
-| `ecc`          | boolean | No       |             |
-| `manufacturer` | string  | No       |             |
-| `model`        | string  | No       |             |
-| `speed`        | integer | No       |             |
+| Property       | Type    | Required | Description                              |
+|----------------|---------|----------|------------------------------------------|
+| `ecc`          | boolean | No       | Error-Correcting Code (ECC) availability |
+| `manufacturer` | string  | No       |                                          |
+| `model`        | string  | No       |                                          |
+| `speed`        | integer | No       | in MHz                                   |
 
 ### storage
 
@@ -328,5 +328,5 @@ Storage details not related to matching but visible to the user for information
 |------------------------|---------|----------|-------------|
 | `manufacturer`         | string  | No       |             |
 | `model`                | string  | No       |             |
-| `sequentialWriteSpeed` | integer | No       |             |
+| `sequentialWriteSpeed` | integer | No       | in Mb/s     |
 

packages/cli/package/src/lib/configs/project/provider/provider4.ts

@@ -99,8 +99,17 @@ const peerRamDetailsSchema = {
   properties: {
     manufacturer: { type: "string", nullable: true },
     model: { type: "string", nullable: true },
-    speed: { type: "integer", nullable: true, minimum: 1 },
-    ecc: { type: "boolean", nullable: true },
+    speed: {
+      description: "in MHz",
+      type: "integer",
+      nullable: true,
+      minimum: 1,
+    },
+    ecc: {
+      description: "Error-Correcting Code (ECC) availability",
+      type: "boolean",
+      nullable: true,
+    },
   },
   required: [],
 } as const satisfies JSONSchemaType<PeerRamDetails>;
@@ -129,7 +138,12 @@ const peerStorageDetailsSchema = {
   properties: {
     manufacturer: { type: "string", nullable: true },
     model: { type: "string", nullable: true },
-    sequentialWriteSpeed: { type: "integer", nullable: true, minimum: 1 },
+    sequentialWriteSpeed: {
+      description: "in Mb/s",
+      type: "integer",
+      nullable: true,
+      minimum: 1,
+    },
   },
   required: [],
 } as const satisfies JSONSchemaType<PeerStorageDetails>;