[CAMEL-18066] OpenApi Specification Generator: Add support for discriminator for xOf

• Type: Improvement
• Status: Resolved
• Priority: Minor
• Resolution: Fixed
• Affects Version/s: 3.14.2
• Fix Version/s: 3.17.0
• Component/s: camel-openapi-java
• Estimated Complexity: Unknown
• Assignee: Unassigned
• Reporter: Johnathan Ingram
• Created: 05/May/22 23:40
• Updated: 09/May/22 07:22
• Resolved: 09/May/22 07:22

Description

Add support for the OpenApi spec 'discriminator' allowing for explicit selection of a schema type based on a property value.

https://redocly.com/docs/resources/discriminator/

 

This class 

@Schema(oneOf = { XOfFormA.class, XOfFormB.class },
        discriminatorProperty = "code",
        discriminatorMapping = {
                @DiscriminatorMapping(value = "a-123", schema = XOfFormA.class),
                @DiscriminatorMapping(value = "b-456", schema = XOfFormB.class) })
public interface OneOfForm {
    // The discriminator explicitly declares which property you can inspect to determine the object type.
    // The discriminator must apply to the same level of the schema it is declared in (common mistake when using nested objects).
} 

will generate

"components" : {
    "schemas" : {
      "OneOfForm" : {
        "oneOf" : [ {
          "$ref" : "#/components/schemas/XOfFormA"
        }, {
          "$ref" : "#/components/schemas/XOfFormB"
        } ],
        "discriminator" : {
          "propertyName" : "code",
          "mapping" : {
            "a-123" : "#/components/schemas/org.apache.camel.openapi.model.XOfFormA",
            "b-456" : "#/components/schemas/org.apache.camel.openapi.model.XOfFormB"
          }
        },

...

 

Issue Links

• links to: GitHub Pull Request #7568