Skip to content

Commit cf158ed

Browse files
committed
Update Migration guide after major release
1 parent c723a79 commit cf158ed

2 files changed

Lines changed: 33 additions & 1 deletion

File tree

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

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

0 commit comments

Comments
 (0)