@netsoc/webspaced v1.2.0
@netsoc/webspaced
@NetsocWebspaced - JavaScript client for @netsoc/webspaced API for managing next-gen webspaces.
This SDK is automatically generated by the OpenAPI Generator project:
- API version: 1.2.0
- Package version: 1.2.0
- 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 @netsoc/webspaced --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 @netsoc/webspaced 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 @NetsocWebspaced = require('@netsoc/webspaced');
var defaultClient = @NetsocWebspaced.ApiClient.instance;
// Configure Bearer (jwt) access token for authorization: jwt
var jwt = defaultClient.authentications['jwt'];
jwt.accessToken = "YOUR ACCESS TOKEN"
// Configure Bearer (jwt) access token for authorization: jwt_admin
var jwt_admin = defaultClient.authentications['jwt_admin'];
jwt_admin.accessToken = "YOUR ACCESS TOKEN"
var api = new @NetsocWebspaced.ConfigApi()
var username = root; // {String} User's username. Can be `self` to indicate the currently authenticated user.
var callback = function(error, data, response) {
if (error) {
console.error(error);
} else {
console.log('API called successfully.');
}
};
api.callDelete(username, callback);
Documentation for API Endpoints
All URIs are relative to https://webspaced.netsoc.ie/v1
Class | Method | HTTP request | Description |
---|---|---|---|
@NetsocWebspaced.ConfigApi | callDelete | DELETE /webspace/{username} | Destroy webspace |
@NetsocWebspaced.ConfigApi | create | POST /webspace/{username} | Initialize webspace |
@NetsocWebspaced.ConfigApi | get | GET /webspace/{username} | Retrieve all webspace information |
@NetsocWebspaced.ConfigApi | getConfig | GET /webspace/{username}/config | Retrieve webspace configuration |
@NetsocWebspaced.ConfigApi | updateConfig | PATCH /webspace/{username}/config | Change webspace config options |
@NetsocWebspaced.ConsoleApi | clearLog | DELETE /webspace/{username}/log | Clear webspace console log |
@NetsocWebspaced.ConsoleApi | console | GET /webspace/{username}/console | Attach to webspace console |
@NetsocWebspaced.ConsoleApi | exec | POST /webspace/{username}/exec | Execute command non-interactively |
@NetsocWebspaced.ConsoleApi | execInteractive | GET /webspace/{username}/exec | Execute a command interactively |
@NetsocWebspaced.ConsoleApi | getLog | GET /webspace/{username}/log | Retrieve webspace console log |
@NetsocWebspaced.DomainsApi | addDomain | POST /webspace/{username}/domains/{domain} | Add custom domain |
@NetsocWebspaced.DomainsApi | getDomains | GET /webspace/{username}/domains | Retrieve webspace domains |
@NetsocWebspaced.DomainsApi | removeDomain | DELETE /webspace/{username}/domains/{domain} | Delete custom domain |
@NetsocWebspaced.ImagesApi | getImages | GET /images | List images |
@NetsocWebspaced.PortsApi | addPort | POST /webspace/{username}/ports/{ePort}/{iPort} | Add port forward |
@NetsocWebspaced.PortsApi | addRandomPort | POST /webspace/{username}/ports/{iPort} | Add random port forward |
@NetsocWebspaced.PortsApi | getPorts | GET /webspace/{username}/ports | Retrieve webspace port forwards |
@NetsocWebspaced.PortsApi | removePort | DELETE /webspace/{username}/ports/{ePort} | Delete port forward |
@NetsocWebspaced.StateApi | getState | GET /webspace/{username}/state | Retrieve webspace state |
@NetsocWebspaced.StateApi | reboot | PUT /webspace/{username}/state | Reboot webspace container |
@NetsocWebspaced.StateApi | shutdown | DELETE /webspace/{username}/state | Shut down webspace container |
@NetsocWebspaced.StateApi | start | POST /webspace/{username}/state | Start webspace container |
@NetsocWebspaced.StateApi | sync | PATCH /webspace/{username}/state | Re-generate webspace backend config |
Documentation for Models
- @NetsocWebspaced.AddRandomPortResponse
- @NetsocWebspaced.Config
- @NetsocWebspaced.Error
- @NetsocWebspaced.ExecInteractiveControl
- @NetsocWebspaced.ExecInteractiveRequest
- @NetsocWebspaced.ExecRequest
- @NetsocWebspaced.ExecResponse
- @NetsocWebspaced.Image
- @NetsocWebspaced.ImageAlias
- @NetsocWebspaced.InitRequest
- @NetsocWebspaced.InterfaceAddress
- @NetsocWebspaced.InterfaceCounters
- @NetsocWebspaced.NetworkInterface
- @NetsocWebspaced.ResizeRequest
- @NetsocWebspaced.State
- @NetsocWebspaced.Usage
- @NetsocWebspaced.Webspace
Documentation for Authorization
jwt
- Type: Bearer authentication (jwt)
jwt_admin
- Type: Bearer authentication (jwt)