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

New view services for UI #7958

Merged
merged 4 commits into from
Dec 6, 2023
Merged

New view services for UI #7958

merged 4 commits into from
Dec 6, 2023

Conversation

mandy-chessell
Copy link
Contributor

Description

This is part of the work to consolidate the UI backed services (#7924). The aim was to add the equivalent REST API services that are in the Egeria UI Application to the OMAG Server and OMAG Server Platform runtimes as view services. This met a complication that these services do not follow Egeria's exception handling rules. Therefore 2 versions of these services are needed:

  • A non-conformant version that exactly matches the Egeria UI application services. These will be used by the existing UI code. These versions are marked as deprecated.
  • A conformant version that should be used for future UI code.

The /glossary REST calls have been added to Glossary Browser OMVS. It required an extension to the underlying Asset Manager OMAS services to allow specific types of glossary term relationships to be retrieved. This update has the effect of merging the services from Glossary View OMAS into Glossary Browser OMVS. Glossary View OMAS has been marked as deprecated. When the Egeria UI Application is removed, this can be removed too.

Similarly, the /asset REST calls have been added to a new view service called Asset Catalog OMVS. Effectively we are moving Asset Catalog OMAS to Asset Catalog OMVS. Asset Catalog OMVS delegates its calls to Asset Consumer OMAS. Again Asset Catalog OMAS has been marked as deprecated and when the Egeria UI Application is removed, this can be removed too.

Finally, the /lineage REST calls have also been added to Asset Catalog OMVS. The aim is to offer a choice - the lineage queries can be directed at the main open metadata repositories. Alternatively, they can be directed to an open lineage server (aka lineage warehouse server) for an optimized version of the lineage queries. The second option is for organizations where lineage is a critical service.

At this point, the Asset Catalog OMVS REST API calls are just skeletons with no implementation. This is to allow for extensions to the search requests offered by the Open Metadata Store.

Firstly, the Anchors classification has been updated to add the type of the anchor. This will allow an asset universe search because we can search for the requested string in all element where there is an anchor classification and the typename of the anchor is "Asset" or one if its subtypes.

The extension to the Anchors classification has been done and the generic handlers are maintaining the type of anchor in the Anchors classification. The new call to the findEntities method is not in place yet.

Secondly, a new graph query is needed in the Open Metadata Store. This is to support the end-to-end lineage requests.
Once it is in place, Asset Catalog OMVS can be built out.

In addition to this work, the Admin services have been updated to add swagger annotations to all of the REST calls plus 3 new admin calls to configure an XTDB repository.

Related Issue(s)

#7924

Testing

At this stage, it is only regression testing. Once the Asset Catalog OMVS serivces are completed, then we can do a full test with the UI code.

Release Notes & Documentation

The Egeria docs website has also been updated

Additional notes

None

Signed-off-by: Mandy Chessell <mandy.e.chessell@gmail.com>
Signed-off-by: Mandy Chessell <mandy.e.chessell@gmail.com>
Signed-off-by: Mandy Chessell <mandy.e.chessell@gmail.com>
Copy link

@github-advanced-security github-advanced-security bot left a comment

Choose a reason for hiding this comment

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

CodeQL found more than 10 potential problems in the proposed changes. Check the Files changed tab for more details.

@mandy-chessell mandy-chessell merged commit b3d54a1 into odpi:main Dec 6, 2023
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