Skip to content

Commit 35d2452

Browse files
Copilothotlong
andcommitted
Improve .describe() strings based on code review feedback
Co-authored-by: hotlong <50353452+hotlong@users.noreply.github.com>
1 parent 9e63343 commit 35d2452

3 files changed

Lines changed: 4 additions & 4 deletions

File tree

packages/spec/src/cloud/marketplace.zod.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -213,7 +213,7 @@ export const MarketplaceListingSchema = z.object({
213213

214214
/** Current listing status */
215215
status: ListingStatusSchema.default('draft')
216-
.describe('Current listing status'),
216+
.describe('Publication state: draft, published, under-review, suspended, deprecated, or unlisted'),
217217

218218
/** Display name */
219219
name: z.string().describe('Display name'),

packages/spec/src/kernel/package-registry.zod.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -59,7 +59,7 @@ export const InstalledPackageSchema = z.object({
5959
* Current lifecycle status.
6060
*/
6161
status: PackageStatusEnum.default('installed')
62-
.describe('Current lifecycle status'),
62+
.describe('Package state: installed, disabled, installing, upgrading, uninstalling, or error'),
6363

6464
/**
6565
* Whether the package is currently enabled (active).

packages/spec/src/kernel/package-upgrade.zod.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -54,7 +54,7 @@ export const MetadataDiffItemSchema = z.object({
5454
name: z.string().describe('Metadata name'),
5555

5656
/** Type of change */
57-
changeType: MetadataChangeTypeSchema.describe('Type of change'),
57+
changeType: MetadataChangeTypeSchema.describe('Category of metadata modification (added, modified, removed, or renamed)'),
5858

5959
/** Whether this change has potential conflicts with customizations */
6060
hasConflict: z.boolean().default(false)
@@ -95,7 +95,7 @@ export const UpgradePlanSchema = z.object({
9595
toVersion: z.string().describe('Target upgrade version'),
9696

9797
/** Overall impact level */
98-
impactLevel: UpgradeImpactLevelSchema.describe('Overall upgrade impact level'),
98+
impactLevel: UpgradeImpactLevelSchema.describe('Severity assessment from none (seamless) to critical (breaking changes)'),
9999

100100
/** List of all metadata changes between versions */
101101
changes: z.array(MetadataDiffItemSchema).describe('All metadata changes'),

0 commit comments

Comments
 (0)