index.json

[{"uri":"/features/authentication/","title":"Authentification","tags":[],"description":"","content":"Connexion L'utilisateur rentre :\n Son email Son mot de passe  Il appuie ensuite sur le bouton de connexion ce qui déclenche un appel à l'API OAuth.\n Si les identifiants sont bon, l'API renvoie le token d'accès ainsi que le token de rafraichissement et l'utilisateur se retrouve la page d'accueil du site Si les identifiants sont incorrects, l'API retourne un code 400 et un message d'erreur s'affiche pour l'utilisateur  Mot de passe oublié L'utilisateur appuie sur un bouton \u0026ldquo;Mot de passe oublié\u0026rdquo; puis renseigne son email avant de valider. Ceci envoie une requête de reset de mot de passe sur l'API GraphQL qui renvoie une des trois réponses suivantes :\n L'email indiqué n'existe pas : on affiche une erreur à l'utilisateur L'email a bien été envoyé : on affiche une page indiquant d'aller consulter les mails  Quand l'utilisateur clique sur le mail de reset de mot de passe dans le mail, cela le renvoie vers une page pour reset sont mot de passe. L'utilisateur doit rentrer son nouveau mot de passe ainsi que confirmer son nouveau mot de passe avant de pouvoir valider. Une fois le formulaire validé, un appel à l'API est effectué pour mettre à jour le mot de passe.\nLe lien de reset de mot de passe n'est valide qu'un certain temps, ce qui peut mener à un lien invalide. Dans ce cas, la page de reset de mot de passe indique juste que le lien n'est plus valide. (la validité d'un lien se vérifie via un appel à l'API GraphQL)\n "},{"uri":"/features/events/","title":"Événements","tags":[],"description":"","content":"Création d'un événement Un utilisateur aillant la permission WRITE_EVENTS peut créer un événement pour son BDE. Pour cela il renseigne les informations suivantes (qui peuvent se distinguer en 3 catégories) :\nLes propriétés intrinsèques de l'événement  Le nom de l'événement La description de l'événement : un texte en markdown La date d'ouverture des réservations : peut ne pas être spécifiée, auquel cas l'événement sera directement ouvert aux réservations La date de fermeture des réservations : peut ne pas être spécifiée, auquel cas l'événement sera ouvert aux réservations indéfiniment Si l'événement est ouvert aux adhérents  Le nombre de places qui peuvent être réservées  Le nombre de places par école :  L'école concernée : (la liste des école peut être récupérée via l'API GraphQL) Le nombre de places pour les adhérents/non-adhérents de cette école (une seule et même valeur) Le nombre de places pour les externes de cette école    Les sondages  Les différents sondages proposé :  Le nom du sondage La description du sondage : un texte en markdown Si le sondage est destiné seulement aux adhérents ou pas Si une réponse au sondage est obligatoire Si le sondage est modifiable seulement par un admin ou pas Les différents choix possibles pour ce sondage :  Le dénomination du choix Le nombre maximum de personnes qui peuvent sélectionner cette options (optionnel)      Exemple de la structure d'un événement Les noms d'attributs ci-dessous ne sont que des exemples, il ne représentent pas exactement le choix définitif des noms qui seront utilisés pour l'API GraphQL.\n title: Campo description: \u0026#34;# Teaser Passez un **incroyable** week-end dans un lieu de *rêve*. # Déroulement On se retrouve place de l\u0026#39;Europe à 8h pour le départ en bus et c\u0026#39;est parti !\u0026#34; bookingStart: 10-09-2021 bookingend: 17-09-2021 limitedToMembers: false places: # Montpellier - bde: dfsd65f-zaza32-54dfd65-sdfs45f schoolPlaces: 300 externPlaces: 0 surveys: - title: Payé description: Est-ce que la place a été payée ? limitedToMembers: false required: true adminRestricted: true choices: - name: Oui max: -1 - title: Régime alimentaire description: Veuillez renseigner si vous avez un régime alimentaire nécessitant une attention particulière limitedToMembers: false required: false adminRestricted: false choices: - name: Végétarien max: -1 - name: Végan max: -1 - name: Sans gluten max: -1 - name: Autre max: -1 - title: Caution description: Est-ce que la caution pour les bus a été donnée ? limitedToMembers: false required: true adminRestricted: true choices: - name: Oui max: -1 - title: Bus description: Dans quel bus voulez-vous être ? limitedToMembers: false required: true adminRestricted: false choices: - name: Bus 1 max: 60 - name: Bus 2 max: 60 - name: Bus 3 max: 60 - name: Bus 4 max: 60 - name: Bus 5 max: 60 Modification d'un événement Tous les paramètres d'un événements doivent pouvoir être changés.\n"},{"uri":"/features/bookings/","title":"Réservations","tags":[],"description":"","content":"Réservations Étudiant Un étudiant peut voir la liste des événements auxquels il peut participer, participe, ou a participé. Pour chaque événement l'étudiant peut voir le nom ainsi que la description de celui-ci. On peut classer un événement dans 5 catégories :\n Un événement que l'on ne peut pas encore réserver (now() \u0026lt; bookingStart) Un événement que l'on peut réserver ((!bookingStart || now() \u0026gt;= bookingStart) \u0026amp;\u0026amp; (!bookingEnd || now() \u0026lt;= bookingEnd)) Un événement qui n'a plus de place de disponibles Un événement que l'on a déjà réservé Un événement que l'on ne peut plus réserver (now() \u0026gt; bookingEnd)  Pour réserver un événement, il clique sur le bouton de réservation de l'événement ; si à ce moment là l'événement n'est pas plein, une réservation est créée pour l'étudiant qui est renvoyé vers page détaillant celle-ci. Il peut alors répondre aux sondages proposés et voir qui a aussi réservé l'événement.\nUn peu imaginer un indicateur pour signaler si des sondages obligatoires n'ont pas encore été remplis.\n Utilisateur avec la permission WRITE_BOOKINKS Un utilisateur avec la permission WRITE_BOOKINGS peut changer les choix des utilisateurs concernant les sondages. Il peut aussi supprimer des réservations et en ajouter.\nModifier une réservation L'utilisateur peut lister les réservations d'un événement ou d'un étudiant, il sélectionne ensuite la réservation et se retrouve sur la page lui permettant de modifier celle-ci.\nSupprimer une réservation Lorsque l'utilisateur est sur la page d'une réservation, il peut supprimer une réservation en cliquant sur un bouton de suppression, une boite de confirmation apparait alors et dans si l'utilisateur valide sa demande de supression, la réservation est supprimée.\nAjouter une réservation L'utilisateur se rend sur la page de l'événement et peut ajouter une réservation pour un étudiant. L'ajout de cette réservation peut mener le nombre de réservations à dépasser le nombre de places disponibles.\n"},{"uri":"/features/","title":"Fonctionnalités","tags":[],"description":"","content":"Chapitre 1 Fonctionnalités Ce chapitre regroupe les fonctionnalités mises à disposition des utilisateurs\n"},{"uri":"/","title":"Accueil","tags":[],"description":"","content":"Accueil Ce site recense les différentes fonctionnalités du site du BDE de Polytech Montpellier en essayant d'expliquer leur fonctionnement de la manière la plus précise possible. Ces spécifications sont sujettes à des changements.\n"},{"uri":"/categories/","title":"Categories","tags":[],"description":"","content":""},{"uri":"/tags/","title":"Tags","tags":[],"description":"","content":""}]