Manually edited oneOf in response schema is overridden

[simba909]

I'm evaluating this gem for a project I'm working on and it looks much nicer than rswag. Well done! 👏🏻

Sorry for the long message that follows.

Now, my Rails app has a model that itself has a property that can be an instance of several different sub-models. The JSON for this can look something like:

{
  "name": "some_name",
  "data": {
    "email": "someone@example.com"
  }
}

or:

{
  "name": "some_name",
  "data": {
    "selfie_url": "https://somewhere.com/public/image.jpg"
  }
}

I have request specs that return both variants of this model. By default rspec-openapi generates an OpenAPI spec that looks something like this:

components:
  schemas:
    MyModel:
      type: object
      properties:
        name:
          type: string
        data:
          type: object
          properties:
            email:
              nullable: true
            selfie_url:
              nullable: true

Which is fine but not quite what I want. I'd like to use the oneOf keyword to differentiate the response types. So I edit my OpenAPI spec to look like this:

components:
  schemas:
    MyModel:
      type: object
      properties:
        name:
          type: string
        data:
          oneOf:
            - type: object
              properties:
                email:
                  type: string
                  format: email
            - type: object
               properties:
                 selfie_url:
                   type: string
                   format: uri

But when I rerun the spec generation, rspec-openapi alters the spec to this:

components:
  schemas:
    MyModel:
      type: object
      properties:
        name:
          type: string
        data:
          oneOf:
            - type: object
              properties:
                email:
                  type: string
                  format: email
            - type: object
               properties:
                 selfie_url:
                   type: string
                   format: uri
            type: object
            properties:
              email:
                nullable: true
              selfie_url:
                nullable: true

Notice that it keeps my oneOf: but adds back the sub-model with all properties being nullable. Is this a known limitation or something I'm doing wrong?

[hss-mateus]

Same issue here. Reading through the source code it seems that this case isn't handled.
A possible implementation is to find the most similar schema, merge it, and if no schema is sufficiently similar, a new option is added to oneOf.

[exoego]

        data:
          oneOf:
            - type: object
              properties:
                email:
                  type: string
                  format: email
            - type: object
               properties:
                 selfie_url:
                   type: string
                   format: uri
            type: object
            properties:
              email:
                nullable: true
              selfie_url:
                nullable: true

It looks weird. oneOf mixes array elements - ... and object properties type: ....
Was that YAML/JSON generated?

[hss-mateus]

yes, it preserves the array elements and also adds the generated object

[exoego]

Closed by #174
Thanks, @hss-mateus