[scala][http4s] fix escaping of reserved words for correct model dese…

[donilg]

There is an example of correct openAPI specification:

{
  "openapi": "3.0.0",
  "info": {
    "title": "Simple API",
    "description": "A simple API with GET and POST endpoints",
    "version": "1.0.0"
  },
  "servers": [
    {
      "url": "https://api.example.com/v1"
    }
  ],
  "paths": {
    "/users": {
      "get": {
        "summary": "Method that has models with a reserved word",
        "parameters": [
          {
            "name": "typeName",
            "in": "query",
            "description": "param",
            "required": true,
            "schema": {
              "type": "string",
              "enum": [
                "active",
                "inactive",
                "pending"
              ]
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Successful response",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/User"
                }
              }
            }
          }
        }
      }
    }
  },
  "components": {
    "schemas": {
      "User": {
        "type": "object",
        "properties": {
          "type": {
            "type": "string",
            "enum": [
              "active",
              "inactive",
              "pending"
            ]
          }
        },
        "required": [
          "type"
        ]
      }
    }
  }
}

JSON response is generated for this OpenAPI specification:

{"_type":"active"}

This is incorrect since we specified that the field should be named type, not _type.
I changed the escaping of reserved words to standard Scala backticks notation so that the JSON decoder could properly map the domain to JSON.

{"type":"active"}

PR checklist

• Read the contribution guidelines.
• Pull Request title clearly describes the work in the pull request and Pull Request description provides details about how to validate the work. Missing information here may result in delayed response from the community.
• Run the following to build the project and update samples:

  ./mvnw clean package || exit
  ./bin/generate-samples.sh ./bin/configs/*.yaml || exit
  ./bin/utils/export_docs_generators.sh || exit
  

• File the PR against the correct branch: master (upcoming 7.x.0 minor release - breaking changes with fallbacks), 8.0.x (breaking changes without fallbacks)
• If your PR is targeting a particular programming language, @mention the technical committee members, so they are more likely to review the pull request.

Hello! 👋
I'd love to get your eyes on this PR when you have a moment.
Thanks in advance!

@clasnake (2017/07), @shijinkui (2018/01), @ramzimaalej (2018/03), @chameleon82 (2020/03), @Bouillie (2020/04) @Fish86 (2023/06)

[wing328]

thanks for the pr

can you please review the CI build failure when you've time?

[wing328]

instead of overriding processCompiler, what about adding lambda function to additional properties?

e.g. https://github.com/OpenAPITools/openapi-generator/blob/master/modules/openapi-generator/src/main/java/org/openapitools/codegen/languages/ScalaSttpClientCodegen.java#L118-L123

[donilg]

I created

    private static class BacktickLambda extends AbstractScalaCodegen.CustomLambda {
        @Override
        public String formatFragment(String fragment) {
            if (fragment.startsWith("`") && fragment.endsWith("`")) {
                String unescaped = fragment.substring(1, fragment.length() - 1);
                return "`" + Escapers.HTML.escape(unescaped) + "`";
            }
            return Escapers.HTML.escape(fragment);
        }
    }

added it to the properties

additionalProperties.put("fnBacktick", new BacktickLambda());

After that, I used it in the templates

{{#fnBacktick}}{{paramName}}{{/fnBacktick}}

and I ended up with non-compiling code

case class User(
  `type`: String
)

[donilg]

I found solution about overriding processCompiler here

https://github.com/OpenAPITools/openapi-generator/blob/master/modules/openapi-generator/src/main/java/org/openapitools/codegen/languages/AbstractScalaCodegen.java#L325-L344

[wing328]

RE:

{{#fnBacktick}}{{paramName}}{{/fnBacktick}}

what about using the following instead to use the original value instead of HTML-escaped value?

{{#fnBacktick}}{{{paramName}}}{{/fnBacktick}}

[donilg]

done