You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@atlas.apache.org by Apoorv Naik <na...@gmail.com> on 2017/03/15 17:36:26 UTC
Review Request 57655: Javadocs and comment changes for
Enunciate/Swagger
-----------------------------------------------------------
This is an automatically generated e-mail. To reply, visit:
https://reviews.apache.org/r/57655/
-----------------------------------------------------------
Review request for atlas.
Bugs: ATLAS-1370
https://issues.apache.org/jira/browse/ATLAS-1370
Repository: atlas
Description
-------
Updated several javadoc comments after a review round within the atlas dev community.
Diffs
-----
build-tools/src/main/resources/enunciate.xml dafd66f9
intg/src/main/java/org/apache/atlas/exception/AtlasBaseException.java 55387027
intg/src/main/java/org/apache/atlas/model/PList.java 0e1722f2
intg/src/main/java/org/apache/atlas/model/SearchFilter.java 7dccf5ef
intg/src/main/java/org/apache/atlas/model/TypeCategory.java e47a8a7d
intg/src/main/java/org/apache/atlas/model/discovery/AtlasSearchResult.java bf1c80e8
intg/src/main/java/org/apache/atlas/model/impexp/AtlasExportRequest.java a015e9bf
intg/src/main/java/org/apache/atlas/model/impexp/AtlasExportResult.java e6a967e5
intg/src/main/java/org/apache/atlas/model/impexp/AtlasImportRequest.java 7530196d
intg/src/main/java/org/apache/atlas/model/impexp/AtlasImportResult.java bfb76377
intg/src/main/java/org/apache/atlas/model/instance/AtlasClassification.java bc48366a
intg/src/main/java/org/apache/atlas/model/instance/AtlasEntity.java 4e3895df
intg/src/main/java/org/apache/atlas/model/instance/AtlasEntityHeader.java 324946a9
intg/src/main/java/org/apache/atlas/model/instance/AtlasObjectId.java 5f0e093d
intg/src/main/java/org/apache/atlas/model/instance/AtlasStruct.java 7c8ae2d7
intg/src/main/java/org/apache/atlas/model/instance/ClassificationAssociateRequest.java 8d0fac61
intg/src/main/java/org/apache/atlas/model/instance/EntityMutationResponse.java 70784363
intg/src/main/java/org/apache/atlas/model/instance/EntityMutations.java b5094205
intg/src/main/java/org/apache/atlas/model/instance/GuidMapping.java 1dab56ad
intg/src/main/java/org/apache/atlas/model/lineage/AtlasLineageInfo.java 561ece51
intg/src/main/java/org/apache/atlas/model/typedef/AtlasBaseTypeDef.java 7308eb73
intg/src/main/java/org/apache/atlas/model/typedef/AtlasClassificationDef.java eeaf7141
intg/src/main/java/org/apache/atlas/model/typedef/AtlasEntityDef.java 85e9d77e
intg/src/main/java/org/apache/atlas/model/typedef/AtlasEnumDef.java a9aaed24
intg/src/main/java/org/apache/atlas/model/typedef/AtlasStructDef.java aee4907a
intg/src/main/java/org/apache/atlas/model/typedef/AtlasTypeDefHeader.java 23b63457
intg/src/main/java/org/apache/atlas/model/typedef/AtlasTypesDef.java af95bff5
intg/src/main/java/org/apache/atlas/store/AtlasTypeDefStore.java 9564b0ca
intg/src/main/java/org/apache/atlas/type/AtlasEnumType.java 1cd27b39
intg/src/main/java/org/apache/atlas/type/AtlasMapType.java 385a9ae9
intg/src/main/java/org/apache/atlas/type/AtlasStructType.java 0eeaf9c2
intg/src/main/java/org/apache/atlas/type/AtlasType.java 28d0a074
intg/src/main/java/org/apache/atlas/type/AtlasTypeRegistry.java ddb6c714
intg/src/main/java/org/apache/atlas/type/AtlasTypeUtil.java eca1abf9
Diff: https://reviews.apache.org/r/57655/diff/1/
Testing
-------
mvn clean install -DskipTests -DskipSite=false -DskipEnunciate=false generates required docs correctly
mvn clean install also runs fine
Thanks,
Apoorv Naik
Re: Review Request 57655: Javadocs and comment changes for
Enunciate/Swagger
Posted by Apoorv Naik <na...@gmail.com>.
> On March 16, 2017, 10:49 p.m., Madhan Neethiraj wrote:
> > intg/src/main/java/org/apache/atlas/model/instance/AtlasEntity.java
> > Line 602 (original), 593 (patched)
> > <https://reviews.apache.org/r/57655/diff/1/?file=1665607#file1665607line608>
> >
> > @XmlSeeAlso annotation might be required when/if this class is used in REST API calls. Consider not deleting this annotation. Please review other such occurances as well.
I tested this change by exposing a temporary API with return type as Atlas(Classification/Enum/Entity/Struct)Defs, removal of @XmlSeeAlso doesn't affect deserialization of the PList<T>.
- Apoorv
-----------------------------------------------------------
This is an automatically generated e-mail. To reply, visit:
https://reviews.apache.org/r/57655/#review169221
-----------------------------------------------------------
On March 15, 2017, 5:36 p.m., Apoorv Naik wrote:
>
> -----------------------------------------------------------
> This is an automatically generated e-mail. To reply, visit:
> https://reviews.apache.org/r/57655/
> -----------------------------------------------------------
>
> (Updated March 15, 2017, 5:36 p.m.)
>
>
> Review request for atlas.
>
>
> Bugs: ATLAS-1370
> https://issues.apache.org/jira/browse/ATLAS-1370
>
>
> Repository: atlas
>
>
> Description
> -------
>
> Updated several javadoc comments after a review round within the atlas dev community.
>
>
> Diffs
> -----
>
> build-tools/src/main/resources/enunciate.xml dafd66f9
> intg/src/main/java/org/apache/atlas/exception/AtlasBaseException.java 55387027
> intg/src/main/java/org/apache/atlas/model/PList.java 0e1722f2
> intg/src/main/java/org/apache/atlas/model/SearchFilter.java 7dccf5ef
> intg/src/main/java/org/apache/atlas/model/TypeCategory.java e47a8a7d
> intg/src/main/java/org/apache/atlas/model/discovery/AtlasSearchResult.java bf1c80e8
> intg/src/main/java/org/apache/atlas/model/impexp/AtlasExportRequest.java a015e9bf
> intg/src/main/java/org/apache/atlas/model/impexp/AtlasExportResult.java e6a967e5
> intg/src/main/java/org/apache/atlas/model/impexp/AtlasImportRequest.java 7530196d
> intg/src/main/java/org/apache/atlas/model/impexp/AtlasImportResult.java bfb76377
> intg/src/main/java/org/apache/atlas/model/instance/AtlasClassification.java bc48366a
> intg/src/main/java/org/apache/atlas/model/instance/AtlasEntity.java 4e3895df
> intg/src/main/java/org/apache/atlas/model/instance/AtlasEntityHeader.java 324946a9
> intg/src/main/java/org/apache/atlas/model/instance/AtlasObjectId.java 5f0e093d
> intg/src/main/java/org/apache/atlas/model/instance/AtlasStruct.java 7c8ae2d7
> intg/src/main/java/org/apache/atlas/model/instance/ClassificationAssociateRequest.java 8d0fac61
> intg/src/main/java/org/apache/atlas/model/instance/EntityMutationResponse.java 70784363
> intg/src/main/java/org/apache/atlas/model/instance/EntityMutations.java b5094205
> intg/src/main/java/org/apache/atlas/model/instance/GuidMapping.java 1dab56ad
> intg/src/main/java/org/apache/atlas/model/lineage/AtlasLineageInfo.java 561ece51
> intg/src/main/java/org/apache/atlas/model/typedef/AtlasBaseTypeDef.java 7308eb73
> intg/src/main/java/org/apache/atlas/model/typedef/AtlasClassificationDef.java eeaf7141
> intg/src/main/java/org/apache/atlas/model/typedef/AtlasEntityDef.java 85e9d77e
> intg/src/main/java/org/apache/atlas/model/typedef/AtlasEnumDef.java a9aaed24
> intg/src/main/java/org/apache/atlas/model/typedef/AtlasStructDef.java aee4907a
> intg/src/main/java/org/apache/atlas/model/typedef/AtlasTypeDefHeader.java 23b63457
> intg/src/main/java/org/apache/atlas/model/typedef/AtlasTypesDef.java af95bff5
> intg/src/main/java/org/apache/atlas/store/AtlasTypeDefStore.java 9564b0ca
> intg/src/main/java/org/apache/atlas/type/AtlasEnumType.java 1cd27b39
> intg/src/main/java/org/apache/atlas/type/AtlasMapType.java 385a9ae9
> intg/src/main/java/org/apache/atlas/type/AtlasStructType.java 0eeaf9c2
> intg/src/main/java/org/apache/atlas/type/AtlasType.java 28d0a074
> intg/src/main/java/org/apache/atlas/type/AtlasTypeRegistry.java ddb6c714
> intg/src/main/java/org/apache/atlas/type/AtlasTypeUtil.java eca1abf9
>
>
> Diff: https://reviews.apache.org/r/57655/diff/1/
>
>
> Testing
> -------
>
> mvn clean install -DskipTests -DskipSite=false -DskipEnunciate=false generates required docs correctly
> mvn clean install also runs fine
>
>
> Thanks,
>
> Apoorv Naik
>
>
Re: Review Request 57655: Javadocs and comment changes for
Enunciate/Swagger
Posted by Madhan Neethiraj <ma...@apache.org>.
-----------------------------------------------------------
This is an automatically generated e-mail. To reply, visit:
https://reviews.apache.org/r/57655/#review169221
-----------------------------------------------------------
Fix it, then Ship it!
intg/src/main/java/org/apache/atlas/model/instance/AtlasEntity.java
Line 602 (original), 593 (patched)
<https://reviews.apache.org/r/57655/#comment241560>
@XmlSeeAlso annotation might be required when/if this class is used in REST API calls. Consider not deleting this annotation. Please review other such occurances as well.
- Madhan Neethiraj
On March 15, 2017, 5:36 p.m., Apoorv Naik wrote:
>
> -----------------------------------------------------------
> This is an automatically generated e-mail. To reply, visit:
> https://reviews.apache.org/r/57655/
> -----------------------------------------------------------
>
> (Updated March 15, 2017, 5:36 p.m.)
>
>
> Review request for atlas.
>
>
> Bugs: ATLAS-1370
> https://issues.apache.org/jira/browse/ATLAS-1370
>
>
> Repository: atlas
>
>
> Description
> -------
>
> Updated several javadoc comments after a review round within the atlas dev community.
>
>
> Diffs
> -----
>
> build-tools/src/main/resources/enunciate.xml dafd66f9
> intg/src/main/java/org/apache/atlas/exception/AtlasBaseException.java 55387027
> intg/src/main/java/org/apache/atlas/model/PList.java 0e1722f2
> intg/src/main/java/org/apache/atlas/model/SearchFilter.java 7dccf5ef
> intg/src/main/java/org/apache/atlas/model/TypeCategory.java e47a8a7d
> intg/src/main/java/org/apache/atlas/model/discovery/AtlasSearchResult.java bf1c80e8
> intg/src/main/java/org/apache/atlas/model/impexp/AtlasExportRequest.java a015e9bf
> intg/src/main/java/org/apache/atlas/model/impexp/AtlasExportResult.java e6a967e5
> intg/src/main/java/org/apache/atlas/model/impexp/AtlasImportRequest.java 7530196d
> intg/src/main/java/org/apache/atlas/model/impexp/AtlasImportResult.java bfb76377
> intg/src/main/java/org/apache/atlas/model/instance/AtlasClassification.java bc48366a
> intg/src/main/java/org/apache/atlas/model/instance/AtlasEntity.java 4e3895df
> intg/src/main/java/org/apache/atlas/model/instance/AtlasEntityHeader.java 324946a9
> intg/src/main/java/org/apache/atlas/model/instance/AtlasObjectId.java 5f0e093d
> intg/src/main/java/org/apache/atlas/model/instance/AtlasStruct.java 7c8ae2d7
> intg/src/main/java/org/apache/atlas/model/instance/ClassificationAssociateRequest.java 8d0fac61
> intg/src/main/java/org/apache/atlas/model/instance/EntityMutationResponse.java 70784363
> intg/src/main/java/org/apache/atlas/model/instance/EntityMutations.java b5094205
> intg/src/main/java/org/apache/atlas/model/instance/GuidMapping.java 1dab56ad
> intg/src/main/java/org/apache/atlas/model/lineage/AtlasLineageInfo.java 561ece51
> intg/src/main/java/org/apache/atlas/model/typedef/AtlasBaseTypeDef.java 7308eb73
> intg/src/main/java/org/apache/atlas/model/typedef/AtlasClassificationDef.java eeaf7141
> intg/src/main/java/org/apache/atlas/model/typedef/AtlasEntityDef.java 85e9d77e
> intg/src/main/java/org/apache/atlas/model/typedef/AtlasEnumDef.java a9aaed24
> intg/src/main/java/org/apache/atlas/model/typedef/AtlasStructDef.java aee4907a
> intg/src/main/java/org/apache/atlas/model/typedef/AtlasTypeDefHeader.java 23b63457
> intg/src/main/java/org/apache/atlas/model/typedef/AtlasTypesDef.java af95bff5
> intg/src/main/java/org/apache/atlas/store/AtlasTypeDefStore.java 9564b0ca
> intg/src/main/java/org/apache/atlas/type/AtlasEnumType.java 1cd27b39
> intg/src/main/java/org/apache/atlas/type/AtlasMapType.java 385a9ae9
> intg/src/main/java/org/apache/atlas/type/AtlasStructType.java 0eeaf9c2
> intg/src/main/java/org/apache/atlas/type/AtlasType.java 28d0a074
> intg/src/main/java/org/apache/atlas/type/AtlasTypeRegistry.java ddb6c714
> intg/src/main/java/org/apache/atlas/type/AtlasTypeUtil.java eca1abf9
>
>
> Diff: https://reviews.apache.org/r/57655/diff/1/
>
>
> Testing
> -------
>
> mvn clean install -DskipTests -DskipSite=false -DskipEnunciate=false generates required docs correctly
> mvn clean install also runs fine
>
>
> Thanks,
>
> Apoorv Naik
>
>