Add class description to controllers #53
Conversation
| /// Example of use: | ||
| /// filter only OnHold and Approved state | ||
| /// 001001 -> 9 | ||
| /// so you can pass 9 to the filter to get only OnHold and Approved | ||
| /// </summary> | ||
| [JsonConverter(typeof(JsonStringEnumConverter))] | ||
| [Flags] | ||
| public enum State |
There was a problem hiding this comment.
Un manière plus simple de déclarer un enum [Flags] serait d'utiliser l'opérateur Bit Shift, par ex. 1<<1 pour 2, 1<<2 pour 4, 1<<3 pour 8, etc. Source : https://aaronbos.dev/posts/csharp-flags-enum
| /// any types, it is not possible to fetch draft events from there. This controller is used to only | ||
| /// create/update draft events. | ||
| /// | ||
| /// Under the hood, this controller uses the IDraftEventService to manage the data by passing the |
There was a problem hiding this comment.
Bonne idée de documenter à la fois la fonctionnalité d'un point de vue utilisateur et d'un point de vue interne au code
| /// consume and the open data API accessible from the front-end or external parties that want to | ||
| /// show data. | ||
| /// | ||
| /// Under the hood, this controller uses the IEventService to manage the event data fetching, as well as |
| /// without having to know your own id. This is useful for updating your own information or fetching | ||
| /// your profile information. This can work for either a moderator or an organizer. | ||
| /// | ||
| /// Under the hood, this controller uses the IUserService to manage the data by passing the userId found in |
| /// setup of the application by allowing having a public endpoint to create a starting moderator. | ||
| /// Without the header x-api-key, this function will not worked. | ||
| /// | ||
| /// Also, the configuration of the access key is done in the .env file. If you want to remove this functionnality. |
There was a problem hiding this comment.
Très bien fait d'avoir documenté les requis de cette fonctionnalité
| /// A moderator can create, get, toggle the active state of an organizer and get a list of all organizers. | ||
| /// | ||
| /// Under the hood, this controller uses the IUserService to manage the data. It also uses the IAuthService to | ||
| /// create a new user in the Supabase database. Finally, it uses the IEmailService to send an email to the newly |
There was a problem hiding this comment.
Il faudrait s'assurer d'avoir les bons réglages dans le fichier .env pour que l'envoi de courriels fonctionne dans Supabase
|
Add class description on controllers, wiki still awaiting some more info coming soon!