[SP-10234] update enums descriptions (#121)

* update enums * update Source descriptions * add descriptions to parsing error codes & notification codes * update description in RFIDErrorCodes * update Scenario * update DocumentType description * Update e-document-type.yml * Update e-document-type.yml * Update e-document-type.yml * Update e-document-type.yml * Update e-document-type.yml * Update e-document-type.yml * Update e-document-type.yml * Update e-document-type.yml * Update e-document-type.yml * Update e-document-type.yml * Update e-document-type.yml --------- Co-authored-by: Vladislav Yakimchik <[email protected]> Co-authored-by: Vladislav Yakimchik <[email protected]>
regulaforensics · Aug 31, 2023 · d0bc1fc · d0bc1fc
1 parent b9d1267
commit d0bc1fc
Show file tree

Hide file tree

Showing 7 changed files with 739 additions and 0 deletions.
diff --git a/.gitignore b/.gitignore
@@ -5,3 +5,6 @@ document-reader-api-doc.html
 /openapi.json
 document-reader-static-doc.html
 *.DS_Store
+*.txt
+*.strings
+*.json
diff --git a/common.yml b/common.yml
@@ -29,6 +29,12 @@ components:
         - "BARCODE"
         - "RFID"
         - "MAGNETIC"
+      x-enum-descriptions:
+        - "Machine readable zone (MRZ)"
+        - "Visual zone"
+        - "Barcode"
+        - "RFID"
+        - "Magnetic"
 
     CheckResult:
       type: integer
@@ -90,6 +96,26 @@ components:
         - "OCR_FREE"
         - "CREDIT_CARD"
         - "CAPTURE"
+      x-enum-descriptions:
+        - "Processing scenario for obtaining MRZ data"
+        - "Processing scenario for obtaining barcode data"
+        - "Processing scenario for detecting document boundaries"
+        - "Processing scenario for obtaining visual zone OCR results"
+        - "Processing scenario for document type recognition"
+        - "Processing scenario for obtaining MRZ and/or barcode data"
+        - "Processing scenario for detecting document boundaries and/or obtaining MRZ data"
+        - "Processing scenario for detecting document boundaries and obtaining MRZ data"
+        - "Processing scenario for detecting the document boundaries and obtaining barcode data"
+        - "Processing scenario for obtaining MRZ data or visual zone OCR results"
+        - "Processing scenario for obtaining MRZ or barcode or visual zone OCR results"
+        - "Processing scenario for detecting document boundaries and obtaining MRZ data or visual zone OCR results"
+        - "Processing scenario for obtaining all document data"
+        - "Processing scenario for obtaining all document data and document authentication"
+        - "Processing scenario for obtaining visual zone OCR results from Russian National Passport and MRZ data from any document"
+        - "Processing scenario for obtaining data from registration stamps"
+        - "Processing scenario for obtaining OCR results of any image"
+        - "Processing scenario for obtaining bank card data"
+        - "Scenario for obtaining an original image without any processing"
 
     ImageData:
       type: object

diff --git a/e-document-type.yml b/e-document-type.yml
@@ -235,6 +235,237 @@ components:
         - 240
         - 241
         - 242
+      x-enum-descriptions:
+        - "Not defined"
+        - "Passport"
+        - "Identity card"
+        - "Diplomatic passport"
+        - "Service passport"
+        - "Seamans identity document"
+        - "Identity card for residence"
+        - "Travel document"
+        - "National identity card"
+        - "Social identity card"
+        - "Alien's identity card"
+        - "Privileged identity card"
+        - "Residence permit identity card"
+        - "Origin card"
+        - "Emergency passport"
+        - "Alien's passport"
+        - "Alternative identity card"
+        - "Visa ID2"
+        - "Visa ID3"
+        - "Authorization card"
+        - "Beginner permit"
+        - "Border crossing card"
+        - "Chauffeur license"
+        - "Chauffeur license under 18"
+        - "Chauffeur license under 21"
+        - "Commercial driving license"
+        - "Commercial driving license instructional permit"
+        - "Commercial driving license under 18"
+        - "Commercial driving license under 21"
+        - "Commercial instruction permit"
+        - "Commercial new permit"
+        - "Concealed carry license"
+        - "Concealed firearm permit"
+        - "Conditional driving license"
+        - "Department of veterans affairs identity card"
+        - "Diplomatic driving license"
+        - "Driving license"
+        - "Driving license instructional permit"
+        - "Driving license instructional permit under 18"
+        - "Driving license instructional permit under 21"
+        - "Driving license learners permit"
+        - "Driving license learners permit under 18"
+        - "Driving license learners permit under 21"
+        - "Driving license novice"
+        - "Driving license novice under 18"
+        - "Driving license novice under 21"
+        - "Driving license registered offender"
+        - "Driving license restricted under 18"
+        - "Driving license restricted under 21"
+        - "Driving license temporary visitor"
+        - "Driving license temporary visitor under 18"
+        - "Driving license temporary visitor under 21"
+        - "Driving license under 18"
+        - "Driving license under 21"
+        - "Employment driving permit"
+        - "Enhanced chauffeur license"
+        - "Enhanced chauffeur license under 18"
+        - "Enhanced chauffeur license under 21"
+        - "Enhanced commercial driving license"
+        - "Enhanced driving license"
+        - "Enhanced driving license under 18"
+        - "Enhanced driving license under 21"
+        - "Enhanced identity card"
+        - "Enhanced identity card under 18"
+        - "Enhanced identity card under 21"
+        - "Enhanced operators license"
+        - "Firearms permit"
+        - "Full provisional license"
+        - "Full provisional license under 18"
+        - "Full provisional license under 21"
+        - "Geneva conventions identity card"
+        - "Graduated driving license under 18"
+        - "Graduated driving license under 21"
+        - "Graduated instruction permit under 18"
+        - "Graduated instruction permit under 21"
+        - "Graduated license under 18"
+        - "Graduated license under 21"
+        - "Handgun carry permit"
+        - "Identity and privilege card"
+        - "Identity card mobility impaired"
+        - "Identity card registered offender"
+        - "Identity card temporary visitor"
+        - "Identity card temporary visitor under 18"
+        - "Identity card temporary visitor under 21"
+        - "Identity card under 18"
+        - "Identity card under 21"
+        - "Other"
+        - "Ignition interlock permit"
+        - "Immigrant visa"
+        - "Instruction permit"
+        - "Instruction permit under 18"
+        - "Instruction permit under 21"
+        - "Interim driving license"
+        - "Interim identity card"
+        - "Intermediate driving license"
+        - "Intermediate driving license under 18"
+        - "Intermediate driving license under 21"
+        - "Junior driving license"
+        - "Learner instructional permit"
+        - "Learner license"
+        - "Learner license under 18"
+        - "Learner license under 21"
+        - "Learner permit"
+        - "Learner permit under 18"
+        - "Learner permit under 21"
+        - "Limited license"
+        - "Limited permit"
+        - "Limited term driving license"
+        - "Limited term identity card"
+        - "Liquor identity card"
+        - "New permit"
+        - "New permit under 18"
+        - "New permit under 21"
+        - "Non-US citizen driving license"
+        - "Occupational driving license"
+        - "Oneida tribe of indians identity card"
+        - "Operator license"
+        - "Operator license under 18"
+        - "Operator license under 21"
+        - "Permanent driving license"
+        - "Permit to re-enter"
+        - "Probationary auto license"
+        - "Probationary driving license under 18"
+        - "Probationary driving license under 21"
+        - "Probationary vehicle sales person license"
+        - "Provisional driving license"
+        - "Provisional driving license under 18"
+        - "Provisional driving license under 21"
+        - "Provisional license"
+        - "Provisional license under 18"
+        - "Provisional license under 21"
+        - "Public passenger chauffeur license"
+        - "Racing and gaming comission card"
+        - "Refugee travel document"
+        - "Renewal permit"
+        - "Restricted commercial driver license"
+        - "Restricted driver license"
+        - "Restricted permit"
+        - "Seasonal permit"
+        - "Seasonal resident identity card"
+        - "Seasonal citizen identity card"
+        - "Sex offender"
+        - "Social security card"
+        - "Temporary driving license"
+        - "Temporary driving license under 18"
+        - "Temporary driving license under 21"
+        - "Temporary identity card"
+        - "Temporary instruction permit identity card"
+        - "Temporary instruction permit identity card under 18"
+        - "Temporary instruction permit identity card under 21"
+        - "Temporary visitor driving license"
+        - "Temporary visitor driving license under 18"
+        - "Temporary visitor driving license under 21"
+        - "Uniformed services identity card"
+        - "Vehicle sales person license"
+        - "Worker identification credential"
+        - "Commercial driving license novice"
+        - "Commercial driving license novice under 18"
+        - "Commercial driving license novice under 21"
+        - "Passport card"
+        - "Passport resident card"
+        - "Personal identification verification"
+        - "Temporary operator license"
+        - "Driving license under 19"
+        - "Identity card under 19"
+        - "Visa"
+        - "Temporary passport"
+        - "Voting card"
+        - "Health card"
+        - "Certificate of citizenship"
+        - "Address card"
+        - "Airport immigration card"
+        - "Alien registration card"
+        - "APEH card"
+        - "Coupon to driving license"
+        - "Crew member certificate"
+        - "Document for return"
+        - "E-card"
+        - "Employment card"
+        - "HKSAR immigration form"
+        - "Immigrant card"
+        - "Labour card"
+        - "Laissez passer"
+        - "Lawyer identity certificate"
+        - "License card"
+        - "Passport stateless"
+        - "Passport child"
+        - "Passport consular"
+        - "Passport diplomatic service"
+        - "Passport official"
+        - "Passport provisional"
+        - "Passport special"
+        - "Permission to the local border traffic"
+        - "Registration certificate"
+        - "Sedesol card"
+        - "Social card"
+        - "TB card"
+        - "Vehicle passport"
+        - "W document"
+        - "Diplomatic identity card"
+        - "Consular identity card"
+        - "Income tax card"
+        - "Residence permit"
+        - "Document of identity"
+        - "Border crossing permit"
+        - "Passport limited validity"
+        - "Sim card"
+        - "Tax card"
+        - "Company card"
+        - "Domestic passport"
+        - "Identity certificate"
+        - "Resident id card"
+        - "Armed forces identity card"
+        - "Professional card"
+        - "Registration stamp"
+        - "Driver card"
+        - "Driver training certificate"
+        - "Qualification driving license"
+        - "Membership card"
+        - "Public vehicle driver authority card"
+        - "Marine license"
+        - "Temporary learner license"
+        - "Temporary commercial driving license"
+        - "Interim instructional permit"
+        - "Certificate of competency"
+        - "Certificate of proficiency"
+        - "Trade license"
+        - "Passport page"
+        - "Invoice"
+        - "Passenger locator form"
       x-enum-varnames:
         - "NOT_DEFINED"
         - "PASSPORT"