Need to introduce inheritance in spec to replace polymorphism in NumberVerificationRequestBody

[patrice-conil]

Problem description
As PhoneNumber and HashedPhoneNumber don't extends NumberVerificationRequestBody a client using strongly typed language must have to serialize its request by hand.

Expected behavior
I want to be able to inject my PhoneNumber or HashedPhoneNumber as NumberVerificationRequestBody

Alternative solution

    NumberVerificationRequestBody:
      allOf:
        - $ref: '#/components/schemas/PhoneNumber'
      description: Payload to verify the phone number
      example:
        phoneNumberType: RegularPhoneNumber
        phoneNumber: "+33601020304"
    PhoneNumber:
      type: object
      properties:
        phoneNumberType:
          type: string
      discriminator:
        propertyName: phoneNumberType
        mapping:
          RegularPhoneNumber: '#/components/schemas/RegularPhoneNumber'
          HashedPhoneNumber: '#/components/schemas/HashedPhoneNumber'

    RegularPhoneNumber:
      allOf:
        - $ref: '#/components/schemas/PhoneNumber'
        - type: object
          properties:
            phoneNumber:
              description: A phone number belonging to the user in **E.164 format (starting with country code)**. Optionally prefixed with '+'.
              type: string
              example: '+346661113334'
    HashedPhoneNumber:
      allOf:
        - $ref: '#/components/schemas/PhoneNumber'
        - type: object
          properties:
            hashedPhoneNumber:
              description: Hashed phone number. SHA-256 (in hexadecimal representation) of the mobile phone number in **E.164 format (starting with country code)**. Optionally prefixed with '+'.
              type: string
              example: 32f67ab4e4312618b09cd23ed8ce41b13e095fe52b73b2e8da8ef49830e50dba

Additional context
This evolution is conform to PR #22 in commonallities

[jlurien]

I understand the issue. If the aim is to send one or the other, an alternative may be to define them as optional properties, indicating that one and only one is expected:

  schemas:
    NumberVerificationRequestBody:
      type: object
      description: Payload to verify the phone number
      minProperties: 1
      maxProperties: 1
      properties:
        phoneNumber:
          description: A phone number belonging to the user in **E.164 format (starting with country code)**. Optionally prefixed with '+'.
          type: string
          example: '+346661113334'
        hashedPhoneNumber:
          description: Hashed phone number. SHA-256 (in hexadecimal representation) of the mobile phone number in **E.164 format (starting with country code)**. Optionally prefixed with '+'.
          type: string
          example: 32f67ab4e4312618b09cd23ed8ce41b13e095fe52b73b2e8da8ef49830e50dba

[patrice-conil]

Hi @jlurien,
Nice solution and because simpler is better, I vote for 😄

[jlurien]

If OK, I can do a PR

[patrice-conil]

Hi @jlurien it's ok for me