atlas-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From Madhan Neethiraj <mad...@apache.org>
Subject Re: Review Request 60681: ATLAS-1698 Glossary OMAS API - early Swagger draft
Date Thu, 26 Oct 2017 23:19:10 GMT

-----------------------------------------------------------
This is an automatically generated e-mail. To reply, visit:
https://reviews.apache.org/r/60681/#review189357
-----------------------------------------------------------




subjectarea-omas/src/main/java/org/apache/atlas/omas/subjectarea/category/Category.java
Lines 49 (patched)
<https://reviews.apache.org/r/60681/#comment266397>

    Instead of having entire object here, consider using 'Refernce' (which seems to be similar
to AtlasObjectId used in entity attributes).
    
    This can help avoid dealing with circular references - like here: Catagory.parentCatagory
object would include reference this Catagory object via it's childrenCategories.



subjectarea-omas/src/main/java/org/apache/atlas/omas/subjectarea/category/Category.java
Lines 139 (patched)
<https://reviews.apache.org/r/60681/#comment266399>

    Consider adding toString() method to all data classes in omas, similar to AtlasStruct.toString().
This will come handy in troubleshootting.



subjectarea-omas/src/main/java/org/apache/atlas/omas/subjectarea/common/Classification.java
Lines 57 (patched)
<https://reviews.apache.org/r/60681/#comment266404>

    An instance of Classification doesn't have a 'qualifiedName' i.e. it doesn't have an identity
outside of the entity to which it is associated with.
    
    Instead, it should have the following fields - similar to AtlasClassification:
    
        private String              typeName;
        private Map<String, Object> attributes;
    
    Also, AtlasClassification doesn't have attributes createdBy, updatedBy, createTime, updateTime
and version. Please review.



subjectarea-omas/src/main/java/org/apache/atlas/omas/subjectarea/common/EmbeddedMedia.java
Lines 38 (patched)
<https://reviews.apache.org/r/60681/#comment266405>

    Shouldn't EmbeddedMedia extend from "Entity", similar to Catagory class above?



subjectarea-omas/src/main/java/org/apache/atlas/omas/subjectarea/common/Entity.java
Lines 57 (patched)
<https://reviews.apache.org/r/60681/#comment266381>

    Would 'owner' attribite be applicable/available to all sub-types of Entity?



subjectarea-omas/src/main/java/org/apache/atlas/omas/subjectarea/common/MediaUsage.java
Lines 40 (patched)
<https://reviews.apache.org/r/60681/#comment266406>

    Consider adding 'UNKNOWN' element to all enums - which can be used to map elements that
are in Atlas but not in OMAS class.



subjectarea-omas/src/main/java/org/apache/atlas/omas/subjectarea/common/Relatable.java
Lines 35 (patched)
<https://reviews.apache.org/r/60681/#comment266411>

    Relatable ==> RelatedEntity?



subjectarea-omas/src/main/java/org/apache/atlas/omas/subjectarea/graph/GlossaryGraphEdge.java
Lines 41 (patched)
<https://reviews.apache.org/r/60681/#comment266427>

    getSerialVersionUID() - why is this accessor needed? Consider removing it from this and
other classes.


- Madhan Neethiraj


On Oct. 19, 2017, 4 p.m., David Radley wrote:
> 
> -----------------------------------------------------------
> This is an automatically generated e-mail. To reply, visit:
> https://reviews.apache.org/r/60681/
> -----------------------------------------------------------
> 
> (Updated Oct. 19, 2017, 4 p.m.)
> 
> 
> Review request for atlas and Madhan Neethiraj.
> 
> 
> Repository: atlas
> 
> 
> Description
> -------
> 
> This is stub code to generate some Glossary OMAS REST interfaces. 
> 
> It does not include : 
> - lineage
> 
> This patch is not to be committed at this time- it is for review purposes only.
> 
> 
> Diffs
> -----
> 
>   build-tools/src/main/resources/enunciate.xml dafd66f9 
>   pom.xml f01c3418 
>   subjectarea-omas/pom.xml PRE-CREATION 
>   subjectarea-omas/src/main/java/org/apache/atlas/omas/subjectarea/category/Category.java
PRE-CREATION 
>   subjectarea-omas/src/main/java/org/apache/atlas/omas/subjectarea/common/Classification.java
PRE-CREATION 
>   subjectarea-omas/src/main/java/org/apache/atlas/omas/subjectarea/common/EmbeddedMedia.java
PRE-CREATION 
>   subjectarea-omas/src/main/java/org/apache/atlas/omas/subjectarea/common/Entity.java
PRE-CREATION 
>   subjectarea-omas/src/main/java/org/apache/atlas/omas/subjectarea/common/MediaUsage.java
PRE-CREATION 
>   subjectarea-omas/src/main/java/org/apache/atlas/omas/subjectarea/common/PList.java
PRE-CREATION 
>   subjectarea-omas/src/main/java/org/apache/atlas/omas/subjectarea/common/Permission.java
PRE-CREATION 
>   subjectarea-omas/src/main/java/org/apache/atlas/omas/subjectarea/common/Reference.java
PRE-CREATION 
>   subjectarea-omas/src/main/java/org/apache/atlas/omas/subjectarea/common/Relatable.java
PRE-CREATION 
>   subjectarea-omas/src/main/java/org/apache/atlas/omas/subjectarea/common/Relationship.java
PRE-CREATION 
>   subjectarea-omas/src/main/java/org/apache/atlas/omas/subjectarea/common/SearchFilter.java
PRE-CREATION 
>   subjectarea-omas/src/main/java/org/apache/atlas/omas/subjectarea/common/Status.java
PRE-CREATION 
>   subjectarea-omas/src/main/java/org/apache/atlas/omas/subjectarea/exception/OMASBaseException.java
PRE-CREATION 
>   subjectarea-omas/src/main/java/org/apache/atlas/omas/subjectarea/exception/OMASErrorCode.java
PRE-CREATION 
>   subjectarea-omas/src/main/java/org/apache/atlas/omas/subjectarea/glossary/Anchor.java
PRE-CREATION 
>   subjectarea-omas/src/main/java/org/apache/atlas/omas/subjectarea/glossary/Glossary.java
PRE-CREATION 
>   subjectarea-omas/src/main/java/org/apache/atlas/omas/subjectarea/graph/GlossaryGraph.java
PRE-CREATION 
>   subjectarea-omas/src/main/java/org/apache/atlas/omas/subjectarea/graph/GlossaryGraphEdge.java
PRE-CREATION 
>   subjectarea-omas/src/main/java/org/apache/atlas/omas/subjectarea/graph/GlossaryGraphEdgeDirection.java
PRE-CREATION 
>   subjectarea-omas/src/main/java/org/apache/atlas/omas/subjectarea/graph/GlossaryGraphNode.java
PRE-CREATION 
>   subjectarea-omas/src/main/java/org/apache/atlas/omas/subjectarea/graph/Graphformat.java
PRE-CREATION 
>   subjectarea-omas/src/main/java/org/apache/atlas/omas/subjectarea/term/ExternalGlossaryLink.java
PRE-CREATION 
>   subjectarea-omas/src/main/java/org/apache/atlas/omas/subjectarea/term/RelatedTerms/Antonym.java
PRE-CREATION 
>   subjectarea-omas/src/main/java/org/apache/atlas/omas/subjectarea/term/RelatedTerms/ISA.java
PRE-CREATION 
>   subjectarea-omas/src/main/java/org/apache/atlas/omas/subjectarea/term/RelatedTerms/PreferedTerm.java
PRE-CREATION 
>   subjectarea-omas/src/main/java/org/apache/atlas/omas/subjectarea/term/RelatedTerms/RelatedTerm.java
PRE-CREATION 
>   subjectarea-omas/src/main/java/org/apache/atlas/omas/subjectarea/term/RelatedTerms/RelatedTerms.java
PRE-CREATION 
>   subjectarea-omas/src/main/java/org/apache/atlas/omas/subjectarea/term/RelatedTerms/ReplacementTerm.java
PRE-CREATION 
>   subjectarea-omas/src/main/java/org/apache/atlas/omas/subjectarea/term/RelatedTerms/Synonym.java
PRE-CREATION 
>   subjectarea-omas/src/main/java/org/apache/atlas/omas/subjectarea/term/RelatedTerms/Translation.java
PRE-CREATION 
>   subjectarea-omas/src/main/java/org/apache/atlas/omas/subjectarea/term/RelatedTerms/ValidValue.java
PRE-CREATION 
>   subjectarea-omas/src/main/java/org/apache/atlas/omas/subjectarea/term/SemanticAssignment/SemanticAssignment.java
PRE-CREATION 
>   subjectarea-omas/src/main/java/org/apache/atlas/omas/subjectarea/term/Term.java PRE-CREATION

>   subjectarea-omas/src/main/java/org/apache/atlas/omas/subjectarea/term/TermRelationshipStatus.java
PRE-CREATION 
>   subjectarea-omas/src/main/java/org/apache/atlas/omas/subjectarea/term/contexts/Context.java
PRE-CREATION 
>   subjectarea-omas/src/main/java/org/apache/atlas/omas/subjectarea/term/spineObjects/SpineObjects.java
PRE-CREATION 
>   subjectarea-omas/src/main/java/org/apache/atlas/omas/subjectarea/term/spineObjects/TermHASARelationship.java
PRE-CREATION 
>   subjectarea-omas/src/main/java/org/apache/atlas/omas/subjectarea/term/spineObjects/TermISATYPEOFRelationship.java
PRE-CREATION 
>   subjectarea-omas/src/main/java/org/apache/atlas/omas/subjectarea/term/spineObjects/TermSpineRelationship.java
PRE-CREATION 
>   subjectarea-omas/src/main/java/org/apache/atlas/omas/subjectarea/term/spineObjects/TermTYPEDBYRelationship.java
PRE-CREATION 
>   subjectarea-omas/src/main/java/org/apache/atlas/omas/subjectarea/term/termCategorization/TermCategorization.java
PRE-CREATION 
>   subjectarea-omas/src/main/java/org/apache/atlas/omas/subjectarea/tree/GlossaryOMASCategory.java
PRE-CREATION 
>   subjectarea-omas/src/main/java/org/apache/atlas/omas/subjectarea/tree/GlossaryTreeElement.java
PRE-CREATION 
>   webapp/pom.xml 7a868086 
>   webapp/src/main/java/org/apache/atlas/web/rest/SubjectAreaOMASREST.java PRE-CREATION

> 
> 
> Diff: https://reviews.apache.org/r/60681/diff/10/
> 
> 
> Testing
> -------
> 
> generated the swagger by running mvn clean install -DskipTests -DskipEnunciate=false.

> the output is in file:///<<GIT_HOME>>/webapp/target/api/v2/apidocs/index.html
> where <<GIT_HOME>> is where you ran the Maven build.
> 
> 
> Thanks,
> 
> David Radley
> 
>


Mime
  • Unnamed multipart/alternative (inline, None, 0 bytes)
View raw message