[
https://issues.apache.org/jira/browse/ATLAS-2049?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=16147176#comment-16147176
]
Mandy Chessell commented on ATLAS-2049:
---------------------------------------
Review of patch (from 24th August).
* "Use of OMAS interfaces by applications is preferred over lower level Atlas
interfaces" - replace with "Applications, tools, engines and data platforms
SHALL use the OMAS APIs rather than the OMRS or low level Apache Atlas
interfaces.
* "Some duplication is to be expected." replace with "Some duplication of
concepts and operations will occur between OMAS APIs to ensure there in
independence between the OMAS interfaces, and each OMAS interface is
self-contained."
* "OMAS implementations will use OMRS" replace with "OMAS implementations will
use an OMRS Connector"
* "OMRS (via the connector framework)" - change to "The OMRS Connector API"
* "OMAS implementations can be built & deployed seperately" replace with "OMAS
implementations can be built & deployed separately from the open metadata
repositories."
* We may wish to deploy the OMAS capability seperately from the underlying
repository, in fact we should be able to deploy individual OMAS implementaions
seperately" replace with "An organization may deploy the OMAS APIs
independently of their metadata repositories using the **Open Metadata and
Governance Access APIs** package. This is used typically for metadata
repository clusters where the Enterprise OMRS connector is being used with
multiple metadata repositories and none of them are particularly dominant. In
fact an organization may deploy the OMAS APIs with a different OMRS connector
configured for each deployment to direct metadata requests for different
communities to different metadata repositories."
* "The structures used on the REST API should be similar to the messaging api"
replace with "The payload structures used on an OMAS REST API should be similar
to those used in its event payloads send and received through is event topics.
* Remove "Different OMASs should represent the same data in the same way" -
this is wrong since each OMAS should be targetted to a community and the
structure of metadata entities is likely to be different for each OMAS.
* "Aim to keep scoping criteria similar across OMAS APIs" - I am not sure about
the scoping criteria - this is a good discussion point.
* "The endpoint will be /v2/omas/<omasname>" - already covered but I agree that
"v2/" need to be removed from endpoint name.
* "The /v2/omas/<omasname>/>object> will be a plural noun." - This only makes
sense if multiple instances exist and for some omas APIs only one is possible -
eg the ConnectedAssetOMAS only has one asset possible.
* "OMRS kafka topic" replace with "the OMRS Topic for the appropriate open
metadata repository cluster"
* "repostitory" replace with "repository"
* "Deployment-time properties will configure the topic names to be used" - only
the root of the topic will change - the leaf par of the topic name should be
fixed and based on the name of the OMAS. Also need to consider if we allow the
OMAS to listen on OMRS Topics from multiple clusters, or none at all. I think
this is still an open question.
* "a client library" replace with "a Java client library"
* "Swagger API documentaion will be generated for each interface" - I would
also add Javadoc for client interface
* Missing point:
* * Java package names are:
------ org.apache.atlas.omas.<omasname>.client - for java client libraries
------ org.apache.atlas.omas.<omasname>.server - for server-side java that
supports the REST API
------ org.apache.atlas.omas.<omasname>.ffdc - for exceptions and error codes
> Document common standards for OMAS interfaces
> ---------------------------------------------
>
> Key: ATLAS-2049
> URL: https://issues.apache.org/jira/browse/ATLAS-2049
> Project: Atlas
> Issue Type: Sub-task
> Reporter: Nigel Jones
> Assignee: Nigel Jones
> Attachments: ATLAS-2049.patch
>
>
> Document (and review) common standards for OMAS interfaces, so as to ensure
> some consistency between the multiple OMASs being developed.
> As per phone discussion with some of team on 15 Aug will create this list in
> a text-like format (perhaps twiki) and review using review board tool.
> Since this will then form documentation for ATlas (internal) developers it
> may make sense to create as a permanent part of the twiki docs, though if so
> we may wish to consider adding other related information there such as
> architectural explanations of omrs, omas etc.
--
This message was sent by Atlassian JIRA
(v6.4.14#64029)
