Kotlin: Generating 'required' schema attribute?

[yahorbarkouski]

Hey! Wondering if it's possible to generate a schema with 'required' attribute like in the following output:

"schema": {
  "type": "object",
  "properties": {
    "steps": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "explanation": {
            "type": "string"
          },
          "output": {
            "type": "string"
          }
        },
        "required": ["explanation", "output"], <- THIS LINE
        "additionalProperties": false
      }
    },
    "final_answer": {
      "type": "string"
    }
  },
  "required": ["steps", "final_answer"], <- THIS LINE
  "additionalProperties": false
}

If so, what option/setting should I use?

I was trying to do so by using withRequiredCheck (even added NotNull JetBrains annotations:)), but no luck:

val configBuilder = SchemaGeneratorConfigBuilder(DRAFT_2020_12, PLAIN_JSON)
      .with(FORBIDDEN_ADDITIONAL_PROPERTIES_BY_DEFAULT)
     
configBuilder.forFields()
      .withRequiredCheck(FieldRequiredCheck { field: Field -> field.isAnnotationPresent(NotNull::class.java) })

[CarstenWickner]

HI @yahorbarkouski,

Generally, yes: the withRequiredCheck() is the correct place to configure this.
The example in the documentation is very similar to yours: https://victools.github.io/jsonschema-generator/#quot-required-quot-keyword

configBuilder.forFields()
    .withRequiredCheck(field -> field.getAnnotationConsideringFieldAndGetter(Nullable.class) == null);

---

However from your code snippet, I assume you are using Kotlin.
If that is the case, you are most likely affected by the same curious Kotlin behaviour as described on #358
If you annotate a field just with:

@NotNull
val field: String

The compiled Java code (that is being analysed by this jsonschema-generator library here), will treat the annotation as being present in a different place.
Instead, you would have to add an explicit prefix to indicate where the annotation shall be added in the compiled Java code, e.g.

@field:NotNull
val field: String

I would expect your configuration to work as expected then.

[yahorbarkouski]

@CarstenWickner @field:NotNull doesn't work, unfortunately, but I get the direction, thank you so much!