Added V2 REST API documentation (apoorvnaik via mneethiraj)
Project: http://git-wip-us.apache.org/repos/asf/incubator-atlas-website/repo Commit: http://git-wip-us.apache.org/repos/asf/incubator-atlas-website/commit/4164eb06 Tree: http://git-wip-us.apache.org/repos/asf/incubator-atlas-website/tree/4164eb06 Diff: http://git-wip-us.apache.org/repos/asf/incubator-atlas-website/diff/4164eb06 Branch: refs/heads/asf-site Commit: 4164eb0651b858a34da9ab87097f5584b5e629b6 Parents: a414116 Author: Madhan Neethiraj <[email protected]> Authored: Fri Feb 17 17:46:30 2017 -0800 Committer: Madhan Neethiraj <[email protected]> Committed: Fri Feb 17 17:53:09 2017 -0800 ---------------------------------------------------------------------- api/v2/application.wadl | 559 + api/v2/css/style.css | 115 + api/v2/data.html | 348 + api/v2/index.html | 454 + api/v2/json_AtlasAttributeDef.html | 222 + api/v2/json_AtlasBaseTypeDef.html | 239 + api/v2/json_AtlasClassification.html | 142 + api/v2/json_AtlasClassificationDef.html | 271 + api/v2/json_AtlasClassifications.html | 167 + api/v2/json_AtlasConstraintDef.html | 143 + api/v2/json_AtlasEntitiesWithExtInfo.html | 305 + api/v2/json_AtlasEntity.html | 275 + api/v2/json_AtlasEntityDef.html | 271 + api/v2/json_AtlasEntityExtInfo.html | 215 + api/v2/json_AtlasEntityHeader.html | 203 + api/v2/json_AtlasEntityWithExtInfo.html | 265 + api/v2/json_AtlasEnumDef.html | 233 + api/v2/json_AtlasEnumElementDef.html | 150 + api/v2/json_AtlasFullTextResult.html | 162 + api/v2/json_AtlasLineageInfo.html | 223 + api/v2/json_AtlasObjectId.html | 193 + api/v2/json_AtlasQueryType.html | 126 + api/v2/json_AtlasSearchResult.html | 245 + api/v2/json_AtlasStruct.html | 145 + api/v2/json_AtlasStructDef.html | 261 + api/v2/json_AtlasTypeDefHeader.html | 150 + api/v2/json_AtlasTypesDef.html | 440 + api/v2/json_AttributeSearchResult.html | 140 + api/v2/json_Cardinality.html | 126 + api/v2/json_ClassificationAssociateRequest.html | 146 + api/v2/json_EntityMutationResponse.html | 546 + api/v2/json_EntityOperation.html | 130 + api/v2/json_LineageDirection.html | 126 + api/v2/json_LineageRelation.html | 140 + api/v2/json_PList.html | 180 + api/v2/json_SortType.html | 126 + api/v2/json_Status.html | 122 + api/v2/json_TypeCategory.html | 146 + api/v2/ns0.xsd | 80 + api/v2/resource_DiscoveryREST.html | 470 + api/v2/resource_EntityREST.html | 3982 +++ api/v2/resource_LineageREST.html | 270 + api/v2/resource_TypesREST.html | 3489 +++ api/v2/resources.html | 194 + api/v2/syntax_json.html | 311 + api/v2/syntax_xml.html | 126 + api/v2/ui/css/print.css | 1367 + api/v2/ui/css/reset.css | 125 + api/v2/ui/css/screen.css | 1494 + api/v2/ui/css/style.css | 250 + api/v2/ui/css/typography.css | 14 + api/v2/ui/fonts/DroidSans-Bold.ttf | Bin 0 -> 42480 bytes api/v2/ui/fonts/DroidSans.ttf | Bin 0 -> 41028 bytes api/v2/ui/fonts/droid-sans-v6-latin-700.eot | Bin 0 -> 22922 bytes api/v2/ui/fonts/droid-sans-v6-latin-700.svg | 411 + api/v2/ui/fonts/droid-sans-v6-latin-700.ttf | Bin 0 -> 40513 bytes api/v2/ui/fonts/droid-sans-v6-latin-700.woff | Bin 0 -> 25992 bytes api/v2/ui/fonts/droid-sans-v6-latin-700.woff2 | Bin 0 -> 11480 bytes api/v2/ui/fonts/droid-sans-v6-latin-regular.eot | Bin 0 -> 22008 bytes api/v2/ui/fonts/droid-sans-v6-latin-regular.svg | 403 + api/v2/ui/fonts/droid-sans-v6-latin-regular.ttf | Bin 0 -> 39069 bytes .../ui/fonts/droid-sans-v6-latin-regular.woff | Bin 0 -> 24868 bytes .../ui/fonts/droid-sans-v6-latin-regular.woff2 | Bin 0 -> 11304 bytes api/v2/ui/images/collapse.gif | Bin 0 -> 69 bytes api/v2/ui/images/expand.gif | Bin 0 -> 73 bytes api/v2/ui/images/explorer_icons.png | Bin 0 -> 5115 bytes api/v2/ui/images/favicon-16x16.png | Bin 0 -> 445 bytes api/v2/ui/images/favicon-32x32.png | Bin 0 -> 1141 bytes api/v2/ui/images/favicon.ico | Bin 0 -> 5430 bytes api/v2/ui/images/logo_small.png | Bin 0 -> 455 bytes api/v2/ui/images/pet_store_api.png | Bin 0 -> 631 bytes api/v2/ui/images/throbber.gif | Bin 0 -> 9257 bytes api/v2/ui/images/wordnik_api.png | Bin 0 -> 670 bytes api/v2/ui/index.html | 118 + api/v2/ui/lang/ca.js | 53 + api/v2/ui/lang/el.js | 56 + api/v2/ui/lang/en.js | 56 + api/v2/ui/lang/es.js | 53 + api/v2/ui/lang/fr.js | 54 + api/v2/ui/lang/geo.js | 56 + api/v2/ui/lang/it.js | 52 + api/v2/ui/lang/ja.js | 53 + api/v2/ui/lang/ko-kr.js | 53 + api/v2/ui/lang/pl.js | 53 + api/v2/ui/lang/pt.js | 53 + api/v2/ui/lang/ru.js | 56 + api/v2/ui/lang/tr.js | 53 + api/v2/ui/lang/translator.js | 39 + api/v2/ui/lang/zh-cn.js | 53 + api/v2/ui/lib/backbone-min.js | 15 + api/v2/ui/lib/es5-shim.js | 2065 ++ api/v2/ui/lib/handlebars-2.0.0.js | 28 + api/v2/ui/lib/handlebars-4.0.5.js | 4608 +++ api/v2/ui/lib/highlight.7.3.pack.js | 1 + api/v2/ui/lib/highlight.9.1.0.pack.js | 2 + api/v2/ui/lib/highlight.9.1.0.pack_extended.js | 34 + api/v2/ui/lib/jquery-1.8.0.min.js | 2 + api/v2/ui/lib/jquery.ba-bbq.min.js | 18 + api/v2/ui/lib/jquery.slideto.min.js | 1 + api/v2/ui/lib/jquery.wiggle.min.js | 8 + api/v2/ui/lib/js-yaml.min.js | 3 + api/v2/ui/lib/jsoneditor.min.js | 11 + api/v2/ui/lib/lodash.min.js | 102 + api/v2/ui/lib/marked.js | 1272 + api/v2/ui/lib/object-assign-pollyfill.js | 23 + api/v2/ui/lib/sanitize-html.min.js | 6 + api/v2/ui/lib/swagger-oauth.js | 347 + api/v2/ui/lib/underscore-min.js | 6 + api/v2/ui/lib/underscore-min.map | 1 + api/v2/ui/o2c.html | 20 + api/v2/ui/swagger-ui.js | 24993 +++++++++++++++++ api/v2/ui/swagger-ui.min.js | 14 + api/v2/ui/swagger.json | 9129 ++++++ api/v2/xml_ns0_PList.html | 242 + api/v2/xml_ns0_searchFilter.html | 242 + api/v2/xml_ns0_sortType.html | 130 + index.html | 3 +- 117 files changed, 65672 insertions(+), 1 deletion(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/incubator-atlas-website/blob/4164eb06/api/v2/application.wadl ---------------------------------------------------------------------- diff --git a/api/v2/application.wadl b/api/v2/application.wadl new file mode 100644 index 0000000..cd12ee0 --- /dev/null +++ b/api/v2/application.wadl @@ -0,0 +1,559 @@ +<?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: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/dsl"> + <wadl:method name="GET"> + <wadl:doc><![CDATA[Retrieve data for the specified DSL]]></wadl:doc> + <wadl:request> + <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: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="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/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: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="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/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[Update classification(s) for an entity represented by a guid. +Classifications are identified by their guid or name]]></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/uniqueAttribute/type/{typeName}"> + <wadl:method name="GET"> + <wadl:doc><![CDATA[Fetch complete definition of an entity given its type and unique attribute.]]></wadl:doc> + <wadl:request> + </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]]></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.]]></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/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/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[a list of classifications 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 trait]]></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:resources> +</wadl:application> \ No newline at end of file http://git-wip-us.apache.org/repos/asf/incubator-atlas-website/blob/4164eb06/api/v2/css/style.css ---------------------------------------------------------------------- diff --git a/api/v2/css/style.css b/api/v2/css/style.css new file mode 100644 index 0000000..8e05fb7 --- /dev/null +++ b/api/v2/css/style.css @@ -0,0 +1,115 @@ +/* + * 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/incubator-atlas-website/blob/4164eb06/api/v2/data.html ---------------------------------------------------------------------- diff --git a/api/v2/data.html b/api/v2/data.html new file mode 100644 index 0000000..3eacea5 --- /dev/null +++ b/api/v2/data.html @@ -0,0 +1,348 @@ +<!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_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_AtlasObjectId.html"> + <td> <span class="datatype-name">AtlasObjectId</span> +</td> + <td> <span class="datatype-description">Reference to an object-instance of an Atlas type - like entity.</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_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_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_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_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_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_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_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> + </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> http://git-wip-us.apache.org/repos/asf/incubator-atlas-website/blob/4164eb06/api/v2/index.html ---------------------------------------------------------------------- diff --git a/api/v2/index.html b/api/v2/index.html new file mode 100644 index 0000000..9748c92 --- /dev/null +++ b/api/v2/index.html @@ -0,0 +1,454 @@ +<!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</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</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="#resources">Resources</a></li> + <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="dropdown"><a href="index.html">Home</a></li> + </ol> + + <div class="page-header"> + Atlas exposes a variety of REST endpoints to work with types, entities, lineage and data discovery. + </div> + + <h1 class="page-header" id="resources">Resources</h1> + + <p> + There is a <a href="application.wadl">WADL document</a> available that describes the resources API. + </p> + + <p> + You may also enjoy the <a href="ui/index.html">interactive interface</a> provided for this API by <a href="http://swagger.io";>Swagger</a>. + </p> + <p> + <a href="ui/index.html" class="btn btn-default">Try it out!</a> + </p> + + <table class="table table-hover resources"> + <thead> + <tr> + <th align="center">name</th> + <th align="center">path</th> + <th align="center">methods</th> + <th align="center">description</th> + </tr> + </thead> + <tbody data-link="row" class="rowlink"> + <tr class="clickable-row" data-href="resource_DiscoveryREST.html"> + <td> <span class="resource-name">DiscoveryREST</span> +</td> + <td class="text-nowrap"><ul class="list-unstyled"><li><samp> <span class="resource-path">/v2/search/dsl</span> +</samp></li><li><samp> <span class="resource-path">/v2/search/fulltext</span> +</samp></li></ul></td> + <td class="text-nowrap"><ul class="list-unstyled"><li><samp> <span class="label label-default resource-method">GET</span> +</samp></li><li><samp> <span class="label label-default resource-method">GET</span> +</samp></li></ul></td> + <td> <span class="resource-description">REST interface for data discovery using dsl or full text search</span> +</td> + </tr> + <tr class="clickable-row" data-href="resource_EntityREST.html"> + <td> <span class="resource-name">EntityREST</span> +</td> + <td class="text-nowrap"><ul class="list-unstyled"><li><samp> <span class="resource-path">/v2/entity</span> +</samp></li><li><samp> <span class="resource-path">/v2/entity/bulk</span> +</samp></li><li><samp> <span class="resource-path">/v2/entity/bulk/classification</span> +</samp></li><li><samp> <span class="resource-path">/v2/entity/guid/{guid}</span> +</samp></li><li><samp> <span class="resource-path">/v2/entity/guid/{guid}/classifications</span> +</samp></li><li><samp> <span class="resource-path">/v2/entity/uniqueAttribute/type/{typeName}</span> +</samp></li><li><samp> <span class="resource-path">/v2/entity/guid/{guid}/classification/{classificationName}</span> +</samp></li></ul></td> + <td class="text-nowrap"><ul class="list-unstyled"><li><samp> <span class="label label-default resource-method">POST</span> +</samp></li><li><samp> <span class="label label-default resource-method">DELETE</span> <span class="label label-default resource-method">GET</span> <span class="label label-default resource-method">POST</span> +</samp></li><li><samp> <span class="label label-default resource-method">POST</span> +</samp></li><li><samp> <span class="label label-default resource-method">DELETE</span> <span class="label label-default resource-method">GET</span> +</samp></li><li><samp> <span class="label label-default resource-method">GET</span> <span class="label label-default resource-method">POST</span> <span class="label label-default resource-method">PUT</span> +</samp></li><li><samp> <span class="label label-default resource-method">DELETE</span> <span class="label label-default resource-method">GET</span> <span class="label label-default resource-method">PUT</span> +</samp></li><li><samp> <span class="label label-default resource-method">DELETE</span> <span class="label label-default resource-method">GET</span> +</samp></li></ul></td> + <td> <span class="resource-description">REST for a single entity</span> +</td> + </tr> + <tr class="clickable-row" data-href="resource_LineageREST.html"> + <td> <span class="resource-name">LineageREST</span> +</td> + <td class="text-nowrap"><ul class="list-unstyled"><li><samp> <span class="resource-path">/v2/lineage/{guid}</span> +</samp></li></ul></td> + <td class="text-nowrap"><ul class="list-unstyled"><li><samp> <span class="label label-default resource-method">GET</span> +</samp></li></ul></td> + <td> <span class="resource-description">REST interface for an entity's lineage information</span> +</td> + </tr> + <tr class="clickable-row" data-href="resource_TypesREST.html"> + <td> <span class="resource-name">TypesREST</span> +</td> + <td class="text-nowrap"><ul class="list-unstyled"><li><samp> <span class="resource-path">/v2/types/typedefs</span> +</samp></li><li><samp> <span class="resource-path">/v2/types/typedefs/headers</span> +</samp></li><li><samp> <span class="resource-path">/v2/types/classificationdef/guid/{guid}</span> +</samp></li><li><samp> <span class="resource-path">/v2/types/classificationdef/name/{name}</span> +</samp></li><li><samp> <span class="resource-path">/v2/types/entitydef/guid/{guid}</span> +</samp></li><li><samp> <span class="resource-path">/v2/types/entitydef/name/{name}</span> +</samp></li><li><samp> <span class="resource-path">/v2/types/enumdef/guid/{guid}</span> +</samp></li><li><samp> <span class="resource-path">/v2/types/enumdef/name/{name}</span> +</samp></li><li><samp> <span class="resource-path">/v2/types/structdef/guid/{guid}</span> +</samp></li><li><samp> <span class="resource-path">/v2/types/structdef/name/{name}</span> +</samp></li><li><samp> <span class="resource-path">/v2/types/typedef/guid/{guid}</span> +</samp></li><li><samp> <span class="resource-path">/v2/types/typedef/name/{name}</span> +</samp></li></ul></td> + <td class="text-nowrap"><ul class="list-unstyled"><li><samp> <span class="label label-default resource-method">DELETE</span> <span class="label label-default resource-method">GET</span> <span class="label label-default resource-method">POST</span> <span class="label label-default resource-method">PUT</span> +</samp></li><li><samp> <span class="label label-default resource-method">GET</span> +</samp></li><li><samp> <span class="label label-default resource-method">GET</span> +</samp></li><li><samp> <span class="label label-default resource-method">GET</span> +</samp></li><li><samp> <span class="label label-default resource-method">GET</span> +</samp></li><li><samp> <span class="label label-default resource-method">GET</span> +</samp></li><li><samp> <span class="label label-default resource-method">GET</span> +</samp></li><li><samp> <span class="label label-default resource-method">GET</span> +</samp></li><li><samp> <span class="label label-default resource-method">GET</span> +</samp></li><li><samp> <span class="label label-default resource-method">GET</span> +</samp></li><li><samp> <span class="label label-default resource-method">GET</span> +</samp></li><li><samp> <span class="label label-default resource-method">GET</span> +</samp></li></ul></td> + <td> <span class="resource-description">REST interface for CRUD operations on type definitions</span> +</td> + </tr> + </tbody> + </table> + + <h1 class="page-header" id="data">Data Types</h1> + + <h3 id="syntax_json"><span class="syntax-name">JSON</span></h3> + + <table class="table table-hover datatypes"> + <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_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_AtlasObjectId.html"> + <td> <span class="datatype-name">AtlasObjectId</span> +</td> + <td> <span class="datatype-description">Reference to an object-instance of an Atlas type - like entity.</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_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_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_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_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_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_TypeCategory.html"> + <td> <span class="datatype-name">TypeCategory</span> +</td> + <td> <span class="datatype-description"></span> +</td> + </tr> + </tbody> + </table> + + <h3 id="syntax_xml"><span class="syntax-name">XML</span></h3> + + <table class="table table-hover datatypes"> + <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_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> + </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> http://git-wip-us.apache.org/repos/asf/incubator-atlas-website/blob/4164eb06/api/v2/json_AtlasAttributeDef.html ---------------------------------------------------------------------- diff --git a/api/v2/json_AtlasAttributeDef.html b/api/v2/json_AtlasAttributeDef.html new file mode 100644 index 0000000..cb8706c --- /dev/null +++ b/api/v2/json_AtlasAttributeDef.html @@ -0,0 +1,222 @@ +<!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: AtlasAttributeDef</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: AtlasAttributeDef</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 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="active dropdown"><a href="syntax_json.html">JSON</a></li> + <li class="dropdown"><a href="json_AtlasAttributeDef.html">AtlasAttributeDef</a></li> + </ol> + + <h1 class="page-header">AtlasAttributeDef <small>Data Type</small></h1> + + <p>class that captures details of a struct-attribute.</p> + + <dl class="dl-horizontal"> + </dl> + + <table class="table datatype-properties"> + <caption>Properties</caption> + <thead> + <tr> + <th>name</th> + <th>data type</th> + <th>description</th> + </tr> + </thead> + <tbody> + <tr> + <td> <span class="property-name">name</span> +</td> + <td> <span class="datatype-reference">string +</span> +</td> + <td> <span class="property-description"></span> +</td> + </tr> + <tr> + <td> <span class="property-name">typeName</span> +</td> + <td> <span class="datatype-reference">string +</span> +</td> + <td> <span class="property-description"></span> +</td> + </tr> + <tr> + <td> <span class="property-name">isOptional</span> +</td> + <td> <span class="datatype-reference">boolean +</span> +</td> + <td> <span class="property-description"></span> +</td> + </tr> + <tr> + <td> <span class="property-name">cardinality</span> +</td> + <td> <span class="datatype-reference"><a href="json_Cardinality.html">Cardinality</a> +</span> +</td> + <td> <span class="property-description"></span> +</td> + </tr> + <tr> + <td> <span class="property-name">valuesMinCount</span> +</td> + <td> <span class="datatype-reference">number +</span> +</td> + <td> <span class="property-description"></span> +</td> + </tr> + <tr> + <td> <span class="property-name">valuesMaxCount</span> +</td> + <td> <span class="datatype-reference">number +</span> +</td> + <td> <span class="property-description"></span> +</td> + </tr> + <tr> + <td> <span class="property-name">isUnique</span> +</td> + <td> <span class="datatype-reference">boolean +</span> +</td> + <td> <span class="property-description"></span> +</td> + </tr> + <tr> + <td> <span class="property-name">isIndexable</span> +</td> + <td> <span class="datatype-reference">boolean +</span> +</td> + <td> <span class="property-description"></span> +</td> + </tr> + <tr> + <td> <span class="property-name">constraints</span> +</td> + <td> <span class="datatype-reference">array of <a href="json_AtlasConstraintDef.html">AtlasConstraintDef</a> +</span> +</td> + <td> <span class="property-description"></span> +</td> + </tr> + </tbody> + </table> + + <p class="lead">Example</p> + + <pre class="prettyprint language-js example">{ + "name" : "...", + "typeName" : "...", + "isOptional" : true, + "cardinality" : "SINGLE", + "valuesMinCount" : 12345, + "valuesMaxCount" : 12345, + "isUnique" : true, + "isIndexable" : true, + "constraints" : [ { + "type" : "...", + "params" : { + "property1" : { }, + "property2" : { } + } + }, { + "type" : "...", + "params" : { + "property1" : { }, + "property2" : { } + } + } ] +}</pre> + + <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> http://git-wip-us.apache.org/repos/asf/incubator-atlas-website/blob/4164eb06/api/v2/json_AtlasBaseTypeDef.html ---------------------------------------------------------------------- diff --git a/api/v2/json_AtlasBaseTypeDef.html b/api/v2/json_AtlasBaseTypeDef.html new file mode 100644 index 0000000..d484076 --- /dev/null +++ b/api/v2/json_AtlasBaseTypeDef.html @@ -0,0 +1,239 @@ +<!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: AtlasBaseTypeDef</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: AtlasBaseTypeDef</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 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="active dropdown"><a href="syntax_json.html">JSON</a></li> + <li class="dropdown"><a href="json_AtlasBaseTypeDef.html">AtlasBaseTypeDef</a></li> + </ol> + + <h1 class="page-header">AtlasBaseTypeDef <small>Data Type</small></h1> + + <p>Base class that captures common-attributes for all Atlas types.</p> + + <dl class="dl-horizontal"> + <dt>Abstract Type</dt> + <dd></dd> + <dt>Subtypes</dt> + <dd><a href="json_AtlasEntityDef.html">AtlasEntityDef</a>, <a href="json_AtlasStructDef.html">AtlasStructDef</a>, <a href="json_AtlasEnumDef.html">AtlasEnumDef</a>, <a href="json_AtlasClassificationDef.html">AtlasClassificationDef</a></dd> + </dl> + + <table class="table datatype-properties"> + <caption>Properties</caption> + <thead> + <tr> + <th>name</th> + <th>data type</th> + <th>description</th> + </tr> + </thead> + <tbody> + <tr> + <td> <span class="property-name">category</span> +</td> + <td> <span class="datatype-reference"><a href="json_TypeCategory.html">TypeCategory</a> +</span> +</td> + <td> <span class="property-description"></span> +</td> + </tr> + <tr> + <td> <span class="property-name">guid</span> +</td> + <td> <span class="datatype-reference">string +</span> +</td> + <td> <span class="property-description"></span> +</td> + </tr> + <tr> + <td> <span class="property-name">createdBy</span> +</td> + <td> <span class="datatype-reference">string +</span> +</td> + <td> <span class="property-description"></span> +</td> + </tr> + <tr> + <td> <span class="property-name">updatedBy</span> +</td> + <td> <span class="datatype-reference">string +</span> +</td> + <td> <span class="property-description"></span> +</td> + </tr> + <tr> + <td> <span class="property-name">createTime</span> +</td> + <td> <span class="datatype-reference">number +</span> +</td> + <td> <span class="property-description"></span> +</td> + </tr> + <tr> + <td> <span class="property-name">updateTime</span> +</td> + <td> <span class="datatype-reference">number +</span> +</td> + <td> <span class="property-description"></span> +</td> + </tr> + <tr> + <td> <span class="property-name">version</span> +</td> + <td> <span class="datatype-reference">number +</span> +</td> + <td> <span class="property-description"></span> +</td> + </tr> + <tr> + <td> <span class="property-name">name</span> +</td> + <td> <span class="datatype-reference">string +</span> +</td> + <td> <span class="property-description"></span> +</td> + </tr> + <tr> + <td> <span class="property-name">description</span> +</td> + <td> <span class="datatype-reference">string +</span> +</td> + <td> <span class="property-description"></span> +</td> + </tr> + <tr> + <td> <span class="property-name">typeVersion</span> +</td> + <td> <span class="datatype-reference">string +</span> +</td> + <td> <span class="property-description"></span> +</td> + </tr> + <tr> + <td> <span class="property-name">options</span> +</td> + <td> <span class="datatype-reference">map of string +</span> +</td> + <td> <span class="property-description"></span> +</td> + </tr> + </tbody> + </table> + + <p class="lead">Example</p> + + <div class="alert alert-warning">This data type is abstract. The example below may be incomplete. More accurate examples can be found in subtypes pages.</div> + + <pre class="prettyprint language-js example">{ + "category" : "ARRAY", + "guid" : "...", + "createdBy" : "...", + "updatedBy" : "...", + "createTime" : 12345, + "updateTime" : 12345, + "version" : 12345, + "name" : "...", + "description" : "...", + "typeVersion" : "...", + "options" : { + "property1" : "...", + "property2" : "..." + } +}</pre> + + <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>
