docs: add caution notice for token leak

maelgangloff · Mar 3, 2024 · b741146 · b741146
1 parent 5964c4e
commit b741146
Show file tree

Hide file tree

Showing 2 changed files with 40 additions and 38 deletions.
diff --git a/README.md b/README.md
@@ -58,42 +58,42 @@ Un wiki est disponible, celui-ci rassemble davantage d'informations sur le fonct
 ## Skolengo
 **Kind**: global class  
 
-* [Skolengo](#Skolengo)
-    * [new Skolengo(oidClient, school, tokenSet, config)](#new_Skolengo_new)
-    * _instance_
-        * [.getUserInfo(userId, params, includes)](#Skolengo+getUserInfo)
-        * [.downloadAttachment(attachment)](#Skolengo+downloadAttachment)
-        * [.getSchoolInfos(params, includes)](#Skolengo+getSchoolInfos)
-        * [.getSchoolInfo(schoolInfoId, params, includes)](#Skolengo+getSchoolInfo)
-        * [.getEvaluationSettings(studentId, limit, offset, params, includes)](#Skolengo+getEvaluationSettings)
-        * [.getEvaluation(studentId, periodId, limit, offset, params, includes)](#Skolengo+getEvaluation)
-        * [.getEvaluationDetail(studentId, evaluationId, params, includes)](#Skolengo+getEvaluationDetail)
-        * [.getPeriodicReportsFiles(studentId, limit, offset, params, includes)](#Skolengo+getPeriodicReportsFiles)
-        * [.getAgenda(studentId, startDate, endDate, limit, offset, params, includes)](#Skolengo+getAgenda)
-        * [.getLesson(studentId, lessonId, params, includes)](#Skolengo+getLesson)
-        * [.getHomeworkAssignments(studentId, startDate, endDate, limit, offset, params, includes)](#Skolengo+getHomeworkAssignments)
-        * [.getHomeworkAssignment(studentId, homeworkId, params, includes)](#Skolengo+getHomeworkAssignment)
-        * [.patchHomeworkAssignment(studentId, homeworkId, attributes, params, includes)](#Skolengo+patchHomeworkAssignment)
-        * [.getUsersMailSettings(userId, params, includes)](#Skolengo+getUsersMailSettings)
-        * [.getCommunicationsFolder(folderId, limit, offset, params, includes)](#Skolengo+getCommunicationsFolder)
-        * [.getCommunication(communicationId, params)](#Skolengo+getCommunication)
-        * [.getCommunicationParticipations(communicationId, params, includes)](#Skolengo+getCommunicationParticipations)
-        * [.getCommunicationParticipants(communicationId, fromGroup, params, includes)](#Skolengo+getCommunicationParticipants)
-        * [.patchCommunicationFolders(communicationId, folders, userId, params)](#Skolengo+patchCommunicationFolders)
-        * [.postCommunication(newCommunication, params)](#Skolengo+postCommunication)
-        * [.postParticipation(participation, params)](#Skolengo+postParticipation)
-        * [.getAbsenceFiles(studentId, limit, offset, params, includes)](#Skolengo+getAbsenceFiles)
-        * [.getAbsenceFile(folderId, params, includes)](#Skolengo+getAbsenceFile)
-        * [.postAbsenceFileState(folderId, reasonId, comment, params)](#Skolengo+postAbsenceFileState)
-        * [.getAbsenceReasons(limit, offset, params)](#Skolengo+getAbsenceReasons)
-        * [.refreshToken(triggerListener)](#Skolengo+refreshToken)
-        * [.getTokenClaims()](#Skolengo+getTokenClaims)
-    * _static_
-        * [.revokeToken(oidClient, token)](#Skolengo.revokeToken)
-        * [.getAppCurrentConfig(httpConfig)](#Skolengo.getAppCurrentConfig)
-        * [.searchSchool(filter, limit, offset, httpConfig)](#Skolengo.searchSchool)
-        * [.getOIDClient(school, redirectUri)](#Skolengo.getOIDClient)
-        * [.fromConfigObject(config, skolengoConfig)](#Skolengo.fromConfigObject)
+- [scolengo-api](#scolengo-api)
+  - [Liste des ENT utilisant Skolengo :](#liste-des-ent-utilisant-skolengo-)
+  - [Skolengo](#skolengo)
+    - [new Skolengo(oidClient, school, tokenSet, config)](#new-skolengooidclient-school-tokenset-config)
+    - [skolengo.getUserInfo(userId, params, includes)](#skolengogetuserinfouserid-params-includes)
+    - [skolengo.downloadAttachment(attachment)](#skolengodownloadattachmentattachment)
+    - [skolengo.getSchoolInfos(params, includes)](#skolengogetschoolinfosparams-includes)
+    - [skolengo.getSchoolInfo(schoolInfoId, params, includes)](#skolengogetschoolinfoschoolinfoid-params-includes)
+    - [skolengo.getEvaluationSettings(studentId, limit, offset, params, includes)](#skolengogetevaluationsettingsstudentid-limit-offset-params-includes)
+    - [skolengo.getEvaluation(studentId, periodId, limit, offset, params, includes)](#skolengogetevaluationstudentid-periodid-limit-offset-params-includes)
+    - [skolengo.getEvaluationDetail(studentId, evaluationId, params, includes)](#skolengogetevaluationdetailstudentid-evaluationid-params-includes)
+    - [skolengo.getPeriodicReportsFiles(studentId, limit, offset, params, includes)](#skolengogetperiodicreportsfilesstudentid-limit-offset-params-includes)
+    - [skolengo.getAgenda(studentId, startDate, endDate, limit, offset, params, includes)](#skolengogetagendastudentid-startdate-enddate-limit-offset-params-includes)
+    - [skolengo.getLesson(studentId, lessonId, params, includes)](#skolengogetlessonstudentid-lessonid-params-includes)
+    - [skolengo.getHomeworkAssignments(studentId, startDate, endDate, limit, offset, params, includes)](#skolengogethomeworkassignmentsstudentid-startdate-enddate-limit-offset-params-includes)
+    - [skolengo.getHomeworkAssignment(studentId, homeworkId, params, includes)](#skolengogethomeworkassignmentstudentid-homeworkid-params-includes)
+    - [skolengo.patchHomeworkAssignment(studentId, homeworkId, attributes, params, includes)](#skolengopatchhomeworkassignmentstudentid-homeworkid-attributes-params-includes)
+    - [skolengo.getUsersMailSettings(userId, params, includes)](#skolengogetusersmailsettingsuserid-params-includes)
+    - [skolengo.getCommunicationsFolder(folderId, limit, offset, params, includes)](#skolengogetcommunicationsfolderfolderid-limit-offset-params-includes)
+    - [skolengo.getCommunication(communicationId, params)](#skolengogetcommunicationcommunicationid-params)
+    - [skolengo.getCommunicationParticipations(communicationId, params, includes)](#skolengogetcommunicationparticipationscommunicationid-params-includes)
+    - [skolengo.getCommunicationParticipants(communicationId, fromGroup, params, includes)](#skolengogetcommunicationparticipantscommunicationid-fromgroup-params-includes)
+    - [skolengo.patchCommunicationFolders(communicationId, folders, userId, params)](#skolengopatchcommunicationfolderscommunicationid-folders-userid-params)
+    - [skolengo.postCommunication(newCommunication, params)](#skolengopostcommunicationnewcommunication-params)
+    - [skolengo.postParticipation(participation, params)](#skolengopostparticipationparticipation-params)
+    - [skolengo.getAbsenceFiles(studentId, limit, offset, params, includes)](#skolengogetabsencefilesstudentid-limit-offset-params-includes)
+    - [skolengo.getAbsenceFile(folderId, params, includes)](#skolengogetabsencefilefolderid-params-includes)
+    - [skolengo.postAbsenceFileState(folderId, reasonId, comment, params)](#skolengopostabsencefilestatefolderid-reasonid-comment-params)
+    - [skolengo.getAbsenceReasons(limit, offset, params)](#skolengogetabsencereasonslimit-offset-params)
+    - [skolengo.refreshToken(triggerListener)](#skolengorefreshtokentriggerlistener)
+    - [skolengo.getTokenClaims()](#skolengogettokenclaims)
+    - [Skolengo.revokeToken(oidClient, token)](#skolengorevoketokenoidclient-token)
+    - [Skolengo.getAppCurrentConfig(httpConfig)](#skolengogetappcurrentconfighttpconfig)
+    - [Skolengo.searchSchool(filter, limit, offset, httpConfig)](#skolengosearchschoolfilter-limit-offset-httpconfig)
+    - [Skolengo.getOIDClient(school, redirectUri)](#skolengogetoidclientschool-redirecturi)
+    - [Skolengo.fromConfigObject(config, skolengoConfig)](#skolengofromconfigobjectconfig-skolengoconfig)
 
 <a name="new_Skolengo_new"></a>
 
@@ -187,7 +187,8 @@ Télécharger une pièce jointe.
 
 Une pièce jointe peut être un fichier inclu dans un courriel, une actualité de l'établissement ou un bulletin périodique.
 
-🚨 ATTENTION: Dans cette requête, votre jeton est envoyé à l'URL du fichier. Assurez-vous que celle-ci provient bien de votre établissement.
+> [!CAUTION]
+> 🚨 ATTENTION: Dans cette requête, votre jeton est envoyé à l'URL du fichier. Assurez-vous que celle-ci provient bien de votre établissement.
 
 **Kind**: instance method of [<code>Skolengo</code>](#Skolengo)  
 

diff --git a/src/index.ts b/src/index.ts
@@ -310,7 +310,8 @@ export class Skolengo {
    *
    * Une pièce jointe peut être un fichier inclu dans un courriel, une actualité de l'établissement ou un bulletin périodique.
    *
-   * 🚨 ATTENTION: Dans cette requête, votre jeton est envoyé à l'URL du fichier. Assurez-vous que celle-ci provient bien de votre établissement.
+   * > [!CAUTION]
+   * > 🚨 ATTENTION: Dans cette requête, votre jeton est envoyé à l'URL du fichier. Assurez-vous que celle-ci provient bien de votre établissement.
    * @async
    * @example ```js
    * const {createWriteStream} = require('node:fs')