interfaces/ts/requests/server.ts

47 lines
1.2 KiB
TypeScript
Raw Normal View History

2024-02-01 13:33:20 +00:00
import type { IServerMetrics } from '../data/server.js';
2024-01-24 00:09:21 +00:00
import * as plugins from '../plugins.js';
2024-01-23 22:38:10 +00:00
2024-02-01 13:33:20 +00:00
/**
* This request can be used between any two players
* Examples:
* WebApp -> Cloudly (get metrics)
* Cloudly -> Webapp (send metrics)
* Cloudly -> Coreflow (get metrics)
* Coreflow -> Cloudly (send metrics)
*/
export interface IRequest_Any_Cloudly_ServerStatus
extends plugins.typedrequestInterfaces.implementsTR<
plugins.typedrequestInterfaces.ITypedRequest,
IRequest_Any_Cloudly_ServerStatus
> {
method: 'getOrSendServerMetrics',
request: {
getOrSend: 'get' | 'send';
serverMetrics?: IServerMetrics;
},
response: {
serverMetrics?: IServerMetrics;
},
}
/**
* this request can be used between any two players
* Examples:
* WebApp -> Cloudly
* Cloudly -> Coreflow
* Cloudly -> HostingProvider
*/
export interface IRequest_TriggerServerAction
2024-01-23 22:38:10 +00:00
extends plugins.typedrequestInterfaces.implementsTR<
plugins.typedrequestInterfaces.ITypedRequest,
2024-02-01 13:33:20 +00:00
IRequest_TriggerServerAction
2024-01-23 22:38:10 +00:00
> {
2024-02-01 13:33:20 +00:00
method: 'triggerServerAction';
2024-01-23 22:38:10 +00:00
request: {
actionName: 'reboot' | 'rebuild';
payload: any;
};
response: {
actionConfirmed: boolean;
};
}