[mod] api:pfad-prefix eingeführt

This commit is contained in:
roydfalk 2024-04-30 19:05:23 +02:00
parent 7d1fe228b5
commit f9f3ad8463
13 changed files with 16 additions and 16 deletions

View file

@ -17,7 +17,7 @@ namespace _espe.api
>( >(
rest_subject, rest_subject,
lib_plankton.http.enum_method.post, lib_plankton.http.enum_method.post,
"/email", _espe.conf.get().server.path_base + "/email",
{ {
"description": "sendet eine E-Mail", "description": "sendet eine E-Mail",
"input_schema": () => ({ "input_schema": () => ({

View file

@ -10,7 +10,7 @@ namespace _espe.api
lib_plankton.rest.register<_espe.service.member.type_value, null>( lib_plankton.rest.register<_espe.service.member.type_value, null>(
rest_subject, rest_subject,
lib_plankton.http.enum_method.delete, lib_plankton.http.enum_method.delete,
"/member/:id", _espe.conf.get().server.path_base + "/member/:id",
{ {
"description": "löscht ein vorhandenes Mitglied", "description": "löscht ein vorhandenes Mitglied",
"restriction": restriction_logged_in, "restriction": restriction_logged_in,

View file

@ -24,7 +24,7 @@ namespace _espe.api
>( >(
rest_subject, rest_subject,
lib_plankton.http.enum_method.get, lib_plankton.http.enum_method.get,
"/member/info/:id", _espe.conf.get().server.path_base + "/member/info/:id",
{ {
"description": "gibt Angaben über ein Mitglied aus, die für die Registrierung verwendet werden dürfen", "description": "gibt Angaben über ein Mitglied aus, die für die Registrierung verwendet werden dürfen",
"input_schema": () => ({ "input_schema": () => ({

View file

@ -23,7 +23,7 @@ namespace _espe.api
>( >(
rest_subject, rest_subject,
lib_plankton.http.enum_method.get, lib_plankton.http.enum_method.get,
"/member/list", _espe.conf.get().server.path_base + "/member/list",
{ {
"description": "listet alle Mitglieder auf", "description": "listet alle Mitglieder auf",
"query_parameters": [ "query_parameters": [

View file

@ -17,7 +17,7 @@ namespace _espe.api
>( >(
rest_subject, rest_subject,
lib_plankton.http.enum_method.patch, lib_plankton.http.enum_method.patch,
"/member/modify/:id", _espe.conf.get().server.path_base + "/member/modify/:id",
{ {
"description": "ändert die Angaben eines vorhandenen Mitglieds", "description": "ändert die Angaben eines vorhandenen Mitglieds",
"input_schema": () => ({ "input_schema": () => ({

View file

@ -17,7 +17,7 @@ namespace _espe.api
>( >(
rest_subject, rest_subject,
lib_plankton.http.enum_method.post, lib_plankton.http.enum_method.post,
"/member/project", _espe.conf.get().server.path_base + "/member/project",
{ {
"description": "erstellt ein neues Mitglied und gibt die erzeugte ID aus", "description": "erstellt ein neues Mitglied und gibt die erzeugte ID aus",
"input_schema": () => ({ "input_schema": () => ({

View file

@ -28,7 +28,7 @@ namespace _espe.api
>( >(
rest_subject, rest_subject,
lib_plankton.http.enum_method.get, lib_plankton.http.enum_method.get,
"/member/read/:id", _espe.conf.get().server.path_base + "/member/read/:id",
{ {
"description": "gibt ein Mitglied anhand seiner ID aus", "description": "gibt ein Mitglied anhand seiner ID aus",
// TODO // TODO

View file

@ -24,7 +24,7 @@ namespace _espe.api
>( >(
rest_subject, rest_subject,
lib_plankton.http.enum_method.post, lib_plankton.http.enum_method.post,
"/member/register/:id", _espe.conf.get().server.path_base + "/member/register/:id",
{ {
"description": "nimmt zusätzliche Angaben eines Mitglieds entgegen", "description": "nimmt zusätzliche Angaben eines Mitglieds entgegen",
"input_schema": () => ({ "input_schema": () => ({

View file

@ -11,21 +11,21 @@ namespace _espe.api
{ {
url_template : string; url_template : string;
}, },
null string
>( >(
rest_subject, rest_subject,
lib_plankton.http.enum_method.post, lib_plankton.http.enum_method.post,
"/member/summon/:id", _espe.conf.get().server.path_base + "/member/summon/:id",
{ {
"description": "sendet an ein Mitglied eine E-Mail mit Aufforderung zur Registrierung", "description": "sendet an ein Mitglied eine E-Mail mit Aufforderung zur Registrierung",
"restriction": restriction_logged_in, "restriction": restriction_logged_in,
"execution": async ({"path_parameters": path_parameters, "input": input}) => { "execution": async ({"path_parameters": path_parameters, "input": input}) => {
const member_id : _espe.type.member_id = parseInt(path_parameters["id"]); const member_id : _espe.type.member_id = parseInt(path_parameters["id"]);
await _espe.service.member.summon(member_id, input.url_template); const url : string = await _espe.service.member.summon(member_id, input.url_template);
return Promise.resolve({ return Promise.resolve({
"status_code": 200, "status_code": 200,
"data": null, "data": url,
}); });
} }
} }

View file

@ -10,7 +10,7 @@ namespace _espe.api
lib_plankton.rest.register<{name : string; password : string;}, string>( lib_plankton.rest.register<{name : string; password : string;}, string>(
rest_subject, rest_subject,
lib_plankton.http.enum_method.post, lib_plankton.http.enum_method.post,
"/session/begin", _espe.conf.get().server.path_base + "/session/begin",
{ {
"description": "führt die Anmeldung am System aus um geschützte Aktionen nutzen zu können", "description": "führt die Anmeldung am System aus um geschützte Aktionen nutzen zu können",
"input_schema": () => ({ "input_schema": () => ({

View file

@ -10,7 +10,7 @@ namespace _espe.api
lib_plankton.rest.register<null, null>( lib_plankton.rest.register<null, null>(
rest_subject, rest_subject,
lib_plankton.http.enum_method.delete, lib_plankton.http.enum_method.delete,
"/session/end", _espe.conf.get().server.path_base + "/session/end",
{ {
"description": "beendet eine Sitzung", "description": "beendet eine Sitzung",
"input_schema": () => ({ "input_schema": () => ({

View file

@ -10,7 +10,7 @@ namespace _espe.api
lib_plankton.rest.register<{data : any; verification : string;}, boolean>( lib_plankton.rest.register<{data : any; verification : string;}, boolean>(
rest_subject, rest_subject,
lib_plankton.http.enum_method.post, lib_plankton.http.enum_method.post,
"/verification/check", _espe.conf.get().server.path_base + "/verification/check",
{ {
"description": "untersucht ob ein Prüfwert zu einer Eingabe passt", "description": "untersucht ob ein Prüfwert zu einer Eingabe passt",
"input_schema": () => ({ "input_schema": () => ({

View file

@ -10,7 +10,7 @@ namespace _espe.api
lib_plankton.rest.register<{data : any;}, string>( lib_plankton.rest.register<{data : any;}, string>(
rest_subject, rest_subject,
lib_plankton.http.enum_method.post, lib_plankton.http.enum_method.post,
"/verification/get", _espe.conf.get().server.path_base + "/verification/get",
{ {
"description": "berechnet einen Prüfwert auf Basis eines Geheimnisses", "description": "berechnet einen Prüfwert auf Basis eines Geheimnisses",
"input_schema": () => ({ "input_schema": () => ({