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.

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

Better Javadoc and REST URL specification #6890

Merged
merged 11 commits into from
Sep 9, 2022

Conversation

mandy-chessell
Copy link
Contributor

@mandy-chessell mandy-chessell commented Sep 8, 2022

Description

This PR extends the number of packages that are included in the javadoc. Specific the bean packages and REST beans.

It restructured the base class for ConnectedAsset to make it neater to include as a client in multiple OMASs.

It also deletes the obsolete clients from Community Profile OMAS. One of these clients was being used by the GovernanceLeadershipSample and so this needed to be recoded from the PersonalProfileManagement to the OrganizationManagement/UserIdentityManagement clients.

In rewriting the GovernanceLeadershipSample I discovered a missing method in the UserIdentityManagement client because it was not possible to set up the userIdentity entity to be anchored on the profile so there is now a new method called createUserIdentityForProfile() method.

I also noticed that there was inconsistency in how the OMASs where building there URLs in the client. This led to some URLs to miss off the serverPlatformURLRoot and others to include it twice. Therefore to reduce the randomness of these errors, the following OMASs form their URLs in a consistent way:

  • Asset Consumer OMAS
  • Asset Manager OMAS
  • Asset Owner OMAS
  • Community Profile OMAS
  • Data Manager OMAS
  • Digital Architecture OMAS
  • Discovery Engine OMAS
  • Governance Engine OMAS
  • Governance Program OMAS
  • Project Management OMAS
  • IT Infrastructure OMAS
  • Stewardship Action OMAS

This is good preparation to the refactoring of many of the REST API calls to a more consistent approach that gives opportunities for common methods in the clients.

Related Issue(s)

The updates to the Topic Integrator OMIS for #6630 are included.

Testing

FVTs - the governance samples now exit with -1 if there is an unexpected condition. This causes the build to stop if any of the samples fail (before their problems were ignored).

Release Notes & Documentation

No impact

Additional notes

None

Signed-off-by: Mandy Chessell <[email protected]>
@mandy-chessell mandy-chessell merged commit b7c08f4 into odpi:master Sep 9, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant