Update doc

This commit is contained in:
T'JAMPENS QUENTIN p2406187
2025-11-17 22:32:30 +01:00
parent 8341021ba5
commit 5b01f2e9f4
11 changed files with 106 additions and 8 deletions
+7
View File
@@ -23,3 +23,10 @@ settings {
encodeUrl: true encodeUrl: true
timeout: 0 timeout: 0
} }
docs {
# /users/logout
Permet de se déconnecter.
Supprime le remember_token et cookies de connexions.
}
+5 -1
View File
@@ -40,5 +40,9 @@ settings {
} }
docs { docs {
Créer un utilisateur test # /users/register
Permet de créer un compte utilisateur.
Entrées: name, lastname, email, password
} }
+18 -1
View File
@@ -5,7 +5,7 @@ meta {
} }
delete { delete {
url: {{url}}/api/users/7 url: {{url}}/api/users/{{id}}
body: none body: none
auth: inherit auth: inherit
} }
@@ -14,7 +14,24 @@ headers {
X-XSRF-TOKEN: X-XSRF-TOKEN:
} }
vars:pre-request {
id: 2
}
settings { settings {
encodeUrl: true encodeUrl: true
timeout: 0 timeout: 0
} }
docs {
# /users/id
Permet de supprimer un compte utilisateur
La connexion est obligatoire, les cookies de connexions/XSRF doivent être présents.
L'utilisateur doit être admin poir supprimer un autre compte utilisateur.
Entrée: id
}
+8
View File
@@ -19,3 +19,11 @@ settings {
encodeUrl: true encodeUrl: true
timeout: 0 timeout: 0
} }
docs {
# /users -- DELETE
Permet de supprimer le compte de l'utilisateur actuellement connecté.
La connexion est obligatoire, les cookies de connexions/XSRF doivent être présents.
}
+6 -1
View File
@@ -5,11 +5,15 @@ meta {
} }
get { get {
url: {{url}}/api/users/5 url: {{url}}/api/users/{{id}}
body: none body: none
auth: inherit auth: inherit
} }
vars:pre-request {
id: 2
}
settings { settings {
encodeUrl: true encodeUrl: true
timeout: 0 timeout: 0
@@ -18,6 +22,7 @@ settings {
docs { docs {
Permet de récupérer les informations d'un utilisateur. Permet de récupérer les informations d'un utilisateur.
Authetification demandée Authetification demandée
Cookies de connexion/XSRF requis.
/api/users/{ID} /api/users/{ID}
+14 -1
View File
@@ -5,7 +5,7 @@ meta {
} }
post { post {
url: {{url}}/api/users/5/role url: {{url}}/api/users/{{id}}/role
body: json body: json
auth: inherit auth: inherit
} }
@@ -23,6 +23,7 @@ body:json {
vars:pre-request { vars:pre-request {
role: 2 role: 2
id: 2
} }
assert { assert {
@@ -33,3 +34,15 @@ settings {
encodeUrl: true encodeUrl: true
timeout: 0 timeout: 0
} }
docs {
# /users/id/role
Permet de modifier le rôle d'un utilisateur.
La connexion est obligatoire, les cookies de connexions/XSRF doivent être présents.
L'utilisateur doit être admin pour modifier le rôle d'un utilisateur.
Entrées: id, role
}
+8 -2
View File
@@ -39,7 +39,13 @@ settings {
} }
docs { docs {
Permet de modifier le nom, le prenom et le numéro de téléphone de l'utilisateur # /users/update
le nom, le prenom et le numéro sont requis en entrée (même si pas modifié) Permet de modifier les données de l'utilisateur actuellement connecté.
La connexion est obligatoire, les cookies de connexions/XSRF doivent être présents.
Entrées: name, lastname, phone
Toutes les données d'entrées sont requises, même celles non modifiées.
} }
+17 -1
View File
@@ -5,7 +5,7 @@ meta {
} }
post { post {
url: {{url}}/api/users/5/validate url: {{url}}/api/users/{{id}}/validate
body: none body: none
auth: inherit auth: inherit
} }
@@ -15,7 +15,23 @@ headers {
X-XSRF-TOKEN: X-XSRF-TOKEN:
} }
vars:pre-request {
id: 2
}
settings { settings {
encodeUrl: true encodeUrl: true
timeout: 0 timeout: 0
} }
docs {
# /users/id/validate
Permet de valider l'inscription d'un nouvel utilisateur.
La connexion est obligatoire, les cookies de connexions/XSRF doivent être présents.
L'utilisateur doit être admin pour valider un autre utilisateur
Entrée: id: identifiant de l'utilisateur qui va être validé.
}
+6
View File
@@ -14,3 +14,9 @@ settings {
encodeUrl: true encodeUrl: true
timeout: 0 timeout: 0
} }
docs {
# /users
Permet de récupérer tous les IDs des utilisateurs.
}
+6
View File
@@ -18,3 +18,9 @@ settings {
encodeUrl: true encodeUrl: true
timeout: 0 timeout: 0
} }
docs {
# /csrf-cookie
Renvoi le cookie XSRF permettant de se connecter et de faire des requêtes afin d'éviter les failles CSRF.
}
+11 -1
View File
@@ -5,7 +5,7 @@ meta {
} }
get { get {
url: {{url}}/api/me url: {{url}}/api/users/me
body: none body: none
auth: inherit auth: inherit
} }
@@ -22,3 +22,13 @@ settings {
encodeUrl: true encodeUrl: true
timeout: 0 timeout: 0
} }
docs {
# /me
Renvoi l'utilisateur acutllement connecté.
La connexion est obligatoire, les cookies de connexions/XSRF doivent être présents.
Renvoi un objet avec les informations de l'utilisateur
}