62 lines
1.6 KiB
TypeScript
62 lines
1.6 KiB
TypeScript
/*
|
|
This file is part of »zeitbild«.
|
|
|
|
Copyright 2025 'kcf' <fenris@folksprak.org>
|
|
|
|
»zeitbild« is free software: you can redistribute it and/or modify
|
|
it under the terms of the GNU Lesser General Public License as published by
|
|
the Free Software Foundation, either version 3 of the License, or
|
|
(at your option) any later version.
|
|
|
|
»zeitbild« is distributed in the hope that it will be useful,
|
|
but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
GNU Lesser General Public License for more details.
|
|
|
|
You should have received a copy of the GNU Lesser General Public License
|
|
along with »zeitbild«. If not, see <http://www.gnu.org/licenses/>.
|
|
*/
|
|
|
|
|
|
namespace _zeitbild.api
|
|
{
|
|
|
|
/**
|
|
*/
|
|
export function register_meta_ping(
|
|
rest_subject : lib_plankton.rest_http.type_rest
|
|
) : void
|
|
{
|
|
lib_plankton.rest_http.register<
|
|
null,
|
|
string
|
|
>
|
|
(
|
|
rest_subject,
|
|
lib_plankton.http.enum_method.get,
|
|
_zeitbild.conf.get().server.path_base + "/meta/ping",
|
|
{
|
|
"description": () => "sendet ein 'pong' zurück; gedacht um die Erreichbarkeit des Backends zu prüfen",
|
|
"input_schema": () => ({
|
|
"nullable": true,
|
|
}),
|
|
"output_schema": () => ({
|
|
"nullable": false,
|
|
"type": "string",
|
|
}),
|
|
"response_body_encode": () => (body) => Promise.resolve<string>(body),
|
|
"response_body_mimetype": () => "text/plain",
|
|
"restriction": () => restriction_none,
|
|
"execution": () => () => {
|
|
return Promise.resolve({
|
|
"status_code": 200,
|
|
"data": "pong",
|
|
});
|
|
},
|
|
}
|
|
);
|
|
}
|
|
|
|
}
|
|
|