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?

[MikeEdgar]

Hi @claudioweiler , generally speaking, the code scanner will place reusable schemas under #/components/schemas and reference them rather than duplicating them throughout the OpenAPI document. Are the references breaking something in how you use the OpenAPI?

[claudioweiler]

Hi @MikeEdgar !

No, no breakings. It's just awkward that some definitions are inlined and others referenced, for the very same type.

Personally, I prefer inlined/embedded schemas for default date-time types. But if it's is possible to ensure that same behavior is consistent, even with refs, I can work with this.