Skip to content

Commit dfa0b91

Browse files
committed
Update MIGRATION.md for v6.x and fix CI workflow
1 parent 7e98bb5 commit dfa0b91

2 files changed

Lines changed: 31 additions & 1 deletion

File tree

.github/workflows/python.yml

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -60,7 +60,9 @@ jobs:
6060
- name: Test with pytest
6161
if: ${{ matrix.python-version == '3.13' &&
6262
github.repository_owner == 'onfido' &&
63-
(github.event_name == 'pull_request' || github.event_name == 'release') }}
63+
(github.event_name == 'pull_request' ||
64+
github.event_name == 'release' ||
65+
github.event_name == 'workflow_dispatch') }}
6466
run: |
6567
poetry run pytest --show-capture=no
6668
env:

MIGRATION.md

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,34 @@ major versions of the client library.
66
It covers changes in core resources, other endpoints, and the OpenAPI generator,
77
ensuring a smooth transition between versions.
88

9+
## Upgrading from 5.x to 6.x
10+
11+
### Core Resources
12+
13+
- Documents
14+
- Driving licence information properties removed from general `DocumentProperties`
15+
and moved to new `DocumentPropertiesWithDrivingLicenceInformation` class
16+
- Workflow Runs
17+
- `created_at_gt` and `created_at_lt` parameters in `list_workflow_runs` changed from
18+
date-time format to date format (YYYY-MM-DD)
19+
20+
### Other Endpoints
21+
22+
- Reports
23+
- Device Intelligence: Removed deprecated `breakdown` property and related
24+
breakdown classes:
25+
- `DeviceIntelligenceBreakdownBreakdown` removed
26+
- `DeviceIntelligenceBreakdownProperties``DeviceIntelligenceProperties`
27+
- `DeviceIntelligenceBreakdownPropertiesDevice``DeviceIntelligencePropertiesDevice`
28+
- `DeviceIntelligenceBreakdownPropertiesGeolocation``DeviceIntelligencePropertiesGeolocation`
29+
- `DeviceIntelligenceBreakdownPropertiesIp``DeviceIntelligencePropertiesIp`
30+
- Identity Enhanced: Changed `total_number_of_sources` and `number_of_matches` from
31+
number to string type
32+
33+
### OpenAPI generator
34+
35+
- Version upgraded from `7.11.0` to `7.16.0`
36+
937
## Upgrading from 4.x to 5.x
1038

1139
### Core Resources

0 commit comments

Comments
 (0)