Implement nullable refs

[BenMorel]

This is a follow-up to #670.

The idea is to transform a nullable property:

/**
 * @OA\Schema()
 */
class Reservation
{
    /**
     * @OA\Property()
     *
     * @var Deal|null
     */
    public $deal;
}

Into this:

components:
  schemas:
    Reservation:
      properties:
        deal:
          nullable: true
          allOf:
            -
              $ref: '#/components/schemas/Deal'

The implementation is simple:

• if the property types contain 'null': set nullable and allOf with ref
• else: set ref as usual

✅ No BC breaks
✅ Covered by tests

[BenMorel]

Any feedback here?

[BenMorel]

Bump.

[bfanger]

I noticed the allOf (which is correct btw) but I'd like to see oneOf and general support for the | operator, not just for null, for example:

/**
 * @var Deal|Scam
 */

Would generate:

       deal:
          oneOf:
            -
              $ref: '#/components/schemas/Deal'
            -
              $ref: '#/components/schemas/Scam'

Do you agree? and would you like to implement that feature?

[BenMorel]

I agree this would be nice, but I think that it is a separate issue that can be handled after the current PR is merged! I can work on it if you wish.

[bfanger]

Merged as 615941e
(I've changed allOf to oneOf, with only one entry it has the same meaning, but makes the aforementioned feature easier to implement)

Looking forward to your PR

[BenMorel]

Cool, thanks! I'll try to find some time this week to work on the generic union types.