ScoDoc/DocScoDoc
7
2
Fork 10
Code Issues 1 Pull Requests 1 Projects Releases Wiki Activity

API: permission et codes status.

Browse Source
This commit is contained in:
Emmanuel Viennet 2022-07-28 09:42:42 +03:00
parent 2edd61fe51
commit 7e32dc6b88
2 changed files with 10 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
docs/DevAPIPermissions.md
View File

@ -90,7 +90,7 @@ p = Partition.query.filter_by(id=partition_id).join(FormSemestre).filter_by(dept
Écriture d'une vue de l'API accessible en mode web et API: Écriture d'une vue de l'API accessible en mode web et API:
``` ```
@bp.route("/api_function/<int:arg>") @api_bp.route("/api_function/<int:arg>")
@api_web_bp.route("/api_function/<int:arg>") @api_web_bp.route("/api_function/<int:arg>")
@login_required @login_required
@scodoc @scodoc

17
docs/ScoDoc9API.md
View File

@ -40,8 +40,8 @@ su - scodoc
# Créer un rôle # Créer un rôle
flask create-role LecteurAPI flask create-role LecteurAPI
# Lui donner les droits nécessaires: ici APIView # Lui donner les droits nécessaires: ici ScoView
flask edit-role LecteurAPI -a APIView flask edit-role LecteurAPI -a ScoView
# Créer un nouvel utilisateur avec ce rôle: # Créer un nouvel utilisateur avec ce rôle:
flask user-create lecteur_api LecteurAPI @all flask user-create lecteur_api LecteurAPI @all
@ -116,6 +116,8 @@ parties expérimentales progressivement mises en production à partir de 9.2.12)
### Accès à l'API REST ### Accès à l'API REST
Elle sera accessible à l'adresse: https://scodoc.monsite.tld/ScoDoc/api/fonction Elle sera accessible à l'adresse: https://scodoc.monsite.tld/ScoDoc/api/fonction
(et aussi https://scodoc.monsite.tld/ScoDoc/api/<dept_acronyme>/fonction pour un
accès avec des droits restreints au département).
#### Authentification #### Authentification
@ -151,14 +153,13 @@ Tous les codes >= 400 indiquent que la requête n'a pas été traitée avec succ
par le serveur ScoDoc. par le serveur ScoDoc.
* [200](https://developer.mozilla.org/fr/docs/Web/HTTP/Status/200) : OK. * [200](https://developer.mozilla.org/fr/docs/Web/HTTP/Status/200) : OK.
* [400](https://developer.mozilla.org/fr/docs/Web/HTTP/Status/401) : Paramètre manquant, ou valeur incorrecte.
* [401](https://developer.mozilla.org/fr/docs/Web/HTTP/Status/401) : Authentification nécessaire. (jeton non précisé ou invalide) * [401](https://developer.mozilla.org/fr/docs/Web/HTTP/Status/401) : Authentification nécessaire. (jeton non précisé ou invalide)
* [403](https://developer.mozilla.org/fr/docs/Web/HTTP/Status/403) : Action * [403](https://developer.mozilla.org/fr/docs/Web/HTTP/Status/403) : Action
non autorisée pour l'utilisateur associé au jeton non autorisée pour l'utilisateur associé au jeton.
* [404](https://developer.mozilla.org/fr/docs/Web/HTTP/Status/404) : Page * [404](https://developer.mozilla.org/fr/docs/Web/HTTP/Status/401) : Adresse
inaccessible: URL inconnue ou paramètre (id) invalide incorrecte, paramètre manquant, ou objet inexistant.
* [406](https://developer.mozilla.org/fr/docs/Web/HTTP/Status/406) : Le JSON indiqué en données POST n'est pas valide. * [500](https://developer.mozilla.org/fr/docs/Web/HTTP/Status/500) : Erreur
* [500](https://developer.mozilla.org/fr/docs/Web/HTTP/Status/500) : Erreur inconnue, contactez-nous. inconnue côté serveur.
## Départements ## Départements