.SettingsApi

All URIs are relative to /api

Method	HTTP request	Description
backendVersion	GET /version	get backend version
getOpenApiYaml	GET /openapi.yaml	get openapi yaml spec

backendVersion

string backendVersion()

Example

import {  } from '';
import * as fs from 'fs';

const configuration = .createConfiguration();
const apiInstance = new .SettingsApi(configuration);

let body:any = {};

apiInstance.backendVersion(body).then((data:any) => {
  console.log('API called successfully. Returned data: ' + data);
}).catch((error:any) => console.error(error));

Parameters

This endpoint does not need any parameter.

Return type

string

Authorization

bearerAuth, cookieAuth

HTTP request headers

Content-Type: Not defined
Accept: text/plain

HTTP response details

Status code	Description	Response headers
200	git version of backend	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getOpenApiYaml

string getOpenApiYaml()

Example

import {  } from '';
import * as fs from 'fs';

const configuration = .createConfiguration();
const apiInstance = new .SettingsApi(configuration);

let body:any = {};

apiInstance.getOpenApiYaml(body).then((data:any) => {
  console.log('API called successfully. Returned data: ' + data);
}).catch((error:any) => console.error(error));

Parameters

This endpoint does not need any parameter.

Return type

string

Authorization

bearerAuth, cookieAuth

HTTP request headers

Content-Type: Not defined
Accept: text/plain

HTTP response details

Status code	Description	Response headers
200	openapi yaml file content	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]