ATLAS-2913 : 0.8.3 Api documentation from swagger
Project: http://git-wip-us.apache.org/repos/asf/atlas-website/repo Commit: http://git-wip-us.apache.org/repos/asf/atlas-website/commit/2f6afcd8 Tree: http://git-wip-us.apache.org/repos/asf/atlas-website/tree/2f6afcd8 Diff: http://git-wip-us.apache.org/repos/asf/atlas-website/diff/2f6afcd8 Branch: refs/heads/asf-site Commit: 2f6afcd85576fe4290522c8add277213cff3fe65 Parents: 2d4dc1a Author: nixonrodrigues <ni...@apache.org> Authored: Thu Nov 1 20:07:42 2018 +0530 Committer: nixonrodrigues <ni...@apache.org> Committed: Thu Nov 1 20:09:14 2018 +0530 ---------------------------------------------------------------------- 0.8.3/api/v2/apidocs/application.wadl | 920 - 0.8.3/api/v2/apidocs/css/style.css | 115 - 0.8.3/api/v2/apidocs/data.html | 446 - 0.8.3/api/v2/apidocs/index.html | 576 - .../api/v2/apidocs/json_AtlasAttributeDef.html | 245 - .../v2/apidocs/json_AtlasBaseModelObject.html | 136 - 0.8.3/api/v2/apidocs/json_AtlasBaseTypeDef.html | 319 - .../v2/apidocs/json_AtlasClassification.html | 142 - .../v2/apidocs/json_AtlasClassificationDef.html | 368 - .../v2/apidocs/json_AtlasClassifications.html | 167 - .../api/v2/apidocs/json_AtlasConstraintDef.html | 143 - .../apidocs/json_AtlasEntitiesWithExtInfo.html | 249 - 0.8.3/api/v2/apidocs/json_AtlasEntity.html | 234 - 0.8.3/api/v2/apidocs/json_AtlasEntityDef.html | 368 - .../api/v2/apidocs/json_AtlasEntityExtInfo.html | 187 - .../api/v2/apidocs/json_AtlasEntityHeader.html | 204 - .../v2/apidocs/json_AtlasEntityWithExtInfo.html | 223 - 0.8.3/api/v2/apidocs/json_AtlasEnumDef.html | 310 - .../v2/apidocs/json_AtlasEnumElementDef.html | 150 - .../v2/apidocs/json_AtlasFullTextResult.html | 163 - 0.8.3/api/v2/apidocs/json_AtlasLineageInfo.html | 225 - 0.8.3/api/v2/apidocs/json_AtlasQueryType.html | 138 - .../api/v2/apidocs/json_AtlasSearchResult.html | 361 - 0.8.3/api/v2/apidocs/json_AtlasStruct.html | 145 - 0.8.3/api/v2/apidocs/json_AtlasStructDef.html | 348 - .../api/v2/apidocs/json_AtlasTypeDefHeader.html | 150 - 0.8.3/api/v2/apidocs/json_AtlasTypesDef.html | 592 - .../v2/apidocs/json_AtlasUserSavedSearch.html | 207 - .../v2/apidocs/json_AttributeSearchResult.html | 140 - 0.8.3/api/v2/apidocs/json_Cardinality.html | 126 - .../json_ClassificationAssociateRequest.html | 146 - 0.8.3/api/v2/apidocs/json_Condition.html | 122 - 0.8.3/api/v2/apidocs/json_Currency.html | 194 - 0.8.3/api/v2/apidocs/json_DateFormat.html | 599 - .../v2/apidocs/json_EntityMutationResponse.html | 561 - 0.8.3/api/v2/apidocs/json_EntityOperation.html | 130 - 0.8.3/api/v2/apidocs/json_FilterCriteria.html | 182 - 0.8.3/api/v2/apidocs/json_Format.html | 125 - 0.8.3/api/v2/apidocs/json_LineageDirection.html | 126 - 0.8.3/api/v2/apidocs/json_LineageRelation.html | 140 - 0.8.3/api/v2/apidocs/json_Locale.html | 357 - 0.8.3/api/v2/apidocs/json_NumberFormat.html | 609 - 0.8.3/api/v2/apidocs/json_Operator.html | 176 - 0.8.3/api/v2/apidocs/json_PList.html | 180 - 0.8.3/api/v2/apidocs/json_RoundingMode.html | 146 - 0.8.3/api/v2/apidocs/json_SavedSearchType.html | 122 - 0.8.3/api/v2/apidocs/json_SearchParameters.html | 252 - 0.8.3/api/v2/apidocs/json_SortType.html | 126 - 0.8.3/api/v2/apidocs/json_Status.html | 122 - 0.8.3/api/v2/apidocs/json_TimeZone.html | 191 - 0.8.3/api/v2/apidocs/json_TypeCategory.html | 150 - 0.8.3/api/v2/apidocs/ns0.xsd | 128 - .../api/v2/apidocs/resource_DiscoveryREST.html | 2763 -- 0.8.3/api/v2/apidocs/resource_EntityREST.html | 4689 ---- 0.8.3/api/v2/apidocs/resource_LineageREST.html | 272 - 0.8.3/api/v2/apidocs/resource_TypesREST.html | 5240 ---- 0.8.3/api/v2/apidocs/resources.html | 218 - 0.8.3/api/v2/apidocs/syntax_json.html | 391 - 0.8.3/api/v2/apidocs/syntax_xml.html | 144 - 0.8.3/api/v2/apidocs/ui/css/print.css | 1367 - 0.8.3/api/v2/apidocs/ui/css/reset.css | 125 - 0.8.3/api/v2/apidocs/ui/css/screen.css | 1494 - 0.8.3/api/v2/apidocs/ui/css/style.css | 250 - 0.8.3/api/v2/apidocs/ui/css/typography.css | 14 - .../api/v2/apidocs/ui/fonts/DroidSans-Bold.ttf | Bin 42480 -> 0 bytes 0.8.3/api/v2/apidocs/ui/fonts/DroidSans.ttf | Bin 41028 -> 0 bytes .../ui/fonts/droid-sans-v6-latin-700.eot | Bin 22922 -> 0 bytes .../ui/fonts/droid-sans-v6-latin-700.svg | 411 - .../ui/fonts/droid-sans-v6-latin-700.ttf | Bin 40513 -> 0 bytes .../ui/fonts/droid-sans-v6-latin-700.woff | Bin 25992 -> 0 bytes .../ui/fonts/droid-sans-v6-latin-700.woff2 | Bin 11480 -> 0 bytes .../ui/fonts/droid-sans-v6-latin-regular.eot | Bin 22008 -> 0 bytes .../ui/fonts/droid-sans-v6-latin-regular.svg | 403 - .../ui/fonts/droid-sans-v6-latin-regular.ttf | Bin 39069 -> 0 bytes .../ui/fonts/droid-sans-v6-latin-regular.woff | Bin 24868 -> 0 bytes .../ui/fonts/droid-sans-v6-latin-regular.woff2 | Bin 11304 -> 0 bytes 0.8.3/api/v2/apidocs/ui/images/collapse.gif | Bin 69 -> 0 bytes 0.8.3/api/v2/apidocs/ui/images/expand.gif | Bin 73 -> 0 bytes .../api/v2/apidocs/ui/images/explorer_icons.png | Bin 5115 -> 0 bytes .../api/v2/apidocs/ui/images/favicon-16x16.png | Bin 445 -> 0 bytes .../api/v2/apidocs/ui/images/favicon-32x32.png | Bin 1141 -> 0 bytes 0.8.3/api/v2/apidocs/ui/images/favicon.ico | Bin 5430 -> 0 bytes 0.8.3/api/v2/apidocs/ui/images/logo_small.png | Bin 455 -> 0 bytes .../api/v2/apidocs/ui/images/pet_store_api.png | Bin 631 -> 0 bytes 0.8.3/api/v2/apidocs/ui/images/throbber.gif | Bin 9257 -> 0 bytes 0.8.3/api/v2/apidocs/ui/images/wordnik_api.png | Bin 670 -> 0 bytes 0.8.3/api/v2/apidocs/ui/index.html | 118 - 0.8.3/api/v2/apidocs/ui/lang/ca.js | 53 - 0.8.3/api/v2/apidocs/ui/lang/el.js | 56 - 0.8.3/api/v2/apidocs/ui/lang/en.js | 56 - 0.8.3/api/v2/apidocs/ui/lang/es.js | 53 - 0.8.3/api/v2/apidocs/ui/lang/fr.js | 54 - 0.8.3/api/v2/apidocs/ui/lang/geo.js | 56 - 0.8.3/api/v2/apidocs/ui/lang/it.js | 52 - 0.8.3/api/v2/apidocs/ui/lang/ja.js | 53 - 0.8.3/api/v2/apidocs/ui/lang/ko-kr.js | 53 - 0.8.3/api/v2/apidocs/ui/lang/pl.js | 53 - 0.8.3/api/v2/apidocs/ui/lang/pt.js | 53 - 0.8.3/api/v2/apidocs/ui/lang/ru.js | 56 - 0.8.3/api/v2/apidocs/ui/lang/tr.js | 53 - 0.8.3/api/v2/apidocs/ui/lang/translator.js | 39 - 0.8.3/api/v2/apidocs/ui/lang/zh-cn.js | 53 - 0.8.3/api/v2/apidocs/ui/lib/backbone-min.js | 15 - 0.8.3/api/v2/apidocs/ui/lib/es5-shim.js | 2065 -- 0.8.3/api/v2/apidocs/ui/lib/handlebars-2.0.0.js | 28 - 0.8.3/api/v2/apidocs/ui/lib/handlebars-4.0.5.js | 4608 --- .../api/v2/apidocs/ui/lib/highlight.7.3.pack.js | 1 - .../v2/apidocs/ui/lib/highlight.9.1.0.pack.js | 2 - .../ui/lib/highlight.9.1.0.pack_extended.js | 34 - 0.8.3/api/v2/apidocs/ui/lib/jquery-1.8.0.min.js | 2 - .../api/v2/apidocs/ui/lib/jquery.ba-bbq.min.js | 18 - .../api/v2/apidocs/ui/lib/jquery.slideto.min.js | 1 - .../api/v2/apidocs/ui/lib/jquery.wiggle.min.js | 8 - 0.8.3/api/v2/apidocs/ui/lib/js-yaml.min.js | 3 - 0.8.3/api/v2/apidocs/ui/lib/jsoneditor.min.js | 11 - 0.8.3/api/v2/apidocs/ui/lib/lodash.min.js | 102 - 0.8.3/api/v2/apidocs/ui/lib/marked.js | 1272 - .../apidocs/ui/lib/object-assign-pollyfill.js | 23 - .../api/v2/apidocs/ui/lib/sanitize-html.min.js | 6 - 0.8.3/api/v2/apidocs/ui/lib/swagger-oauth.js | 347 - 0.8.3/api/v2/apidocs/ui/lib/underscore-min.js | 6 - 0.8.3/api/v2/apidocs/ui/lib/underscore-min.map | 1 - 0.8.3/api/v2/apidocs/ui/o2c.html | 20 - 0.8.3/api/v2/apidocs/ui/swagger-ui.js | 24993 ----------------- 0.8.3/api/v2/apidocs/ui/swagger-ui.min.js | 14 - 0.8.3/api/v2/apidocs/ui/swagger.json | 16593 ----------- 0.8.3/api/v2/apidocs/xml_ns0_PList.html | 242 - .../apidocs/xml_ns0_atlasBaseModelObject.html | 151 - .../v2/apidocs/xml_ns0_atlasClassification.html | 159 - 0.8.3/api/v2/apidocs/xml_ns0_atlasStruct.html | 168 - 0.8.3/api/v2/apidocs/xml_ns0_searchFilter.html | 242 - 0.8.3/api/v2/apidocs/xml_ns0_sortType.html | 130 - 0.8.3/api/v2/application.wadl | 920 + 0.8.3/api/v2/data.html | 446 + 0.8.3/api/v2/index.html | 576 + 0.8.3/api/v2/json_AtlasAttributeDef.html | 245 + 0.8.3/api/v2/json_AtlasBaseModelObject.html | 136 + 0.8.3/api/v2/json_AtlasBaseTypeDef.html | 319 + 0.8.3/api/v2/json_AtlasClassification.html | 142 + 0.8.3/api/v2/json_AtlasClassificationDef.html | 368 + 0.8.3/api/v2/json_AtlasClassifications.html | 167 + 0.8.3/api/v2/json_AtlasConstraintDef.html | 143 + 0.8.3/api/v2/json_AtlasEntitiesWithExtInfo.html | 249 + 0.8.3/api/v2/json_AtlasEntity.html | 234 + 0.8.3/api/v2/json_AtlasEntityDef.html | 368 + 0.8.3/api/v2/json_AtlasEntityExtInfo.html | 187 + 0.8.3/api/v2/json_AtlasEntityHeader.html | 204 + 0.8.3/api/v2/json_AtlasEntityWithExtInfo.html | 223 + 0.8.3/api/v2/json_AtlasEnumDef.html | 310 + 0.8.3/api/v2/json_AtlasEnumElementDef.html | 150 + 0.8.3/api/v2/json_AtlasFullTextResult.html | 163 + 0.8.3/api/v2/json_AtlasLineageInfo.html | 225 + 0.8.3/api/v2/json_AtlasQueryType.html | 138 + 0.8.3/api/v2/json_AtlasSearchResult.html | 361 + 0.8.3/api/v2/json_AtlasStruct.html | 145 + 0.8.3/api/v2/json_AtlasStructDef.html | 348 + 0.8.3/api/v2/json_AtlasTypeDefHeader.html | 150 + 0.8.3/api/v2/json_AtlasTypesDef.html | 592 + 0.8.3/api/v2/json_AtlasUserSavedSearch.html | 207 + 0.8.3/api/v2/json_AttributeSearchResult.html | 140 + 0.8.3/api/v2/json_Cardinality.html | 126 + .../v2/json_ClassificationAssociateRequest.html | 146 + 0.8.3/api/v2/json_Condition.html | 122 + 0.8.3/api/v2/json_Currency.html | 194 + 0.8.3/api/v2/json_DateFormat.html | 599 + 0.8.3/api/v2/json_EntityMutationResponse.html | 561 + 0.8.3/api/v2/json_EntityOperation.html | 130 + 0.8.3/api/v2/json_FilterCriteria.html | 182 + 0.8.3/api/v2/json_Format.html | 125 + 0.8.3/api/v2/json_LineageDirection.html | 126 + 0.8.3/api/v2/json_LineageRelation.html | 140 + 0.8.3/api/v2/json_Locale.html | 357 + 0.8.3/api/v2/json_NumberFormat.html | 609 + 0.8.3/api/v2/json_Operator.html | 176 + 0.8.3/api/v2/json_PList.html | 180 + 0.8.3/api/v2/json_RoundingMode.html | 146 + 0.8.3/api/v2/json_SavedSearchType.html | 122 + 0.8.3/api/v2/json_SearchParameters.html | 252 + 0.8.3/api/v2/json_SortType.html | 126 + 0.8.3/api/v2/json_Status.html | 122 + 0.8.3/api/v2/json_TimeZone.html | 191 + 0.8.3/api/v2/json_TypeCategory.html | 150 + 0.8.3/api/v2/ns0.xsd | 128 + 0.8.3/api/v2/resource_DiscoveryREST.html | 2763 ++ 0.8.3/api/v2/resource_EntityREST.html | 4689 ++++ 0.8.3/api/v2/resource_LineageREST.html | 272 + 0.8.3/api/v2/resource_TypesREST.html | 5240 ++++ 0.8.3/api/v2/resources.html | 218 + 0.8.3/api/v2/syntax_json.html | 391 + 0.8.3/api/v2/syntax_xml.html | 144 + 0.8.3/api/v2/xml_ns0_PList.html | 242 + 0.8.3/api/v2/xml_ns0_atlasBaseModelObject.html | 151 + 0.8.3/api/v2/xml_ns0_atlasClassification.html | 159 + 0.8.3/api/v2/xml_ns0_atlasStruct.html | 168 + 0.8.3/api/v2/xml_ns0_searchFilter.html | 242 + 0.8.3/api/v2/xml_ns0_sortType.html | 130 + 196 files changed, 27675 insertions(+), 82938 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/atlas-website/blob/2f6afcd8/0.8.3/api/v2/apidocs/application.wadl ---------------------------------------------------------------------- diff --git a/0.8.3/api/v2/apidocs/application.wadl b/0.8.3/api/v2/apidocs/application.wadl deleted file mode 100644 index 1e0e573..0000000 --- a/0.8.3/api/v2/apidocs/application.wadl +++ /dev/null @@ -1,920 +0,0 @@ -<?xml version="1.0" encoding="UTF-8" standalone="yes"?> -<?enunciate-assumed-base-uri ./?> -<wadl:application xmlns:wadl="http://wadl.dev.java.net/2009/02" xmlns:xs="http://www.w3.org/2001/XMLSchema"> - - <wadl:doc xmlns:enunciate="http://enunciate.webcohesion.com/" enunciate:generatedBy="Enunciate-2.0"/> - - <wadl:grammars> - <wadl:include href="ns0.xsd"/> - </wadl:grammars> - - <wadl:resources base="./"> - - <wadl:resource path="v2/entity"> - <wadl:method name="POST"> - <wadl:doc><![CDATA[Create new entity or update existing entity in Atlas. -Existing entity is matched using its unique guid if supplied or by its unique attributes eg: qualifiedName]]></wadl:doc> - <wadl:request> - <wadl:representation mediaType="application/json"> - </wadl:representation> - </wadl:request> - <wadl:response> - <wadl:doc><![CDATA[EntityMutationResponse]]></wadl:doc> - <wadl:representation mediaType="application/json"/> - </wadl:response> - </wadl:method> - </wadl:resource> - - <wadl:resource path="v2/entity/bulk"> - <wadl:method name="GET"> - <wadl:doc><![CDATA[Bulk API to retrieve list of entities identified by its GUIDs.]]></wadl:doc> - <wadl:request> - <wadl:param name="guid" style="query"> - <wadl:doc><![CDATA[]]></wadl:doc> - </wadl:param> - <wadl:param name="minExtInfo" style="query"> - <wadl:doc><![CDATA[]]></wadl:doc> - </wadl:param> - </wadl:request> - <wadl:response> - <wadl:representation mediaType="application/json"/> - </wadl:response> - </wadl:method> - </wadl:resource> - - <wadl:resource path="v2/entity/bulk"> - <wadl:method name="POST"> - <wadl:doc><![CDATA[Bulk API to create new entities or update existing entities in Atlas. -Existing entity is matched using its unique guid if supplied or by its unique attributes eg: qualifiedName]]></wadl:doc> - <wadl:request> - <wadl:representation mediaType="application/json"> - </wadl:representation> - </wadl:request> - <wadl:response> - <wadl:representation mediaType="application/json"/> - </wadl:response> - </wadl:method> - </wadl:resource> - - <wadl:resource path="v2/entity/bulk"> - <wadl:method name="DELETE"> - <wadl:doc><![CDATA[Bulk API to delete list of entities identified by its GUIDs]]></wadl:doc> - <wadl:request> - <wadl:param name="guid" style="query"> - <wadl:doc><![CDATA[]]></wadl:doc> - </wadl:param> - </wadl:request> - <wadl:response> - <wadl:representation mediaType="application/json"/> - </wadl:response> - </wadl:method> - </wadl:resource> - - <wadl:resource path="v2/lineage/{guid}"> - <wadl:method name="GET"> - <wadl:doc><![CDATA[Returns lineage info about entity.]]></wadl:doc> - <wadl:request> - <wadl:param name="depth" style="query"> - <wadl:doc><![CDATA[- number of hops for lineage]]></wadl:doc> - </wadl:param> - <wadl:param name="direction" style="query"> - <wadl:doc><![CDATA[- input, output or both]]></wadl:doc> - </wadl:param> - </wadl:request> - <wadl:response status="400"> - <wadl:doc><![CDATA[Bad query parameters]]></wadl:doc> - </wadl:response> - <wadl:response status="404"> - <wadl:doc><![CDATA[If no lineage is found for the given entity]]></wadl:doc> - </wadl:response> - <wadl:response status="200"> - <wadl:doc><![CDATA[AtlasLineageInfo]]></wadl:doc> - <wadl:representation mediaType="application/json"/> - </wadl:response> - </wadl:method> - <wadl:param name="guid" style="template"> - <wadl:doc><![CDATA[- unique entity id]]></wadl:doc> - </wadl:param> - </wadl:resource> - - <wadl:resource path="v2/search/attribute"> - <wadl:method name="GET"> - <wadl:doc><![CDATA[Retrieve data for the specified attribute search query]]></wadl:doc> - <wadl:request> - <wadl:param name="attrName" style="query"> - <wadl:doc><![CDATA[Attribute name]]></wadl:doc> - </wadl:param> - <wadl:param name="attrValuePrefix" style="query"> - <wadl:doc><![CDATA[Attibute value to search on]]></wadl:doc> - </wadl:param> - <wadl:param name="limit" style="query"> - <wadl:doc><![CDATA[limit the result set to only include the specified number of entries]]></wadl:doc> - </wadl:param> - <wadl:param name="offset" style="query"> - <wadl:doc><![CDATA[start offset of the result set (useful for pagination)]]></wadl:doc> - </wadl:param> - <wadl:param name="typeName" style="query"> - <wadl:doc><![CDATA[limit the result to only entities of specified type or its sub-types]]></wadl:doc> - </wadl:param> - </wadl:request> - <wadl:response status="400"> - <wadl:doc><![CDATA[Invalid wildcard or query parameters]]></wadl:doc> - </wadl:response> - <wadl:response status="200"> - <wadl:doc><![CDATA[Search results]]></wadl:doc> - <wadl:representation mediaType="application/json"/> - </wadl:response> - </wadl:method> - </wadl:resource> - - <wadl:resource path="v2/search/basic"> - <wadl:method name="GET"> - <wadl:doc><![CDATA[Retrieve data for the specified fulltext query]]></wadl:doc> - <wadl:request> - <wadl:param name="classification" style="query"> - <wadl:doc><![CDATA[limit the result to only entities tagged with the given classification or or its sub-types]]></wadl:doc> - </wadl:param> - <wadl:param name="excludeDeletedEntities" style="query"> - <wadl:doc><![CDATA[]]></wadl:doc> - </wadl:param> - <wadl:param name="limit" style="query"> - <wadl:doc><![CDATA[limit the result set to only include the specified number of entries]]></wadl:doc> - </wadl:param> - <wadl:param name="offset" style="query"> - <wadl:doc><![CDATA[start offset of the result set (useful for pagination)]]></wadl:doc> - </wadl:param> - <wadl:param name="query" style="query"> - <wadl:doc><![CDATA[Fulltext query]]></wadl:doc> - </wadl:param> - <wadl:param name="typeName" style="query"> - <wadl:doc><![CDATA[limit the result to only entities of specified type or its sub-types]]></wadl:doc> - </wadl:param> - </wadl:request> - <wadl:response status="400"> - <wadl:doc><![CDATA[Invalid fulltext or query parameters]]></wadl:doc> - </wadl:response> - <wadl:response status="200"> - <wadl:doc><![CDATA[Search results]]></wadl:doc> - <wadl:representation mediaType="application/json"/> - </wadl:response> - </wadl:method> - </wadl:resource> - - <wadl:resource path="v2/search/basic"> - <wadl:method name="POST"> - <wadl:doc><![CDATA[Attribute based search for entities satisfying the search parameters]]></wadl:doc> - <wadl:request> - <wadl:doc><![CDATA[Search parameters]]></wadl:doc> - <wadl:representation mediaType="application/json"> - </wadl:representation> - </wadl:request> - <wadl:response status="400"> - <wadl:doc><![CDATA[Tag/Entity doesn't exist or Tag/entity filter is present without tag/type name]]></wadl:doc> - </wadl:response> - <wadl:response status="200"> - <wadl:doc><![CDATA[Atlas search result]]></wadl:doc> - <wadl:representation mediaType="application/json"/> - </wadl:response> - </wadl:method> - </wadl:resource> - - <wadl:resource path="v2/search/dsl"> - <wadl:method name="GET"> - <wadl:doc><![CDATA[Retrieve data for the specified DSL]]></wadl:doc> - <wadl:request> - <wadl:param name="classification" style="query"> - <wadl:doc><![CDATA[limit the result to only entities tagged with the given classification or or its sub-types]]></wadl:doc> - </wadl:param> - <wadl:param name="limit" style="query"> - <wadl:doc><![CDATA[limit the result set to only include the specified number of entries]]></wadl:doc> - </wadl:param> - <wadl:param name="offset" style="query"> - <wadl:doc><![CDATA[start offset of the result set (useful for pagination)]]></wadl:doc> - </wadl:param> - <wadl:param name="query" style="query"> - <wadl:doc><![CDATA[DSL query]]></wadl:doc> - </wadl:param> - <wadl:param name="typeName" style="query"> - <wadl:doc><![CDATA[limit the result to only entities of specified type or its sub-types]]></wadl:doc> - </wadl:param> - </wadl:request> - <wadl:response status="400"> - <wadl:doc><![CDATA[Invalid DSL or query parameters]]></wadl:doc> - </wadl:response> - <wadl:response status="200"> - <wadl:doc><![CDATA[Search results]]></wadl:doc> - <wadl:representation mediaType="application/json"/> - </wadl:response> - </wadl:method> - </wadl:resource> - - <wadl:resource path="v2/search/fulltext"> - <wadl:method name="GET"> - <wadl:doc><![CDATA[Retrieve data for the specified fulltext query]]></wadl:doc> - <wadl:request> - <wadl:param name="excludeDeletedEntities" style="query"> - <wadl:doc><![CDATA[]]></wadl:doc> - </wadl:param> - <wadl:param name="limit" style="query"> - <wadl:doc><![CDATA[limit the result set to only include the specified number of entries]]></wadl:doc> - </wadl:param> - <wadl:param name="offset" style="query"> - <wadl:doc><![CDATA[start offset of the result set (useful for pagination)]]></wadl:doc> - </wadl:param> - <wadl:param name="query" style="query"> - <wadl:doc><![CDATA[Fulltext query]]></wadl:doc> - </wadl:param> - </wadl:request> - <wadl:response status="400"> - <wadl:doc><![CDATA[Invalid fulltext or query parameters]]></wadl:doc> - </wadl:response> - <wadl:response status="200"> - <wadl:doc><![CDATA[Search results]]></wadl:doc> - <wadl:representation mediaType="application/json"/> - </wadl:response> - </wadl:method> - </wadl:resource> - - <wadl:resource path="v2/search/relationship"> - <wadl:method name="GET"> - <wadl:doc><![CDATA[Relationship search to search for related entities satisfying the search parameters]]></wadl:doc> - <wadl:request> - <wadl:param name="excludeDeletedEntities" style="query"> - <wadl:doc><![CDATA[]]></wadl:doc> - </wadl:param> - <wadl:param name="guid" style="query"> - <wadl:doc><![CDATA[Attribute name]]></wadl:doc> - </wadl:param> - <wadl:param name="limit" style="query"> - <wadl:doc><![CDATA[limit the result set to only include the specified number of entries]]></wadl:doc> - </wadl:param> - <wadl:param name="offset" style="query"> - <wadl:doc><![CDATA[start offset of the result set (useful for pagination)]]></wadl:doc> - </wadl:param> - <wadl:param name="relation" style="query"> - <wadl:doc><![CDATA[relationName]]></wadl:doc> - </wadl:param> - <wadl:param name="sortBy" style="query"> - <wadl:doc><![CDATA[sort the result using this attribute name, default value is 'name']]></wadl:doc> - </wadl:param> - <wadl:param name="sortOrder" style="query"> - <wadl:doc><![CDATA[sorting order]]></wadl:doc> - </wadl:param> - </wadl:request> - <wadl:response status="400"> - <wadl:doc><![CDATA[guid is not a valid entity type or attributeName is not a valid relationship attribute]]></wadl:doc> - </wadl:response> - <wadl:response status="200"> - <wadl:doc><![CDATA[Atlas search result]]></wadl:doc> - <wadl:representation mediaType="application/json"/> - </wadl:response> - </wadl:method> - </wadl:resource> - - <wadl:resource path="v2/search/saved"> - <wadl:method name="POST"> - <wadl:doc><![CDATA[]]></wadl:doc> - <wadl:request> - <wadl:representation mediaType="application/json"> - </wadl:representation> - </wadl:request> - <wadl:response> - <wadl:doc><![CDATA[the saved search-object]]></wadl:doc> - <wadl:representation mediaType="application/json"/> - </wadl:response> - </wadl:method> - </wadl:resource> - - <wadl:resource path="v2/search/saved"> - <wadl:method name="PUT"> - <wadl:doc><![CDATA[]]></wadl:doc> - <wadl:request> - <wadl:representation mediaType="application/json"> - </wadl:representation> - </wadl:request> - <wadl:response> - <wadl:doc><![CDATA[the updated search-object]]></wadl:doc> - <wadl:representation mediaType="application/json"/> - </wadl:response> - </wadl:method> - </wadl:resource> - - <wadl:resource path="v2/search/saved"> - <wadl:method name="GET"> - <wadl:doc><![CDATA[]]></wadl:doc> - <wadl:request> - <wadl:param name="user" style="query"> - <wadl:doc><![CDATA[User for whom the search is retrieved]]></wadl:doc> - </wadl:param> - </wadl:request> - <wadl:response> - <wadl:doc><![CDATA[list of all saved searches for given user]]></wadl:doc> - <wadl:representation mediaType="application/json"/> - </wadl:response> - </wadl:method> - </wadl:resource> - - <wadl:resource path="v2/types/typedefs"> - <wadl:method name="GET"> - <wadl:doc><![CDATA[Bulk retrieval API for retrieving all type definitions in Atlas]]></wadl:doc> - <wadl:response status="200"> - <wadl:doc><![CDATA[A composite wrapper object with lists of all type definitions]]></wadl:doc> - <wadl:representation mediaType="application/json"/> - </wadl:response> - </wadl:method> - </wadl:resource> - - <wadl:resource path="v2/types/typedefs"> - <wadl:method name="POST"> - <wadl:doc><![CDATA[Bulk create APIs for all atlas type definitions, only new definitions will be created. -Any changes to the existing definitions will be discarded]]></wadl:doc> - <wadl:request> - <wadl:doc><![CDATA[A composite wrapper object with corresponding lists of the type definition]]></wadl:doc> - <wadl:representation mediaType="application/json"> - </wadl:representation> - </wadl:request> - <wadl:response status="400"> - <wadl:doc><![CDATA[On validation failure for any type definitions]]></wadl:doc> - </wadl:response> - <wadl:response status="200"> - <wadl:doc><![CDATA[A composite wrapper object with lists of type definitions that were successfully -created]]></wadl:doc> - <wadl:representation mediaType="application/json"/> - </wadl:response> - </wadl:method> - </wadl:resource> - - <wadl:resource path="v2/types/typedefs"> - <wadl:method name="PUT"> - <wadl:doc><![CDATA[Bulk update API for all types, changes detected in the type definitions would be persisted]]></wadl:doc> - <wadl:request> - <wadl:doc><![CDATA[A composite object that captures all type definition changes]]></wadl:doc> - <wadl:representation mediaType="application/json"> - </wadl:representation> - </wadl:request> - <wadl:response status="400"> - <wadl:doc><![CDATA[On validation failure for any type definitions]]></wadl:doc> - </wadl:response> - <wadl:response status="200"> - <wadl:doc><![CDATA[A composite object with lists of type definitions that were updated]]></wadl:doc> - <wadl:representation mediaType="application/json"/> - </wadl:response> - </wadl:method> - </wadl:resource> - - <wadl:resource path="v2/types/typedefs"> - <wadl:method name="DELETE"> - <wadl:doc><![CDATA[Bulk delete API for all types]]></wadl:doc> - <wadl:request> - <wadl:doc><![CDATA[A composite object that captures all types to be deleted]]></wadl:doc> - <wadl:representation mediaType="application/json"> - </wadl:representation> - </wadl:request> - <wadl:response status="400"> - <wadl:doc><![CDATA[On validation failure for any type definitions]]></wadl:doc> - </wadl:response> - </wadl:method> - </wadl:resource> - - <wadl:resource path="v2/entity/bulk/classification"> - <wadl:method name="POST"> - <wadl:doc><![CDATA[Bulk API to associate a tag to multiple entities]]></wadl:doc> - <wadl:request> - <wadl:representation mediaType="application/json"> - </wadl:representation> - </wadl:request> - </wadl:method> - </wadl:resource> - - <wadl:resource path="v2/entity/guid/{guid}"> - <wadl:method name="GET"> - <wadl:doc><![CDATA[Fetch complete definition of an entity given its GUID.]]></wadl:doc> - <wadl:request> - <wadl:param name="minExtInfo" style="query"> - <wadl:doc><![CDATA[]]></wadl:doc> - </wadl:param> - </wadl:request> - <wadl:response> - <wadl:doc><![CDATA[AtlasEntity]]></wadl:doc> - <wadl:representation mediaType="application/json"/> - </wadl:response> - </wadl:method> - <wadl:param name="guid" style="template"> - <wadl:doc><![CDATA[GUID for the entity]]></wadl:doc> - </wadl:param> - </wadl:resource> - - <wadl:resource path="v2/entity/guid/{guid}"> - <wadl:method name="PUT"> - <wadl:doc><![CDATA[Entity Partial Update - Add/Update entity attribute identified by its GUID. -Supports only uprimitive attribute type and entity references. -does not support updation of complex types like arrays, maps -Null updates are not possible]]></wadl:doc> - <wadl:request> - <wadl:representation mediaType="application/json"> - </wadl:representation> - <wadl:param name="name" style="query"> - <wadl:doc><![CDATA[]]></wadl:doc> - </wadl:param> - </wadl:request> - <wadl:response> - <wadl:representation mediaType="application/json"/> - </wadl:response> - </wadl:method> - <wadl:param name="guid" style="template"> - <wadl:doc><![CDATA[]]></wadl:doc> - </wadl:param> - </wadl:resource> - - <wadl:resource path="v2/entity/guid/{guid}"> - <wadl:method name="DELETE"> - <wadl:doc><![CDATA[Delete an entity identified by its GUID.]]></wadl:doc> - <wadl:request> - </wadl:request> - <wadl:response> - <wadl:doc><![CDATA[EntityMutationResponse]]></wadl:doc> - <wadl:representation mediaType="application/json"/> - </wadl:response> - </wadl:method> - <wadl:param name="guid" style="template"> - <wadl:doc><![CDATA[GUID for the entity]]></wadl:doc> - </wadl:param> - </wadl:resource> - - <wadl:resource path="v2/search/saved/{guid}"> - <wadl:method name="DELETE"> - <wadl:doc><![CDATA[]]></wadl:doc> - <wadl:request> - </wadl:request> - </wadl:method> - <wadl:param name="guid" style="template"> - <wadl:doc><![CDATA[Name of the saved search]]></wadl:doc> - </wadl:param> - </wadl:resource> - - <wadl:resource path="v2/search/saved/{name}"> - <wadl:method name="GET"> - <wadl:doc><![CDATA[]]></wadl:doc> - <wadl:request> - <wadl:param name="user" style="query"> - <wadl:doc><![CDATA[User for whom the search is retrieved]]></wadl:doc> - </wadl:param> - </wadl:request> - <wadl:response> - <wadl:representation mediaType="application/json"/> - </wadl:response> - </wadl:method> - <wadl:param name="name" style="template"> - <wadl:doc><![CDATA[Name of the saved search]]></wadl:doc> - </wadl:param> - </wadl:resource> - - <wadl:resource path="v2/types/typedefs/headers"> - <wadl:method name="GET"> - <wadl:doc><![CDATA[Bulk retrieval API for all type definitions returned as a list of minimal information header]]></wadl:doc> - <wadl:response status="200"> - <wadl:doc><![CDATA[List of AtlasTypeDefHeader AtlasTypeDefHeader]]></wadl:doc> - <wadl:representation mediaType="application/json"/> - </wadl:response> - </wadl:method> - </wadl:resource> - - <wadl:resource path="v2/entity/guid/{guid}/classifications"> - <wadl:method name="GET"> - <wadl:doc><![CDATA[Gets the list of classifications for a given entity represented by a guid.]]></wadl:doc> - <wadl:request> - </wadl:request> - <wadl:response> - <wadl:doc><![CDATA[a list of classifications for the given entity guid]]></wadl:doc> - <wadl:representation mediaType="application/json"/> - </wadl:response> - </wadl:method> - <wadl:param name="guid" style="template"> - <wadl:doc><![CDATA[globally unique identifier for the entity]]></wadl:doc> - </wadl:param> - </wadl:resource> - - <wadl:resource path="v2/entity/guid/{guid}/classifications"> - <wadl:method name="POST"> - <wadl:doc><![CDATA[Adds classifications to an existing entity represented by a guid.]]></wadl:doc> - <wadl:request> - <wadl:representation mediaType="application/json"> - </wadl:representation> - </wadl:request> - </wadl:method> - <wadl:param name="guid" style="template"> - <wadl:doc><![CDATA[globally unique identifier for the entity]]></wadl:doc> - </wadl:param> - </wadl:resource> - - <wadl:resource path="v2/entity/guid/{guid}/classifications"> - <wadl:method name="PUT"> - <wadl:doc><![CDATA[Updates classifications to an existing entity represented by a guid.]]></wadl:doc> - <wadl:request> - <wadl:representation mediaType="application/json"> - </wadl:representation> - <wadl:representation mediaType="application/xml" element="atlasClassification"> - </wadl:representation> - </wadl:request> - </wadl:method> - <wadl:param name="guid" style="template"> - <wadl:doc><![CDATA[globally unique identifier for the entity]]></wadl:doc> - </wadl:param> - </wadl:resource> - - <wadl:resource path="v2/entity/guid/{guid}/header"> - <wadl:method name="GET"> - <wadl:doc><![CDATA[Get entity header given its GUID.]]></wadl:doc> - <wadl:request> - </wadl:request> - <wadl:response> - <wadl:doc><![CDATA[AtlasEntity]]></wadl:doc> - <wadl:representation mediaType="application/json"/> - </wadl:response> - </wadl:method> - <wadl:param name="guid" style="template"> - <wadl:doc><![CDATA[GUID for the entity]]></wadl:doc> - </wadl:param> - </wadl:resource> - - <wadl:resource path="v2/entity/uniqueAttribute/type/{typeName}"> - <wadl:method name="GET"> - <wadl:doc><![CDATA[Fetch complete definition of an entity given its type and unique attribute. - -In addition to the typeName path parameter, attribute key-value pair(s) can be provided in the following format - -attr:<attrName>=<attrValue> - -NOTE: The attrName and attrValue should be unique across entities, eg. qualifiedName - -The REST request would look something like this - -GET /v2/entity/uniqueAttribute/type/aType?attr:aTypeAttribute=someValue]]></wadl:doc> - <wadl:request> - <wadl:param name="minExtInfo" style="query"> - <wadl:doc><![CDATA[]]></wadl:doc> - </wadl:param> - </wadl:request> - <wadl:response> - <wadl:doc><![CDATA[AtlasEntityWithExtInfo]]></wadl:doc> - <wadl:representation mediaType="application/json"/> - </wadl:response> - </wadl:method> - <wadl:param name="typeName" style="template"> - <wadl:doc><![CDATA[]]></wadl:doc> - </wadl:param> - </wadl:resource> - - <wadl:resource path="v2/entity/uniqueAttribute/type/{typeName}"> - <wadl:method name="PUT"> - <wadl:doc><![CDATA[Entity Partial Update - Allows a subset of attributes to be updated on -an entity which is identified by its type and unique attribute eg: Referenceable.qualifiedName. -Null updates are not possible - -In addition to the typeName path parameter, attribute key-value pair(s) can be provided in the following format - -attr:<attrName>=<attrValue> - -NOTE: The attrName and attrValue should be unique across entities, eg. qualifiedName - -The REST request would look something like this - -PUT /v2/entity/uniqueAttribute/type/aType?attr:aTypeAttribute=someValue]]></wadl:doc> - <wadl:request> - <wadl:representation mediaType="application/json"> - </wadl:representation> - </wadl:request> - <wadl:response> - <wadl:representation mediaType="application/json"/> - </wadl:response> - </wadl:method> - <wadl:param name="typeName" style="template"> - <wadl:doc><![CDATA[]]></wadl:doc> - </wadl:param> - </wadl:resource> - - <wadl:resource path="v2/entity/uniqueAttribute/type/{typeName}"> - <wadl:method name="DELETE"> - <wadl:doc><![CDATA[Delete an entity identified by its type and unique attributes. - -In addition to the typeName path parameter, attribute key-value pair(s) can be provided in the following format - -attr:<attrName>=<attrValue> - -NOTE: The attrName and attrValue should be unique across entities, eg. qualifiedName - -The REST request would look something like this - -DELETE /v2/entity/uniqueAttribute/type/aType?attr:aTypeAttribute=someValue]]></wadl:doc> - <wadl:request> - </wadl:request> - <wadl:response> - <wadl:doc><![CDATA[EntityMutationResponse]]></wadl:doc> - <wadl:representation mediaType="application/json"/> - </wadl:response> - </wadl:method> - <wadl:param name="typeName" style="template"> - <wadl:doc><![CDATA[- entity type to be deleted]]></wadl:doc> - </wadl:param> - </wadl:resource> - - <wadl:resource path="v2/search/saved/execute/{name}"> - <wadl:method name="GET"> - <wadl:doc><![CDATA[Attribute based search for entities satisfying the search parameters]]></wadl:doc> - <wadl:request> - <wadl:param name="user" style="query"> - <wadl:doc><![CDATA[saved-search owner]]></wadl:doc> - </wadl:param> - </wadl:request> - <wadl:response> - <wadl:doc><![CDATA[Atlas search result]]></wadl:doc> - <wadl:representation mediaType="application/json"/> - </wadl:response> - </wadl:method> - <wadl:param name="name" style="template"> - <wadl:doc><![CDATA[name of saved-search]]></wadl:doc> - </wadl:param> - </wadl:resource> - - <wadl:resource path="v2/types/classificationdef/guid/{guid}"> - <wadl:method name="GET"> - <wadl:doc><![CDATA[Get the classification definition for the given guid]]></wadl:doc> - <wadl:request> - </wadl:request> - <wadl:response status="404"> - <wadl:doc><![CDATA[On Failed lookup for the given guid]]></wadl:doc> - </wadl:response> - <wadl:response status="200"> - <wadl:doc><![CDATA[classification definition]]></wadl:doc> - <wadl:representation mediaType="application/json"/> - </wadl:response> - </wadl:method> - <wadl:param name="guid" style="template"> - <wadl:doc><![CDATA[classification guid]]></wadl:doc> - </wadl:param> - </wadl:resource> - - <wadl:resource path="v2/types/classificationdef/name/{name}"> - <wadl:method name="GET"> - <wadl:doc><![CDATA[Get the classification definition by it's name (unique)]]></wadl:doc> - <wadl:request> - </wadl:request> - <wadl:response status="404"> - <wadl:doc><![CDATA[On Failed lookup for the given name]]></wadl:doc> - </wadl:response> - <wadl:response status="200"> - <wadl:doc><![CDATA[classification definition]]></wadl:doc> - <wadl:representation mediaType="application/json"/> - </wadl:response> - </wadl:method> - <wadl:param name="name" style="template"> - <wadl:doc><![CDATA[classification name]]></wadl:doc> - </wadl:param> - </wadl:resource> - - <wadl:resource path="v2/types/entitydef/guid/{guid}"> - <wadl:method name="GET"> - <wadl:doc><![CDATA[Get the Entity definition for the given guid]]></wadl:doc> - <wadl:request> - </wadl:request> - <wadl:response status="404"> - <wadl:doc><![CDATA[On Failed lookup for the given guid]]></wadl:doc> - </wadl:response> - <wadl:response status="200"> - <wadl:doc><![CDATA[Entity definition]]></wadl:doc> - <wadl:representation mediaType="application/json"/> - </wadl:response> - </wadl:method> - <wadl:param name="guid" style="template"> - <wadl:doc><![CDATA[entity guid]]></wadl:doc> - </wadl:param> - </wadl:resource> - - <wadl:resource path="v2/types/entitydef/name/{name}"> - <wadl:method name="GET"> - <wadl:doc><![CDATA[Get the entity definition by it's name (unique)]]></wadl:doc> - <wadl:request> - </wadl:request> - <wadl:response status="404"> - <wadl:doc><![CDATA[On Failed lookup for the given name]]></wadl:doc> - </wadl:response> - <wadl:response status="200"> - <wadl:doc><![CDATA[Entity definition]]></wadl:doc> - <wadl:representation mediaType="application/json"/> - </wadl:response> - </wadl:method> - <wadl:param name="name" style="template"> - <wadl:doc><![CDATA[entity name]]></wadl:doc> - </wadl:param> - </wadl:resource> - - <wadl:resource path="v2/types/enumdef/guid/{guid}"> - <wadl:method name="GET"> - <wadl:doc><![CDATA[Get the enum definition for the given guid]]></wadl:doc> - <wadl:request> - </wadl:request> - <wadl:response status="404"> - <wadl:doc><![CDATA[On Failed lookup for the given guid]]></wadl:doc> - </wadl:response> - <wadl:response status="200"> - <wadl:doc><![CDATA[enum definition]]></wadl:doc> - <wadl:representation mediaType="application/json"/> - </wadl:response> - </wadl:method> - <wadl:param name="guid" style="template"> - <wadl:doc><![CDATA[enum guid]]></wadl:doc> - </wadl:param> - </wadl:resource> - - <wadl:resource path="v2/types/enumdef/name/{name}"> - <wadl:method name="GET"> - <wadl:doc><![CDATA[Get the enum definition by it's name (unique)]]></wadl:doc> - <wadl:request> - </wadl:request> - <wadl:response status="404"> - <wadl:doc><![CDATA[On Failed lookup for the given name]]></wadl:doc> - </wadl:response> - <wadl:response status="200"> - <wadl:doc><![CDATA[enum definition]]></wadl:doc> - <wadl:representation mediaType="application/json"/> - </wadl:response> - </wadl:method> - <wadl:param name="name" style="template"> - <wadl:doc><![CDATA[enum name]]></wadl:doc> - </wadl:param> - </wadl:resource> - - <wadl:resource path="v2/types/structdef/guid/{guid}"> - <wadl:method name="GET"> - <wadl:doc><![CDATA[Get the struct definition for the given guid]]></wadl:doc> - <wadl:request> - </wadl:request> - <wadl:response status="404"> - <wadl:doc><![CDATA[On Failed lookup for the given guid]]></wadl:doc> - </wadl:response> - <wadl:response status="200"> - <wadl:doc><![CDATA[struct definition]]></wadl:doc> - <wadl:representation mediaType="application/json"/> - </wadl:response> - </wadl:method> - <wadl:param name="guid" style="template"> - <wadl:doc><![CDATA[struct guid]]></wadl:doc> - </wadl:param> - </wadl:resource> - - <wadl:resource path="v2/types/structdef/name/{name}"> - <wadl:method name="GET"> - <wadl:doc><![CDATA[Get the struct definition by it's name (unique)]]></wadl:doc> - <wadl:request> - </wadl:request> - <wadl:response status="404"> - <wadl:doc><![CDATA[On Failed lookup for the given name]]></wadl:doc> - </wadl:response> - <wadl:response status="200"> - <wadl:doc><![CDATA[struct definition]]></wadl:doc> - <wadl:representation mediaType="application/json"/> - </wadl:response> - </wadl:method> - <wadl:param name="name" style="template"> - <wadl:doc><![CDATA[struct name]]></wadl:doc> - </wadl:param> - </wadl:resource> - - <wadl:resource path="v2/types/typedef/guid/{guid}"> - <wadl:method name="GET"> - <wadl:doc><![CDATA[]]></wadl:doc> - <wadl:request> - </wadl:request> - <wadl:response status="404"> - <wadl:doc><![CDATA[Failed lookup]]></wadl:doc> - </wadl:response> - <wadl:response status="200"> - <wadl:doc><![CDATA[Type definition]]></wadl:doc> - <wadl:representation mediaType="application/json"/> - </wadl:response> - </wadl:method> - <wadl:param name="guid" style="template"> - <wadl:doc><![CDATA[GUID of the type]]></wadl:doc> - </wadl:param> - </wadl:resource> - - <wadl:resource path="v2/types/typedef/name/{name}"> - <wadl:method name="GET"> - <wadl:doc><![CDATA[Get type definition by it's name]]></wadl:doc> - <wadl:request> - </wadl:request> - <wadl:response status="404"> - <wadl:doc><![CDATA[Failed lookup by name]]></wadl:doc> - </wadl:response> - <wadl:response status="200"> - <wadl:doc><![CDATA[Type definition]]></wadl:doc> - <wadl:representation mediaType="application/json"/> - </wadl:response> - </wadl:method> - <wadl:param name="name" style="template"> - <wadl:doc><![CDATA[Type name]]></wadl:doc> - </wadl:param> - </wadl:resource> - - <wadl:resource path="v2/types/typedef/name/{typeName}"> - <wadl:method name="DELETE"> - <wadl:doc><![CDATA[Delete API for type identified by its name.]]></wadl:doc> - <wadl:request> - </wadl:request> - <wadl:response status="400"> - <wadl:doc><![CDATA[On validation failure for any type definitions]]></wadl:doc> - </wadl:response> - </wadl:method> - <wadl:param name="typeName" style="template"> - <wadl:doc><![CDATA[Name of the type to be deleted.]]></wadl:doc> - </wadl:param> - </wadl:resource> - - <wadl:resource path="v2/entity/guid/{guid}/classification/{classificationName}"> - <wadl:method name="GET"> - <wadl:doc><![CDATA[Gets the list of classifications for a given entity represented by a guid.]]></wadl:doc> - <wadl:request> - </wadl:request> - <wadl:response> - <wadl:doc><![CDATA[classification for the given entity guid]]></wadl:doc> - <wadl:representation mediaType="application/json"/> - </wadl:response> - </wadl:method> - <wadl:param name="classificationName" style="template"> - <wadl:doc><![CDATA[]]></wadl:doc> - </wadl:param> - <wadl:param name="guid" style="template"> - <wadl:doc><![CDATA[globally unique identifier for the entity]]></wadl:doc> - </wadl:param> - </wadl:resource> - - <wadl:resource path="v2/entity/guid/{guid}/classification/{classificationName}"> - <wadl:method name="DELETE"> - <wadl:doc><![CDATA[Deletes a given classification from an existing entity represented by a guid.]]></wadl:doc> - <wadl:request> - </wadl:request> - </wadl:method> - <wadl:param name="classificationName" style="template"> - <wadl:doc><![CDATA[name of the classifcation]]></wadl:doc> - </wadl:param> - <wadl:param name="guid" style="template"> - <wadl:doc><![CDATA[globally unique identifier for the entity]]></wadl:doc> - </wadl:param> - </wadl:resource> - - <wadl:resource path="v2/entity/uniqueAttribute/type/{typeName}/classifications"> - <wadl:method name="POST"> - <wadl:doc><![CDATA[Adds classification to the entity identified by its type and unique attributes.]]></wadl:doc> - <wadl:request> - <wadl:representation mediaType="application/json"> - </wadl:representation> - </wadl:request> - </wadl:method> - <wadl:param name="typeName" style="template"> - <wadl:doc><![CDATA[]]></wadl:doc> - </wadl:param> - </wadl:resource> - - <wadl:resource path="v2/entity/uniqueAttribute/type/{typeName}/classifications"> - <wadl:method name="PUT"> - <wadl:doc><![CDATA[Updates classification on an entity identified by its type and unique attributes.]]></wadl:doc> - <wadl:request> - <wadl:representation mediaType="application/json"> - </wadl:representation> - </wadl:request> - </wadl:method> - <wadl:param name="typeName" style="template"> - <wadl:doc><![CDATA[]]></wadl:doc> - </wadl:param> - </wadl:resource> - - <wadl:resource path="v2/search/saved/execute/guid/{guid}"> - <wadl:method name="GET"> - <wadl:doc><![CDATA[Attribute based search for entities satisfying the search parameters]]></wadl:doc> - <wadl:request> - </wadl:request> - <wadl:response> - <wadl:doc><![CDATA[Atlas search result]]></wadl:doc> - <wadl:representation mediaType="application/json"/> - </wadl:response> - </wadl:method> - <wadl:param name="guid" style="template"> - <wadl:doc><![CDATA[Guid identifying saved search]]></wadl:doc> - </wadl:param> - </wadl:resource> - - <wadl:resource path="v2/entity/uniqueAttribute/type/{typeName}/classification/{classificationName}"> - <wadl:method name="DELETE"> - <wadl:doc><![CDATA[Deletes a given classification from an entity identified by its type and unique attributes.]]></wadl:doc> - <wadl:request> - </wadl:request> - </wadl:method> - <wadl:param name="classificationName" style="template"> - <wadl:doc><![CDATA[name of the classification]]></wadl:doc> - </wadl:param> - <wadl:param name="typeName" style="template"> - <wadl:doc><![CDATA[]]></wadl:doc> - </wadl:param> - </wadl:resource> - </wadl:resources> -</wadl:application> \ No newline at end of file http://git-wip-us.apache.org/repos/asf/atlas-website/blob/2f6afcd8/0.8.3/api/v2/apidocs/css/style.css ---------------------------------------------------------------------- diff --git a/0.8.3/api/v2/apidocs/css/style.css b/0.8.3/api/v2/apidocs/css/style.css deleted file mode 100644 index 8e05fb7..0000000 --- a/0.8.3/api/v2/apidocs/css/style.css +++ /dev/null @@ -1,115 +0,0 @@ -/* - * Base structure - */ - -/* Move down content because we have a fixed navbar that is 50px tall */ -body { - position:relative; - padding-top: 50px; -} - -.footer { - width: 100%; - /* Set the fixed height of the footer here */ - height: 60px; - background-color: #f5f5f5; -} - -/* - * Global add-ons - */ -.sub-header { - padding-bottom: 10px; - border-bottom: 1px solid #eee; -} - -/* - * Sidebar - */ - -/* Hide for mobile, show later */ -.sidebar { - display: none; -} -@media (min-width: 768px) { - .sidebar { - position: fixed; - top: 51px; - bottom: 0; - left: 0; - z-index: 1000; - display: block; - padding: 20px; - overflow-x: hidden; - overflow-y: auto; /* Scrollable contents if viewport is shorter than content. */ - background-color: #f5f5f5; - border-right: 1px solid #eee; - } -} - -/* Sidebar navigation */ -.nav-sidebar { - margin-right: -21px; /* 20px padding + 1px border */ - margin-bottom: 20px; - margin-left: -20px; -} -.nav-sidebar > li > a { - padding-right: 20px; - padding-left: 20px; -} -.nav-sidebar > .active > a, -.nav-sidebar > .active > a:hover, -.nav-sidebar > .active > a:focus { - color: #fff; - background-color: #428bca; -} - -/* - * Main content - */ -.main { - padding: 20px; -} -@media (min-width: 768px) { - .main { - padding-right: 40px; - padding-left: 40px; - } -} -.main .page-header { - margin-top: 0; -} -.footer > .container { - padding-top: 20px; - text-align: center; -} - -/* - * Row Links - */ -.table.rowlink td:not(.rowlink-skip), -.table .rowlink td:not(.rowlink-skip) { - cursor: pointer; -} -.table.rowlink td:not(.rowlink-skip) a, -.table .rowlink td:not(.rowlink-skip) a { - font: inherit; - color: inherit; - text-decoration: inherit; -} -.multi-row-description { - border-left: 1px solid #DDD; -} - -pre { - max-height: 40em; -} - -/* shift the anchors to accommodate fixed navbar. See https://github.com/twbs/bootstrap/issues/1768#issuecomment-46519033 */ -*[id]:before { - display: block; - content: " "; - margin-top: -70px; - height: 70px; - visibility: hidden; -} http://git-wip-us.apache.org/repos/asf/atlas-website/blob/2f6afcd8/0.8.3/api/v2/apidocs/data.html ---------------------------------------------------------------------- diff --git a/0.8.3/api/v2/apidocs/data.html b/0.8.3/api/v2/apidocs/data.html deleted file mode 100644 index 430a88e..0000000 --- a/0.8.3/api/v2/apidocs/data.html +++ /dev/null @@ -1,446 +0,0 @@ -<!DOCTYPE html> -<html lang="en"> -<head> - <meta charset="utf-8"> - <meta http-equiv="X-UA-Compatible" content="IE=edge"> - <meta name="viewport" content="width=device-width, initial-scale=1"> - <!-- The above 3 meta tags *must* come first in the head; any other head content must come *after* these tags --> - - <title>Atlas REST API: Data Types</title> - - <!-- Mobile viewport optimized: j.mp/bplateviewport --> - <meta name="viewport" content="width=device-width, initial-scale=1.0"> - - <!-- Bootstrap core CSS --> - <link rel="stylesheet" href="https://maxcdn.bootstrapcdn.com/bootstrap/3.3.4/css/bootstrap.min.css"> - - <!--custom css for these pages--> - <link rel="stylesheet" href="css/style.css"> - - <!-- HTML5 shim and Respond.js for IE8 support of HTML5 elements and media queries --> - <!--[if lt IE 9]> - <script src="https://oss.maxcdn.com/html5shiv/3.7.2/html5shiv.min.js"></script> - <script src="https://oss.maxcdn.com/respond/1.4.2/respond.min.js"></script> - <![endif]--> -</head> - -<body data-spy="scroll" data-target="#apinav"> - - <nav class="navbar navbar-inverse navbar-fixed-top"> - <div class="container-fluid"> - <div class="navbar-header"> - <button type="button" class="navbar-toggle collapsed" data-toggle="collapse" data-target="#navbar"> - <span class="sr-only">Toggle navigation</span> - <span class="icon-bar"></span> - <span class="icon-bar"></span> - <span class="icon-bar"></span> - </button> - <a class="navbar-brand" href="index.html">Atlas REST API: Data Types</a> - </div> - <div id="navbar" class="navbar-collapse collapse"> - <ul class="nav navbar-nav navbar-right"> - <li><a href="resources.html">Resources</a></li> - <li><a href="data.html">Data Types</a></li> - </ul> - </div> - </div> - </nav> - - <div class="container-fluid"> - <div class="row"> - <div class="col-sm-3 col-md-2 sidebar" id="apinav"> - <ul class="nav nav-sidebar"> - <li><a href="#syntax_json">JSON</a></li> - <li><a href="#syntax_xml">XML</a></li> - <li class="divider"></li> - <li class="text-right"><a href="#top"><small>Back to Top</small></a></li> - </ul> - </div> - - <div class="col-sm-9 col-sm-offset-3 col-md-10 col-md-offset-2 main"> - <ol class="breadcrumb" id="top"> - <li class="active dropdown"><a href="index.html">Home</a></li> - <li class="dropdown"><a href="data.html">Data Types</a></li> - </ol> - - <h1 class="page-header" id="data">Data Types</h1> - - <h3 id="syntax_json">JSON</h3> - - <table class="table table-hover data-types"> - <thead> - <tr> - <th align="center">type</th> - <th align="center">description</th> - </tr> - </thead> - <tbody data-link="row" class="rowlink"> - <tr class="clickable-row" data-href="json_AtlasAttributeDef.html"> - <td> <span class="datatype-name">AtlasAttributeDef</span> -</td> - <td> <span class="datatype-description">class that captures details of a struct-attribute.</span> -</td> - </tr> - <tr class="clickable-row" data-href="json_AtlasBaseModelObject.html"> - <td> <span class="datatype-name">AtlasBaseModelObject</span> -</td> - <td> <span class="datatype-description"></span> -</td> - </tr> - <tr class="clickable-row" data-href="json_AtlasBaseTypeDef.html"> - <td> <span class="datatype-name">AtlasBaseTypeDef</span> -</td> - <td> <span class="datatype-description">Base class that captures common-attributes for all Atlas types.</span> -</td> - </tr> - <tr class="clickable-row" data-href="json_AtlasClassification.html"> - <td> <span class="datatype-name">AtlasClassification</span> -</td> - <td> <span class="datatype-description">An instance of a classification; it doesn't have an identity, this object exists only when associated with an entity.</span> -</td> - </tr> - <tr class="clickable-row" data-href="json_AtlasClassificationDef.html"> - <td> <span class="datatype-name">AtlasClassificationDef</span> -</td> - <td> <span class="datatype-description">class that captures details of a classification-type.</span> -</td> - </tr> - <tr class="clickable-row" data-href="json_AtlasClassifications.html"> - <td> <span class="datatype-name">AtlasClassifications</span> -</td> - <td> <span class="datatype-description">REST serialization friendly list.</span> -</td> - </tr> - <tr class="clickable-row" data-href="json_AtlasConstraintDef.html"> - <td> <span class="datatype-name">AtlasConstraintDef</span> -</td> - <td> <span class="datatype-description">class that captures details of a constraint.</span> -</td> - </tr> - <tr class="clickable-row" data-href="json_AtlasEntitiesWithExtInfo.html"> - <td> <span class="datatype-name">AtlasEntitiesWithExtInfo</span> -</td> - <td> <span class="datatype-description">An instance of an entity along with extended info - like hive_table, hive_database.</span> -</td> - </tr> - <tr class="clickable-row" data-href="json_AtlasEntity.html"> - <td> <span class="datatype-name">AtlasEntity</span> -</td> - <td> <span class="datatype-description">An instance of an entity - like hive_table, hive_database.</span> -</td> - </tr> - <tr class="clickable-row" data-href="json_AtlasEntityDef.html"> - <td> <span class="datatype-name">AtlasEntityDef</span> -</td> - <td> <span class="datatype-description">class that captures details of a entity-type.</span> -</td> - </tr> - <tr class="clickable-row" data-href="json_AtlasEntityExtInfo.html"> - <td> <span class="datatype-name">AtlasEntityExtInfo</span> -</td> - <td> <span class="datatype-description">An instance of an entity along with extended info - like hive_table, hive_database.</span> -</td> - </tr> - <tr class="clickable-row" data-href="json_AtlasEntityHeader.html"> - <td> <span class="datatype-name">AtlasEntityHeader</span> -</td> - <td> <span class="datatype-description">An instance of an entity - like hive_table, hive_database.</span> -</td> - </tr> - <tr class="clickable-row" data-href="json_AtlasEntityWithExtInfo.html"> - <td> <span class="datatype-name">AtlasEntityWithExtInfo</span> -</td> - <td> <span class="datatype-description">An instance of an entity along with extended info - like hive_table, hive_database.</span> -</td> - </tr> - <tr class="clickable-row" data-href="json_AtlasEnumDef.html"> - <td> <span class="datatype-name">AtlasEnumDef</span> -</td> - <td> <span class="datatype-description">class that captures details of an enum-type.</span> -</td> - </tr> - <tr class="clickable-row" data-href="json_AtlasEnumElementDef.html"> - <td> <span class="datatype-name">AtlasEnumElementDef</span> -</td> - <td> <span class="datatype-description">class that captures details of an enum-element.</span> -</td> - </tr> - <tr class="clickable-row" data-href="json_AtlasFullTextResult.html"> - <td> <span class="datatype-name">AtlasFullTextResult</span> -</td> - <td> <span class="datatype-description"></span> -</td> - </tr> - <tr class="clickable-row" data-href="json_AtlasLineageInfo.html"> - <td> <span class="datatype-name">AtlasLineageInfo</span> -</td> - <td> <span class="datatype-description"></span> -</td> - </tr> - <tr class="clickable-row" data-href="json_AtlasQueryType.html"> - <td> <span class="datatype-name">AtlasQueryType</span> -</td> - <td> <span class="datatype-description"></span> -</td> - </tr> - <tr class="clickable-row" data-href="json_AtlasSearchResult.html"> - <td> <span class="datatype-name">AtlasSearchResult</span> -</td> - <td> <span class="datatype-description"></span> -</td> - </tr> - <tr class="clickable-row" data-href="json_AtlasStruct.html"> - <td> <span class="datatype-name">AtlasStruct</span> -</td> - <td> <span class="datatype-description">Captures details of struct contents. Not instantiated directly, used only via AtlasEntity, AtlasClassification.</span> -</td> - </tr> - <tr class="clickable-row" data-href="json_AtlasStructDef.html"> - <td> <span class="datatype-name">AtlasStructDef</span> -</td> - <td> <span class="datatype-description">class that captures details of a struct-type.</span> -</td> - </tr> - <tr class="clickable-row" data-href="json_AtlasTypeDefHeader.html"> - <td> <span class="datatype-name">AtlasTypeDefHeader</span> -</td> - <td> <span class="datatype-description"></span> -</td> - </tr> - <tr class="clickable-row" data-href="json_AtlasTypesDef.html"> - <td> <span class="datatype-name">AtlasTypesDef</span> -</td> - <td> <span class="datatype-description"></span> -</td> - </tr> - <tr class="clickable-row" data-href="json_AtlasUserSavedSearch.html"> - <td> <span class="datatype-name">AtlasUserSavedSearch</span> -</td> - <td> <span class="datatype-description"></span> -</td> - </tr> - <tr class="clickable-row" data-href="json_AttributeSearchResult.html"> - <td> <span class="datatype-name">AttributeSearchResult</span> -</td> - <td> <span class="datatype-description"></span> -</td> - </tr> - <tr class="clickable-row" data-href="json_Cardinality.html"> - <td> <span class="datatype-name">Cardinality</span> -</td> - <td> <span class="datatype-description">single-valued attribute or multi-valued attribute.</span> -</td> - </tr> - <tr class="clickable-row" data-href="json_ClassificationAssociateRequest.html"> - <td> <span class="datatype-name">ClassificationAssociateRequest</span> -</td> - <td> <span class="datatype-description"></span> -</td> - </tr> - <tr class="clickable-row" data-href="json_Condition.html"> - <td> <span class="datatype-name">Condition</span> -</td> - <td> <span class="datatype-description"></span> -</td> - </tr> - <tr class="clickable-row" data-href="json_Currency.html"> - <td> <span class="datatype-name">Currency</span> -</td> - <td> <span class="datatype-description"></span> -</td> - </tr> - <tr class="clickable-row" data-href="json_DateFormat.html"> - <td> <span class="datatype-name">DateFormat</span> -</td> - <td> <span class="datatype-description"></span> -</td> - </tr> - <tr class="clickable-row" data-href="json_EntityMutationResponse.html"> - <td> <span class="datatype-name">EntityMutationResponse</span> -</td> - <td> <span class="datatype-description"></span> -</td> - </tr> - <tr class="clickable-row" data-href="json_EntityOperation.html"> - <td> <span class="datatype-name">EntityOperation</span> -</td> - <td> <span class="datatype-description"></span> -</td> - </tr> - <tr class="clickable-row" data-href="json_FilterCriteria.html"> - <td> <span class="datatype-name">FilterCriteria</span> -</td> - <td> <span class="datatype-description"></span> -</td> - </tr> - <tr class="clickable-row" data-href="json_Format.html"> - <td> <span class="datatype-name">Format</span> -</td> - <td> <span class="datatype-description"></span> -</td> - </tr> - <tr class="clickable-row" data-href="json_LineageDirection.html"> - <td> <span class="datatype-name">LineageDirection</span> -</td> - <td> <span class="datatype-description"></span> -</td> - </tr> - <tr class="clickable-row" data-href="json_LineageRelation.html"> - <td> <span class="datatype-name">LineageRelation</span> -</td> - <td> <span class="datatype-description"></span> -</td> - </tr> - <tr class="clickable-row" data-href="json_Locale.html"> - <td> <span class="datatype-name">Locale</span> -</td> - <td> <span class="datatype-description"></span> -</td> - </tr> - <tr class="clickable-row" data-href="json_NumberFormat.html"> - <td> <span class="datatype-name">NumberFormat</span> -</td> - <td> <span class="datatype-description"></span> -</td> - </tr> - <tr class="clickable-row" data-href="json_Operator.html"> - <td> <span class="datatype-name">Operator</span> -</td> - <td> <span class="datatype-description">Supported search operations -Logical comparision operators can only be used with numbers or dates -IN, LIKE, startsWith, endsWith, CONTAINS can only be used with strings or text</span> -</td> - </tr> - <tr class="clickable-row" data-href="json_PList.html"> - <td> <span class="datatype-name">PList</span> -</td> - <td> <span class="datatype-description">Paginated-list, for returning search results.</span> -</td> - </tr> - <tr class="clickable-row" data-href="json_RoundingMode.html"> - <td> <span class="datatype-name">RoundingMode</span> -</td> - <td> <span class="datatype-description"></span> -</td> - </tr> - <tr class="clickable-row" data-href="json_SavedSearchType.html"> - <td> <span class="datatype-name">SavedSearchType</span> -</td> - <td> <span class="datatype-description"></span> -</td> - </tr> - <tr class="clickable-row" data-href="json_SearchParameters.html"> - <td> <span class="datatype-name">SearchParameters</span> -</td> - <td> <span class="datatype-description"></span> -</td> - </tr> - <tr class="clickable-row" data-href="json_SortType.html"> - <td> <span class="datatype-name">SortType</span> -</td> - <td> <span class="datatype-description">to specify whether the result should be sorted? If yes, whether asc or desc.</span> -</td> - </tr> - <tr class="clickable-row" data-href="json_Status.html"> - <td> <span class="datatype-name">Status</span> -</td> - <td> <span class="datatype-description">Status of the entity - can be active or deleted. Deleted entities are not removed from Atlas store.</span> -</td> - </tr> - <tr class="clickable-row" data-href="json_TimeZone.html"> - <td> <span class="datatype-name">TimeZone</span> -</td> - <td> <span class="datatype-description"></span> -</td> - </tr> - <tr class="clickable-row" data-href="json_TypeCategory.html"> - <td> <span class="datatype-name">TypeCategory</span> -</td> - <td> <span class="datatype-description"></span> -</td> - </tr> - </tbody> - </table> - - <h3 id="syntax_xml">XML</h3> - - <table class="table table-hover data-types"> - <caption>Default Namespace (<a href="ns0.xsd">schema</a>)</caption> - <thead> - <tr> - <th align="center">type</th> - <th align="center">description</th> - </tr> - </thead> - <tbody data-link="row" class="rowlink"> - <tr class="clickable-row" data-href="xml_ns0_atlasBaseModelObject.html"> - <td> <span class="datatype-name">atlasBaseModelObject</span> -</td> - <td> <span class="datatype-description"></span> -</td> - </tr> - <tr class="clickable-row" data-href="xml_ns0_PList.html"> - <td> <span class="datatype-name">PList</span> -</td> - <td> <span class="datatype-description">Paginated-list, for returning search results.</span> -</td> - </tr> - <tr class="clickable-row" data-href="xml_ns0_searchFilter.html"> - <td> <span class="datatype-name">searchFilter</span> -</td> - <td> <span class="datatype-description">Generic filter, to specify search criteria using name/value pairs.</span> -</td> - </tr> - <tr class="clickable-row" data-href="xml_ns0_sortType.html"> - <td> <span class="datatype-name">sortType</span> -</td> - <td> <span class="datatype-description">to specify whether the result should be sorted? If yes, whether asc or desc.</span> -</td> - </tr> - <tr class="clickable-row" data-href="xml_ns0_atlasClassification.html"> - <td> <span class="datatype-name">atlasClassification</span> -</td> - <td> <span class="datatype-description">An instance of a classification; it doesn't have an identity, this object exists only when associated with an entity.</span> -</td> - </tr> - <tr class="clickable-row" data-href="xml_ns0_atlasStruct.html"> - <td> <span class="datatype-name">atlasStruct</span> -</td> - <td> <span class="datatype-description">Captures details of struct contents. Not instantiated directly, used only via AtlasEntity, AtlasClassification.</span> -</td> - </tr> - </tbody> - </table> - - <footer class="footer"> - <div class="container"> - <p class="text-muted">Generated by <a href="http://enunciate.webcohesion.com">Enunciate</a>.</p> - </div> - </footer> - - </div> - </div> - </div> - - - <!-- JavaScript placed at the end of the document so the pages load faster. --> - <script src="https://cdnjs.cloudflare.com/ajax/libs/jquery/1.11.2/jquery.min.js"></script> - - <!-- Bootstrap core JavaScript - ================================================== --> - <script src="https://maxcdn.bootstrapcdn.com/bootstrap/3.3.4/js/bootstrap.min.js"></script> - - <!-- prettify code blocks. see http://code.google.com/p/google-code-prettify/ --> - <script src="https://cdn.rawgit.com/google/code-prettify/master/loader/run_prettify.js" type="text/javascript"></script> - <script> - $(function() { - $(".clickable-row").click(function() { - window.document.location = $(this).data("href"); - }); - - $('[data-toggle="tooltip"]').tooltip() - }); - </script> - -</body> -</html>