From a6f30eb487e4d3859c3f11d05673cb1028767083 Mon Sep 17 00:00:00 2001 From: Artsiom Shamsutdzinau Date: Wed, 5 Feb 2025 14:49:34 +0100 Subject: [PATCH 1/2] feat: add descriptions for resource details --- .../lib/configs/project/provider/provider4.ts | 20 ++++++++++++++++--- 1 file changed, 17 insertions(+), 3 deletions(-) diff --git a/packages/cli/package/src/lib/configs/project/provider/provider4.ts b/packages/cli/package/src/lib/configs/project/provider/provider4.ts index 6e64ad3ce..130e80bb4 100644 --- a/packages/cli/package/src/lib/configs/project/provider/provider4.ts +++ b/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; @@ -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; From f72d15e3660db29b0279c1432a76a91797e23edc Mon Sep 17 00:00:00 2001 From: shamsartem <12379793+shamsartem@users.noreply.github.com> Date: Wed, 5 Feb 2025 13:51:45 +0000 Subject: [PATCH 2/2] Apply automatic changes --- packages/cli/package/docs/configs/provider.md | 28 +++++++++---------- 1 file changed, 14 insertions(+), 14 deletions(-) diff --git a/packages/cli/package/docs/configs/provider.md b/packages/cli/package/docs/configs/provider.md index ec83cac72..27104c9f1 100644 --- a/packages/cli/package/docs/configs/provider.md +++ b/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 |