[Changed] Refactor MatchRequestBody‎ to allow proper schema validation for provided identifier

code/API_definitions/device-identifier.yaml

@@ -354,13 +354,13 @@ paths:
             schema:
               $ref: "#/components/schemas/MatchRequestBody"
             examples:
-              Match Device By 3-Legged Access Token:
+              Match Device IMEISV By 3-Legged Access Token:
                 $ref: '#/components/examples/MatchDeviceBy3LeggedToken'
-              Match Device By Phone Number:
+              Match Device IMEI By Phone Number:
                 $ref: '#/components/examples/MatchDeviceByPhoneNumber'
-              Match Device By IP Address:
+              Match Device TAC By IP Address:
                 $ref: '#/components/examples/MatchDeviceByIPAddress'
-              Match Device By Multiple Identifiers:
+              Match Device IMEISV By Multiple Identifiers:
                 $ref: '#/components/examples/MatchDeviceByMultipleIdentifiers'
 
       responses:
@@ -636,6 +636,62 @@ components:
                 message: The provided identifier cannot be matched to a device.
 
   schemas:
+    Imei:
+      description: Schema for the International Mobile Equipment Identity (IMEI) of a physical mobile device
+      type: string
+      minLength: 15
+      maxLength: 15
+      pattern: ^[0-9]{15}$
+      example: "490154203237518"
+
+    ImeiSv:
+      description: Schema for the International Mobile Equipment Identity - Software Version (IMEISV) of a physical mobile device
+      type: string
+      minLength: 16
+      maxLength: 16
+      pattern: ^[0-9]{16}$
+      example: "4901542032375180"
+
+    Tac:
+      description: Schema for the IMEI Type Allocation Code (TAC) of a physical mobile device
+      type: string
+      minLength: 8
+      maxLength: 8
+      pattern: ^[0-9]{8}$
+      example: "49015420"
+
+    Ppid:
+      description: Schema for the Pairwise Pseudonymous Identifier (PPID) of a physical mobile device
+      type: string
+      minLength: 64
+      maxLength: 128
+      pattern: ^[a-fA-F0-9]{64,128}$
+      example: "b083f65ccdad365d7489fff24b6d5074b30c12b6d81db3404d25964ffd908813"
+
+    RequestBody:
+      description: Common request body to allow optional Device object to be passed
+      type: object
+      properties:
+        device:
+          $ref: "../common/CAMARA_common.yaml#/components/schemas/Device"
+
+    MatchRequestBody:
+      description: Request body for match-identifier operation, containing an optional mobile device subscription identifier, and the physical device identifier to match against
+      allOf:
+        - $ref: "#/components/schemas/RequestBody"
+        - type: object
+          oneOf:
+            - required: [imeisv]
+            - required: [imei]
+            - required: [tac]
+          properties:
+            imeisv:
+              $ref: "#/components/schemas/ImeiSv"
+            imei:
+              $ref: "#/components/schemas/Imei"
+            tac:
+              $ref: "#/components/schemas/Tac"
+
     CommonResponseBody:
       description: |
         Common parameters to be included in all responses
@@ -661,17 +717,9 @@ components:
       type: object
       properties:
         imeisv:
-          type: string
-          maxLength: 16
-          pattern: ^[0-9]{16}$
-          description: IMEISV of the device
-          example: "4901542032375180"
+          $ref: "#/components/schemas/ImeiSv"
         imei:
-          type: string
-          maxLength: 15
-          pattern: ^[0-9]{15}$
-          description: IMEI of the device
-          example: "490154203237518"
+          $ref: "#/components/schemas/Imei"
 
     RetrieveIdentifierResponse:
       description: Response body definition for retrieveIdentifier operation
@@ -696,11 +744,7 @@ components:
       type: object
       properties:
         tac:
-          type: string
-          maxLength: 8
-          pattern: ^[0-9]{8}$
-          description: IMEI Type Allocation Code of the device
-          example: "49015420"
+          $ref: "#/components/schemas/Tac"
         model:
           description: Model of the device
           allOf:
@@ -727,12 +771,7 @@ components:
       type: object
       properties:
         ppid:
-          type: string
-          minLength: 64
-          maxLength: 128
-          pattern: ^[a-fA-F0-9]{64,128}$
-          description: A PPID for the identified physical device
-          example: "b083f65ccdad365d7489fff24b6d5074b30c12b6d81db3404d25964ffd908813"
+          $ref: "#/components/schemas/Ppid"
 
     RetrievePpidResponse:
       description: Response body definition for retrievePpid operation
@@ -743,44 +782,6 @@ components:
         - $ref: "#/components/schemas/CommonResponseBody"
         - $ref: "#/components/schemas/DevicePpid"
 
-    RequestBody:
-      description: Common request body to allow optional Device object to be passed
-      type: object
-      properties:
-        device:
-          $ref: "../common/CAMARA_common.yaml#/components/schemas/Device"
-
-    MatchRequestBody:
-      description: Request body for match-identifier operation, containing an optional mobile device subscription identifier, and the physical device identifier to match against
-      allOf:
-        - $ref: "#/components/schemas/RequestBody"
-        - type: object
-          required:
-            - providedIdentifierType
-            - providedIdentifier
-          properties:
-            providedIdentifierType:
-              $ref: "#/components/schemas/ProvidedIdentifierType"
-            providedIdentifier:
-              type: string
-              minLength: 8
-              maxLength: 16
-              pattern: ^[0-9]{8,16}$
-              description: The device identifier value to match against. Must match the format constraints for the specified identifier type.
-              example: "490154203237518"
-
-    ProvidedIdentifierType:
-      type: string
-      enum:
-        - IMEI
-        - IMEISV
-        - TAC
-      description: |
-        Type of the provided device identifier. Format requirements:
-        - IMEI: 15 digits (pattern: ^[0-9]{15}$)
-        - IMEISV: 16 digits (pattern: ^[0-9]{16}$)
-        - TAC: 8 digits (pattern: ^[0-9]{8}$)
-
     MatchResult:
       description: |
         The result of matching the provided device identifier against the network's identifier for the subscription
@@ -831,36 +832,32 @@ components:
           networkAccessIdentifier: "123456789@example.com"
 
     MatchDeviceBy3LeggedToken:
-      description: Match identifier when device is identified by access token
+      description: Match IMEISV when device is identified using a 3-legged access token
       value:
-        providedIdentifierType: "IMEISV"
-        providedIdentifier: "4901542032375181"
+        imeisv: "4901542032375181"
 
     MatchDeviceByPhoneNumber:
-      description: Matching device identifier by phone number and provided IMEI using a 2-legged access token
+      description: Matching IMEI when identifying device by phone number and using a 2-legged access token
       value:
         device:
           phoneNumber: "+123456789"
-        providedIdentifierType: "IMEI"
-        providedIdentifier: "490154203237518"
+        imei: "490154203237518"
 
     MatchDeviceByIPAddress:
-      description: Matching device identifier by IP address and provided TAC
+      description: Matching TAC when identifying device by IP address and using a 2-legged access token
       value:
         device:
           ipv4Address:
             publicAddress: "84.125.93.10"
             publicPort: 59765
-        providedIdentifierType: "TAC"
-        providedIdentifier: "49015420"
+        tac: "49015420"
 
     MatchDeviceByMultipleIdentifiers:
-      description: Matching device identifier by multiple subscription identifiers and provided IMEISV
+      description: Matching IMEISV when identifying device by multiple identifiers and using a 2-legged access token
       value:
         device:
           phoneNumber: "+123456789"
           ipv4Address:
             publicAddress: "84.125.93.10"
             publicPort: 59765
-        providedIdentifierType: "IMEISV"
-        providedIdentifier: "4901542032375180"
+        imeisv: "4901542032375180"