Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

Draft
wants to merge 1 commit into
base: master
Choose a base branch
from
Draft

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

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 19 additions & 5 deletions schemas/reports/definitions.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,15 +24,29 @@ 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: "#/document_report_document"

document_report_document:
type: object
required:
- id
properties:
id:
type: string
format: uuid
description: ID of uploaded document to use.

facial_similarity_report_shared:
properties:
live_photos:
Expand Down
1 change: 1 addition & 0 deletions schemas/reports/document_report.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
allOf:
- $ref: definitions.yaml#/report_shared
- $ref: definitions.yaml#/document_report_shared
- type: object
properties:
breakdown:
Expand Down
1 change: 1 addition & 0 deletions schemas/reports/document_video_report.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
allOf:
- $ref: definitions.yaml#/report_shared
- $ref: definitions.yaml#/document_report_shared
- type: object
properties:
breakdown:
Expand Down
1 change: 1 addition & 0 deletions schemas/reports/document_video_with_address_information_report.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
allOf:
- $ref: definitions.yaml#/report_shared
- $ref: definitions.yaml#/document_report_shared
- type: object
properties:
breakdown:
Expand Down
1 change: 1 addition & 0 deletions schemas/reports/document_with_address_information_report.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
allOf:
- $ref: definitions.yaml#/report_shared
- $ref: definitions.yaml#/document_report_shared
- type: object
properties:
breakdown:
Expand Down
1 change: 1 addition & 0 deletions schemas/reports/document_with_driver_verification_report.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
allOf:
- $ref: definitions.yaml#/report_shared
- $ref: definitions.yaml#/document_report_shared
- type: object
properties:
breakdown:
Expand Down
1 change: 1 addition & 0 deletions schemas/reports/document_with_driving_licence_information_report.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
allOf:
- $ref: definitions.yaml#/report_shared
- $ref: definitions.yaml#/document_report_shared
- type: object
properties:
breakdown:
Expand Down
1 change: 1 addition & 0 deletions schemas/reports/facial_similarity_motion_report.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
allOf:
- $ref: definitions.yaml#/report_shared
- $ref: definitions.yaml#/document_report_shared
- $ref: definitions.yaml#/facial_similarity_report_shared
- type: object
properties:
Expand Down
1 change: 1 addition & 0 deletions schemas/reports/facial_similarity_photo_fully_auto_report.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
allOf:
- $ref: definitions.yaml#/report_shared
- $ref: definitions.yaml#/document_report_shared
- $ref: definitions.yaml#/facial_similarity_report_shared
- type: object
properties:
Expand Down
1 change: 1 addition & 0 deletions schemas/reports/facial_similarity_photo_report.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
allOf:
- $ref: definitions.yaml#/report_shared
- $ref: definitions.yaml#/document_report_shared
- $ref: definitions.yaml#/facial_similarity_report_shared
- type: object
properties:
Expand Down
1 change: 1 addition & 0 deletions schemas/reports/facial_similarity_video_report.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
allOf:
- $ref: definitions.yaml#/report_shared
- $ref: definitions.yaml#/document_report_shared
- $ref: definitions.yaml#/facial_similarity_report_shared
- type: object
properties:
Expand Down
8 changes: 0 additions & 8 deletions schemas/reports/report_document.yaml
View file
Open in desktop

This file was deleted.