Weaviate NPM | npm.io

weaviate_api

WeaviateApi - JavaScript client for weaviate_api Lets you register, view and manage cloud ready devices.

API version: v1-alpha
Package version: v1-alpha
Build package: io.swagger.codegen.languages.JavascriptClientCodegen For more information, please visit https://github.com/weaviate/weaviate

Installation

npm

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

Then install it via:

npm install weaviate --save

git

If the library is hosted at a git repository, e.g. https://github.com/weaviate/weaviate-client-nodejs then install it via:

    npm install weaviate/weaviate-client-nodejs --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.

Getting Started

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

var WeaviateApi = require('weaviate');

var defaultClient = WeaviateApi.ApiClient.instance;

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

var api = new WeaviateApi.AclEntriesApi()

var deviceId = "deviceId_example"; // {String} ID of the device to use.

var aclEntryId = "aclEntryId_example"; // {String} Unique ACL entry ID.

var opts = { 
  'alt': "json", // {String} Data format for the response.
  'fields': "fields_example", // {String} Selector specifying which fields to include in a partial response.
  'key': "key_example", // {String} API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
  'oauthToken': "oauthToken_example", // {String} OAuth 2.0 token for the current user.
  'prettyPrint': true, // {Boolean} Returns response with indentations and line breaks.
  'quotaUser': "quotaUser_example", // {String} Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. Overrides userIp if both are provided.
  'userIp': "userIp_example", // {String} IP address of the site where the request originates. Use this if you want to enforce per-user limits.
  'hl': "hl_example" // {String} Specifies the language code that should be used for text values in the API response.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.weaveAclEntriesDelete(deviceId, aclEntryId, opts, callback);

Documentation for API Endpoints

All URIs are relative to https://localhost/weaviate/v1-alpha

Class	Method	HTTP request
WeaviateApi.AclEntriesApi	weaveAclEntriesDelete	DELETE /devices/{deviceId}/aclEntries/{aclEntryId}
WeaviateApi.AclEntriesApi	weaveAclEntriesGet	GET /devices/{deviceId}/aclEntries/{aclEntryId}
WeaviateApi.AclEntriesApi	weaveAclEntriesInsert	POST /devices/{deviceId}/aclEntries
WeaviateApi.AclEntriesApi	weaveAclEntriesList	GET /devices/{deviceId}/aclEntries
WeaviateApi.AclEntriesApi	weaveAclEntriesPatch	PATCH /devices/{deviceId}/aclEntries/{aclEntryId}
WeaviateApi.AclEntriesApi	weaveAclEntriesUpdate	PUT /devices/{deviceId}/aclEntries/{aclEntryId}
WeaviateApi.AdaptersApi	weaveAdaptersAccept	POST /adapters/accept
WeaviateApi.AdaptersApi	weaveAdaptersActivate	POST /adapters/{adapterId}/activate
WeaviateApi.AdaptersApi	weaveAdaptersDeactivate	POST /adapters/{adapterId}/deactivate
WeaviateApi.AdaptersApi	weaveAdaptersGet	GET /adapters/{adapterId}
WeaviateApi.AdaptersApi	weaveAdaptersList	GET /adapters
WeaviateApi.CommandsApi	weaveCommandsCancel	POST /commands/{commandId}/cancel
WeaviateApi.CommandsApi	weaveCommandsDelete	DELETE /commands/{commandId}
WeaviateApi.CommandsApi	weaveCommandsGet	GET /commands/{commandId}
WeaviateApi.CommandsApi	weaveCommandsGetQueue	GET /commands/queue
WeaviateApi.CommandsApi	weaveCommandsInsert	POST /commands
WeaviateApi.CommandsApi	weaveCommandsList	GET /commands
WeaviateApi.CommandsApi	weaveCommandsPatch	PATCH /commands/{commandId}
WeaviateApi.CommandsApi	weaveCommandsUpdate	PUT /commands/{commandId}
WeaviateApi.DevicesApi	weaveDevicesAddLabel	POST /devices/{deviceId}/addLabel
WeaviateApi.DevicesApi	weaveDevicesAddNickname	POST /devices/{deviceId}/addNickname
WeaviateApi.DevicesApi	weaveDevicesDelete	DELETE /devices/{deviceId}
WeaviateApi.DevicesApi	weaveDevicesGet	GET /devices/{deviceId}
WeaviateApi.DevicesApi	weaveDevicesInsert	POST /devices
WeaviateApi.DevicesApi	weaveDevicesList	GET /devices
WeaviateApi.DevicesApi	weaveDevicesPatch	PATCH /devices/{deviceId}
WeaviateApi.DevicesApi	weaveDevicesPatchState	POST /devices/{deviceId}/patchState
WeaviateApi.DevicesApi	weaveDevicesRemoveLabel	POST /devices/{deviceId}/removeLabel
WeaviateApi.DevicesApi	weaveDevicesRemoveNickname	POST /devices/{deviceId}/removeNickname
WeaviateApi.DevicesApi	weaveDevicesUpdate	PUT /devices/{deviceId}
WeaviateApi.DevicesApi	weaveDevicesUpdateParent	POST /devices/{deviceId}/updateParent
WeaviateApi.EventsApi	weaveEventsDeleteAll	POST /events/deleteAll
WeaviateApi.EventsApi	weaveEventsList	GET /events
WeaviateApi.EventsApi	weaveEventsRecordDeviceEvents	POST /events/recordDeviceEvents
WeaviateApi.ModelManifestsApi	weaveModelManifestsGet	GET /modelManifests/{modelManifestId}
WeaviateApi.ModelManifestsApi	weaveModelManifestsList	GET /modelManifests
WeaviateApi.ModelManifestsApi	weaveModelManifestsValidateCommandDefs	POST /modelManifests/validateCommandDefs
WeaviateApi.ModelManifestsApi	weaveModelManifestsValidateComponents	POST /modelManifests/validateComponents
WeaviateApi.ModelManifestsApi	weaveModelManifestsValidateDeviceState	POST /modelManifests/validateDeviceState