v7.0.1 Usage Question: reserved word mapping with custom templates

[PRTGC]

Description

I have a set of custom templates for generating rust code.
It is based of v5.4 rust / request client templates.

Generating code with openapi definition with properties like 'type' works with
the standard v7.0.1 generation, but not with my custom template.
I have a configuration file with all kinds of options set.
Like

# java -jar openapi-generator-cli-5.4.0.jar generate -c d42/OpenAPI_Gen.yml --skip-validate-spec > d42\Generated.out
#  --global-propery apiDocs=false,apiTests=true,modelDocs=false,modelTests=true
generatorName: rust
outputDir: d42
library: reqwest
#direct 
inputSpec: d42/device42.yaml
#inputSpec: d42\spec2.json
templateDir: ../openapi_templates5/
skipFormModel: false
apiDocs: false
apiTests: true
modelDocs: false
modelTests: true
#reserved-words-mappings: type=r#type
files: # https://openapi-generator.tech/docs/customization/
  impl/api_impl.mustache:
    templateType: API
    folder: src/api_impl
    destinationFilename: _impl.rs_
  impl/model_impl.mustache:
    templateType: Model
    folder: src/model_impl
    destinationFilename: _impl.rs_
  impl/errors_impl.mustache:
    templateType: SupportingFiles
    folder: src/model_impl
    destinationFilename: errors_impl.rs_
  impl/api_mod_impl.mustache:
    destinationFilename: mod.rs_
    templateType: SupportingFiles
    folder: src/api_impl
  impl/model_mod_impl.mustache:
    destinationFilename: mod.rs_
    templateType: SupportingFiles
    folder: src/model_impl
  impl/warp_impl.mustache:
    destinationFilename: warp_impl.rs_
    templateType: SupportingFiles
    folder: src
  impl/sensor_impl.mustache:
    destinationFilename: sensor_impl.rs_
    templateType: SupportingFiles
    folder: src
  impl/build.mustache:
    destinationFilename: build.rs_
    templateType: SupportingFiles
  impl/main_impl.mustache:
    destinationFilename: src/main.rs_
    templateType: SupportingFiles
additionalProperties:
  vendorExtensions.x-outputDir: d42
  httpUserAgent: prtgclib_rust
  vendorExtensions.x-gen-exe: prtgc_d42
  supportAsync: true
  supportMultipleResponses: true
  packageName: prtgclib_d42api
  packageVersion: 0.2.33
  vendorExtensions.x-moahclient: true

Exception in thread "main" java.lang.RuntimeException: Could not generate model 'device'
        at org.openapitools.codegen.DefaultGenerator.generateModels(DefaultGenerator.java:583)
        at org.openapitools.codegen.DefaultGenerator.generate(DefaultGenerator.java:960)
        at org.openapitools.codegen.cmd.Generate.execute(Generate.java:511)
        at org.openapitools.codegen.cmd.OpenApiGeneratorCommand.run(OpenApiGeneratorCommand.java:32)
        at org.openapitools.codegen.OpenAPIGenerator.main(OpenAPIGenerator.java:66)
Caused by: java.lang.RuntimeException: reserved word type not allowed

How to I force the generator to use the standard rust reserved word substitution?

openapi-generator version

v 7.0.1

OpenAPI declaration file content or url

https://api.device42.com/device42.yaml

Command line used for generation

java -jar ../openapi-generator-cli-7.0.1.jar generate -c d42/OpenAPI_Gen.yml --skip-validate-spec > d42\Generated.out

Related issues/PRs

#16103

[wing328]

It is based of v5.4 rust / request client templates.

what about upgrading to the latest stable version instead of using an old version released 2 years ago?

[PRTGC]

Well, that is what I'm trying to do...
The issue has been the problems with the reserved words.
Every update since 6.0 I tried running it, and got the 'type' exception .
The modified templates should be fine as is.
The question is why is it not using the reserved word substitution.
Is there a parameter or cfg entry to control it ?
Or more over, why is it not using the translation ?

[wing328]

Generating code with openapi definition with properties like 'type' works with
the standard v7.0.1 generation, but not with my custom template.

without the custom template, it's pretty much impossible to troublehshoot.

What issue did you run into using the default template? mind sharing with us what you don't like?

[wing328]

as you probably aware, you can may the property name to something else using the nameMappings option

are you using the latest master? the option was added to rust abstract codegen recenlty if I remember correctly

[PRTGC]

Hi...
Thanks for getting back to me..

The only real question I have is...
What controls the "reserved word" substitution ?
How do I enable/disable the reserved word substitution when generating rust code ?
There must be something in my config file that overrides or disables the substitution.
(Both command line and config file)

The PR list the command-line arguments for substitution as:
--name-mappings type=underscoreType, type=typeWithUnderscore

I tried :
--name-mappings type=r#type
Which did not work

I did a diff on the v5.4.0 and v7.0.1 templates, there are not much that is different.
And nothing that would indicate the difference in substitution.

If there is something in the templates that actually controls the reserved word substitution, I'll have to make a subset
that compiles without my internal libraries...

[wing328]

The PR list the command-line arguments for substitution as:

which version of openapi-generator are you using?

[PRTGC]

I am trying to run v7.0.1
java -jar openapi-generator-cli-7.0.1.jar generate -c d42/OpenAPI_Gen.yml --name-mappings type=r#type

[wing328]

please try the latest master instead as the name mapping support in rust generators was added after v7.0.1 release

[PRTGC]

I will do that...
The crazy thing is that it works with the plain call in the release version.
But it does not work with the modified templates

[PRTGC]

same result with:
java -jar openapi-generator-cli-7.1.0.jar generate -c d42/OpenAPI_Gen.yml --skip-validate-spec --name-mappings type=r#type

[wing328]

latest master - not latest stable version

you can find the snapshot version in https://oss.sonatype.org/content/repositories/snapshots/org/openapitools/openapi-generator-cli/7.2.0-SNAPSHOT/

[PRTGC]

I'll try that...
Here is another crazy one...
When I turn on verbose I get:

[main] WARN  o.o.c.languages.AbstractRustCodegen - type cannot be used as a field/variable name. Renamed to r#type
[main] WARN  o.o.c.languages.AbstractRustCodegen - type cannot be used as a field/variable name. Renamed to r#type
[main] WARN  o.o.c.languages.AbstractRustCodegen - type cannot be used as a field/variable name. Renamed to r#type
[main] WARN  o.o.c.languages.AbstractRustCodegen - type cannot be used as a field/variable name. Renamed to r#type
[main] WARN  o.o.c.languages.AbstractRustCodegen - type cannot be used as a field/variable name. Renamed to r#type
[main] WARN  o.o.c.languages.AbstractRustCodegen - type cannot be used as a field/variable name. Renamed to r#type
[main] WARN  o.o.c.languages.AbstractRustCodegen - type cannot be used as a field/variable name. Renamed to r#type
[main] WARN  o.o.c.languages.AbstractRustCodegen - type cannot be used as a field/variable name. Renamed to r#type
[main] WARN  o.o.c.languages.AbstractRustCodegen - type cannot be used as a field/variable name. Renamed to r#type
[main] WARN  o.o.c.languages.AbstractRustCodegen - where cannot be used as a field/variable name. Renamed to r#where
[main] WARN  o.o.c.languages.AbstractRustCodegen - where cannot be used as a field/variable name. Renamed to r#where
[main] WARN  o.o.c.languages.AbstractRustCodegen - where cannot be used as a field/variable name. Renamed to r#where

So I guess the question is... why do we still get this one:

Exception in thread "main" java.lang.RuntimeException: Could not generate model 'device'
        at org.openapitools.codegen.DefaultGenerator.generateModels(DefaultGenerator.java:592)
        at org.openapitools.codegen.DefaultGenerator.generate(DefaultGenerator.java:991)
        at org.openapitools.codegen.cmd.Generate.execute(Generate.java:519)
        at org.openapitools.codegen.cmd.OpenApiGeneratorCommand.run(OpenApiGeneratorCommand.java:32)
        at org.openapitools.codegen.OpenAPIGenerator.main(OpenAPIGenerator.java:66)
Caused by: java.lang.RuntimeException: reserved word type not allowed
        at org.openapitools.codegen.DefaultCodegen.escapeReservedWord(DefaultCodegen.java:1732)
        at org.openapitools.codegen.templating.mustache.LowercaseLambda.execute(LowercaseLambda.java:57)
        at com.samskivert.mustache.Mustache$SectionSegment.execute(Mustache.java:949)
        at com.samskivert.mustache.Template.executeSegs(Template.java:170)
        at com.samskivert.mustache.Mustache$IncludedTemplateSegment.execute(Mustache.java:831)
        at com.samskivert.mustache.Mustache$BlockSegment.executeSegs(Mustache.java:920)
        at com.samskivert.mustache.Mustache$SectionSegment.execute(Mustache.java:941)
        at com.samskivert.mustache.Mustache$BlockSegment.executeSegs(Mustache.java:920)
        at com.samskivert.mustache.Mustache$InvertedSegment.execute(Mustache.java:992)
        at com.samskivert.mustache.Mustache$BlockSegment.executeSegs(Mustache.java:920)
        at com.samskivert.mustache.Mustache$InvertedSegment.execute(Mustache.java:988)
        at com.samskivert.mustache.Mustache$BlockSegment.executeSegs(Mustache.java:920)
        at com.samskivert.mustache.Mustache$SectionSegment.execute(Mustache.java:956)
        at com.samskivert.mustache.Mustache$BlockSegment.executeSegs(Mustache.java:920)
        at com.samskivert.mustache.Mustache$SectionSegment.execute(Mustache.java:941)
        at com.samskivert.mustache.Template.executeSegs(Template.java:170)
        at com.samskivert.mustache.Template.execute(Template.java:137)
        at com.samskivert.mustache.Template.execute(Template.java:128)
        at org.openapitools.codegen.templating.MustacheEngineAdapter.compileTemplate(MustacheEngineAdapter.java:65)
        at org.openapitools.codegen.TemplateManager.write(TemplateManager.java:163)
        at org.openapitools.codegen.DefaultGenerator.processTemplateToFile(DefaultGenerator.java:1140)
        at org.openapitools.codegen.DefaultGenerator.processTemplateToFile(DefaultGenerator.java:1127)
        at org.openapitools.codegen.DefaultGenerator.generateModel(DefaultGenerator.java:431)
        at org.openapitools.codegen.DefaultGenerator.generateModels(DefaultGenerator.java:583)

[PRTGC]

Using latest snapshot: generator-cli-7.2.0-20231212.145822-96.jar

  at org.openapitools.codegen.DefaultGenerator.generate(DefaultGenerator.java:1235)
    at org.openapitools.codegen.cmd.Generate.execute(Generate.java:527)
    at org.openapitools.codegen.cmd.OpenApiGeneratorCommand.run(OpenApiGeneratorCommand.java:32)
    at org.openapitools.codegen.OpenAPIGenerator.main(OpenAPIGenerator.java:66)

Caused by: java.lang.RuntimeException: reserved word type not allowed
at org.openapitools.codegen.DefaultCodegen.escapeReservedWord(DefaultCodegen.java:1752)
at org.openapitools.codegen.templating.mustache.LowercaseLambda.execute(LowercaseLambda.java:57)
at com.samskivert.mustache.Mustache$SectionSegment.execute(Mustache.java:949)
at com.samskivert.mustache.Template.executeSegs(Template.java:170)
at com.samskivert.mustache.Mustache$IncludedTemplateSegment.execute(Mustache.java:831)
at com.samskivert.mustache.Mustache$BlockSegment.executeSegs(Mustache.java:920)
at com.samskivert.mustache.Mustache$SectionSegment.execute(Mustache.java:941)
at com.samskivert.mustache.Mustache$BlockSegment.executeSegs(Mustache.java:920)
at com.samskivert.mustache.Mustache$InvertedSegment.execute(Mustache.java:992)
at com.samskivert.mustache.Mustache$BlockSegment.executeSegs(Mustache.java:920)
at com.samskivert.mustache.Mustache$InvertedSegment.execute(Mustache.java:988)
at com.samskivert.mustache.Mustache$BlockSegment.executeSegs(Mustache.java:920)
at com.samskivert.mustache.Mustache$SectionSegment.execute(Mustache.java:956)

[wing328]

at org.openapitools.codegen.DefaultCodegen.escapeReservedWord(DefaultCodegen.java:1752)
at org.openapitools.codegen.templating.mustache.LowercaseLambda.execute(LowercaseLambda.java:57)

my guess is that you're using {{baseName}} (instead of {{name}}) inside the lower case lambda mustache handler

again without the custom templates, hard to tell the exact cause.