Remove document property for reports where it's not applicable (#134)

* Remove document property for reports where it's not applicable

* A small additional improvement

Author: dvacca-onfido

schemas/reports/definitions.yaml

@@ -24,17 +24,26 @@ report_shared:
       type: string
       format: uuid
       description: The ID of the check to which the report belongs. Read-only.
-    documents:
-      type: array
-      description: Array of objects with document ids that were used in the Onfido engine. [ONLY POPULATED FOR DOCUMENT AND FACIAL SIMILARITY REPORTS]
-      items:
-        $ref: report_document.yaml
     name:
       $ref: "#/report_name"
       description: The name of the report type.
 
+document_report_shared:
+  type: object
+  properties:
+    documents:
+      type: array
+      description: Array of objects with document ids that were used in the Onfido engine.
+      items:
+        $ref: "#/report_document"
+
 facial_similarity_report_shared:
   properties:
+    documents:
+      type: array
+      description: Array of objects with document ids that were used in the Onfido engine.
+      items:
+        $ref: "#/report_document"
     live_photos:
       type: array
       description: Array of objects with live photo ids that were used in the Onfido engine.
@@ -56,6 +65,16 @@ facial_similarity_report_shared:
       items:
         $ref: "#/facial_similarity_report_media"
 
+report_document:
+  type: object
+  required:
+    - id
+  properties:
+    id:
+      type: string
+      format: uuid
+      description: ID of uploaded document to use.
+
 facial_similarity_report_media:
   type: object
   required:

schemas/reports/document_report.yaml

@@ -1,5 +1,6 @@
 allOf:
   - $ref: definitions.yaml#/report_shared
+  - $ref: definitions.yaml#/document_report_shared
   - type: object
     properties:
       breakdown:

schemas/reports/document_video_report.yaml

@@ -1,5 +1,6 @@
 allOf:
   - $ref: definitions.yaml#/report_shared
+  - $ref: definitions.yaml#/document_report_shared
   - type: object
     properties:
       breakdown:

schemas/reports/document_video_with_address_information_report.yaml

@@ -1,5 +1,6 @@
 allOf:
   - $ref: definitions.yaml#/report_shared
+  - $ref: definitions.yaml#/document_report_shared
   - type: object
     properties:
       breakdown:

schemas/reports/document_with_address_information_report.yaml

@@ -1,5 +1,6 @@
 allOf:
   - $ref: definitions.yaml#/report_shared
+  - $ref: definitions.yaml#/document_report_shared
   - type: object
     properties:
       breakdown:

schemas/reports/document_with_driver_verification_report.yaml

@@ -1,5 +1,6 @@
 allOf:
   - $ref: definitions.yaml#/report_shared
+  - $ref: definitions.yaml#/document_report_shared
   - type: object
     properties:
       breakdown:

schemas/reports/document_with_driving_licence_information_report.yaml

@@ -1,5 +1,6 @@
 allOf:
   - $ref: definitions.yaml#/report_shared
+  - $ref: definitions.yaml#/document_report_shared
   - type: object
     properties:
       breakdown: