Skip to content

Commit 19263c5

Browse files
Merge pull request #83 from onfido/release-upgrade
Refresh onfido-python after onfido-openapi-spec update (db5a1b5)
2 parents d8ca983 + cf158ed commit 19263c5

41 files changed

Lines changed: 305 additions & 115 deletions

Some content is hidden

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

.markdownlint.json

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
{
2+
"MD024": false
3+
}

.openapi-generator/VERSION

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
7.9.0
1+
7.11.0

.release.json

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
11
{
22
"source": {
33
"repo_url": "https://github.com/onfido/onfido-openapi-spec",
4-
"short_sha": "0eec622",
5-
"long_sha": "0eec6225e66b9f905dac23fe4eb18a1584517f64",
6-
"version": ""
4+
"short_sha": "db5a1b5",
5+
"long_sha": "db5a1b59681fa467b324b4116de24d88d56d7452",
6+
"version": "v5.0.0"
77
},
88
"release": "v5.0.0"
99
}

MIGRATION.md

Lines changed: 30 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,34 @@
11
# Migration Guide
22

3+
This guide provides detailed instructions on how to upgrade between different
4+
major versions of the client library.
5+
6+
It covers changes in core resources, other endpoints, and the OpenAPI generator,
7+
ensuring a smooth transition between versions.
8+
9+
## Upgrading from 4.x to 5.x
10+
11+
### Core Resources
12+
13+
- Documents
14+
- Allow any string as `file_type`
15+
16+
### Other Endpoints
17+
18+
- Webhooks
19+
- Drop `WORKFLOW_SIGNED_EVIDENCE_FILE_DOT_CREATED` enum value from
20+
`WebhookEventType` enum
21+
- Make `href` property in `WebhookEventPayloadObject` optional
22+
- Reports
23+
- Allow the deprecated `records` property in `WatchlistAml` and
24+
`WatchlistStandard` reports to be any object, and not just a string
25+
- Remove `documents` property from all reports except Document and
26+
Facial Similarity reports
27+
28+
### OpenAPI generator
29+
30+
- Version upgraded from `7.9.0` to `7.11.0`
31+
332
## Upgrading from 3.x to 4.x
433

534
### Core Resources
@@ -27,5 +56,5 @@
2756

2857
### OpenAPI generator
2958

30-
- Version upgraded from 7.6.0 to 7.9.0
59+
- Version upgraded from `7.6.0` to `7.9.0`
3160
- Remove support for python 3.7

README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ This version uses Onfido API v3.6. Refer to our [API versioning guide](https://d
1313

1414
### Requirements
1515

16-
Python 3.7+
16+
Python 3.8+
1717

1818
### Installation
1919

@@ -119,7 +119,7 @@ Except for accessing Task object's outputs, avoid using the `additional_properti
119119

120120
## Contributing
121121

122-
This library is automatically generated using [OpenAPI Generator](https://openapi-generator.tech) (version: 7.9.0); therefore, all contributions (except test files) should target the [Onfido OpenAPI specification repository](https://github.com/onfido/onfido-openapi-spec/tree/master) instead of this repository. Please follow the contribution guidelines provided in the OpenAPI specification repository.
122+
This library is automatically generated using [OpenAPI Generator](https://openapi-generator.tech) (version: 7.11.0); therefore, all contributions (except test files) should target the [Onfido OpenAPI specification repository](https://github.com/onfido/onfido-openapi-spec/tree/master) instead of this repository. Please follow the contribution guidelines provided in the OpenAPI specification repository.
123123

124124
For contributions to the tests instead, please follow the steps below:
125125

onfido/api_client.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -517,7 +517,7 @@ def parameters_to_url_query(self, params, collection_formats):
517517
if k in collection_formats:
518518
collection_format = collection_formats[k]
519519
if collection_format == 'multi':
520-
new_params.extend((k, str(value)) for value in v)
520+
new_params.extend((k, quote(str(value))) for value in v)
521521
else:
522522
if collection_format == 'ssv':
523523
delimiter = ' '

0 commit comments

Comments
 (0)