Skip to content

Commit

Permalink
Update MIGRATING.md
Browse files Browse the repository at this point in the history
  • Loading branch information
arvindkrishnakumar-okta authored Jul 6, 2020
1 parent 7559222 commit 29fed4f
Showing 1 changed file with 14 additions and 16 deletions.
30 changes: 14 additions & 16 deletions MIGRATING.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,51 +5,49 @@ This SDK uses semantic versioning and follows Okta's [library version policy](ht
## Migrating from 1.x.x to 2.0.0

Version 2.0.0 of this SDK introduces a number of breaking changes from previous versions.
In addition to many new classes/interfaces, some existing classes/interfaces are no longer backward compatible due to method renaming and signature changes, see [Breaking Changes](#breaking-changes).
In addition to many new classes/interfaces, some existing classes/interfaces are no longer backward compatible due to method renaming and signature changes.

### Breaking Changes

#### All `*Factor` classes Renamed to `*UserFactor` #####
#### All `*Factor` classes Renamed to `*UserFactor`
This means that you will now have to start using the new `*UserFactor` objects instead.

### Package `com.okta.sdk.client.Client` ###
### Package `com.okta.sdk.client.Client`

Below methods have been renamed for the sake of clarity.

- Renamed `createRule` to `createGroupRule`
- Renamed `getRule` to `getGroupRule`
- Renamed `listRules` to `listGroupRules`

### Package `com.okta.sdk.resource.log.LogEventList` ###
### Package `com.okta.sdk.resource.log.LogEventList`

The API used to get log info has undergone a signature change (note the order swap of `until` and `since` parameters).

- `getLogs(String until, String since, String filter, String q, String sortOrder)`
Signature changed to `getLogs(Date since, Date until, String filter, String q, String sortOrder)`

### Package `com.okta.sdk.resource.group.GroupList` ###
### Package `com.okta.sdk.resource.group.GroupList`

The API used to list the groups to which a user belongs, has undergone a signature change.
There is no need for supplying the `expand` parameter anymore.

- `listGroups(String q, String filter, String expand)`
Signature changed to `listGroups(String q, String filter)`

### Package `com.okta.sdk.resource.application.SwaThreeFieldApplicationSettingsApplication` ###
### Package `com.okta.sdk.resource.application.SwaThreeFieldApplicationSettingsApplication`

Below APIs have undergone a name change.

- `getTargetUrl` Renamed to `getTargetURL`
- `setTargetUrl` Renamed to `setTargetURL`

### Package `com.okta.sdk.resource.group.Group` ###
### Package `com.okta.sdk.resource.group.Group`

With the introduction of enum type `com.okta.sdk.resource.group.GroupType`, the get group type operation will now make
use of this new type instead of the `String` type used earlier.

- `getType` Return type changed from `String` to `com.okta.sdk.resource.group.GroupType`

### Package `com.okta.sdk.resource.group.rule.GroupRule` ###
### Package `com.okta.sdk.resource.group.rule.GroupRule`

The properties `allGroupsValid` & `_embedded` were not used by the backend earlier and were always set to `null`.
As part of this upgrade, we will remove it from the method signatures.
Expand All @@ -58,7 +56,7 @@ As part of this upgrade, we will remove it from the method signatures.
- Removed `getEmbedded` (property `_embedded` is removed)
- `delete(Boolean removeUsers)` Signature changed to `delete()`

### Package `com.okta.sdk.resource.log.LogAuthenticationContext` ###
### Package `com.okta.sdk.resource.log.LogAuthenticationContext`

The API to get log credential provider used to return a list of objects of type `LogCredentialProvider` earlier.
Moving forward, the return type will be a single object of type `LogCredentialProvider`.
Expand All @@ -70,26 +68,26 @@ Moving forward, the return type will be a single object of type `LogCredentialTy

- `getCredentialType` Return type changed from `List<com.okta.sdk.resource.log.LogCredentialType>` to `com.okta.sdk.resource.log.LogCredentialType`

### Package `com.okta.sdk.resource.policy.PolicyRule` ###
### Package `com.okta.sdk.resource.policy.PolicyRule`

There is no need of exposing setter for the `read-only` property `id`.
- Removed `setId` (property `id` is `read-only`)

### Package `com.okta.sdk.resource.user.factor.VerifyFactorRequest` ###
### Package `com.okta.sdk.resource.user.factor.VerifyFactorRequest`

The property `tokenLifetimeSeconds` will not used by the backend going forward.

- Removed `getTokenLifetimeSeconds` & `setTokenLifetimeSeconds` (property `tokenLifetimeSeconds` is removed)

### Package `com.okta.sdk.resource.user.Role` ###
### Package `com.okta.sdk.resource.user.Role`

With the introduction of enum type `com.okta.sdk.resource.role.RoleType`, the getter/setter for role type operation will now make
use of this new type instead of the `String` type used earlier.

- `getType` Return type changed from `String` to `com.okta.sdk.resource.role.RoleType`
- `setType` Param type changed from `String` to `com.okta.sdk.resource.role.RoleType`

### Package `com.okta.sdk.resource.user.User` ###
### Package `com.okta.sdk.resource.user.User`

The below method names have been refactored to be more apt:
- Renamed `addGroupTarget` to `addGroupTargetToRole`
Expand All @@ -113,7 +111,7 @@ The `expirePassword` Return type changed from `com.okta.sdk.resource.user.TempPa
The reset password method will no longer need a provider argument.
- `resetPassword(String provider, Boolean sendEmail)` Signature changed to `resetPassword(Boolean sendEmail)`

### Package `com.okta.sdk.resource.user.UserCredentials` ###
### Package `com.okta.sdk.resource.user.UserCredentials`

The property `emails` was not used by the backend and was always `null` hitherto.
- Removed `getEmails` & `setEmails` (property `emails` was removed)
Expand Down

0 comments on commit 29fed4f

Please sign in to comment.