Function commandInputSchemaFor

cmd/help_input_schema.go:10–84

(args []jsonCommandArg, flags []jsonCommandFlag)

)

func commandInputSchemaFor(args []jsonCommandArg, flags []jsonCommandFlag) jsonCommandInputSchema {
	schema := jsonCommandInputSchema{
		Type:                 "object",
		AdditionalProperties: false,
		Required:             []string{},
		Properties:           map[string]jsonCommandInputProperty{},
	}

	for _, arg := range args {
		name := commandInputPropertyName(arg.Name)
		property := jsonCommandInputProperty{
			Type:        commandInputPropertyType(arg.ValueKind, ""),
			Description: arg.Description,
			Enum:        sortedCopyStringSlice(arg.EnumValues),
			XCLIKind:    "arg",
			XCLIName:    arg.Name,
			XValueKind:  arg.ValueKind,
			XStreamDash: arg.StreamDash,
		}
		if arg.Variadic {
			property.Type = "array"
			property.Items = &jsonCommandInputProperty{
				Type: commandInputPropertyType(arg.ValueKind, ""),
				Enum: sortedCopyStringSlice(arg.EnumValues),
			}
			property.Enum = nil
			if arg.Required {
				property.MinItems = 1
			}
		}
		if format := commandInputPropertyFormat(arg.ValueKind); format != "" && !arg.Variadic {
			property.Format = format
		}
		schema.Properties[name] = property
		if arg.Required {
			schema.Required = append(schema.Required, name)
		}
	}

	for _, flag := range flags {
		if !commandInputSchemaIncludesFlag(flag) {
			continue
		}
		name := commandInputPropertyName(flag.Name)
		propertyType := commandInputPropertyType(flag.ValueKind, flag.Type)
		property := jsonCommandInputProperty{
			Type:        propertyType,
			Description: flag.Usage,
			Enum:        sortedCopyStringSlice(flag.EnumValues),
			XCLIKind:    "flag",
			XCLIName:    flag.Name,
			XValueKind:  flag.ValueKind,
			XSensitive:  flag.Sensitive,
			XConflicts:  commandInputPropertyNames(flag.Conflicts),
			XInherited:  flag.Inherited,
			XShorthand:  flag.Shorthand,
			XMayPrompt:  flag.MayPrompt,
		}