backend/source/api/actions/session_end.ts

/*
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_session_end(
		rest_subject : lib_plankton.rest_http.type_rest
	) : void
	{
		register<null, null>(
			rest_subject,
			lib_plankton.http.enum_method.delete,
			"/session/end",
			{
				"description": "beendet eine Sitzung",
				"input_schema": () => ({
					"type": "null",
				}),
				"output_schema": () => ({
					"type": "null",
				}),
				"restriction": restriction_logged_in,
				"execution": async (stuff) => {
					const session : {key : string; value : lib_plankton.session.type_session} = await session_from_stuff(stuff);
					await lib_plankton.session.end(session.key);
					return Promise.resolve(
						{
							"status_code": 200,
							"data": null,
						}
					);
				},
			}
		);
	}
	
}