History

Vernon Keenan 0a2691ea69 swagger client		2022-09-03 14:10:56 -07:00
..
.openapi-generator	swagger client	2022-09-03 14:10:56 -07:00
docs	swagger client	2022-09-03 14:10:56 -07:00
src	swagger client	2022-09-03 14:10:56 -07:00
test	swagger client	2022-09-03 14:10:56 -07:00
.babelrc	swagger client	2022-09-03 14:10:56 -07:00
.gitignore	swagger client	2022-09-03 14:10:56 -07:00
.openapi-generator-ignore	swagger client	2022-09-03 14:10:56 -07:00
.travis.yml	swagger client	2022-09-03 14:10:56 -07:00
README.md	swagger client	2022-09-03 14:10:56 -07:00
git_push.sh	swagger client	2022-09-03 14:10:56 -07:00
mocha.opts	swagger client	2022-09-03 14:10:56 -07:00
package.json	swagger client	2022-09-03 14:10:56 -07:00

README.md

devops

Devops - JavaScript client for devops System Operations Microservice This SDK is automatically generated by the OpenAPI Generator project:

API version: 0.0.2
Package version: 0.0.2
Build package: org.openapitools.codegen.languages.JavascriptClientCodegen

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 devops --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 devops 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 Devops = require('devops');

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

var api = new Devops.ClusterApi()
var clusterIdPath = "clusterIdPath_example"; // {String} Taxnexus Record Id of a Cluster
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getCluster(clusterIdPath, callback);

Documentation for API Endpoints

All URIs are relative to http://devops.vernonkeenan.com:8080/v1

Class	Method	HTTP request	Description
Devops.ClusterApi	getCluster	GET /clusters/{clusterIdPath}	Get a single Cluster object
Devops.ClusterApi	getClusters	GET /clusters	Get a list Clusters
Devops.ClusterApi	getClustersObservable	GET /clusters/observable	Get Clusters in an observable array
Devops.ClusterApi	postClusters	POST /clusters	Create new Clusters
Devops.ClusterApi	putClusters	PUT /clusters	Update Clustera
Devops.CorsApi	clusterOptions	OPTIONS /clusters/observable
Devops.CorsApi	clustersOptions	OPTIONS /clusters
Devops.CorsApi	databaseOptions	OPTIONS /databases/observable
Devops.CorsApi	databasesOptions	OPTIONS /databases
Devops.CorsApi	templateOptions	OPTIONS /templates/observable
Devops.CorsApi	templatesOptions	OPTIONS /templates
Devops.CorsApi	tenantOptions	OPTIONS /tenants/observable
Devops.CorsApi	tenantsOptions	OPTIONS /tenants
Devops.CorsApi	userOptions	OPTIONS /users/observable
Devops.CorsApi	usersOptions	OPTIONS /users
Devops.DatabaseApi	getDatabase	GET /databases/{databaseIdPath}	Get a single Database object
Devops.DatabaseApi	getDatabases	GET /databases	Get a list Databases
Devops.DatabaseApi	getDatabasesObservable	GET /databases/observable	Get Databases in an observable array
Devops.DatabaseApi	postDatabases	POST /databases	Create new Databases
Devops.DatabaseApi	putDatabases	PUT /databases	Update Databases
Devops.TemplateApi	getTemplate	GET /templates/{templateIdPath}	Get a single Template object
Devops.TemplateApi	getTemplates	GET /templates	Get a list Templates
Devops.TemplateApi	getTemplatesObservable	GET /templates/observable	Get Templates in an observable array
Devops.TemplateApi	postTemplates	POST /templates	Create new Templates
Devops.TenantApi	getTenant	GET /tenants/{tenantIdPath}	Get a single Tenant object
Devops.TenantApi	getTenants	GET /tenants	Get a list Tenants
Devops.TenantApi	getTenantsObservable	GET /tenants/observable	Get Tenants in an observable array
Devops.TenantApi	postTenants	POST /tenants	Create new Tenants
Devops.TenantApi	putTenants	PUT /tenants	Update Tenants
Devops.UserApi	getUser	GET /users/{userIdPath}	Get a single User object
Devops.UserApi	getUsers	GET /users	Get a list Users
Devops.UserApi	getUsersObservable	GET /users/observable	Get Users in an observable array
Devops.UserApi	postUsers	POST /users	Create new Users
Devops.UserApi	putUsers	PUT /users	Update existing users

Documentation for Models

Documentation for Authorization

ApiKeyAuth

Type: API key
API key parameter name: X-API-Key
Location: HTTP header