sibyl_javascript_client v0.13.1
openapi_for_sibyl2_server
OpenapiForSibyl2Server - JavaScript client for openapi_for_sibyl2_server No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) This SDK is automatically generated by the OpenAPI Generator project:
- API version: 1.0
- Package version: 1.0
- Build package: org.openapitools.codegen.languages.JavascriptClientCodegen For more information, please visit https://github.com/williamfzc
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 openapi_for_sibyl2_server --save
Finally, you need to build the module:
npm run build
Local development
To use the library locally without publishing to a remote npm registry, first install the dependencies by changing into the directory containing package.json
(and this README). Let's call this JAVASCRIPT_CLIENT_DIR
. Then run:
npm install
Next, link it globally in npm with the following, also from JAVASCRIPT_CLIENT_DIR
:
npm link
To use the link you just defined in your project, switch to the directory you want to use your openapi_for_sibyl2_server from, and run:
npm link /path/to/<JAVASCRIPT_CLIENT_DIR>
Finally, you need to build the module:
npm run build
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:
var OpenapiForSibyl2Server = require('openapi_for_sibyl2_server');
var api = new OpenapiForSibyl2Server.BasicQueryApi()
var repo = "repo_example"; // {String} repo
var rev = "rev_example"; // {String} rev
var file = "file_example"; // {String} file
var callback = function(error, data, response) {
if (error) {
console.error(error);
} else {
console.log('API called successfully. Returned data: ' + data);
}
};
api.apiV1ClazzGet(repo, rev, file, callback);
Documentation for API Endpoints
All URIs are relative to http://localhost
Class | Method | HTTP request | Description |
---|---|---|---|
OpenapiForSibyl2Server.BasicQueryApi | apiV1ClazzGet | GET /api/v1/clazz | class query |
OpenapiForSibyl2Server.BasicQueryApi | apiV1FuncGet | GET /api/v1/func | func query |
OpenapiForSibyl2Server.BasicQueryApi | apiV1FuncctxGet | GET /api/v1/funcctx | func ctx query |
OpenapiForSibyl2Server.OpsApi | opsMonitorUploadGet | GET /ops/monitor/upload | upload status query |
OpenapiForSibyl2Server.OpsApi | opsPingGet | GET /ops/ping | ping example |
OpenapiForSibyl2Server.OpsApi | opsVersionGet | GET /ops/version | sibyl version |
OpenapiForSibyl2Server.ReferenceQueryApi | apiV1ReferenceCountFuncctxGet | GET /api/v1/reference/count/funcctx | funcctx query by ref |
OpenapiForSibyl2Server.ReferenceQueryApi | apiV1ReferenceCountFuncctxReverseGet | GET /api/v1/reference/count/funcctx/reverse | funcctx query by referenced |
OpenapiForSibyl2Server.RegexQueryApi | apiV1RegexClazzGet | GET /api/v1/regex/clazz | clazz query |
OpenapiForSibyl2Server.RegexQueryApi | apiV1RegexFuncGet | GET /api/v1/regex/func | func query |
OpenapiForSibyl2Server.RegexQueryApi | apiV1RegexFuncctxGet | GET /api/v1/regex/funcctx | func ctx query |
OpenapiForSibyl2Server.ScopeApi | apiV1FileGet | GET /api/v1/file | file query by repo and rev |
OpenapiForSibyl2Server.ScopeApi | apiV1RepoDelete | DELETE /api/v1/repo | repo delete |
OpenapiForSibyl2Server.ScopeApi | apiV1RepoGet | GET /api/v1/repo | query all the repos |
OpenapiForSibyl2Server.ScopeApi | apiV1RevDelete | DELETE /api/v1/rev | rev delete |
OpenapiForSibyl2Server.ScopeApi | apiV1RevGet | GET /api/v1/rev | rev query by repo name |
OpenapiForSibyl2Server.SignatureQueryApi | apiV1SignatureFuncGet | GET /api/v1/signature/func | func query |
OpenapiForSibyl2Server.SignatureQueryApi | apiV1SignatureFuncctxChainGet | GET /api/v1/signature/funcctx/chain | funcctx chain query |
OpenapiForSibyl2Server.SignatureQueryApi | apiV1SignatureFuncctxGet | GET /api/v1/signature/funcctx | funcctx query |
OpenapiForSibyl2Server.SignatureQueryApi | apiV1SignatureFuncctxRchainGet | GET /api/v1/signature/funcctx/rchain | funcctx reverse chain query |
OpenapiForSibyl2Server.SignatureQueryApi | apiV1SignatureRegexFuncGet | GET /api/v1/signature/regex/func | func query |
OpenapiForSibyl2Server.StatQueryApi | apiV1RevStatGet | GET /api/v1/rev/stat | rev stat |
Documentation for Models
- OpenapiForSibyl2Server.CorePoint
- OpenapiForSibyl2Server.CoreSpan
- OpenapiForSibyl2Server.ObjectFunctionContextSlimWithSignature
- OpenapiForSibyl2Server.ObjectFunctionWithSignature
- OpenapiForSibyl2Server.ObjectRevInfo
- OpenapiForSibyl2Server.ObjectValueUnit
- OpenapiForSibyl2Server.ServiceContextTree
- OpenapiForSibyl2Server.ServiceFunctionContextChain
- OpenapiForSibyl2Server.ServiceRevStat
- OpenapiForSibyl2Server.Sibyl2ClazzWithPath
- OpenapiForSibyl2Server.Sibyl2FunctionContextSlim
- OpenapiForSibyl2Server.Sibyl2FunctionWithPath
Documentation for Authorization
All endpoints do not require authorization.
1 year ago