Skip to content

Commit 6fa94cb

Browse files
committed
add class descriptions
1 parent a943f64 commit 6fa94cb

File tree

101 files changed

+428
-1154
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

101 files changed

+428
-1154
lines changed

.openapi-generator/FILES

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,7 @@ regula/documentreader/webclient/gen/models/authenticity_check_list.py
1313
regula/documentreader/webclient/gen/models/authenticity_check_result_item.py
1414
regula/documentreader/webclient/gen/models/authenticity_result.py
1515
regula/documentreader/webclient/gen/models/authenticity_result_all_of.py
16+
regula/documentreader/webclient/gen/models/authenticity_result_type.py
1617
regula/documentreader/webclient/gen/models/check_diagnose.py
1718
regula/documentreader/webclient/gen/models/check_result.py
1819
regula/documentreader/webclient/gen/models/chosen_document_type.py
@@ -58,6 +59,7 @@ regula/documentreader/webclient/gen/models/lexical_analysis_result.py
5859
regula/documentreader/webclient/gen/models/lexical_analysis_result_all_of.py
5960
regula/documentreader/webclient/gen/models/light.py
6061
regula/documentreader/webclient/gen/models/list_verified_fields.py
62+
regula/documentreader/webclient/gen/models/measure_system.py
6163
regula/documentreader/webclient/gen/models/ocr_security_text_result.py
6264
regula/documentreader/webclient/gen/models/ocr_security_text_result_all_of.py
6365
regula/documentreader/webclient/gen/models/one_candidate.py

generator-templates/model.mustache

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,14 +14,16 @@ from {{packageName}}.models import *
1414

1515
{{#models}}
1616
{{#model}}
17+
"""
18+
{{unescapedDescription}}
19+
"""
1720
class {{classname}}(object):
1821
"""NOTE: This class is auto generated by OpenAPI Generator.
1922
Ref: https://openapi-generator.tech
2023

2124
Do not edit the class manually.
2225
"""
2326
{{#allowableValues}}{{#enumVars}}
24-
"{{enumDescription}}"
2527
{{#model.isString}}{{name}} = {{{value}}}{{/model.isString}}{{^model.isString}}{{name}} = int({{{value}}}){{/model.isString}}
2628
{{/enumVars}}{{/allowableValues}}
2729
{{#allowableValues}}

regula/documentreader/webclient/gen/__init__.py

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -30,6 +30,7 @@
3030
from regula.documentreader.webclient.gen.models.authenticity_check_result_item import AuthenticityCheckResultItem
3131
from regula.documentreader.webclient.gen.models.authenticity_result import AuthenticityResult
3232
from regula.documentreader.webclient.gen.models.authenticity_result_all_of import AuthenticityResultAllOf
33+
from regula.documentreader.webclient.gen.models.authenticity_result_type import AuthenticityResultType
3334
from regula.documentreader.webclient.gen.models.check_diagnose import CheckDiagnose
3435
from regula.documentreader.webclient.gen.models.check_result import CheckResult
3536
from regula.documentreader.webclient.gen.models.chosen_document_type import ChosenDocumentType
@@ -76,6 +77,7 @@
7677
from regula.documentreader.webclient.gen.models.lexical_analysis_result_all_of import LexicalAnalysisResultAllOf
7778
from regula.documentreader.webclient.gen.models.light import Light
7879
from regula.documentreader.webclient.gen.models.list_verified_fields import ListVerifiedFields
80+
from regula.documentreader.webclient.gen.models.measure_system import MeasureSystem
7981
from regula.documentreader.webclient.gen.models.ocr_security_text_result import OCRSecurityTextResult
8082
from regula.documentreader.webclient.gen.models.ocr_security_text_result_all_of import OCRSecurityTextResultAllOf
8183
from regula.documentreader.webclient.gen.models.one_candidate import OneCandidate

regula/documentreader/webclient/gen/configuration.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -374,7 +374,7 @@ def to_debug_report(self):
374374
return "Python SDK Debug Report:\n"\
375375
"OS: {env}\n"\
376376
"Python Version: {pyversion}\n"\
377-
"Version of the API: 5.4.0\n"\
377+
"Version of the API: 5.5.0\n"\
378378
"SDK Package Version: 1.0.0".\
379379
format(env=sys.platform, pyversion=sys.version)
380380

regula/documentreader/webclient/gen/models/__init__.py

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,7 @@
1414
from regula.documentreader.webclient.gen.models.authenticity_check_result_item import AuthenticityCheckResultItem
1515
from regula.documentreader.webclient.gen.models.authenticity_result import AuthenticityResult
1616
from regula.documentreader.webclient.gen.models.authenticity_result_all_of import AuthenticityResultAllOf
17+
from regula.documentreader.webclient.gen.models.authenticity_result_type import AuthenticityResultType
1718
from regula.documentreader.webclient.gen.models.check_diagnose import CheckDiagnose
1819
from regula.documentreader.webclient.gen.models.check_result import CheckResult
1920
from regula.documentreader.webclient.gen.models.chosen_document_type import ChosenDocumentType
@@ -60,6 +61,7 @@
6061
from regula.documentreader.webclient.gen.models.lexical_analysis_result_all_of import LexicalAnalysisResultAllOf
6162
from regula.documentreader.webclient.gen.models.light import Light
6263
from regula.documentreader.webclient.gen.models.list_verified_fields import ListVerifiedFields
64+
from regula.documentreader.webclient.gen.models.measure_system import MeasureSystem
6365
from regula.documentreader.webclient.gen.models.ocr_security_text_result import OCRSecurityTextResult
6466
from regula.documentreader.webclient.gen.models.ocr_security_text_result_all_of import OCRSecurityTextResultAllOf
6567
from regula.documentreader.webclient.gen.models.one_candidate import OneCandidate

regula/documentreader/webclient/gen/models/area_container.py

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,9 @@
1414
from regula.documentreader.webclient.gen.models import *
1515

1616

17+
"""
18+
Checked fragment coordinates
19+
"""
1720
class AreaContainer(object):
1821
"""NOTE: This class is auto generated by OpenAPI Generator.
1922
Ref: https://openapi-generator.tech

regula/documentreader/webclient/gen/models/authenticity_check_list.py

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,9 @@
1414
from regula.documentreader.webclient.gen.models import *
1515

1616

17+
"""
18+
19+
"""
1720
class AuthenticityCheckList(object):
1821
"""NOTE: This class is auto generated by OpenAPI Generator.
1922
Ref: https://openapi-generator.tech

regula/documentreader/webclient/gen/models/authenticity_check_result_item.py

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,9 @@
1414
from regula.documentreader.webclient.gen.models import *
1515

1616

17+
"""
18+
Common fields for all authenticity result objects
19+
"""
1720
class AuthenticityCheckResultItem(object):
1821
"""NOTE: This class is auto generated by OpenAPI Generator.
1922
Ref: https://openapi-generator.tech

regula/documentreader/webclient/gen/models/authenticity_result.py

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,9 @@
1414
from regula.documentreader.webclient.gen.models import *
1515

1616

17+
"""
18+
19+
"""
1720
class AuthenticityResult(object):
1821
"""NOTE: This class is auto generated by OpenAPI Generator.
1922
Ref: https://openapi-generator.tech

regula/documentreader/webclient/gen/models/authenticity_result_all_of.py

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,9 @@
1414
from regula.documentreader.webclient.gen.models import *
1515

1616

17+
"""
18+
19+
"""
1720
class AuthenticityResultAllOf(object):
1821
"""NOTE: This class is auto generated by OpenAPI Generator.
1922
Ref: https://openapi-generator.tech

0 commit comments

Comments
 (0)