Allow uppercase letters(A-Z) for document keys (#483)

To support capital letters, an additional rule, case_sensitive_slug is added.

internal/validation/validation.go

@@ -33,6 +33,7 @@ const (
 	// (https://datatracker.ietf.org/doc/html/rfc3986#section-2.3)
 	// and copied from https://gist.github.com/dpk/4757681
 	slugRegexString                   = `^[a-z0-9\-._~]+$`
+	caseSensitiveSlugRegexString      = `^[a-zA-Z0-9\-._~]+$`
 	containAlphaRegexString           = `[a-zA-Z]`
 	containNumberRegexString          = `[0-9]`
 	containSpecialCharRegexString     = `[\{\}\[\]\/?.,;:|\)*~!^\-_+<>@\#$%&\\\=\(\'\"\x60]`
@@ -42,6 +43,7 @@ const (
 
 var (
 	slugRegex                   = regexp.MustCompile(slugRegexString)
+	caseSensitiveSlugRegex      = regexp.MustCompile(caseSensitiveSlugRegexString)
 	containAlphaRegex           = regexp.MustCompile(containAlphaRegexString)
 	containNumberRegex          = regexp.MustCompile(containNumberRegexString)
 	containSpecialCharRegex     = regexp.MustCompile(containSpecialCharRegexString)
@@ -234,6 +236,14 @@ func init() {
 	})
 	RegisterTranslation("slug", "{0} must only contain letters, numbers, hyphen, period, underscore, and tilde")
 
+	RegisterValidation("case_sensitive_slug", func(level validator.FieldLevel) bool {
+		val := level.Field().String()
+		return caseSensitiveSlugRegex.MatchString(val)
+	})
+	RegisterTranslation(
+		"case_sensitive_slug",
+		"{0} must only contain case-sensitive letters, numbers, hyphen, period, underscore, and tilde")
+
 	RegisterValidation("alpha_num_special", func(level validator.FieldLevel) bool {
 		val := level.Field().String()
 		return hasAlphaNumSpecial(val)

internal/validation/validation_test.go

@@ -36,6 +36,15 @@ func TestValidation(t *testing.T) {
 		err = ValidateValue("invalid-key-$-wrong-string-value", "required,slug,min=4,max=30")
 		assert.Equal(t, err.(Violation).Tag, "slug")
 
+		err = ValidateValue("Invalid-Key", "required,slug,min=4,max=30")
+		assert.Equal(t, err.(Violation).Tag, "slug")
+
+		err = ValidateValue("Valid-Doc-Key", "required,case_sensitive_slug,min=4,max=30")
+		assert.Nil(t, err, "Valid document Key with case-sensitive letters")
+
+		err = ValidateValue("Invalid Doc Key", "required,case_sensitive_slug,min=4,max=30")
+		assert.Equal(t, err.(Violation).Tag, "case_sensitive_slug")
+
 		err = ValidateValue("1h30m20s", "duration,min=2")
 		assert.Nil(t, err, "valid time duration string format")
 

pkg/document/key/key.go

@@ -41,7 +41,7 @@ func (k Key) String() string {
 func (k Key) Validate() error {
 	if err := validation.Validate(k.String(), []any{
 		"required",
-		"slug",
+		"case_sensitive_slug",
 		"min=4",
 		"max=120",
 	}); err != nil {

pkg/document/key/key_test.go

@@ -36,6 +36,9 @@ func TestKey(t *testing.T) {
 
 		err = Key("-----_________________-a").Validate()
 		assert.Nil(t, err, "key should be valid")
+
+		err = Key("Capital-Character-Key").Validate()
+		assert.Nil(t, err, "key should be valid")
 	})
 
 	t.Run("invalid key test", func(t *testing.T) {