e990603311
This adds a JS client for the OAPI interface, and introduces the SocketIO stuff into Flamenco Manager itself. To build & run: - in `web/manager-api` run `npm install` - in `web/manager-api` run `npm link` - in `web/app` run `npm install` - in `web/app` run `npm link flamenco-manager` - in `web/app` run `yarn serve` This may not be a complete list, but at least some of those steps are necessary.
1.6 KiB
1.6 KiB
flamencoManager.MetaApi
All URIs are relative to http://localhost
| Method | HTTP request | Description |
|---|---|---|
| getConfiguration | GET /api/configuration | Get the configuration of this Manager. |
| getVersion | GET /api/version | Get the Flamenco version of this Manager |
getConfiguration
ManagerConfiguration getConfiguration()
Get the configuration of this Manager.
Example
import flamencoManager from 'flamenco-manager';
let apiInstance = new flamencoManager.MetaApi();
apiInstance.getConfiguration().then((data) => {
console.log('API called successfully. Returned data: ' + data);
}, (error) => {
console.error(error);
});
Parameters
This endpoint does not need any parameter.
Return type
Authorization
No authorization required
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
getVersion
FlamencoVersion getVersion()
Get the Flamenco version of this Manager
Example
import flamencoManager from 'flamenco-manager';
let apiInstance = new flamencoManager.MetaApi();
apiInstance.getVersion().then((data) => {
console.log('API called successfully. Returned data: ' + data);
}, (error) => {
console.error(error);
});
Parameters
This endpoint does not need any parameter.
Return type
Authorization
No authorization required
HTTP request headers
- Content-Type: Not defined
- Accept: application/json