Improved applications' endpoints documentation

NIAEFEUP · Sep 10, 2023 · 5e73233 · 5e73233
1 parent 69fa138
commit 5e73233
Show file tree

Hide file tree

Showing 4 changed files with 11 additions and 5 deletions.
diff --git a/documentation/docs/applications/approve.md b/documentation/docs/applications/approve.md
@@ -170,6 +170,7 @@ values={[
 
 </TabItem>
 </Tabs>
+
 ### Example 5 - Application is not verified
 
 **Code** : <Highlight level="danger" inline>409 CONFLICT</Highlight>

diff --git a/documentation/docs/applications/create.md b/documentation/docs/applications/create.md
@@ -13,8 +13,8 @@ import Highlight from "../../src/highlight.js"
 ## Details
 
 This endpoint is used to create company applications.
-In order of a Company to use its account, the company must verify its application by clicking in a link sent by email after the creation of the application and then the Company should
-finish its registration.
+In order for a Company to use its account, the company must verify its application by clicking in a link sent 
+by email after its creation. After that the Company should finish its registration.
 
 **URL** : `/apply/company`
 
@@ -36,7 +36,11 @@ see [register](../auth/register).
 Email used for the company application and subsequent account.
 
 Must be in a valid email format.
-Can't already be in use for accounts or other applications.
+Can't already be in use on any account.
+
+:::info
+After creating an application, if another application is created with the same email after 10 minutes, the existing one will be replaced. Creating the new application before the 10 minute mark will result in an error.
+:::
 
 ### password
 
@@ -181,7 +185,7 @@ values={[
   "password": "password123",
   "companyName": "Company",
   "motivation": "We wish to revolutionize the industry with young engineers."
-}
+}ara quem usa o timetable-bruteforcer
 ```
 
 </TabItem>

diff --git a/documentation/docs/applications/reject.md b/documentation/docs/applications/reject.md
@@ -197,6 +197,7 @@ values={[
 
 </TabItem>
 </Tabs>
+
 ### Example 5 - Application is not verified
 
 **Code** : <Highlight level="danger" inline>409 CONFLICT</Highlight>

diff --git a/documentation/docs/applications/search.md b/documentation/docs/applications/search.md
@@ -188,7 +188,7 @@ values={[
       "submittedAt": "2022-09-07T13:15:15.971Z",
       "isVerified": false,
       "__v": 0,
-      "state": "PENDING"
+      "state": "UNVERIFIED"
     }
   ],
   "docCount": 4