Function IsAPIName

shared/validate/validate.go:563–599

IsAPIName checks whether the provided value is a suitable name for an API object.

(value string, allowSlashes bool)

// IsAPIName checks whether the provided value is a suitable name for an API object.
func IsAPIName(value string, allowSlashes bool) error {
	// Limit length to 64 characters.
	if len(value) > 64 {
		return errors.New("Maximum name length is 64 characters")
	}

	// Check for unicode characters.
	for _, r := range value {
		if unicode.IsSpace(r) {
			return errors.New("Name cannot contain white space")
		}
	}

	// Check for special URL characters.
	reservedChars := []string{"$", "?", "&", "+", "\"", "'", "`", "*"}
	if !allowSlashes {
		reservedChars = append(reservedChars, "/")
	}

	for _, char := range reservedChars {
		if strings.Contains(value, char) {
			return fmt.Errorf("Name contains invalid character %q", char)
		}
	}

	// Check beginning and end.
	match, err := regexp.MatchString(`^[a-zA-Z0-9]+(.*[a-zA-Z0-9]+)?$`, value)
	if err != nil {
		return err
	}

	if !match {
		return errors.New("Names must start and end with an alphanumeric character")
	}

	return nil
}

// IsUUID validates whether a value is a UUID.
func IsUUID(value string) error {