Schema specification for java.time

[claudioweiler]

Hi!

I'm migrating my OpenAPI specification from Swagger to MicroProfile.

I have some java.time objects that are generating schema definition differently, and I can't find why.

Let's stick with java.time.LocalDate for this scenario.

On Swagger it was generated always inline, as:

"schema": {
  "type": "string",
  "format": "date"
}

And on MicroProfile it is generated as:

"schema": {
    "format": "date",
    "type": "string",
    "example": "2022-03-10"
}

MicroProfile schemas are better handled as it shows examples, but it switch in generating schema inlined and referenced, like this:

"schema": {
  "$ref": "#/components/schemas/LocalDate"
}

So, my questions are:

1. Why is it generating inlined/referenced schemas for java.time definitions? (should I create an issue?)
2. Can I force behavior somehow?

[Azquelt]

The specification doesn't define whether schemas should be placed inline in the document or referenced since they're semantically the same. That choice is left up to the implementation.

I would ask this question to whichever MicroProfile implementation you're using. They should be able to say what strategy they use for creating schemas and may have a configuration option for it.

[claudioweiler]

Oh, got it. I think implementation is "wildfly-microprofile-openapi-smallrye-34.0.1".

Will take a look at RH github. Thanks.