larksuite/cli · error

%s field %q Description is required

Error message

%s field %q Description is required

What it means

Shape validation guard: a typed object field's Description is empty or whitespace-only; descriptions are required for generated schema/help quality.

Source

Thrown at shortcuts/common/typed_compile_data.go:311

			return fmt.Errorf("%s item lengths must be nonnegative", path)
		}
		if value.MinItems != nil && value.MaxItems != nil && *value.MinItems > *value.MaxItems {
			return fmt.Errorf("%s minItems exceeds maxItems", path)
		}
		return validateShape(value.Items, path+".Items")
	case typedObjectShape:
		seen := make(map[string]struct{})
		for i := range value.Fields {
			field := &value.Fields[i]
			if field.Name == "" {
				return fmt.Errorf("%s.Fields[%d].Name is required", path, i)
			}
			if _, duplicate := seen[field.Name]; duplicate {
				return fmt.Errorf("%s contains duplicate field %q", path, field.Name)
			}
			seen[field.Name] = struct{}{}
			if strings.TrimSpace(field.Description) == "" {
				return fmt.Errorf("%s field %q Description is required", path, field.Name)
			}
			if err := validateShape(field.Shape, path+"/"+field.Name); err != nil {
				return err
			}
		}
		if value.AdditionalPropertiesShape != nil && !value.AdditionalProperties {
			return fmt.Errorf("%s AdditionalPropertiesShape requires AdditionalProperties", path)
		}
		if value.AdditionalPropertiesShape != nil {
			return validateShape(value.AdditionalPropertiesShape, path+".AdditionalPropertiesShape")
		}
	case typedOneOfShape:
		if len(value.Variants) < 2 {
			return fmt.Errorf("%s oneOf requires at least two variants", path)
		}
		for i, variant := range value.Variants {
			if err := validateShape(variant, fmt.Sprintf("%s.Variants[%d]", path, i)); err != nil {
				return err

View on GitHub (pinned to 7fd6ef3c07)

Solutions

1. Add a Description to the field

When it happens

Trigger: Thrown at shortcuts/common/typed_compile_data.go:311 when the library encounters an invalid state.

Common situations: See trigger scenarios.

AI-assisted analysis of larksuite/cli@7fd6ef3c07 (2026-09-04). Data as JSON: /api/errors/8f50ed4c6f0c2bd7. Report an issue: GitHub.