Components fields name too restrictive? #1387
Labels
clarification
requests to clarify, but not change, part of the spec
examples
requests for more or better examples in the specification
Components fields name currently has this regex as restrictions:
^[a-zA-Z0-9\.\-_]+$
This was mainly discussed and agreed on in #634.
I found this restriction a little too restrictive. I'd imagine that for the Schemas part of the component, most people will use class names as field names. Allowing the period (.) is good because that allows you to add namespace to class name
Namespace.ClassName
.However, quite a number of languages have generics and APIs can have request body that are of type implementing generics. The current allowed characters make it very difficult to represent class name that is derived from generic type. The most intuitive (I think) way to represent generic class name as string is to use some kind of brackets/parentheses
Namespace.GenericClassName(AnotherClassName)
. Of course, one can bypass this by using the allowed underscore or hyphen instead, but that just looks plain ugly.Should we allow parentheses and/or brackets?
The text was updated successfully, but these errors were encountered: