[REQ] Add x-field-extra-annotation for "kotlin" generator

[alex-semenk]

Is your feature request related to a problem? Please describe.

Currently java generator (as well as some other generators) has x-field-extra-annotation feature, which allows to annotate Java fileds for any model class, generated from openapi spec. You can find description of x-field-extra-annotation property in openapi-generator docs https://openapi-generator.tech/docs/generators/java/
Currently kotlin generator doesn't support this feature as you can find in docs https://openapi-generator.tech/docs/generators/kotlin/

Describe the solution you'd like

The request is to add support for x-field-extra-annotation feature for "kotlin" generator. So kotlin models can be generated with additional field annotations. This is especially vital when you need to provide custom @JsonSerialize or JsonDeserialize annotation to deserialize or serialize model correctly. Currently I didn't found any workaround to provide custom JsonSerialize/JsonDeserialize annotations for model fields.

Describe alternatives you've considered

The only alternative solution I can see so far is to define customized template for kotlin model generator, to manually add support for x-field-extra-annotation attribute.

Additional context

Here is an example of openapi spec and expected generated model

OpenAPI spec:

Account:
  type: "object"
  required:
    - "name"
    - "assets"
  properties:
    name:
      type: "string"
    assets:
      type: "object"
      additionalProperties:
        type: "string"
      x-field-extra-annotation: "@JsonDeserialize(converter = AssetConverter::class)"

Generated Model:

data class Account (

    @field:JsonProperty("name")
    val name: kotlin.String,

    @field:JsonProperty("assets")
    @JsonDeserialize(converter = AssetConverter::class)
    val assets: Map<String, String>
)

[wing328]

@alex-semenk thanks for the suggestion. May I know if you've time to contribute a PR for that?

[alex-semenk]

@wing328 Sure, I think I might find some time a little later to add the feature. I will let you know when I will have some progress on this.

[Oleksii-Hovderchak]

Hello, is it planned? I see it's available in the documentation: https://openapi-generator.tech/docs/generators/java/
but adding class or field level configs has zero effect

[alex-semenk]

Hi @Oleksii-Hovderchak the documentation you provided is for "java" generator, however current issue is open for "kotlin" generator. For which generator are you missing "x-field-extra-annotation" feature?

[Fitpet-Jake]

Does not support kotlin generator "x-field-extra-annotation"?

[aldex32]

unfortunately kotlin is lagging behind :-(

[alarv]

+1

[alarv]

+1

[dzmitry-ivanou]

Hi @Oleksii-Hovderchak the documentation you provided is for "java" generator, however current issue is open for "kotlin" generator. For which generator are you missing "x-field-extra-annotation" feature?

Would it work for kotlin-spring?
The x-... extensions are defined in https://openapi-generator.tech/docs/generators/kotlin-spring/

[alarv]

Just tested on the latest openapi version id("org.openapi.generator") version "7.9.0" and this works! Don't know who implemented it but thanks!

[alex-semenk]

Hi, I've tried to update to latest version id("org.openapi.generator") version "7.9.0", however x-field-extra-annotation still doesn't work for me.
I also can't see it in kotlin generator documentation https://openapi-generator.tech/docs/generators/kotlin/
And can't see field being added to mustache templates in repository for kotlin.

@alarv are use sure annotations where added for you to generated classes?

[alarv]

Hi, I've tried to update to latest version id("org.openapi.generator") version "7.9.0", however x-field-extra-annotation still doesn't work for me. I also can't see it in kotlin generator documentation https://openapi-generator.tech/docs/generators/kotlin/ And can't see field being added to mustache templates in repository for kotlin.

@alarv are use sure annotations where added for you to generated classes?

Hi @alex-semenk, yes it works for me like this:

     dataObjects:
          type: array
          items:
            $ref: '#/components/schemas/EntitySchema'
          x-field-extra-annotation: "@get:org.mysite.api.service.model.constraints.ValidEntity"

[alex-semenk]

@alarv I tried this code but it still doesn't generate annotation for me. The generated code looks like this

@get:JsonProperty("dataObjects")
val dataObjects: kotlin.collections.List<EntitySchema>? = null,