Is there a way to add keepChars param for schema casing formatting?

[dlohvinov]

Hi!

I use openapi-format to convert schema from snake_case to camelCase, but i struggle with a parameter names which include . in it.

For instance, there are some parameters with the names like cursor.created_at which represent an object-like formatting:

cursor: {
  created_at,
}

and those parameter names are formatted to cursorCreatedAt, using dot notation as a separator.

I see, in case-anything casing converter there is a second config parameter with keep property.
More over, I assume that this param is supposed to be supported in casing.js util function, but I don't get it how can I pass this param in my openapi-format config file (or programmatic usage).

my .openapiformatrc looks like this:

{
  "casingSet": {
      "parametersQuery": "camelCase",
      "properties": "camelCase",
  },
  "filterSet": {
    "tags": ["Roles", "UserSettings"]
  }
}

[thim81]

hi @dlohvinov

I'll have to look into this, since the goal is to keep the openapi-format configuration simple.
The idea was that the casingSet option would case the full property name, without distinction.
The casingSet is a list of targets that will be matched and cased.

Looking at your use-case, you would want another option to define characters (like .) to keep.

I see 2 options:

• build-in . detection that gets preserved during casing (but that might cause unwanted side-effects for users who actually want to case the name, including the..
• a config option to define a "keep" character, which can be set per casingSet item, which makes the configuration more complex

{
  "casingSet": {
      "parametersQuery": "camelCase",
       "parametersQueryKeep": ".",
      "properties": "camelCase",
  },

Option 1 is not really an option, because of the uncontrollable side-effects it might bring.
Option 2, would be an "advanced" option, but it will make the configuration a bit more complex if you have to apply the "keep" for multiple properties.

Do you perhaps another idea or option to consider?