@anansi-lineage/anansi-sdk

anansi_rest_api

AnansiRestApi - JavaScript client for anansi_rest_api These endpoints describe the REST API of the Anansi Data Lineage Tool. The Catalog endpoint is for saving data into Nodes. The Relationships endpoints is for connecting data between Nodes. The endpoints use JWT as the security mechanism. This SDK is automatically generated by the Swagger Codegen project:

• API version: 1.0
• Package version: 1.1
• Build package: io.swagger.codegen.v3.generators.javascript.JavaScriptClientCodegen For more information, please visit https://www.suketa.in

Installation

For Node.js

npm

To publish the library as a npm, please follow the procedure in "Publishing npm packages".

Then install it via:

npm install anansi_rest_api --save

git

If the library is hosted at a git repository, e.g. https://github.com/GIT_USER_ID/GIT_REPO_ID then install it via:

    npm install GIT_USER_ID/GIT_REPO_ID --save

For browser

The library also works in the browser environment via npm and browserify. After following the above steps with Node.js and installing browserify with npm install -g browserify, perform the following (assuming main.js is your entry file):

browserify main.js > bundle.js

Then include bundle.js in the HTML pages.

Webpack Configuration

Using Webpack you may encounter the following error: "Module not found: Error: Cannot resolve module", most certainly you should disable AMD loader. Add/merge the following section to your webpack config:

module: {
  rules: [
    {
      parser: {
        amd: false
      }
    }
  ]
}

Getting Started

Please follow the installation instruction and execute the following JS code:

import { ApiClient } from '@anansi-lineage/anansi-sdk';
var defaultClient = ApiClient.instance;

// Configure API key authorization: JWT
var JWT = defaultClient.authentications['JWT'];
JWT.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//JWT.apiKeyPrefix['Authorization'] = "Token"

var api = new ApiClient.DefaultApi()
var tableName = "tableName_example"; // {String} Also can be called Node Name interchangeably.
var unusedParameter = "unusedParameter_example"; // {String} This is a unused parameter. It can be set to anything.
var opts = { 
  'body': [{
  "value" : [ {
    "Email" : "[e-mail]"
  } ]
}] // {[Object]} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.deleteApiCatalogTableName(tableName, unusedParameter, opts, callback);

Documentation for API Endpoints

All URIs are relative to http://localhost:80

Class	Method	HTTP request	Description
AnansiRestApi.DefaultApi	deleteApiCatalogTableName	DELETE /api/catalog/{tableName}/{unusedParameter}	Delete Catalog Entries
AnansiRestApi.DefaultApi	deleteApiRelationshipUnusedParameterCatalogName	DELETE /api/relationship/{UnusedParameter}	Delete Relationships
AnansiRestApi.DefaultApi	getApiRelationship	GET /api/relationship	GET Relationships
AnansiRestApi.DefaultApi	getCatalogTablename	GET /api/catalog/{tableName}	Get Catalog Data by Table Name
AnansiRestApi.DefaultApi	patchApiCatalogTableNameX	PATCH /api/catalog/{tableName}/{unusedParameter}	Update Properties in the table
AnansiRestApi.DefaultApi	patchApiRelationship	PATCH /api/relationship/{UnusedParameter}	Update Relationship
AnansiRestApi.DefaultApi	postApiCatalogTableName	POST /api/catalog/{tableName}	Create New Entries in the Table
AnansiRestApi.DefaultApi	postApiGraphCatalogName	POST /api/graph/{catalogName}	Generate Graph
AnansiRestApi.DefaultApi	postApiRelationship	POST /api/relationship	Create Relationships
AnansiRestApi.DefaultApi	postApiToken	POST /api/token	Generate the JWT token

Documentation for Models

• AnansiRestApi.ApiTokenBody
• AnansiRestApi.ErrorResponse
• AnansiRestApi.GraphRequest
• AnansiRestApi.GraphRequestItem
• AnansiRestApi.GraphRequestItemNodeIdInfo
• AnansiRestApi.GraphResponse
• AnansiRestApi.OneOfGraphResponseEdges
• AnansiRestApi.OneOfGraphResponseNodes
• AnansiRestApi.Relationship
• AnansiRestApi.RelationshipUnusedParameterBody
• AnansiRestApi.SuccessResponseOnCRUD

Documentation for Authorization

JWT

• Type: API key
• API key parameter name: Authorization
• Location: HTTP header