Plugin generates OpenAPI output that doesn't match spec

[dennisameling]

Hi! Consider the following OpenApiInfo configuration:

      javalinConfig.plugins.register(
            OpenApiPlugin(
                OpenApiPluginConfiguration()
                    .withDefinitionConfiguration { version: String, definition: DefinitionConfiguration ->
                        definition
                            .withOpenApiInfo { openApiInfo: OpenApiInfo ->
                                openApiInfo.title = "Demo"
                                openApiInfo.description = "This is a demo description."
                                openApiInfo.version = version
                            }
                    }
            )
        )

... which generates this output:

{
  "openapi" : "3.0.3",
  "info" : {
    "title" : "Demo API",
    "summary" : null,
    "description" : "This is a demo description.",
    "terms_of_service" : null,
    "contact" : null,
    "license" : null,
    "version" : "default"
  }
}

When pasting this into https://editor.swagger.io for example (or any OpenAPI spec validator), it fails on these things:

• summary and terms_of_service aren't part of the OpenAPI 3 spec
• info.contact and info.license are null but should either be left out completely or be objects

I'd expect the null values to be left out completely. Am I doing something wrong in my implementation?

Thanks!

[dzikoysk]

To be fair, I don't remember why we have these properties. I think it might be a good idea to filter them from scheme.

[dzikoysk]

It looks like those summary & termsOfService are a part of 3.1.0:

• https://spec.openapis.org/oas/v3.1.0#info-object
• https://swagger.io/specification/#info-object

But terms_of_service should be termsOfService. It seems like you're using different configuration of ObjectMapper in Javalin, because by default it's in a proper form:

[dennisameling]

Ah sorry, my bad indeed! Thanks a lot for looking into it 😊