-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathendpoints.yml
116 lines (106 loc) · 2.06 KB
/
endpoints.yml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
# User
- endpunkt: /user
methode: GET
beschreibung: Liste aller nutzer
parameter:
- filter: name # optional
rückgabewerte: [
{
"name": "str",
"id": "str"
}
]
- endpunkt: /user/{id}
methode: GET
beschreibung: Liefert einen Nutzer.
rückgabewerte: {
"name": "str",
"id": "str",
"lists": [
"id"
]
}
- endpunkt: /user/{id}
methode: DELETE
beschreibung: Löscht einen Nutzer.
- endpunkt: /user
methode: POST
beschreibung: Erstellen eines Nutzers
body: {
"name": "str"
}
rückgabewerte: {
"name": "str",
"id": "str"
}
# List
- endpunkt: /user/{id}/list/{id}
methode: GET
beschreibung: Liefert alle Einträge einer Todo-Liste zurück.
rückgabewerte: {
"id": "str",
"name": "str",
"owner": "id",
"entry": [
{
"id": "str",
"name": "str",
"description": "str"
}
]
}
- endpunkt: /user/{id}/list/{id}
methode: DELETE
beschreibung: Löscht die angegebene Liste.
- endpunkt: /user/{id}/list
methode: POST
beschreibung: Erstellt eine neue Liste.
body: {
"name": "str",
}
rückgabewerte: {
"id": "str",
"name": "str"
}
- endpunkt: /user/{id}/list/{id}
methode: PUT
beschreibung: Aktualisiert den Namen einer Liste.
body: {
"name": "str",
}
rückgabewerte: {
"id": "str",
"name": "str"
}
- endpunkt: /user/{id}/list/{id}/entry
methode: POST
beschreibung: Fügt einen Eintrag zu einer Liste hinzu.
body: {
"name": "str",
"description": "str",
}
rückgabewerte: {
"id": "str",
"name": "str",
"description": "str",
}
- endpunkt: /user/{id}/list/{id}/entry/{id}
methode: GET
beschreibung: Liefert einen Eintrag in einer Liste.
rückgabewerte: {
"id": "str",
"name": "str",
"description": "str",
}
- endpunkt: /user/{id}/list/{id}/entry/{id}
methode: POST
beschreibung: Aktualisiert einen Eintrag in einer Liste.
body: {
"name": "str",
"description": "str",
}
rückgabewerte: {
"id": "str",
"name": "str",
"description": "str",
}