Skip to content

Commit 949e0e3

Browse files
adorton-adobeadorton-adobe
committed
update release notes
1 parent c43a73a commit 949e0e3

File tree

2 files changed

+159
-3
lines changed

2 files changed

+159
-3
lines changed

‎.changelog/changelog.md

Lines changed: 86 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,89 @@
1+
| tag | date | title |
2+
|---|---|---|
3+
| v3.0 | 2023-05-18 | umapi-client v3.0 |
4+
5+
# Changes in Version 3
6+
7+
This is a major release and contains many compatibility-breaking changes. Chief
8+
among these is an ovehaul of the auth layer and the the introduction of the
9+
`OAuthS2S` auth class which authenticates UMAPI clients using
10+
[Server-to-Server](https://developer.adobe.com/developer-console/docs/guides/authentication/ServerToServerAuthentication/implementation/)
11+
authentication. JWT-based authentication functionality is deprecated.
12+
13+
Refer to the user guide for details:
14+
15+
https://adobe-apiplatform.github.io/umapi-client.py/v3/
16+
17+
## Summary of Changes
18+
19+
- Authentication Interface
20+
- New `AuthBase` to cover basic auth functionality
21+
- Old JWT stuff rolled into single `JWTAuth` class
22+
- New `OAuthS2S` class representing new Server-to-Server authentication method
23+
- Connection Interface
24+
- Removed `auth_dict` functionality
25+
- `AuthBase`-derived object must be passed to `Connection` constructor via
26+
`auth` parameter
27+
- Removed `ims_host` and `ims_endpoint_jwt` - these are `AuthBase` attributes
28+
- `user_management_endpoint` renamed to `endpoint`
29+
- Removed `logger` param
30+
- Changes to timeout and retry constructor params
31+
- Renamed `retry_max_attempts` to `max_retries`
32+
- Removed `retry_first_delay`
33+
- Removed `retry_random_delay`
34+
- `timeout_seconds` renamed to `timeout`
35+
- Removal of "throttling" params
36+
- `throttle_actions`
37+
- `throttle_commands`
38+
- `throttle_groups`
39+
- Removed Deprecated Enums
40+
- `GroupTypes`
41+
- `RoleTypes`
42+
- Enum Naming Tweaks
43+
- `IdentityTypes` -> `IdentityType`
44+
- `IfAlreadyExistsOptions` -> `IfAlreadyExistsOption`
45+
- `UserAction` Changes
46+
- Constructor Updates
47+
- Replaced `email` and `username` params with `user` param that models the
48+
`user` field in a UMAPI action command object. This can be username or
49+
email address depending on context.
50+
- Removed `id_type` field. Identity type is only needed when creating a new
51+
user.
52+
- Refactor some validation to `create()`
53+
- `create()` Updates
54+
- `email` is now mandatory
55+
- Add `id_type` parameter
56+
- Perform some validation that was done in the constructor
57+
- `update()` Updates
58+
- Country code is not a valid user update parameter
59+
- `add_to_groups()` Updates
60+
- It isn't possible to assign a user to all group
61+
- Group type is deprecated
62+
- `remove_from_groups()` Updates
63+
- Group type is deprecated
64+
- `add_role()` and `remove_role()` were removed because role-based
65+
functionality is deprecated in the API
66+
- Country code removed from `update()` because UMAPI does not support
67+
country code updates
68+
- `UserQuery` Updates
69+
- Change `email` param in constructor to `user_string` to reflect UMAPI
70+
terminology. Add `domain` parameter which is supported by UMAPI.
71+
- `UsersQuery` Updates
72+
- Remove `identity_type` parameter from constructor. The UMAPI has never
73+
supported filtering users by identity type.
74+
- Rename `UserGroupAction` to `GroupAction`
75+
- `GroupAction` Changes
76+
- `products` paramter in `add_to_products()` and `remove_from_products()` is
77+
mandatory
78+
- It isn't possible to add all products to a group or remove all (without
79+
enumerating every product profile in `products`)
80+
- `users` parameter in `add_users()` and `remove_users()` is mandatory
81+
- `UserGroupsQuery` class removed because the `user-group` UMAPI endpoint does
82+
not exist
83+
- Deleted `legacy.py`
84+
85+
---
86+
187
| tag | date | title |
288
|---|---|---|
389
| v2.22 | 2023-03-07 | umapi-client v2.22 |

‎.changelog/latest.md

Lines changed: 73 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,79 @@
11
# Changes in Version 3
22

3+
This is a major release and contains many compatibility-breaking changes. Chief
4+
among these is an ovehaul of the auth layer and the the introduction of the
5+
`OAuthS2S` auth class which authenticates UMAPI clients using
6+
[Server-to-Server](https://developer.adobe.com/developer-console/docs/guides/authentication/ServerToServerAuthentication/implementation/)
7+
authentication. JWT-based authentication functionality is deprecated.
8+
9+
Refer to the user guide for details:
10+
11+
https://adobe-apiplatform.github.io/umapi-client.py/v3/
12+
13+
## Summary of Changes
14+
315
- Authentication Interface
16+
- New `AuthBase` to cover basic auth functionality
17+
- Old JWT stuff rolled into single `JWTAuth` class
18+
- New `OAuthS2S` class representing new Server-to-Server authentication method
419
- Connection Interface
5-
- OAuth Server-to-Server
6-
- UserAction Changes
20+
- Removed `auth_dict` functionality
21+
- `AuthBase`-derived object must be passed to `Connection` constructor via
22+
`auth` parameter
23+
- Removed `ims_host` and `ims_endpoint_jwt` - these are `AuthBase` attributes
24+
- `user_management_endpoint` renamed to `endpoint`
25+
- Removed `logger` param
26+
- Changes to timeout and retry constructor params
27+
- Renamed `retry_max_attempts` to `max_retries`
28+
- Removed `retry_first_delay`
29+
- Removed `retry_random_delay`
30+
- `timeout_seconds` renamed to `timeout`
31+
- Removal of "throttling" params
32+
- `throttle_actions`
33+
- `throttle_commands`
34+
- `throttle_groups`
35+
- Removed Deprecated Enums
36+
- `GroupTypes`
37+
- `RoleTypes`
38+
- Enum Naming Tweaks
39+
- `IdentityTypes` -> `IdentityType`
40+
- `IfAlreadyExistsOptions` -> `IfAlreadyExistsOption`
41+
- `UserAction` Changes
42+
- Constructor Updates
43+
- Replaced `email` and `username` params with `user` param that models the
44+
`user` field in a UMAPI action command object. This can be username or
45+
email address depending on context.
46+
- Removed `id_type` field. Identity type is only needed when creating a new
47+
user.
48+
- Refactor some validation to `create()`
49+
- `create()` Updates
50+
- `email` is now mandatory
51+
- Add `id_type` parameter
52+
- Perform some validation that was done in the constructor
53+
- `update()` Updates
54+
- Country code is not a valid user update parameter
55+
- `add_to_groups()` Updates
56+
- It isn't possible to assign a user to all group
57+
- Group type is deprecated
58+
- `remove_from_groups()` Updates
59+
- Group type is deprecated
60+
- `add_role()` and `remove_role()` were removed because role-based
61+
functionality is deprecated in the API
762
- Country code removed from `update()` because UMAPI does not support
863
country code updates
9-
- Enum Naming Tweaks
64+
- `UserQuery` Updates
65+
- Change `email` param in constructor to `user_string` to reflect UMAPI
66+
terminology. Add `domain` parameter which is supported by UMAPI.
67+
- `UsersQuery` Updates
68+
- Remove `identity_type` parameter from constructor. The UMAPI has never
69+
supported filtering users by identity type.
70+
- Rename `UserGroupAction` to `GroupAction`
71+
- `GroupAction` Changes
72+
- `products` paramter in `add_to_products()` and `remove_from_products()` is
73+
mandatory
74+
- It isn't possible to add all products to a group or remove all (without
75+
enumerating every product profile in `products`)
76+
- `users` parameter in `add_users()` and `remove_users()` is mandatory
77+
- `UserGroupsQuery` class removed because the `user-group` UMAPI endpoint does
78+
not exist
79+
- Deleted `legacy.py`

0 commit comments

Comments
 (0)