Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
3 changes: 3 additions & 0 deletions .markdownlint.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
{
"MD024": false
}
2 changes: 1 addition & 1 deletion .openapi-generator/VERSION
Original file line number Diff line number Diff line change
@@ -1 +1 @@
7.9.0
7.11.0
6 changes: 3 additions & 3 deletions .release.json
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
{
"source": {
"repo_url": "https://github.com/onfido/onfido-openapi-spec",
"short_sha": "0eec622",
"long_sha": "0eec6225e66b9f905dac23fe4eb18a1584517f64",
"version": ""
"short_sha": "db5a1b5",
"long_sha": "db5a1b59681fa467b324b4116de24d88d56d7452",
"version": "v5.0.0"
},
"release": "v5.0.0"
}
31 changes: 30 additions & 1 deletion MIGRATION.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,34 @@
# Migration Guide

This guide provides detailed instructions on how to upgrade between different
major versions of the client library.

It covers changes in core resources, other endpoints, and the OpenAPI generator,
ensuring a smooth transition between versions.

## Upgrading from 4.x to 5.x

### Core Resources

- Documents
- Allow any string as `file_type`

### Other Endpoints

- Webhooks
- Drop `WORKFLOW_SIGNED_EVIDENCE_FILE_DOT_CREATED` enum value from
`WebhookEventType` enum
- Make `href` property in `WebhookEventPayloadObject` optional
- Reports
- Allow the deprecated `records` property in `WatchlistAml` and
`WatchlistStandard` reports to be any object, and not just a string
- Remove `documents` property from all reports except Document and
Facial Similarity reports

### OpenAPI generator

- Version upgraded from `7.9.0` to `7.11.0`

## Upgrading from 3.x to 4.x

### Core Resources
Expand Down Expand Up @@ -27,5 +56,5 @@

### OpenAPI generator

- Version upgraded from 7.6.0 to 7.9.0
- Version upgraded from `7.6.0` to `7.9.0`
- Remove support for python 3.7
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ This version uses Onfido API v3.6. Refer to our [API versioning guide](https://d

### Requirements

Python 3.7+
Python 3.8+

### Installation

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

## Contributing

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.
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.

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

Expand Down
2 changes: 1 addition & 1 deletion onfido/api_client.py
Original file line number Diff line number Diff line change
Expand Up @@ -517,7 +517,7 @@ def parameters_to_url_query(self, params, collection_formats):
if k in collection_formats:
collection_format = collection_formats[k]
if collection_format == 'multi':
new_params.extend((k, str(value)) for value in v)
new_params.extend((k, quote(str(value))) for value in v)
else:
if collection_format == 'ssv':
delimiter = ' '
Expand Down
Loading