From 7fa0cd71c013c3122e5576299720eb0b6a5e6239 Mon Sep 17 00:00:00 2001 From: Benoît Verhaeghe Date: Sat, 28 Jan 2017 16:27:06 +0100 Subject: [PATCH] Les Transactions --- api.raml | 219 +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++------------------------ 1 file changed, 195 insertions(+), 24 deletions(-) diff --git a/api.raml b/api.raml index dd74f26..7c52ec4 100644 --- a/api.raml +++ b/api.raml @@ -3,28 +3,7 @@ title: API d'Etunicorn baseUri: https://etunicorn.plil.net/{version}/ version: v1 -securitySchemes: - - oauth_2_0: - description: Il faut un token OAuth 2.0 pour utiliser cette API - type: OAuth 2.0 - describedBy: - headers: - Authorization: - description: | - Utilisé pour envoyer un token d'accès OAuth 2. Ne pas envoyer en même temps que le paramètre de requête "access_token" - type: string - queryParameters: - access_token: - description: | - Utilisé pour envoyer un token d'accès OAuth 2. Ne pas envoyer en même temps que le header "Authorization" - type: string - responses: - 401: - description: Token expiré ou invalide. Reconnectez-vous - 403: - description: Permission refusée. Se re-connecter ne changera rien - -# Les codes 400 sont implicites +# Les codes 400 et 403 sont implicites /login: post: description: Instancie une nouvelle connexion @@ -65,10 +44,11 @@ securitySchemes: 204: description: Déconnecté avec succès 404: - description: Jeton invalide ou expiré. À priori, vous êtes déjà déconnecté + description: Jeton non trouvé /personne: get: <<<<<<< HEAD +<<<<<<< HEAD securedBy: [oauth_2_0] <<<<<<< HEAD description: Obtenir la liste des persones @@ -81,6 +61,10 @@ securitySchemes: description: Obtenir la liste des persones. Nécessite COMPTE_ADMIN responses: >>>>>>> f177050... Ajout des permissions +======= + description: Obtenir la liste des persones + responses: +>>>>>>> e551d2a... Les Transactions 200: body: application/json: @@ -97,8 +81,12 @@ securitySchemes: ] /{idPersonne}: get: +<<<<<<< HEAD securedBy: [oauth_2_0] description: Obtenir les infos sur une personne. Nécessite COMPTE_ADMIN +======= + description: Obtenir les infos sur une personne +>>>>>>> e551d2a... Les Transactions responses: 200: description: Utilisateur récupéré @@ -116,8 +104,12 @@ securitySchemes: 404: description: Utilisateur non trouvé put: +<<<<<<< HEAD securedBy: [oauth_2_0] description: Modifer les infos d'une personne. Nécessite COMPTE_ADMIN +======= + description: Modifer les infos d'une personne +>>>>>>> e551d2a... Les Transactions queryParameters: carte: displayName: ID de la carte NFC @@ -148,15 +140,18 @@ securitySchemes: 404: description: Utilisateur non trouvé delete: +<<<<<<< HEAD securedBy: [oauth_2_0] description: Obtenir les infos sur une personne. Nécessite COMPTE_ADMIN +======= + description: Obtenir les infos sur une personne +>>>>>>> e551d2a... Les Transactions responses: 204: description: Utilisateur supprimé 404: description: Utilisateur non trouvé post: - securedBy: [oauth_2_0] description: Ajoute une nouvelle personne queryParameters: carte: @@ -194,8 +189,12 @@ securitySchemes: } /role: get: +<<<<<<< HEAD securedBy: [oauth_2_0] description: Liste les rôles. Nécessite ROLE_ADMIN +======= + description: Liste les rôles +>>>>>>> e551d2a... Les Transactions responses: 200: body: @@ -219,8 +218,12 @@ securitySchemes: } ] post: +<<<<<<< HEAD securedBy: [oauth_2_0] description: Ajoute un nouveau rôle. Nécessite ROLE_ADMIN +======= + description: Ajoute un nouveau rôle +>>>>>>> e551d2a... Les Transactions queryParameters: nom: type: string @@ -234,16 +237,24 @@ securitySchemes: description: Un rôle avec le même nom existe déjà /{nomRole}: delete: +<<<<<<< HEAD securedBy: [oauth_2_0] description: Supprime un rôle. Nécessite ROLE_ADMIN +======= + description: Supprime un rôle +>>>>>>> e551d2a... Les Transactions responses: 204: description: Rôle supprimé 404: description: Rôle inconnu post: +<<<<<<< HEAD securedBy: [oauth_2_0] description: Ajoute une permission à un rôle. Nécessite ROLE_ADMIN +======= + description: Ajoute une permission à un rôle +>>>>>>> e551d2a... Les Transactions queryParameters: nom: type: string @@ -256,8 +267,12 @@ securitySchemes: description: Permission ou rôle inconnu /{nomPermission}: delete: +<<<<<<< HEAD securedBy: [oauth_2_0] description: Enlève la permission du rôle. Nécessite ROLE_ADMIN +======= + description: Enlève la permission du rôle +>>>>>>> e551d2a... Les Transactions responses: 204: description: Permission enlevée avec succès @@ -265,8 +280,12 @@ securitySchemes: description: Permission ou rôle inconnu /permission: get: +<<<<<<< HEAD securedBy: [oauth_2_0] description: Liste les permissions. Nécessite ROLE_ADMIN +======= + description: Liste les permissions +>>>>>>> e551d2a... Les Transactions responses: 200: body: @@ -283,8 +302,12 @@ securitySchemes: /evenement: get: +<<<<<<< HEAD securedBy: [oauth_2_0] description: Obtenir la liste de tout les evenements. Nécessite EVNMT_ADMIN ou EVNMT_ACHETER ou EVNMT_REMBOURSER +======= + description: Obtenir la liste de tout les evenements +>>>>>>> e551d2a... Les Transactions responses: 200: body: @@ -305,8 +328,12 @@ securitySchemes: } ] post: +<<<<<<< HEAD securedBy: [oauth_2_0] description: Permet de creer un nouvel evenement. Nécessite EVNMT_ADMIN +======= + description: Permet de creer un nouvel evenement +>>>>>>> e551d2a... Les Transactions queryParameters: nomEvenement: description: Le nom de l'evenement @@ -325,8 +352,11 @@ securitySchemes: /{evenementId}: put: +<<<<<<< HEAD description: Permet de modifier un évènement existant. Nécessite EVNMT_ADMIN securedBy: [oauth_2_0] +======= +>>>>>>> e551d2a... Les Transactions queryParameters: nomEvenement: description: Le nom de l'evenement @@ -346,8 +376,12 @@ securitySchemes: 404: description: L'evenement n'existe pas get: +<<<<<<< HEAD securedBy: [oauth_2_0] description: Obtenir l'evenement {evenementId}. Nécessite EVNMT_ADMIN ou EVNMT_ACHETER ou EVNMT_REMBOURSER +======= + description: Obtenir l'evenement {evenementId} +>>>>>>> e551d2a... Les Transactions responses: 200: body: @@ -364,8 +398,12 @@ securitySchemes: 404: description: Evenement non existant delete: +<<<<<<< HEAD securedBy: [oauth_2_0] description: Permet de supprimer l'evenement {evenementId}. Nécessite EVNMT_ADMIN +======= + description: Permet de supprimer l'evenement {evenementId} +>>>>>>> e551d2a... Les Transactions responses: 200: description: L'evenement a été bien supprimé @@ -375,8 +413,12 @@ securitySchemes: /consomation: get: +<<<<<<< HEAD securedBy: [oauth_2_0] description: Obtenir la liste de toutes les consomations. Nécessite CONSO_ADMIN ou CONSO_ACHETER ou CONSO_REMBOURSER +======= + description: Obtenir la liste de tout les consomations +>>>>>>> e551d2a... Les Transactions responses: 200: body: @@ -395,8 +437,12 @@ securitySchemes: } ] post: +<<<<<<< HEAD securedBy: [oauth_2_0] description: Permet de creer une nouvelle consomation. Nécessite CONSO_ADMIN +======= + description: Permet de creer un nouvel evenement +>>>>>>> e551d2a... Les Transactions queryParameters: nomConsomation: description: Le nom de la Consomation @@ -411,8 +457,11 @@ securitySchemes: /{consomationId}: put: +<<<<<<< HEAD securedBy: [oauth_2_0] description: Permet de modifier une consommation. Nécessite CONSO_ADMIN +======= +>>>>>>> e551d2a... Les Transactions queryParameters: nomEvenement: description: Le nom de la Consomation @@ -428,8 +477,12 @@ securitySchemes: 404: description: L'evenement n'existe pas get: +<<<<<<< HEAD securedBy: [oauth_2_0] description: Obtenir la Consomation {consomationId}. Nécessite CONSO_ADMIN ou CONSO_ACHETER ou CONSO_REMBOURSER +======= + description: Obtenir la Consomation {consomationId} +>>>>>>> e551d2a... Les Transactions responses: 200: body: @@ -446,8 +499,126 @@ securitySchemes: 404: description: Consomation non existante delete: +<<<<<<< HEAD securedBy: [oauth_2_0] description: Permet de supprimer la consomation {consomationId}. Nécessite CONSO_ADMIN +======= + description: Permet de supprimer la consomation {consomationId} +>>>>>>> e551d2a... Les Transactions responses: 200: description: La consomation a été bien supprime +/participe: + post: + description: Permet d'ajouter une personne a un evenement + queryParameters: + idPersonne: + type: integer + required: true + description: l'identifiant unique de l'utilisateur + idEvenement: + type: integer + required: true + description: l'identifiant unique d'un evenement + responses: + 201: + description: La personne est bien inscrite a cet evenement + get: + description: Permet de savoir si une personne participe a un evenement + queryParameters: + idPersonne: + type: integer + required: true + description: l'identifiant unique de l'utilisateur + idEvenement: + type: integer + required: true + description: l'identifiant unique d'un evenement + responses: + 200: + description: La personne est bien inscrite à l'evenement + 404: + description: La personne n'est pas inscrite à l'evenement + + +/transaction: + get: + description: Permet de recuperer la liste des transaction + responses: + 200: + description: On recupere la liste des transactions + body: + application/json: + example: | + [ + { + "participant": 1, + "acteur": 18, + "idTransaction": 42, + "type": true, + "date": "2003-12-01", + "prix": 25.23 + }, + { + "participant": 5, + "acteur": 1, + "idTransaction": 43, + "type": true, + "date": "2003-12-01", + "prix": -25.23 + } + ] + /participant/{idPersonne}: + get: + description: Permet de recuperer la liste des transaction d'une personne + responses: + 200: + description: On recupere la liste des transactions + body: + application/json: + example: | + [ + { + "participant": 1, + "acteur": 18, + "idTransaction": 42, + "type": true, + "date": "2003-12-01", + "prix": 25.23 + }, + { + "participant": 1, + "acteur": 12, + "idTransaction": 43, + "type": true, + "date": "2003-12-01", + "prix": -25.23 + } + ] + /acteur/{idPersonne}: + get: + description: Permet de recuperer la liste des transaction d'une personne + responses: + 200: + description: On recupere la liste des transactions + body: + application/json: + example: | + [ + { + "participant": 1, + "acteur": 18, + "idTransaction": 42, + "type": true, + "date": "2003-12-01", + "prix": 25.23 + }, + { + "participant": 1, + "acteur": 12, + "idTransaction": 43, + "type": true, + "date": "2003-12-01", + "prix": -25.23 + } + ] -- libgit2 0.21.2