Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

OKTA-308935: Create Migration Guide for Java Mgmt SDK v2.0.0 #423

Merged
merged 17 commits into from
Jul 7, 2020
Merged

OKTA-308935: Create Migration Guide for Java Mgmt SDK v2.0.0 #423

merged 17 commits into from
Jul 7, 2020

Conversation

arvindkrishnakumar-okta
Copy link
Contributor

@arvindkrishnakumar-okta arvindkrishnakumar-okta commented Jul 2, 2020 •
edited
Loading

Issue(s)

OKTA-308935

Description

Create Migration Guide for v2.0.0 release of Java Mgmt SDK.

Category

  • Bugfix
  • Enhancement
  • New Feature
  • Configuration Change
  • Versioning Change
  • Unit Test(s)
  • Documentation

@arvindkrishnakumar-okta arvindkrishnakumar-okta changed the title Okta 308935 create migration guide for sdk v2.0.0 OKTA-308935: Create Migration Guide for SDK v2.0.0 Jul 2, 2020
@arvindkrishnakumar-okta arvindkrishnakumar-okta changed the base branch from master to dev_openapi_v2.0.0_major_rel July 2, 2020 07:43
@codecov-commenter
Copy link

codecov-commenter commented Jul 2, 2020 •
edited
Loading

Codecov Report

Merging #423 into dev_openapi_v2.0.0_major_rel will not change coverage.
The diff coverage is n/a.

Impacted file tree graph

@@                       Coverage Diff                       @@
##             dev_openapi_v2.0.0_major_rel     #423   +/-   ##
===============================================================
  Coverage                           81.10%   81.10%           
  Complexity                            953      953           
===============================================================
  Files                                 121      121           
  Lines                                3208     3208           
  Branches                              407      407           
===============================================================
  Hits                                 2602     2602           
  Misses                                423      423           
  Partials                              183      183

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 3bc371d...bbe5a1b. Read the comment docs.

bdemers
bdemers reviewed Jul 2, 2020
View reviewed changes
MIGRATING.md Outdated Show resolved Hide resolved
bdemers
bdemers reviewed Jul 2, 2020
View reviewed changes
MIGRATING.md Outdated Show resolved Hide resolved
bdemers
bdemers reviewed Jul 2, 2020
View reviewed changes
MIGRATING.md Outdated Show resolved Hide resolved
bdemers
bdemers reviewed Jul 2, 2020
View reviewed changes
MIGRATING.md Outdated Show resolved Hide resolved
bdemers
bdemers reviewed Jul 2, 2020
View reviewed changes
MIGRATING.md Outdated Show resolved Hide resolved
bdemers
bdemers reviewed Jul 2, 2020
View reviewed changes
MIGRATING.md Outdated Show resolved Hide resolved
bdemers
bdemers reviewed Jul 2, 2020
View reviewed changes
MIGRATING.md Outdated Show resolved Hide resolved
bdemers
bdemers reviewed Jul 2, 2020
View reviewed changes
MIGRATING.md Outdated Show resolved Hide resolved
bdemers
bdemers reviewed Jul 2, 2020
View reviewed changes
MIGRATING.md Outdated Show resolved Hide resolved
bdemers
bdemers reviewed Jul 2, 2020
View reviewed changes
MIGRATING.md Outdated Show resolved Hide resolved
bdemers
bdemers reviewed Jul 2, 2020
View reviewed changes
MIGRATING.md Outdated Show resolved Hide resolved
bdemers
bdemers reviewed Jul 2, 2020
View reviewed changes
MIGRATING.md Show resolved Hide resolved
bdemers
bdemers reviewed Jul 2, 2020
View reviewed changes
MIGRATING.md Outdated Show resolved Hide resolved
bdemers
bdemers reviewed Jul 2, 2020
View reviewed changes
MIGRATING.md Outdated Show resolved Hide resolved
bdemers
bdemers reviewed Jul 2, 2020
View reviewed changes
MIGRATING.md Outdated Show resolved Hide resolved
bdemers
bdemers reviewed Jul 2, 2020
View reviewed changes
MIGRATING.md Outdated Show resolved Hide resolved
bdemers
bdemers reviewed Jul 2, 2020
View reviewed changes
MIGRATING.md Outdated Show resolved Hide resolved
bdemers
bdemers reviewed Jul 2, 2020
View reviewed changes
MIGRATING.md Outdated Show resolved Hide resolved
bdemers
bdemers suggested changes Jul 2, 2020
View reviewed changes
Copy link
Contributor

@bdemers bdemers left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Great first pass!
We need to provide some explanations, and directions on what to do for the migration.

the JsonWebKey.getExpiresAt type change concerns me, this seems like a bug in the spec (probably a field missing a format: "date-time")

@arvindkrishnakumar-okta arvindkrishnakumar-okta force-pushed the okta-308935-create-migration-guide-for-sdk-v2.0.0 branch from 838a306 to b836376 Compare July 2, 2020 16:12
@arvindkrishnakumar-okta arvindkrishnakumar-okta force-pushed the okta-308935-create-migration-guide-for-sdk-v2.0.0 branch from d122277 to edce132 Compare July 7, 2020 17:01
bdemers
bdemers reviewed Jul 7, 2020
View reviewed changes
MIGRATING.md Outdated
- `listGroups(String q, String filter, String expand)`
Signature changed to `listGroups(String q, String filter)`

With this removal of `expand` parameter, the caller has two options of achieving the previous result:
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This should be indented, take a look at how the page renders

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

fixed

bdemers
bdemers reviewed Jul 7, 2020
View reviewed changes
MIGRATING.md Outdated Show resolved Hide resolved
bdemers
bdemers reviewed Jul 7, 2020
View reviewed changes
MIGRATING.md Outdated Show resolved Hide resolved
bdemers
bdemers reviewed Jul 7, 2020
View reviewed changes
MIGRATING.md Outdated Show resolved Hide resolved
bdemers
bdemers reviewed Jul 7, 2020
View reviewed changes
MIGRATING.md Outdated
.get("/api/v1/groups", ExtensibleResource.class);
```

Note that the support for `expand` parameter support might go away anytime in future.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

indent

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

fixed

bdemers
bdemers reviewed Jul 7, 2020
View reviewed changes
MIGRATING.md Outdated Show resolved Hide resolved
bdemers
bdemers reviewed Jul 7, 2020
View reviewed changes
MIGRATING.md
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`.

- `getCredentialProvider` Return type changed from `List<com.okta.sdk.resource.log.LogCredentialProvider>` to `com.okta.sdk.resource.log.LogCredentialProvider`
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

was the previous spec wrong?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

looks like it, yes.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

add a note about this

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

will do

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

done

bdemers
bdemers reviewed Jul 7, 2020
View reviewed changes
MIGRATING.md
The API to get log credential type used to return a list of objects of type `LogCredentialType` earlier.
Moving forward, the return type will be a single object of type `LogCredentialType`.

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

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

was the spec wrong before?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

looks like it, yes.

bdemers
bdemers reviewed Jul 7, 2020
View reviewed changes
MIGRATING.md Show resolved Hide resolved
bdemers
bdemers reviewed Jul 7, 2020
View reviewed changes
MIGRATING.md Show resolved Hide resolved
bdemers
bdemers reviewed Jul 7, 2020
View reviewed changes
MIGRATING.md Outdated Show resolved Hide resolved
bdemers
bdemers reviewed Jul 7, 2020
View reviewed changes
MIGRATING.md Outdated Show resolved Hide resolved
bdemers
bdemers reviewed Jul 7, 2020
View reviewed changes
MIGRATING.md Show resolved Hide resolved
@arvindkrishnakumar-okta arvindkrishnakumar-okta force-pushed the okta-308935-create-migration-guide-for-sdk-v2.0.0 branch from 98cb4c4 to 4fb60d7 Compare July 7, 2020 17:22
@arvindkrishnakumar-okta arvindkrishnakumar-okta merged commit 4a39c4b into dev_openapi_v2.0.0_major_rel Jul 7, 2020
@arvindkrishnakumar-okta arvindkrishnakumar-okta deleted the okta-308935-create-migration-guide-for-sdk-v2.0.0 branch July 7, 2020 19:38
arvindkrishnakumar-okta added a commit that referenced this pull request Jul 7, 2020
@arvindkrishnakumar-okta @ivanezeigbo-okta @bdemers
OKTA-302317: Release Java Mgmt SDK v2.0.0 (#422)
03cabad 
* upgrade to openapi v2.0.0 (#380)

* openapi spec update - remove 200 response from generateCsrForApplication

* Update OktaOrgCleaner.groovy

* Fix flaky GroupsIT#groupUserOperationsTest test

* Update GroupsIT.groovy

* OKTA-279039: Fix flaky ApplicationsIT associateUserWithApplication test

* Update GroupsIT.groovy

* Addressed review comment

* OKTA-289656: Add Applications API Integration Tests

* OKTA-289655: Add Admin role API Integration Tests

* Open API Csr rename update (#394)

* openapi csr rename update

* Merge pull request #396

* revert csr model rename (#398)

* revert csr model rename

* open api spec update (#401)

* open api spec update

* Open API spec - fix binding enum value for ProtocolEndpoint model (#406)

* OKTA-289662: Add SMS Templates API Integration Tests (#395)

* OKTA-289665: Add Linked Objects Integration Tests (#404)

* Updated Licence Header in LinkedObjectsIT (#410)

* OKTA-289668: Add User Type Integration Tests (#405)

* Open API Update - Sync with #238 #239  (#411)

* sync with open api pr #240 (#413)

* Open API Update - Sync with #241 (#412)

* Open API Update - Sync with #242 (#414)

* Open API Update - Sync with Open API PR 243 (#416)

* OKTA-289657: Add Factors API Integration Tests (#391)

* OKTA-289659: Add Event Hooks Integration Tests (#399)

* OKTA-289659: Add Authorization Server Integration Tests (#402)

* OKTA-289660: Add Inline Hooks Integration Tests (#400)

* Open API Update - Sync with Open API PR 244 (#418)

* fixed copy paste error

* OKTA-289661: Add Feature API Integration Tests (#397)

* Open API Update - Sync with Open API PR 249 (#420)

* OKTA-289663: Add IdP Integration Tests (#409)

* resolved merge conflicts with master changes

* removed Default prefix from few Idp builders

* added swagger code gen check for backward compatibility requirements per review comments

* fixed findbugs error

* updates per swagger regen code and one other update to Idp builder

* fixed expiresAt param type in spec

* deprecated old classes

* refactored InlineHooksIT - deactivate created hooks so it can be cleaned up after test

* Remove deprecated code (#426)

* Remove deprecated code

* fix typo

* fixed PMD violation - unused inports

* Update integration-tests/src/test/groovy/com/okta/sdk/tests/it/CrudTestSupport.groovy

Co-authored-by: Brian Demers <bdemers@apache.org>

* Update integration-tests/src/test/groovy/com/okta/sdk/tests/it/FactorsIT.groovy

Co-authored-by: Brian Demers <bdemers@apache.org>

* Update integration-tests/src/test/groovy/com/okta/sdk/tests/it/UsersIT.groovy

Co-authored-by: Brian Demers <bdemers@apache.org>

* Update integration-tests/src/test/groovy/com/okta/sdk/tests/it/GroupsIT.groovy

Co-authored-by: Brian Demers <bdemers@apache.org>

* minor improvements (#427)

* OKTA-308935: Create Migration Guide for Java Mgmt SDK v2.0.0 (#423)

Co-authored-by: Ivan Ezeigbo <56391095+ivanezeigbo-okta@users.noreply.github.com>
Co-authored-by: Brian Demers <bdemers@apache.org>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@bdemers bdemers bdemers approved these changes

@laura-rodriguez laura-rodriguez laura-rodriguez approved these changes

@robertjd robertjd Awaiting requested review from robertjd

@shuowu shuowu Awaiting requested review from shuowu

@bryanapellanes-okta bryanapellanes-okta Awaiting requested review from bryanapellanes-okta

@vijetmahabaleshwar-okta vijetmahabaleshwar-okta Awaiting requested review from vijetmahabaleshwar-okta

@bretterer bretterer Awaiting requested review from bretterer

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
6 participants
@arvindkrishnakumar-okta @codecov-commenter @bdemers @bretterer @laura-rodriguez @vijetmahabaleshwar-okta