http://git-wip-us.apache.org/repos/asf/atlas-website/blob/58bb55a6/api/v2/resource_LineageREST.html ---------------------------------------------------------------------- diff --git a/api/v2/resource_LineageREST.html b/api/v2/resource_LineageREST.html index 5d0da52..2f46369 100644 --- a/api/v2/resource_LineageREST.html +++ b/api/v2/resource_LineageREST.html @@ -15,7 +15,7 @@ <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"> + <link rel="stylesheet" href="css/enunciate.css"> <!-- HTML5 shim and Respond.js for IE8 support of HTML5 elements and media queries --> <!--[if lt IE 9]> @@ -50,7 +50,7 @@ <div class="row"> <div class="col-sm-3 col-md-2 sidebar" id="apinav"> <ul class="nav nav-sidebar"> - <li><a href="#resource_LineageREST_getLineageGraph_GET">GET /v2/lineage/{guid}</a></li> + <li><a href="#resource_LineageREST_getLineageGraph_GET"><abbr title="GET /v2/lineage/{guid}"><span class="sideoverflow">GET /v2/lineage/{guid}</span></abbr></a></li> <li class="divider"></li> <li class="text-right"><a href="#top"><small>Back to Top</small></a></li> </ul> @@ -143,9 +143,9 @@ </thead> <tbody> <tr> - <td><abbr data-toggle="tooltip" data-placement="top" title="Use the "Accept: application/json" HTTP header to request that this media type be provided by the server."><span class="response-type">application/json</span></abbr></td> - <td><span class="datatype-reference"><a href="json_AtlasLineageInfo.html">AtlasLineageInfo</a> - (JSON)</span></td> + <td><abbr data-toggle="tooltip" data-placement="top" title="Use the "Accept: application/json;charset=UTF-8" HTTP header to request that this media type be provided by the server."><span class="response-type">application/json;charset=UTF-8</span></abbr></td> + <td><span class="datatype-reference">(custom) +</span></td> <td><span class="response-description">AtlasLineageInfo</span></td> </tr> </tbody> @@ -158,7 +158,7 @@ <h5>Request</h5> <pre> GET /v2/lineage/{guid} -Accept: application/json +Accept: application/json;charset=UTF-8 </pre> </div> @@ -166,45 +166,10 @@ Accept: application/json <h5>Response</h5> <pre> HTTP/1.1 200 OK -Content-Type: application/json - - <code class="prettyprint language-js"> -{ - "baseEntityGuid" : "...", - "guidEntityMap" : { - "property1" : { - "guid" : "...", - "status" : "DELETED", - "displayText" : "...", - "classificationNames" : [ "...", "..." ], - "typeName" : "...", - "attributes" : { - "property1" : { }, - "property2" : { } - } - }, - "property2" : { - "guid" : "...", - "status" : "ACTIVE", - "displayText" : "...", - "classificationNames" : [ "...", "..." ], - "typeName" : "...", - "attributes" : { - "property1" : { }, - "property2" : { } - } - } - }, - "relations" : [ { - "fromEntityId" : "...", - "toEntityId" : "..." - }, { - "fromEntityId" : "...", - "toEntityId" : "..." - } ], - "lineageDirection" : "BOTH", - "lineageDepth" : 12345 -} +Content-Type: application/json;charset=UTF-8 + + <code class="prettyprint language-txt"> +... </code> </pre> </div>
http://git-wip-us.apache.org/repos/asf/atlas-website/blob/58bb55a6/api/v2/resource_RelationshipREST.html ---------------------------------------------------------------------- diff --git a/api/v2/resource_RelationshipREST.html b/api/v2/resource_RelationshipREST.html index 026e7d7..28af161 100644 --- a/api/v2/resource_RelationshipREST.html +++ b/api/v2/resource_RelationshipREST.html @@ -15,7 +15,7 @@ <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"> + <link rel="stylesheet" href="css/enunciate.css"> <!-- HTML5 shim and Respond.js for IE8 support of HTML5 elements and media queries --> <!--[if lt IE 9]> @@ -50,10 +50,10 @@ <div class="row"> <div class="col-sm-3 col-md-2 sidebar" id="apinav"> <ul class="nav nav-sidebar"> - <li><a href="#resource_RelationshipREST_create_POST">POST /v2/relationship</a></li> - <li><a href="#resource_RelationshipREST_update_PUT">PUT /v2/relationship</a></li> - <li><a href="#resource_RelationshipREST_deleteById_DELETE"><abbr title="DELETE /v2/relationship/guid/{guid}">DELETE /v2/relationship/guid/{...</abbr></a></li> - <li><a href="#resource_RelationshipREST_getById_GET"><abbr title="GET /v2/relationship/guid/{guid}">GET /v2/relationship/guid/{gui...</abbr></a></li> + <li><a href="#resource_RelationshipREST_create_POST"><abbr title="POST /v2/relationship"><span class="sideoverflow">POST /v2/relationship</span></abbr></a></li> + <li><a href="#resource_RelationshipREST_update_PUT"><abbr title="PUT /v2/relationship"><span class="sideoverflow">PUT /v2/relationship</span></abbr></a></li> + <li><a href="#resource_RelationshipREST_deleteById_DELETE"><abbr title="DELETE /v2/relationship/guid/{guid}"><span class="sideoverflow">DELETE /v2/relationship/guid/{guid}</span></abbr></a></li> + <li><a href="#resource_RelationshipREST_getById_GET"><abbr title="GET /v2/relationship/guid/{guid}"><span class="sideoverflow">GET /v2/relationship/guid/{guid}</span></abbr></a></li> <li class="divider"></li> <li class="text-right"><a href="#top"><small>Back to Top</small></a></li> </ul> @@ -85,9 +85,9 @@ </thead> <tbody> <tr> - <td><abbr data-toggle="tooltip" data-placement="top" title="Use the "Content-Type: application/json" HTTP header to specify this media type to the server."><span class="request-type">application/json</span></abbr></td> - <td><span class="datatype-reference"><a href="json_AtlasRelationship.html">AtlasRelationship</a> - (JSON)</span></td> + <td><abbr data-toggle="tooltip" data-placement="top" title="Use the "Content-Type: application/json;charset=UTF-8" HTTP header to specify this media type to the server."><span class="request-type">application/json;charset=UTF-8</span></abbr></td> + <td><span class="datatype-reference">(custom) +</span></td> </tr> </tbody> </table> @@ -98,13 +98,15 @@ <tr> <th>media type</th> <th>data type</th> + <th>description</th> </tr> </thead> <tbody> <tr> - <td><abbr data-toggle="tooltip" data-placement="top" title="Use the "Accept: application/json" HTTP header to request that this media type be provided by the server."><span class="response-type">application/json</span></abbr></td> - <td><span class="datatype-reference"><a href="json_AtlasRelationship.html">AtlasRelationship</a> - (JSON)</span></td> + <td><abbr data-toggle="tooltip" data-placement="top" title="Use the "Accept: application/json;charset=UTF-8" HTTP header to request that this media type be provided by the server."><span class="response-type">application/json;charset=UTF-8</span></abbr></td> + <td><span class="datatype-reference">(custom) +</span></td> + <td><span class="response-description"></span></td> </tr> </tbody> </table> @@ -116,41 +118,11 @@ <h5>Request</h5> <pre> POST /v2/relationship -Content-Type: application/json -Accept: application/json - - <code class="prettyprint language-js"> -{ - "guid" : "...", - "status" : "DELETED", - "createdBy" : "...", - "updatedBy" : "...", - "createTime" : 12345, - "updateTime" : 12345, - "version" : 12345, - "end1" : { - "guid" : "...", - "typeName" : "...", - "uniqueAttributes" : { - "property1" : { }, - "property2" : { } - } - }, - "end2" : { - "guid" : "...", - "typeName" : "...", - "uniqueAttributes" : { - "property1" : { }, - "property2" : { } - } - }, - "label" : "...", - "typeName" : "...", - "attributes" : { - "property1" : { }, - "property2" : { } - } -} +Content-Type: application/json;charset=UTF-8 +Accept: application/json;charset=UTF-8 + + <code class="prettyprint language-txt"> +... </code> </pre> </div> @@ -158,40 +130,10 @@ Accept: application/json <h5>Response</h5> <pre> HTTP/1.1 201 Created -Content-Type: application/json - - <code class="prettyprint language-js"> -{ - "guid" : "...", - "status" : "ACTIVE", - "createdBy" : "...", - "updatedBy" : "...", - "createTime" : 12345, - "updateTime" : 12345, - "version" : 12345, - "end1" : { - "guid" : "...", - "typeName" : "...", - "uniqueAttributes" : { - "property1" : { }, - "property2" : { } - } - }, - "end2" : { - "guid" : "...", - "typeName" : "...", - "uniqueAttributes" : { - "property1" : { }, - "property2" : { } - } - }, - "label" : "...", - "typeName" : "...", - "attributes" : { - "property1" : { }, - "property2" : { } - } -} +Content-Type: application/json;charset=UTF-8 + + <code class="prettyprint language-txt"> +... </code> </pre> </div> @@ -214,9 +156,9 @@ Content-Type: application/json </thead> <tbody> <tr> - <td><abbr data-toggle="tooltip" data-placement="top" title="Use the "Content-Type: application/json" HTTP header to specify this media type to the server."><span class="request-type">application/json</span></abbr></td> - <td><span class="datatype-reference"><a href="json_AtlasRelationship.html">AtlasRelationship</a> - (JSON)</span></td> + <td><abbr data-toggle="tooltip" data-placement="top" title="Use the "Content-Type: application/json;charset=UTF-8" HTTP header to specify this media type to the server."><span class="request-type">application/json;charset=UTF-8</span></abbr></td> + <td><span class="datatype-reference">(custom) +</span></td> </tr> </tbody> </table> @@ -227,13 +169,15 @@ Content-Type: application/json <tr> <th>media type</th> <th>data type</th> + <th>description</th> </tr> </thead> <tbody> <tr> - <td><abbr data-toggle="tooltip" data-placement="top" title="Use the "Accept: application/json" HTTP header to request that this media type be provided by the server."><span class="response-type">application/json</span></abbr></td> - <td><span class="datatype-reference"><a href="json_AtlasRelationship.html">AtlasRelationship</a> - (JSON)</span></td> + <td><abbr data-toggle="tooltip" data-placement="top" title="Use the "Accept: application/json;charset=UTF-8" HTTP header to request that this media type be provided by the server."><span class="response-type">application/json;charset=UTF-8</span></abbr></td> + <td><span class="datatype-reference">(custom) +</span></td> + <td><span class="response-description"></span></td> </tr> </tbody> </table> @@ -245,41 +189,11 @@ Content-Type: application/json <h5>Request</h5> <pre> PUT /v2/relationship -Content-Type: application/json -Accept: application/json - - <code class="prettyprint language-js"> -{ - "guid" : "...", - "status" : "ACTIVE", - "createdBy" : "...", - "updatedBy" : "...", - "createTime" : 12345, - "updateTime" : 12345, - "version" : 12345, - "end1" : { - "guid" : "...", - "typeName" : "...", - "uniqueAttributes" : { - "property1" : { }, - "property2" : { } - } - }, - "end2" : { - "guid" : "...", - "typeName" : "...", - "uniqueAttributes" : { - "property1" : { }, - "property2" : { } - } - }, - "label" : "...", - "typeName" : "...", - "attributes" : { - "property1" : { }, - "property2" : { } - } -} +Content-Type: application/json;charset=UTF-8 +Accept: application/json;charset=UTF-8 + + <code class="prettyprint language-txt"> +... </code> </pre> </div> @@ -287,40 +201,10 @@ Accept: application/json <h5>Response</h5> <pre> HTTP/1.1 204 No Content -Content-Type: application/json - - <code class="prettyprint language-js"> -{ - "guid" : "...", - "status" : "ACTIVE", - "createdBy" : "...", - "updatedBy" : "...", - "createTime" : 12345, - "updateTime" : 12345, - "version" : 12345, - "end1" : { - "guid" : "...", - "typeName" : "...", - "uniqueAttributes" : { - "property1" : { }, - "property2" : { } - } - }, - "end2" : { - "guid" : "...", - "typeName" : "...", - "uniqueAttributes" : { - "property1" : { }, - "property2" : { } - } - }, - "label" : "...", - "typeName" : "...", - "attributes" : { - "property1" : { }, - "property2" : { } - } -} +Content-Type: application/json;charset=UTF-8 + + <code class="prettyprint language-txt"> +... </code> </pre> </div> @@ -384,6 +268,8 @@ HTTP/1.1 204 No Content <th>name</th> <th>type</th> <th>description</th> + <th>default</th> + <th>constraints</th> </tr> </thead> <tbody> @@ -391,6 +277,15 @@ HTTP/1.1 204 No Content <td><span class="parameter-name">guid</span></td> <td>path</td> <td><span class="parameter-description"></span></td> + <td><span class="parameter-default-value"> </span></td> + <td><span class="parameter-constraints"> </span></td> + </tr> + <tr> + <td><span class="parameter-name">extendedInfo</span></td> + <td>query</td> + <td><span class="parameter-description"></span></td> + <td><span class="parameter-default-value">false</span></td> + <td><span class="parameter-constraints">boolean</span></td> </tr> </tbody> </table> @@ -401,13 +296,15 @@ HTTP/1.1 204 No Content <tr> <th>media type</th> <th>data type</th> + <th>description</th> </tr> </thead> <tbody> <tr> - <td><abbr data-toggle="tooltip" data-placement="top" title="Use the "Accept: application/json" HTTP header to request that this media type be provided by the server."><span class="response-type">application/json</span></abbr></td> - <td><span class="datatype-reference"><a href="json_AtlasRelationship.html">AtlasRelationship</a> - (JSON)</span></td> + <td><abbr data-toggle="tooltip" data-placement="top" title="Use the "Accept: application/json;charset=UTF-8" HTTP header to request that this media type be provided by the server."><span class="response-type">application/json;charset=UTF-8</span></abbr></td> + <td><span class="datatype-reference">(custom) +</span></td> + <td><span class="response-description"></span></td> </tr> </tbody> </table> @@ -419,7 +316,7 @@ HTTP/1.1 204 No Content <h5>Request</h5> <pre> GET /v2/relationship/guid/{guid} -Accept: application/json +Accept: application/json;charset=UTF-8 </pre> </div> @@ -427,40 +324,10 @@ Accept: application/json <h5>Response</h5> <pre> HTTP/1.1 200 OK -Content-Type: application/json - - <code class="prettyprint language-js"> -{ - "guid" : "...", - "status" : "ACTIVE", - "createdBy" : "...", - "updatedBy" : "...", - "createTime" : 12345, - "updateTime" : 12345, - "version" : 12345, - "end1" : { - "guid" : "...", - "typeName" : "...", - "uniqueAttributes" : { - "property1" : { }, - "property2" : { } - } - }, - "end2" : { - "guid" : "...", - "typeName" : "...", - "uniqueAttributes" : { - "property1" : { }, - "property2" : { } - } - }, - "label" : "...", - "typeName" : "...", - "attributes" : { - "property1" : { }, - "property2" : { } - } -} +Content-Type: application/json;charset=UTF-8 + + <code class="prettyprint language-txt"> +... </code> </pre> </div>
