backend/source/api/actions/group_list.ts
2025-08-21 21:46:05 +00:00

75 lines
1.8 KiB
TypeScript

/*
Espe | Ein schlichtes Werkzeug zur Mitglieder-Verwaltung | Backend
Copyright (C) 2024 Christian Fraß
This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public
License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later
version.
This program 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 General Public License for more details.
You should have received a copy of the GNU General Public License along with this program. If not, see
<https://www.gnu.org/licenses/>.
*/
namespace _espe.api
{
/**
*/
export function register_group_list(
rest_subject : lib_plankton.rest_http.type_rest
) : void
{
lib_plankton.rest_http.register<
null,
Array<
{
id : _espe.type.invitation_id;
name : string;
}
>
>(
rest_subject,
lib_plankton.http.enum_method.get,
_espe.api.full_path("/group/list"),
{
/**
* @todo translation
*/
"description": () => "listet alle Gruppen auf",
"output_schema": () => ({
"type": "object",
"nullable": false,
"additionalProperties": false,
"properties": {
"id": {
"nullable": false,
"type": "intiger",
"description": "ID"
},
"name": {
"nullable": false,
"type": "string",
"description": "Name"
},
},
"required": [
"id",
"name",
]
}),
"restriction": () => restriction_logged_in,
"execution": () => async ({}) => {
const data = await _espe.service.group.list();
return Promise.resolve({
"status_code": 200,
"data": data
});
}
}
);
}
}